* 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>
330 lines
10 KiB
TypeScript
330 lines
10 KiB
TypeScript
import type { ClawdbotConfig } from "../config/config.js";
|
|
import { formatErrorMessage } from "../infra/errors.js";
|
|
import type { createSubsystemLogger } from "../logging.js";
|
|
import { resolveProviderDefaultAccountId } from "../providers/plugins/helpers.js";
|
|
import {
|
|
getProviderPlugin,
|
|
listProviderPlugins,
|
|
type ProviderId,
|
|
} from "../providers/plugins/index.js";
|
|
import type { ProviderAccountSnapshot } from "../providers/plugins/types.js";
|
|
import { DEFAULT_ACCOUNT_ID } from "../routing/session-key.js";
|
|
import type { RuntimeEnv } from "../runtime.js";
|
|
|
|
export type ProviderRuntimeSnapshot = {
|
|
providers: Partial<Record<ProviderId, ProviderAccountSnapshot>>;
|
|
providerAccounts: Partial<
|
|
Record<ProviderId, Record<string, ProviderAccountSnapshot>>
|
|
>;
|
|
};
|
|
|
|
type SubsystemLogger = ReturnType<typeof createSubsystemLogger>;
|
|
|
|
type ProviderRuntimeStore = {
|
|
aborts: Map<string, AbortController>;
|
|
tasks: Map<string, Promise<unknown>>;
|
|
runtimes: Map<string, ProviderAccountSnapshot>;
|
|
};
|
|
|
|
function createRuntimeStore(): ProviderRuntimeStore {
|
|
return {
|
|
aborts: new Map(),
|
|
tasks: new Map(),
|
|
runtimes: new Map(),
|
|
};
|
|
}
|
|
|
|
function isAccountEnabled(account: unknown): boolean {
|
|
if (!account || typeof account !== "object") return true;
|
|
const enabled = (account as { enabled?: boolean }).enabled;
|
|
return enabled !== false;
|
|
}
|
|
|
|
function resolveDefaultRuntime(
|
|
providerId: ProviderId,
|
|
): ProviderAccountSnapshot {
|
|
const plugin = getProviderPlugin(providerId);
|
|
return plugin?.status?.defaultRuntime ?? { accountId: DEFAULT_ACCOUNT_ID };
|
|
}
|
|
|
|
function cloneDefaultRuntime(
|
|
providerId: ProviderId,
|
|
accountId: string,
|
|
): ProviderAccountSnapshot {
|
|
return { ...resolveDefaultRuntime(providerId), accountId };
|
|
}
|
|
|
|
type ProviderManagerOptions = {
|
|
loadConfig: () => ClawdbotConfig;
|
|
providerLogs: Record<ProviderId, SubsystemLogger>;
|
|
providerRuntimeEnvs: Record<ProviderId, RuntimeEnv>;
|
|
};
|
|
|
|
export type ProviderManager = {
|
|
getRuntimeSnapshot: () => ProviderRuntimeSnapshot;
|
|
startProviders: () => Promise<void>;
|
|
startProvider: (provider: ProviderId, accountId?: string) => Promise<void>;
|
|
stopProvider: (provider: ProviderId, accountId?: string) => Promise<void>;
|
|
markProviderLoggedOut: (
|
|
providerId: ProviderId,
|
|
cleared: boolean,
|
|
accountId?: string,
|
|
) => void;
|
|
};
|
|
|
|
// Provider docking: lifecycle hooks (`plugin.gateway`) flow through this manager.
|
|
export function createProviderManager(
|
|
opts: ProviderManagerOptions,
|
|
): ProviderManager {
|
|
const { loadConfig, providerLogs, providerRuntimeEnvs } = opts;
|
|
|
|
const providerStores = new Map<ProviderId, ProviderRuntimeStore>();
|
|
|
|
const getStore = (providerId: ProviderId): ProviderRuntimeStore => {
|
|
const existing = providerStores.get(providerId);
|
|
if (existing) return existing;
|
|
const next = createRuntimeStore();
|
|
providerStores.set(providerId, next);
|
|
return next;
|
|
};
|
|
|
|
const getRuntime = (
|
|
providerId: ProviderId,
|
|
accountId: string,
|
|
): ProviderAccountSnapshot => {
|
|
const store = getStore(providerId);
|
|
return (
|
|
store.runtimes.get(accountId) ??
|
|
cloneDefaultRuntime(providerId, accountId)
|
|
);
|
|
};
|
|
|
|
const setRuntime = (
|
|
providerId: ProviderId,
|
|
accountId: string,
|
|
patch: ProviderAccountSnapshot,
|
|
): ProviderAccountSnapshot => {
|
|
const store = getStore(providerId);
|
|
const current = getRuntime(providerId, accountId);
|
|
const next = { ...current, ...patch, accountId };
|
|
store.runtimes.set(accountId, next);
|
|
return next;
|
|
};
|
|
|
|
const startProvider = async (providerId: ProviderId, accountId?: string) => {
|
|
const plugin = getProviderPlugin(providerId);
|
|
const startAccount = plugin?.gateway?.startAccount;
|
|
if (!startAccount) return;
|
|
const cfg = loadConfig();
|
|
const store = getStore(providerId);
|
|
const accountIds = accountId
|
|
? [accountId]
|
|
: plugin.config.listAccountIds(cfg);
|
|
if (accountIds.length === 0) return;
|
|
|
|
await Promise.all(
|
|
accountIds.map(async (id) => {
|
|
if (store.tasks.has(id)) return;
|
|
const account = plugin.config.resolveAccount(cfg, id);
|
|
const enabled = plugin.config.isEnabled
|
|
? plugin.config.isEnabled(account, cfg)
|
|
: isAccountEnabled(account);
|
|
if (!enabled) {
|
|
setRuntime(providerId, id, {
|
|
accountId: id,
|
|
running: false,
|
|
lastError:
|
|
plugin.config.disabledReason?.(account, cfg) ?? "disabled",
|
|
});
|
|
return;
|
|
}
|
|
|
|
let configured = true;
|
|
if (plugin.config.isConfigured) {
|
|
configured = await plugin.config.isConfigured(account, cfg);
|
|
}
|
|
if (!configured) {
|
|
setRuntime(providerId, id, {
|
|
accountId: id,
|
|
running: false,
|
|
lastError:
|
|
plugin.config.unconfiguredReason?.(account, cfg) ??
|
|
"not configured",
|
|
});
|
|
return;
|
|
}
|
|
|
|
const abort = new AbortController();
|
|
store.aborts.set(id, abort);
|
|
setRuntime(providerId, id, {
|
|
accountId: id,
|
|
running: true,
|
|
lastStartAt: Date.now(),
|
|
lastError: null,
|
|
});
|
|
|
|
const log = providerLogs[providerId];
|
|
const task = startAccount({
|
|
cfg,
|
|
accountId: id,
|
|
account,
|
|
runtime: providerRuntimeEnvs[providerId],
|
|
abortSignal: abort.signal,
|
|
log,
|
|
getStatus: () => getRuntime(providerId, id),
|
|
setStatus: (next) => setRuntime(providerId, id, next),
|
|
});
|
|
const tracked = Promise.resolve(task)
|
|
.catch((err) => {
|
|
const message = formatErrorMessage(err);
|
|
setRuntime(providerId, id, { accountId: id, lastError: message });
|
|
log.error?.(`[${id}] provider exited: ${message}`);
|
|
})
|
|
.finally(() => {
|
|
store.aborts.delete(id);
|
|
store.tasks.delete(id);
|
|
setRuntime(providerId, id, {
|
|
accountId: id,
|
|
running: false,
|
|
lastStopAt: Date.now(),
|
|
});
|
|
});
|
|
store.tasks.set(id, tracked);
|
|
}),
|
|
);
|
|
};
|
|
|
|
const stopProvider = async (providerId: ProviderId, accountId?: string) => {
|
|
const plugin = getProviderPlugin(providerId);
|
|
const cfg = loadConfig();
|
|
const store = getStore(providerId);
|
|
const knownIds = new Set<string>([
|
|
...store.aborts.keys(),
|
|
...store.tasks.keys(),
|
|
...(plugin ? plugin.config.listAccountIds(cfg) : []),
|
|
]);
|
|
if (accountId) {
|
|
knownIds.clear();
|
|
knownIds.add(accountId);
|
|
}
|
|
|
|
await Promise.all(
|
|
Array.from(knownIds.values()).map(async (id) => {
|
|
const abort = store.aborts.get(id);
|
|
const task = store.tasks.get(id);
|
|
if (!abort && !task && !plugin?.gateway?.stopAccount) return;
|
|
abort?.abort();
|
|
if (plugin?.gateway?.stopAccount) {
|
|
const account = plugin.config.resolveAccount(cfg, id);
|
|
await plugin.gateway.stopAccount({
|
|
cfg,
|
|
accountId: id,
|
|
account,
|
|
runtime: providerRuntimeEnvs[providerId],
|
|
abortSignal: abort?.signal ?? new AbortController().signal,
|
|
log: providerLogs[providerId],
|
|
getStatus: () => getRuntime(providerId, id),
|
|
setStatus: (next) => setRuntime(providerId, id, next),
|
|
});
|
|
}
|
|
try {
|
|
await task;
|
|
} catch {
|
|
// ignore
|
|
}
|
|
store.aborts.delete(id);
|
|
store.tasks.delete(id);
|
|
setRuntime(providerId, id, {
|
|
accountId: id,
|
|
running: false,
|
|
lastStopAt: Date.now(),
|
|
});
|
|
}),
|
|
);
|
|
};
|
|
|
|
const startProviders = async () => {
|
|
for (const plugin of listProviderPlugins()) {
|
|
await startProvider(plugin.id);
|
|
}
|
|
};
|
|
|
|
const markProviderLoggedOut = (
|
|
providerId: ProviderId,
|
|
cleared: boolean,
|
|
accountId?: string,
|
|
) => {
|
|
const plugin = getProviderPlugin(providerId);
|
|
if (!plugin) return;
|
|
const cfg = loadConfig();
|
|
const resolvedId =
|
|
accountId ??
|
|
resolveProviderDefaultAccountId({
|
|
plugin,
|
|
cfg,
|
|
});
|
|
const current = getRuntime(providerId, resolvedId);
|
|
const next: ProviderAccountSnapshot = {
|
|
accountId: resolvedId,
|
|
running: false,
|
|
lastError: cleared ? "logged out" : current.lastError,
|
|
};
|
|
if (typeof current.connected === "boolean") {
|
|
next.connected = false;
|
|
}
|
|
setRuntime(providerId, resolvedId, next);
|
|
};
|
|
|
|
const getRuntimeSnapshot = (): ProviderRuntimeSnapshot => {
|
|
const cfg = loadConfig();
|
|
const providers: ProviderRuntimeSnapshot["providers"] = {};
|
|
const providerAccounts: ProviderRuntimeSnapshot["providerAccounts"] = {};
|
|
for (const plugin of listProviderPlugins()) {
|
|
const store = getStore(plugin.id);
|
|
const accountIds = plugin.config.listAccountIds(cfg);
|
|
const defaultAccountId = resolveProviderDefaultAccountId({
|
|
plugin,
|
|
cfg,
|
|
accountIds,
|
|
});
|
|
const accounts: Record<string, ProviderAccountSnapshot> = {};
|
|
for (const id of accountIds) {
|
|
const account = plugin.config.resolveAccount(cfg, id);
|
|
const enabled = plugin.config.isEnabled
|
|
? plugin.config.isEnabled(account, cfg)
|
|
: isAccountEnabled(account);
|
|
const described = plugin.config.describeAccount?.(account, cfg);
|
|
const configured = described?.configured;
|
|
const current =
|
|
store.runtimes.get(id) ?? cloneDefaultRuntime(plugin.id, id);
|
|
const next = { ...current, accountId: id };
|
|
if (!next.running) {
|
|
if (!enabled) {
|
|
next.lastError ??=
|
|
plugin.config.disabledReason?.(account, cfg) ?? "disabled";
|
|
} else if (configured === false) {
|
|
next.lastError ??=
|
|
plugin.config.unconfiguredReason?.(account, cfg) ??
|
|
"not configured";
|
|
}
|
|
}
|
|
accounts[id] = next;
|
|
}
|
|
const defaultAccount =
|
|
accounts[defaultAccountId] ??
|
|
cloneDefaultRuntime(plugin.id, defaultAccountId);
|
|
providers[plugin.id] = defaultAccount;
|
|
providerAccounts[plugin.id] = accounts;
|
|
}
|
|
return { providers, providerAccounts };
|
|
};
|
|
|
|
return {
|
|
getRuntimeSnapshot,
|
|
startProviders,
|
|
startProvider,
|
|
stopProvider,
|
|
markProviderLoggedOut,
|
|
};
|
|
}
|