Files
clawdbot/src/gateway/server.reload.test.ts
Peter Steinberger 7acd26a2fc Move provider to a plugin-architecture (#661)
* refactor: introduce provider plugin registry

* refactor: move provider CLI to plugins

* docs: add provider plugin implementation notes

* refactor: shift provider runtime logic into plugins

* refactor: add plugin defaults and summaries

* docs: update provider plugin notes

* feat(commands): add /commands slash list

* Auto-reply: tidy help message

* Auto-reply: fix status command lint

* Tests: align google shared expectations

* Auto-reply: tidy help message

* Auto-reply: fix status command lint

* refactor: move provider routing into plugins

* test: align agent routing expectations

* docs: update provider plugin notes

* refactor: route replies via provider plugins

* docs: note route-reply plugin hooks

* refactor: extend provider plugin contract

* refactor: derive provider status from plugins

* refactor: unify gateway provider control

* refactor: use plugin metadata in auto-reply

* fix: parenthesize cron target selection

* refactor: derive gateway methods from plugins

* refactor: generalize provider logout

* refactor: route provider logout through plugins

* refactor: move WhatsApp web login methods into plugin

* refactor: generalize provider log prefixes

* refactor: centralize default chat provider

* refactor: derive provider lists from registry

* refactor: move provider reload noops into plugins

* refactor: resolve web login provider via alias

* refactor: derive CLI provider options from plugins

* refactor: derive prompt provider list from plugins

* style: apply biome lint fixes

* fix: resolve provider routing edge cases

* docs: update provider plugin refactor notes

* fix(gateway): harden agent provider routing

* refactor: move provider routing into plugins

* refactor: move provider CLI to plugins

* refactor: derive provider lists from registry

* fix: restore slash command parsing

* refactor: align provider ids for schema

* refactor: unify outbound target resolution

* fix: keep outbound labels stable

* feat: add msteams to cron surfaces

* fix: clean up lint build issues

* refactor: localize chat provider alias normalization

* refactor: drive gateway provider lists from plugins

* docs: update provider plugin notes

* style: format message-provider

* fix: avoid provider registry init cycles

* style: sort message-provider imports

* fix: relax provider alias map typing

* refactor: move provider routing into plugins

* refactor: add plugin pairing/config adapters

* refactor: route pairing and provider removal via plugins

* refactor: align auto-reply provider typing

* test: stabilize telegram media mocks

* docs: update provider plugin refactor notes

* refactor: pluginize outbound targets

* refactor: pluginize provider selection

* refactor: generalize text chunk limits

* docs: update provider plugin notes

* refactor: generalize group session/config

* fix: normalize provider id for room detection

* fix: avoid provider init in system prompt

* style: formatting cleanup

* refactor: normalize agent delivery targets

* test: update outbound delivery labels

* chore: fix lint regressions

* refactor: extend provider plugin adapters

* refactor: move elevated/block streaming defaults to plugins

* refactor: defer outbound send deps to plugins

* docs: note plugin-driven streaming/elevated defaults

* refactor: centralize webchat provider constant

* refactor: add provider setup adapters

* refactor: delegate provider add config to plugins

* docs: document plugin-driven provider add

* refactor: add plugin state/binding metadata

* refactor: build agent provider status from plugins

* docs: note plugin-driven agent bindings

* refactor: centralize internal provider constant usage

* fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing)

* refactor: centralize default chat provider

* refactor: centralize WhatsApp target normalization

* refactor: move provider routing into plugins

* refactor: normalize agent delivery targets

* chore: fix lint regressions

* fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing)

* feat: expand provider plugin adapters

* refactor: route auto-reply via provider plugins

* fix: align WhatsApp target normalization

* fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing)

* refactor: centralize WhatsApp target normalization

* feat: add /config chat config updates

* docs: add /config get alias

* feat(commands): add /commands slash list

* refactor: centralize default chat provider

* style: apply biome lint fixes

* chore: fix lint regressions

* fix: clean up whatsapp allowlist typing

* style: format config command helpers

* refactor: pluginize tool threading context

* refactor: normalize session announce targets

* docs: note new plugin threading and announce hooks

* refactor: pluginize message actions

* docs: update provider plugin actions notes

* fix: align provider action adapters

* refactor: centralize webchat checks

* style: format message provider helpers

* refactor: move provider onboarding into adapters

* docs: note onboarding provider adapters

* feat: add msteams onboarding adapter

* style: organize onboarding imports

* fix: normalize msteams allowFrom types

* feat: add plugin text chunk limits

* refactor: use plugin chunk limit fallbacks

* feat: add provider mention stripping hooks

* style: organize provider plugin type imports

* refactor: generalize health snapshots

* refactor: update macOS health snapshot handling

* docs: refresh health snapshot notes

* style: format health snapshot updates

* refactor: drive security warnings via plugins

* docs: note provider security adapter

* style: format provider security adapters

* refactor: centralize provider account defaults

* refactor: type gateway client identity constants

* chore: regen gateway protocol swift

* fix: degrade health on failed provider probe

* refactor: centralize pairing approve hint

* docs: add plugin CLI command references

* refactor: route auth and tool sends through plugins

* docs: expand provider plugin hooks

* refactor: document provider docking touchpoints

* refactor: normalize internal provider defaults

* refactor: streamline outbound delivery wiring

* refactor: make provider onboarding plugin-owned

* refactor: support provider-owned agent tools

* refactor: move telegram draft chunking into telegram module

* refactor: infer provider tool sends via extractToolSend

* fix: repair plugin onboarding imports

* refactor: de-dup outbound target normalization

* style: tidy plugin and agent imports

* refactor: data-drive provider selection line

* fix: satisfy lint after provider plugin rebase

* test: deflake gateway-cli coverage

* style: format gateway-cli coverage test

* refactor(provider-plugins): simplify provider ids

* test(pairing-cli): avoid provider-specific ternary

* style(macos): swiftformat HealthStore

* refactor(sandbox): derive provider tool denylist

* fix(sandbox): avoid plugin init in defaults

* refactor(provider-plugins): centralize provider aliases

* style(test): satisfy biome

* refactor(protocol): v3 providers.status maps

* refactor(ui): adapt to protocol v3

* refactor(macos): adapt to protocol v3

* test: update providers.status v3 fixtures

* refactor(gateway): map provider runtime snapshot

* test(gateway): update reload runtime snapshot

* refactor(whatsapp): normalize heartbeat provider id

* docs(refactor): update provider plugin notes

* style: satisfy biome after rebase

* fix: describe sandboxed elevated in prompt

* feat(gateway): add agent image attachments + live probe

* refactor: derive CLI provider options from plugins

* fix(gateway): harden agent provider routing

* fix(gateway): harden agent provider routing

* refactor: align provider ids for schema

* fix(protocol): keep agent provider string

* fix(gateway): harden agent provider routing

* fix(protocol): keep agent provider string

* refactor: normalize agent delivery targets

* refactor: support provider-owned agent tools

* refactor(config): provider-keyed elevated allowFrom

* style: satisfy biome

* fix(gateway): appease provider narrowing

* style: satisfy biome

* refactor(reply): move group intro hints into plugin

* fix(reply): avoid plugin registry init cycle

* refactor(providers): add lightweight provider dock

* refactor(gateway): use typed client id in connect

* refactor(providers): document docks and avoid init cycles

* refactor(providers): make media limit helper generic

* fix(providers): break plugin registry import cycles

* style: satisfy biome

* refactor(status-all): build providers table from plugins

* refactor(gateway): delegate web login to provider plugin

* refactor(provider): drop web alias

* refactor(provider): lazy-load monitors

* style: satisfy lint/format

* style: format status-all providers table

* style: swiftformat gateway discovery model

* test: make reload plan plugin-driven

* fix: avoid token stringification in status-all

* refactor: make provider IDs explicit in status

* feat: warn on signal/imessage provider runtime errors

* test: cover gateway provider runtime warnings in status

* fix: add runtime kind to provider status issues

* test: cover health degradation on probe failure

* fix: keep routeReply lightweight

* style: organize routeReply imports

* refactor(web): extract auth-store helpers

* refactor(whatsapp): lazy login imports

* refactor(outbound): route replies via plugin outbound

* docs: update provider plugin notes

* style: format provider status issues

* fix: make sandbox scope warning wrap-safe

* refactor: load outbound adapters from provider plugins

* docs: update provider plugin outbound notes

* style(macos): fix swiftformat lint

* docs: changelog for provider plugins

* fix(macos): satisfy swiftformat

* fix(macos): open settings via menu action

* style: format after rebase

* fix(macos): open Settings via menu action

---------

Co-authored-by: LK <luke@kyohere.com>
Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Xin <xin@imfing.com>
2026-01-11 11:45:25 +00:00

327 lines
8.9 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import {
getFreePort,
installGatewayTestHooks,
startGatewayServer,
} 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 startHeartbeatRunner = vi.fn(() => ({ stop: heartbeatStop }));
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: {},
},
})),
startProviders: vi.fn(async () => {}),
startProvider: vi.fn(async () => {}),
stopProvider: vi.fn(async () => {}),
markProviderLoggedOut: vi.fn(),
};
const createProviderManager = 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,
startHeartbeatRunner,
startGmailWatcher,
stopGmailWatcher,
providerManager,
createProviderManager,
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-providers.js", () => ({
createProviderManager: hoisted.createProviderManager,
}));
vi.mock("./config-reload.js", () => ({
startGatewayConfigReloader: hoisted.startGatewayConfigReloader,
}));
installGatewayTestHooks();
describe("gateway hot reload", () => {
let prevSkipProviders: string | undefined;
let prevSkipGmail: string | undefined;
beforeEach(() => {
prevSkipProviders = process.env.CLAWDBOT_SKIP_PROVIDERS;
prevSkipGmail = process.env.CLAWDBOT_SKIP_GMAIL_WATCHER;
process.env.CLAWDBOT_SKIP_PROVIDERS = "0";
delete process.env.CLAWDBOT_SKIP_GMAIL_WATCHER;
});
afterEach(() => {
if (prevSkipProviders === undefined) {
delete process.env.CLAWDBOT_SKIP_PROVIDERS;
} else {
process.env.CLAWDBOT_SKIP_PROVIDERS = prevSkipProviders;
}
if (prevSkipGmail === undefined) {
delete process.env.CLAWDBOT_SKIP_GMAIL_WATCHER;
} else {
process.env.CLAWDBOT_SKIP_GMAIL_WATCHER = prevSkipGmail;
}
});
it("applies hot reload actions for providers + services", 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 },
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",
"telegram.botToken",
"discord.token",
"signal.account",
"imessage.enabled",
],
restartGateway: false,
restartReasons: [],
hotReasons: ["web.enabled"],
reloadHooks: true,
restartGmailWatcher: true,
restartBrowserControl: true,
restartCron: true,
restartHeartbeat: true,
restartProviders: 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(2);
expect(hoisted.heartbeatStop).toHaveBeenCalledTimes(1);
expect(hoisted.cronInstances.length).toBe(2);
expect(hoisted.cronInstances[0].stop).toHaveBeenCalledTimes(1);
expect(hoisted.cronInstances[1].start).toHaveBeenCalledTimes(1);
expect(hoisted.providerManager.stopProvider).toHaveBeenCalledTimes(5);
expect(hoisted.providerManager.startProvider).toHaveBeenCalledTimes(5);
expect(hoisted.providerManager.stopProvider).toHaveBeenCalledWith(
"whatsapp",
);
expect(hoisted.providerManager.startProvider).toHaveBeenCalledWith(
"whatsapp",
);
expect(hoisted.providerManager.stopProvider).toHaveBeenCalledWith(
"telegram",
);
expect(hoisted.providerManager.startProvider).toHaveBeenCalledWith(
"telegram",
);
expect(hoisted.providerManager.stopProvider).toHaveBeenCalledWith(
"discord",
);
expect(hoisted.providerManager.startProvider).toHaveBeenCalledWith(
"discord",
);
expect(hoisted.providerManager.stopProvider).toHaveBeenCalledWith("signal");
expect(hoisted.providerManager.startProvider).toHaveBeenCalledWith(
"signal",
);
expect(hoisted.providerManager.stopProvider).toHaveBeenCalledWith(
"imessage",
);
expect(hoisted.providerManager.startProvider).toHaveBeenCalledWith(
"imessage",
);
await server.close();
});
it("emits SIGUSR1 on restart plan when listener exists", async () => {
const port = await getFreePort();
const server = await startGatewayServer(port);
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,
restartProviders: new Set(),
noopPaths: [],
},
{},
);
expect(signalSpy).toHaveBeenCalledTimes(1);
await server.close();
});
});