mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-08 04:41:25 +00:00
test: move gateway server coverage to e2e
This commit is contained in:
Peter Steinberger
312
src/gateway/server.reload.e2e.test.ts
Normal file
312
src/gateway/server.reload.e2e.test.ts
Normal file
@@ -0,0 +1,312 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import {
|
||||
connectOk,
|
||||
getFreePort,
|
||||
installGatewayTestHooks,
|
||||
rpcReq,
|
||||
startGatewayServer,
|
||||
startServerWithClient,
|
||||
} from "./test-helpers.js";
|
||||
|
||||
const hoisted = vi.hoisted(() => {
|
||||
const cronInstances: Array<{
|
||||
start: ReturnType<typeof vi.fn>;
|
||||
stop: ReturnType<typeof vi.fn>;
|
||||
}> = [];
|
||||
|
||||
class CronServiceMock {
|
||||
start = vi.fn(async () => {});
|
||||
stop = vi.fn();
|
||||
constructor() {
|
||||
cronInstances.push(this);
|
||||
}
|
||||
}
|
||||
|
||||
const browserStop = vi.fn(async () => {});
|
||||
const startBrowserControlServerIfEnabled = vi.fn(async () => ({
|
||||
stop: browserStop,
|
||||
}));
|
||||
|
||||
const heartbeatStop = vi.fn();
|
||||
const heartbeatUpdateConfig = vi.fn();
|
||||
const startHeartbeatRunner = vi.fn(() => ({
|
||||
stop: heartbeatStop,
|
||||
updateConfig: heartbeatUpdateConfig,
|
||||
}));
|
||||
|
||||
const startGmailWatcher = vi.fn(async () => ({ started: true }));
|
||||
const stopGmailWatcher = vi.fn(async () => {});
|
||||
|
||||
const providerManager = {
|
||||
getRuntimeSnapshot: vi.fn(() => ({
|
||||
providers: {
|
||||
whatsapp: {
|
||||
running: false,
|
||||
connected: false,
|
||||
reconnectAttempts: 0,
|
||||
lastConnectedAt: null,
|
||||
lastDisconnect: null,
|
||||
lastMessageAt: null,
|
||||
lastEventAt: null,
|
||||
lastError: null,
|
||||
},
|
||||
telegram: {
|
||||
running: false,
|
||||
lastStartAt: null,
|
||||
lastStopAt: null,
|
||||
lastError: null,
|
||||
mode: null,
|
||||
},
|
||||
discord: {
|
||||
running: false,
|
||||
lastStartAt: null,
|
||||
lastStopAt: null,
|
||||
lastError: null,
|
||||
},
|
||||
slack: {
|
||||
running: false,
|
||||
lastStartAt: null,
|
||||
lastStopAt: null,
|
||||
lastError: null,
|
||||
},
|
||||
signal: {
|
||||
running: false,
|
||||
lastStartAt: null,
|
||||
lastStopAt: null,
|
||||
lastError: null,
|
||||
baseUrl: null,
|
||||
},
|
||||
imessage: {
|
||||
running: false,
|
||||
lastStartAt: null,
|
||||
lastStopAt: null,
|
||||
lastError: null,
|
||||
cliPath: null,
|
||||
dbPath: null,
|
||||
},
|
||||
msteams: {
|
||||
running: false,
|
||||
lastStartAt: null,
|
||||
lastStopAt: null,
|
||||
lastError: null,
|
||||
},
|
||||
},
|
||||
providerAccounts: {
|
||||
whatsapp: {},
|
||||
telegram: {},
|
||||
discord: {},
|
||||
slack: {},
|
||||
signal: {},
|
||||
imessage: {},
|
||||
msteams: {},
|
||||
},
|
||||
})),
|
||||
startChannels: vi.fn(async () => {}),
|
||||
startChannel: vi.fn(async () => {}),
|
||||
stopChannel: vi.fn(async () => {}),
|
||||
markChannelLoggedOut: vi.fn(),
|
||||
};
|
||||
|
||||
const createChannelManager = vi.fn(() => providerManager);
|
||||
|
||||
const reloaderStop = vi.fn(async () => {});
|
||||
let onHotReload: ((plan: unknown, nextConfig: unknown) => Promise<void>) | null = null;
|
||||
let onRestart: ((plan: unknown, nextConfig: unknown) => void) | null = null;
|
||||
|
||||
const startGatewayConfigReloader = vi.fn(
|
||||
(opts: { onHotReload: typeof onHotReload; onRestart: typeof onRestart }) => {
|
||||
onHotReload = opts.onHotReload as typeof onHotReload;
|
||||
onRestart = opts.onRestart as typeof onRestart;
|
||||
return { stop: reloaderStop };
|
||||
},
|
||||
);
|
||||
|
||||
return {
|
||||
CronService: CronServiceMock,
|
||||
cronInstances,
|
||||
browserStop,
|
||||
startBrowserControlServerIfEnabled,
|
||||
heartbeatStop,
|
||||
heartbeatUpdateConfig,
|
||||
startHeartbeatRunner,
|
||||
startGmailWatcher,
|
||||
stopGmailWatcher,
|
||||
providerManager,
|
||||
createChannelManager,
|
||||
startGatewayConfigReloader,
|
||||
reloaderStop,
|
||||
getOnHotReload: () => onHotReload,
|
||||
getOnRestart: () => onRestart,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("../cron/service.js", () => ({
|
||||
CronService: hoisted.CronService,
|
||||
}));
|
||||
|
||||
vi.mock("./server-browser.js", () => ({
|
||||
startBrowserControlServerIfEnabled: hoisted.startBrowserControlServerIfEnabled,
|
||||
}));
|
||||
|
||||
vi.mock("../infra/heartbeat-runner.js", () => ({
|
||||
startHeartbeatRunner: hoisted.startHeartbeatRunner,
|
||||
}));
|
||||
|
||||
vi.mock("../hooks/gmail-watcher.js", () => ({
|
||||
startGmailWatcher: hoisted.startGmailWatcher,
|
||||
stopGmailWatcher: hoisted.stopGmailWatcher,
|
||||
}));
|
||||
|
||||
vi.mock("./server-channels.js", () => ({
|
||||
createChannelManager: hoisted.createChannelManager,
|
||||
}));
|
||||
|
||||
vi.mock("./config-reload.js", () => ({
|
||||
startGatewayConfigReloader: hoisted.startGatewayConfigReloader,
|
||||
}));
|
||||
|
||||
installGatewayTestHooks({ scope: "suite" });
|
||||
|
||||
describe("gateway hot reload", () => {
|
||||
let prevSkipChannels: string | undefined;
|
||||
let prevSkipGmail: string | undefined;
|
||||
|
||||
beforeEach(() => {
|
||||
prevSkipChannels = process.env.CLAWDBOT_SKIP_CHANNELS;
|
||||
prevSkipGmail = process.env.CLAWDBOT_SKIP_GMAIL_WATCHER;
|
||||
process.env.CLAWDBOT_SKIP_CHANNELS = "0";
|
||||
delete process.env.CLAWDBOT_SKIP_GMAIL_WATCHER;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
if (prevSkipChannels === undefined) {
|
||||
delete process.env.CLAWDBOT_SKIP_CHANNELS;
|
||||
} else {
|
||||
process.env.CLAWDBOT_SKIP_CHANNELS = prevSkipChannels;
|
||||
}
|
||||
if (prevSkipGmail === undefined) {
|
||||
delete process.env.CLAWDBOT_SKIP_GMAIL_WATCHER;
|
||||
} else {
|
||||
process.env.CLAWDBOT_SKIP_GMAIL_WATCHER = prevSkipGmail;
|
||||
}
|
||||
});
|
||||
|
||||
it("applies hot reload actions and emits restart signal", async () => {
|
||||
const port = await getFreePort();
|
||||
const server = await startGatewayServer(port);
|
||||
|
||||
const onHotReload = hoisted.getOnHotReload();
|
||||
expect(onHotReload).toBeTypeOf("function");
|
||||
|
||||
const nextConfig = {
|
||||
hooks: {
|
||||
enabled: true,
|
||||
token: "secret",
|
||||
gmail: { account: "me@example.com" },
|
||||
},
|
||||
cron: { enabled: true, store: "/tmp/cron.json" },
|
||||
agents: { defaults: { heartbeat: { every: "1m" }, maxConcurrent: 2 } },
|
||||
browser: { enabled: true, controlUrl: "http://127.0.0.1:18791" },
|
||||
web: { enabled: true },
|
||||
channels: {
|
||||
telegram: { botToken: "token" },
|
||||
discord: { token: "token" },
|
||||
signal: { account: "+15550000000" },
|
||||
imessage: { enabled: true },
|
||||
},
|
||||
};
|
||||
|
||||
await onHotReload?.(
|
||||
{
|
||||
changedPaths: [
|
||||
"hooks.gmail.account",
|
||||
"cron.enabled",
|
||||
"agents.defaults.heartbeat.every",
|
||||
"browser.enabled",
|
||||
"web.enabled",
|
||||
"channels.telegram.botToken",
|
||||
"channels.discord.token",
|
||||
"channels.signal.account",
|
||||
"channels.imessage.enabled",
|
||||
],
|
||||
restartGateway: false,
|
||||
restartReasons: [],
|
||||
hotReasons: ["web.enabled"],
|
||||
reloadHooks: true,
|
||||
restartGmailWatcher: true,
|
||||
restartBrowserControl: true,
|
||||
restartCron: true,
|
||||
restartHeartbeat: true,
|
||||
restartChannels: new Set(["whatsapp", "telegram", "discord", "signal", "imessage"]),
|
||||
noopPaths: [],
|
||||
},
|
||||
nextConfig,
|
||||
);
|
||||
|
||||
expect(hoisted.stopGmailWatcher).toHaveBeenCalled();
|
||||
expect(hoisted.startGmailWatcher).toHaveBeenCalledWith(nextConfig);
|
||||
|
||||
expect(hoisted.browserStop).toHaveBeenCalledTimes(1);
|
||||
expect(hoisted.startBrowserControlServerIfEnabled).toHaveBeenCalledTimes(2);
|
||||
|
||||
expect(hoisted.startHeartbeatRunner).toHaveBeenCalledTimes(1);
|
||||
expect(hoisted.heartbeatUpdateConfig).toHaveBeenCalledTimes(1);
|
||||
expect(hoisted.heartbeatUpdateConfig).toHaveBeenCalledWith(nextConfig);
|
||||
|
||||
expect(hoisted.cronInstances.length).toBe(2);
|
||||
expect(hoisted.cronInstances[0].stop).toHaveBeenCalledTimes(1);
|
||||
expect(hoisted.cronInstances[1].start).toHaveBeenCalledTimes(1);
|
||||
|
||||
expect(hoisted.providerManager.stopChannel).toHaveBeenCalledTimes(5);
|
||||
expect(hoisted.providerManager.startChannel).toHaveBeenCalledTimes(5);
|
||||
expect(hoisted.providerManager.stopChannel).toHaveBeenCalledWith("whatsapp");
|
||||
expect(hoisted.providerManager.startChannel).toHaveBeenCalledWith("whatsapp");
|
||||
expect(hoisted.providerManager.stopChannel).toHaveBeenCalledWith("telegram");
|
||||
expect(hoisted.providerManager.startChannel).toHaveBeenCalledWith("telegram");
|
||||
expect(hoisted.providerManager.stopChannel).toHaveBeenCalledWith("discord");
|
||||
expect(hoisted.providerManager.startChannel).toHaveBeenCalledWith("discord");
|
||||
expect(hoisted.providerManager.stopChannel).toHaveBeenCalledWith("signal");
|
||||
expect(hoisted.providerManager.startChannel).toHaveBeenCalledWith("signal");
|
||||
expect(hoisted.providerManager.stopChannel).toHaveBeenCalledWith("imessage");
|
||||
expect(hoisted.providerManager.startChannel).toHaveBeenCalledWith("imessage");
|
||||
|
||||
const onRestart = hoisted.getOnRestart();
|
||||
expect(onRestart).toBeTypeOf("function");
|
||||
|
||||
const signalSpy = vi.fn();
|
||||
process.once("SIGUSR1", signalSpy);
|
||||
|
||||
onRestart?.(
|
||||
{
|
||||
changedPaths: ["gateway.port"],
|
||||
restartGateway: true,
|
||||
restartReasons: ["gateway.port"],
|
||||
hotReasons: [],
|
||||
reloadHooks: false,
|
||||
restartGmailWatcher: false,
|
||||
restartBrowserControl: false,
|
||||
restartCron: false,
|
||||
restartHeartbeat: false,
|
||||
restartChannels: new Set(),
|
||||
noopPaths: [],
|
||||
},
|
||||
{},
|
||||
);
|
||||
|
||||
expect(signalSpy).toHaveBeenCalledTimes(1);
|
||||
|
||||
await server.close();
|
||||
});
|
||||
});
|
||||
|
||||
describe("gateway agents", () => {
|
||||
it("lists configured agents via agents.list RPC", async () => {
|
||||
const { server, ws } = await startServerWithClient();
|
||||
await connectOk(ws);
|
||||
const res = await rpcReq<{ agents: Array<{ id: string }> }>(ws, "agents.list", {});
|
||||
expect(res.ok).toBe(true);
|
||||
expect(res.payload?.agents.map((agent) => agent.id)).toContain("main");
|
||||
ws.close();
|
||||
await server.close();
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user