mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-10 03:52:42 +00:00
refactor: share feishu webhook monitor harness
This commit is contained in:
@@ -1,9 +1,7 @@
|
|||||||
import crypto from "node:crypto";
|
import crypto from "node:crypto";
|
||||||
import { createServer } from "node:http";
|
|
||||||
import type { AddressInfo } from "node:net";
|
|
||||||
import type { ClawdbotConfig } from "openclaw/plugin-sdk/feishu";
|
|
||||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||||
import { createFeishuRuntimeMockModule } from "./monitor.test-mocks.js";
|
import { createFeishuRuntimeMockModule } from "./monitor.test-mocks.js";
|
||||||
|
import { withRunningWebhookMonitor } from "./monitor.webhook.test-helpers.js";
|
||||||
|
|
||||||
const probeFeishuMock = vi.hoisted(() => vi.fn());
|
const probeFeishuMock = vi.hoisted(() => vi.fn());
|
||||||
|
|
||||||
@@ -23,61 +21,6 @@ vi.mock("./runtime.js", () => createFeishuRuntimeMockModule());
|
|||||||
|
|
||||||
import { monitorFeishuProvider, stopFeishuMonitor } from "./monitor.js";
|
import { monitorFeishuProvider, stopFeishuMonitor } from "./monitor.js";
|
||||||
|
|
||||||
async function getFreePort(): Promise<number> {
|
|
||||||
const server = createServer();
|
|
||||||
await new Promise<void>((resolve) => server.listen(0, "127.0.0.1", () => resolve()));
|
|
||||||
const address = server.address() as AddressInfo | null;
|
|
||||||
if (!address) {
|
|
||||||
throw new Error("missing server address");
|
|
||||||
}
|
|
||||||
await new Promise<void>((resolve) => server.close(() => resolve()));
|
|
||||||
return address.port;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function waitUntilServerReady(url: string): Promise<void> {
|
|
||||||
for (let i = 0; i < 50; i += 1) {
|
|
||||||
try {
|
|
||||||
const response = await fetch(url, { method: "GET" });
|
|
||||||
if (response.status >= 200 && response.status < 500) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
} catch {
|
|
||||||
// retry
|
|
||||||
}
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, 20));
|
|
||||||
}
|
|
||||||
throw new Error(`server did not start: ${url}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function buildConfig(params: {
|
|
||||||
accountId: string;
|
|
||||||
path: string;
|
|
||||||
port: number;
|
|
||||||
verificationToken?: string;
|
|
||||||
encryptKey?: string;
|
|
||||||
}): ClawdbotConfig {
|
|
||||||
return {
|
|
||||||
channels: {
|
|
||||||
feishu: {
|
|
||||||
enabled: true,
|
|
||||||
accounts: {
|
|
||||||
[params.accountId]: {
|
|
||||||
enabled: true,
|
|
||||||
appId: "cli_test",
|
|
||||||
appSecret: "secret_test", // pragma: allowlist secret
|
|
||||||
connectionMode: "webhook",
|
|
||||||
webhookHost: "127.0.0.1",
|
|
||||||
webhookPort: params.port,
|
|
||||||
webhookPath: params.path,
|
|
||||||
encryptKey: params.encryptKey,
|
|
||||||
verificationToken: params.verificationToken,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
} as ClawdbotConfig;
|
|
||||||
}
|
|
||||||
|
|
||||||
function signFeishuPayload(params: {
|
function signFeishuPayload(params: {
|
||||||
encryptKey: string;
|
encryptKey: string;
|
||||||
payload: Record<string, unknown>;
|
payload: Record<string, unknown>;
|
||||||
@@ -107,43 +50,6 @@ function encryptFeishuPayload(encryptKey: string, payload: Record<string, unknow
|
|||||||
return Buffer.concat([iv, encrypted]).toString("base64");
|
return Buffer.concat([iv, encrypted]).toString("base64");
|
||||||
}
|
}
|
||||||
|
|
||||||
async function withRunningWebhookMonitor(
|
|
||||||
params: {
|
|
||||||
accountId: string;
|
|
||||||
path: string;
|
|
||||||
verificationToken: string;
|
|
||||||
encryptKey: string;
|
|
||||||
},
|
|
||||||
run: (url: string) => Promise<void>,
|
|
||||||
) {
|
|
||||||
const port = await getFreePort();
|
|
||||||
const cfg = buildConfig({
|
|
||||||
accountId: params.accountId,
|
|
||||||
path: params.path,
|
|
||||||
port,
|
|
||||||
encryptKey: params.encryptKey,
|
|
||||||
verificationToken: params.verificationToken,
|
|
||||||
});
|
|
||||||
|
|
||||||
const abortController = new AbortController();
|
|
||||||
const runtime = { log: vi.fn(), error: vi.fn(), exit: vi.fn() };
|
|
||||||
const monitorPromise = monitorFeishuProvider({
|
|
||||||
config: cfg,
|
|
||||||
runtime,
|
|
||||||
abortSignal: abortController.signal,
|
|
||||||
});
|
|
||||||
|
|
||||||
const url = `http://127.0.0.1:${port}${params.path}`;
|
|
||||||
await waitUntilServerReady(url);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await run(url);
|
|
||||||
} finally {
|
|
||||||
abortController.abort();
|
|
||||||
await monitorPromise;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
stopFeishuMonitor();
|
stopFeishuMonitor();
|
||||||
});
|
});
|
||||||
@@ -159,6 +65,7 @@ describe("Feishu webhook signed-request e2e", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const payload = { type: "url_verification", challenge: "challenge-token" };
|
const payload = { type: "url_verification", challenge: "challenge-token" };
|
||||||
const response = await fetch(url, {
|
const response = await fetch(url, {
|
||||||
@@ -185,6 +92,7 @@ describe("Feishu webhook signed-request e2e", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const response = await fetch(url, {
|
const response = await fetch(url, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
@@ -208,6 +116,7 @@ describe("Feishu webhook signed-request e2e", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const response = await fetch(url, {
|
const response = await fetch(url, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
@@ -231,6 +140,7 @@ describe("Feishu webhook signed-request e2e", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const payload = { type: "url_verification", challenge: "challenge-token" };
|
const payload = { type: "url_verification", challenge: "challenge-token" };
|
||||||
const response = await fetch(url, {
|
const response = await fetch(url, {
|
||||||
@@ -255,6 +165,7 @@ describe("Feishu webhook signed-request e2e", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const payload = {
|
const payload = {
|
||||||
schema: "2.0",
|
schema: "2.0",
|
||||||
@@ -283,6 +194,7 @@ describe("Feishu webhook signed-request e2e", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const payload = {
|
const payload = {
|
||||||
encrypt: encryptFeishuPayload("encrypt_key", {
|
encrypt: encryptFeishuPayload("encrypt_key", {
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
import { createServer } from "node:http";
|
|
||||||
import type { AddressInfo } from "node:net";
|
|
||||||
import type { ClawdbotConfig } from "openclaw/plugin-sdk/feishu";
|
|
||||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||||
import {
|
import {
|
||||||
createFeishuClientMockModule,
|
createFeishuClientMockModule,
|
||||||
createFeishuRuntimeMockModule,
|
createFeishuRuntimeMockModule,
|
||||||
} from "./monitor.test-mocks.js";
|
} from "./monitor.test-mocks.js";
|
||||||
|
import {
|
||||||
|
buildWebhookConfig,
|
||||||
|
getFreePort,
|
||||||
|
withRunningWebhookMonitor,
|
||||||
|
} from "./monitor.webhook.test-helpers.js";
|
||||||
|
|
||||||
const probeFeishuMock = vi.hoisted(() => vi.fn());
|
const probeFeishuMock = vi.hoisted(() => vi.fn());
|
||||||
|
|
||||||
@@ -33,98 +35,6 @@ import {
|
|||||||
stopFeishuMonitor,
|
stopFeishuMonitor,
|
||||||
} from "./monitor.js";
|
} from "./monitor.js";
|
||||||
|
|
||||||
async function getFreePort(): Promise<number> {
|
|
||||||
const server = createServer();
|
|
||||||
await new Promise<void>((resolve) => server.listen(0, "127.0.0.1", () => resolve()));
|
|
||||||
const address = server.address() as AddressInfo | null;
|
|
||||||
if (!address) {
|
|
||||||
throw new Error("missing server address");
|
|
||||||
}
|
|
||||||
await new Promise<void>((resolve) => server.close(() => resolve()));
|
|
||||||
return address.port;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function waitUntilServerReady(url: string): Promise<void> {
|
|
||||||
for (let i = 0; i < 50; i += 1) {
|
|
||||||
try {
|
|
||||||
const response = await fetch(url, { method: "GET" });
|
|
||||||
if (response.status >= 200 && response.status < 500) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
} catch {
|
|
||||||
// retry
|
|
||||||
}
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, 20));
|
|
||||||
}
|
|
||||||
throw new Error(`server did not start: ${url}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function buildConfig(params: {
|
|
||||||
accountId: string;
|
|
||||||
path: string;
|
|
||||||
port: number;
|
|
||||||
verificationToken?: string;
|
|
||||||
encryptKey?: string;
|
|
||||||
}): ClawdbotConfig {
|
|
||||||
return {
|
|
||||||
channels: {
|
|
||||||
feishu: {
|
|
||||||
enabled: true,
|
|
||||||
accounts: {
|
|
||||||
[params.accountId]: {
|
|
||||||
enabled: true,
|
|
||||||
appId: "cli_test",
|
|
||||||
appSecret: "secret_test", // pragma: allowlist secret
|
|
||||||
connectionMode: "webhook",
|
|
||||||
webhookHost: "127.0.0.1",
|
|
||||||
webhookPort: params.port,
|
|
||||||
webhookPath: params.path,
|
|
||||||
encryptKey: params.encryptKey,
|
|
||||||
verificationToken: params.verificationToken,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
} as ClawdbotConfig;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function withRunningWebhookMonitor(
|
|
||||||
params: {
|
|
||||||
accountId: string;
|
|
||||||
path: string;
|
|
||||||
verificationToken: string;
|
|
||||||
encryptKey: string;
|
|
||||||
},
|
|
||||||
run: (url: string) => Promise<void>,
|
|
||||||
) {
|
|
||||||
const port = await getFreePort();
|
|
||||||
const cfg = buildConfig({
|
|
||||||
accountId: params.accountId,
|
|
||||||
path: params.path,
|
|
||||||
port,
|
|
||||||
encryptKey: params.encryptKey,
|
|
||||||
verificationToken: params.verificationToken,
|
|
||||||
});
|
|
||||||
|
|
||||||
const abortController = new AbortController();
|
|
||||||
const runtime = { log: vi.fn(), error: vi.fn(), exit: vi.fn() };
|
|
||||||
const monitorPromise = monitorFeishuProvider({
|
|
||||||
config: cfg,
|
|
||||||
runtime,
|
|
||||||
abortSignal: abortController.signal,
|
|
||||||
});
|
|
||||||
|
|
||||||
const url = `http://127.0.0.1:${port}${params.path}`;
|
|
||||||
await waitUntilServerReady(url);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await run(url);
|
|
||||||
} finally {
|
|
||||||
abortController.abort();
|
|
||||||
await monitorPromise;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
clearFeishuWebhookRateLimitStateForTest();
|
clearFeishuWebhookRateLimitStateForTest();
|
||||||
stopFeishuMonitor();
|
stopFeishuMonitor();
|
||||||
@@ -134,7 +44,7 @@ describe("Feishu webhook security hardening", () => {
|
|||||||
it("rejects webhook mode without verificationToken", async () => {
|
it("rejects webhook mode without verificationToken", async () => {
|
||||||
probeFeishuMock.mockResolvedValue({ ok: true, botOpenId: "bot_open_id" });
|
probeFeishuMock.mockResolvedValue({ ok: true, botOpenId: "bot_open_id" });
|
||||||
|
|
||||||
const cfg = buildConfig({
|
const cfg = buildWebhookConfig({
|
||||||
accountId: "missing-token",
|
accountId: "missing-token",
|
||||||
path: "/hook-missing-token",
|
path: "/hook-missing-token",
|
||||||
port: await getFreePort(),
|
port: await getFreePort(),
|
||||||
@@ -148,7 +58,7 @@ describe("Feishu webhook security hardening", () => {
|
|||||||
it("rejects webhook mode without encryptKey", async () => {
|
it("rejects webhook mode without encryptKey", async () => {
|
||||||
probeFeishuMock.mockResolvedValue({ ok: true, botOpenId: "bot_open_id" });
|
probeFeishuMock.mockResolvedValue({ ok: true, botOpenId: "bot_open_id" });
|
||||||
|
|
||||||
const cfg = buildConfig({
|
const cfg = buildWebhookConfig({
|
||||||
accountId: "missing-encrypt-key",
|
accountId: "missing-encrypt-key",
|
||||||
path: "/hook-missing-encrypt",
|
path: "/hook-missing-encrypt",
|
||||||
port: await getFreePort(),
|
port: await getFreePort(),
|
||||||
@@ -167,6 +77,7 @@ describe("Feishu webhook security hardening", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
const response = await fetch(url, {
|
const response = await fetch(url, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
@@ -189,6 +100,7 @@ describe("Feishu webhook security hardening", () => {
|
|||||||
verificationToken: "verify_token",
|
verificationToken: "verify_token",
|
||||||
encryptKey: "encrypt_key",
|
encryptKey: "encrypt_key",
|
||||||
},
|
},
|
||||||
|
monitorFeishuProvider,
|
||||||
async (url) => {
|
async (url) => {
|
||||||
let saw429 = false;
|
let saw429 = false;
|
||||||
for (let i = 0; i < 130; i += 1) {
|
for (let i = 0; i < 130; i += 1) {
|
||||||
|
|||||||
98
extensions/feishu/src/monitor.webhook.test-helpers.ts
Normal file
98
extensions/feishu/src/monitor.webhook.test-helpers.ts
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
import { createServer } from "node:http";
|
||||||
|
import type { AddressInfo } from "node:net";
|
||||||
|
import type { ClawdbotConfig } from "openclaw/plugin-sdk/feishu";
|
||||||
|
import { vi } from "vitest";
|
||||||
|
import type { monitorFeishuProvider } from "./monitor.js";
|
||||||
|
|
||||||
|
export async function getFreePort(): Promise<number> {
|
||||||
|
const server = createServer();
|
||||||
|
await new Promise<void>((resolve) => server.listen(0, "127.0.0.1", () => resolve()));
|
||||||
|
const address = server.address() as AddressInfo | null;
|
||||||
|
if (!address) {
|
||||||
|
throw new Error("missing server address");
|
||||||
|
}
|
||||||
|
await new Promise<void>((resolve) => server.close(() => resolve()));
|
||||||
|
return address.port;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function waitUntilServerReady(url: string): Promise<void> {
|
||||||
|
for (let i = 0; i < 50; i += 1) {
|
||||||
|
try {
|
||||||
|
const response = await fetch(url, { method: "GET" });
|
||||||
|
if (response.status >= 200 && response.status < 500) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// retry
|
||||||
|
}
|
||||||
|
await new Promise((resolve) => setTimeout(resolve, 20));
|
||||||
|
}
|
||||||
|
throw new Error(`server did not start: ${url}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function buildWebhookConfig(params: {
|
||||||
|
accountId: string;
|
||||||
|
path: string;
|
||||||
|
port: number;
|
||||||
|
verificationToken?: string;
|
||||||
|
encryptKey?: string;
|
||||||
|
}): ClawdbotConfig {
|
||||||
|
return {
|
||||||
|
channels: {
|
||||||
|
feishu: {
|
||||||
|
enabled: true,
|
||||||
|
accounts: {
|
||||||
|
[params.accountId]: {
|
||||||
|
enabled: true,
|
||||||
|
appId: "cli_test",
|
||||||
|
appSecret: "secret_test", // pragma: allowlist secret
|
||||||
|
connectionMode: "webhook",
|
||||||
|
webhookHost: "127.0.0.1",
|
||||||
|
webhookPort: params.port,
|
||||||
|
webhookPath: params.path,
|
||||||
|
encryptKey: params.encryptKey,
|
||||||
|
verificationToken: params.verificationToken,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
} as ClawdbotConfig;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function withRunningWebhookMonitor(
|
||||||
|
params: {
|
||||||
|
accountId: string;
|
||||||
|
path: string;
|
||||||
|
verificationToken: string;
|
||||||
|
encryptKey: string;
|
||||||
|
},
|
||||||
|
monitor: typeof monitorFeishuProvider,
|
||||||
|
run: (url: string) => Promise<void>,
|
||||||
|
) {
|
||||||
|
const port = await getFreePort();
|
||||||
|
const cfg = buildWebhookConfig({
|
||||||
|
accountId: params.accountId,
|
||||||
|
path: params.path,
|
||||||
|
port,
|
||||||
|
encryptKey: params.encryptKey,
|
||||||
|
verificationToken: params.verificationToken,
|
||||||
|
});
|
||||||
|
|
||||||
|
const abortController = new AbortController();
|
||||||
|
const runtime = { log: vi.fn(), error: vi.fn(), exit: vi.fn() };
|
||||||
|
const monitorPromise = monitor({
|
||||||
|
config: cfg,
|
||||||
|
runtime,
|
||||||
|
abortSignal: abortController.signal,
|
||||||
|
});
|
||||||
|
|
||||||
|
const url = `http://127.0.0.1:${port}${params.path}`;
|
||||||
|
await waitUntilServerReady(url);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await run(url);
|
||||||
|
} finally {
|
||||||
|
abortController.abort();
|
||||||
|
await monitorPromise;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user