mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-12 17:51:22 +00:00
239 lines
16 KiB
TypeScript
239 lines
16 KiB
TypeScript
import { existsSync, readFileSync } from "node:fs";
|
|
import { dirname, relative, resolve } from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import ts from "typescript";
|
|
import { describe, expect, it } from "vitest";
|
|
import { loadPluginManifestRegistry } from "../manifest-registry.js";
|
|
|
|
const ROOT_DIR = resolve(dirname(fileURLToPath(import.meta.url)), "../..");
|
|
const bundledPluginRoots = new Map(
|
|
loadPluginManifestRegistry({ cache: true, config: {} })
|
|
.plugins.filter((plugin) => plugin.origin === "bundled")
|
|
.map((plugin) => [plugin.id, plugin.rootDir] as const),
|
|
);
|
|
|
|
function bundledPluginFile(pluginId: string, relativePath: string): string {
|
|
const rootDir = bundledPluginRoots.get(pluginId);
|
|
if (!rootDir) {
|
|
throw new Error(`missing bundled plugin root for ${pluginId}`);
|
|
}
|
|
return relative(resolve(ROOT_DIR, ".."), resolve(rootDir, relativePath)).replaceAll("\\", "/");
|
|
}
|
|
|
|
const RUNTIME_API_EXPORT_GUARDS: Record<string, readonly string[]> = {
|
|
[bundledPluginFile("discord", "runtime-api.ts")]: [
|
|
'export * from "./src/audit.js";',
|
|
'export * from "./src/actions/runtime.js";',
|
|
'export * from "./src/actions/runtime.moderation-shared.js";',
|
|
'export * from "./src/actions/runtime.shared.js";',
|
|
'export * from "./src/channel-actions.js";',
|
|
'export * from "./src/directory-live.js";',
|
|
'export * from "./src/monitor.js";',
|
|
'export * from "./src/monitor/gateway-plugin.js";',
|
|
'export * from "./src/monitor/gateway-registry.js";',
|
|
'export * from "./src/monitor/presence-cache.js";',
|
|
'export * from "./src/monitor/thread-bindings.js";',
|
|
'export * from "./src/monitor/thread-bindings.manager.js";',
|
|
'export * from "./src/monitor/timeouts.js";',
|
|
'export * from "./src/probe.js";',
|
|
'export * from "./src/resolve-channels.js";',
|
|
'export * from "./src/resolve-users.js";',
|
|
'export * from "./src/outbound-session-route.js";',
|
|
'export * from "./src/send.js";',
|
|
'export * from "./src/send.components.js";',
|
|
'export { setDiscordRuntime } from "./src/runtime.js";',
|
|
],
|
|
[bundledPluginFile("imessage", "runtime-api.ts")]: [
|
|
'export { DEFAULT_ACCOUNT_ID, getChatChannelMeta, type ChannelPlugin, type OpenClawConfig } from "openclaw/plugin-sdk/core";',
|
|
'export { buildChannelConfigSchema, IMessageConfigSchema } from "./config-api.js";',
|
|
'export { PAIRING_APPROVED_MESSAGE } from "openclaw/plugin-sdk/channel-status";',
|
|
'export { buildComputedAccountStatusSnapshot, collectStatusIssuesFromLastError } from "openclaw/plugin-sdk/status-helpers";',
|
|
'export { formatTrimmedAllowFromEntries } from "openclaw/plugin-sdk/channel-config-helpers";',
|
|
'export { resolveIMessageConfigAllowFrom, resolveIMessageConfigDefaultTo } from "./src/config-accessors.js";',
|
|
'export { looksLikeIMessageTargetId, normalizeIMessageMessagingTarget } from "./src/normalize.js";',
|
|
'export { resolveChannelMediaMaxBytes } from "openclaw/plugin-sdk/media-runtime";',
|
|
'export { resolveIMessageGroupRequireMention, resolveIMessageGroupToolPolicy } from "./src/group-policy.js";',
|
|
'export { monitorIMessageProvider } from "./src/monitor.js";',
|
|
'export type { MonitorIMessageOpts } from "./src/monitor.js";',
|
|
'export { probeIMessage } from "./src/probe.js";',
|
|
'export type { IMessageProbe } from "./src/probe.js";',
|
|
'export { sendMessageIMessage } from "./src/send.js";',
|
|
'export { setIMessageRuntime } from "./src/runtime.js";',
|
|
'export { chunkTextForOutbound } from "./src/channel-api.js";',
|
|
'export type IMessageAccountConfig = Omit< NonNullable<NonNullable<RuntimeApiOpenClawConfig["channels"]>["imessage"]>, "accounts" | "defaultAccount" >;',
|
|
],
|
|
[bundledPluginFile("googlechat", "runtime-api.ts")]: [
|
|
'export { DEFAULT_ACCOUNT_ID } from "openclaw/plugin-sdk/account-id";',
|
|
'export { createActionGate, jsonResult, readNumberParam, readReactionParams, readStringParam } from "openclaw/plugin-sdk/channel-actions";',
|
|
'export { buildChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-primitives";',
|
|
'export type { ChannelMessageActionAdapter, ChannelMessageActionName, ChannelStatusIssue } from "openclaw/plugin-sdk/channel-contract";',
|
|
'export { missingTargetError } from "openclaw/plugin-sdk/channel-feedback";',
|
|
'export { createAccountStatusSink, runPassiveAccountLifecycle } from "openclaw/plugin-sdk/channel-lifecycle";',
|
|
'export { createChannelPairingController } from "openclaw/plugin-sdk/channel-pairing";',
|
|
'export { createChannelReplyPipeline } from "openclaw/plugin-sdk/channel-reply-pipeline";',
|
|
'export { evaluateGroupRouteAccessForPolicy, resolveDmGroupAccessWithLists, resolveSenderScopedGroupPolicy } from "openclaw/plugin-sdk/channel-policy";',
|
|
'export { PAIRING_APPROVED_MESSAGE } from "openclaw/plugin-sdk/channel-status";',
|
|
'export { chunkTextForOutbound } from "openclaw/plugin-sdk/text-chunking";',
|
|
'export type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime";',
|
|
'export { GROUP_POLICY_BLOCKED_LABEL, isDangerousNameMatchingEnabled, resolveAllowlistProviderRuntimeGroupPolicy, resolveDefaultGroupPolicy, warnMissingProviderGroupPolicyFallbackOnce } from "openclaw/plugin-sdk/config-runtime";',
|
|
'export { fetchRemoteMedia, resolveChannelMediaMaxBytes } from "openclaw/plugin-sdk/media-runtime";',
|
|
'export { loadOutboundMediaFromUrl } from "openclaw/plugin-sdk/outbound-media";',
|
|
'export type { PluginRuntime } from "openclaw/plugin-sdk/runtime-store";',
|
|
'export { fetchWithSsrFGuard } from "openclaw/plugin-sdk/ssrf-runtime";',
|
|
'export { GoogleChatConfigSchema, type GoogleChatAccountConfig, type GoogleChatConfig } from "openclaw/plugin-sdk/googlechat-runtime-shared";',
|
|
'export { extractToolSend } from "openclaw/plugin-sdk/tool-send";',
|
|
'export { resolveInboundMentionDecision } from "openclaw/plugin-sdk/channel-inbound";',
|
|
'export { resolveInboundRouteEnvelopeBuilderWithRuntime } from "openclaw/plugin-sdk/inbound-envelope";',
|
|
'export { resolveWebhookPath } from "openclaw/plugin-sdk/webhook-path";',
|
|
'export { registerWebhookTargetWithPluginRoute, resolveWebhookTargetWithAuthOrReject, withResolvedWebhookRequestPipeline } from "openclaw/plugin-sdk/webhook-targets";',
|
|
'export { createWebhookInFlightLimiter, readJsonWebhookBodyOrReject, type WebhookInFlightLimiter } from "openclaw/plugin-sdk/webhook-request-guards";',
|
|
'export { setGoogleChatRuntime } from "./src/runtime.js";',
|
|
],
|
|
[bundledPluginFile("irc", "runtime-api.ts")]: [
|
|
'export { setIrcRuntime } from "./src/runtime.js";',
|
|
],
|
|
[bundledPluginFile("matrix", "runtime-api.ts")]: [
|
|
'export * from "./src/auth-precedence.js";',
|
|
'export { requiresExplicitMatrixDefaultAccount, resolveMatrixDefaultOrOnlyAccountId } from "./src/account-selection.js";',
|
|
'export * from "./src/account-selection.js";',
|
|
'export * from "./src/env-vars.js";',
|
|
'export * from "./src/storage-paths.js";',
|
|
'export { ensureMatrixSdkInstalled, isMatrixSdkAvailable } from "./src/matrix/deps.js";',
|
|
'export { assertHttpUrlTargetsPrivateNetwork, closeDispatcher, createPinnedDispatcher, resolvePinnedHostnameWithPolicy, ssrfPolicyFromDangerouslyAllowPrivateNetwork, ssrfPolicyFromAllowPrivateNetwork, type LookupFn, type SsrFPolicy } from "openclaw/plugin-sdk/ssrf-runtime";',
|
|
'export { setMatrixThreadBindingIdleTimeoutBySessionKey, setMatrixThreadBindingMaxAgeBySessionKey } from "./src/matrix/thread-bindings-shared.js";',
|
|
'export { setMatrixRuntime } from "./src/runtime.js";',
|
|
'export { writeJsonFileAtomically } from "openclaw/plugin-sdk/json-store";',
|
|
'export type { ChannelDirectoryEntry, ChannelMessageActionContext, OpenClawConfig, PluginRuntime, RuntimeLogger, RuntimeEnv, WizardPrompter } from "openclaw/plugin-sdk/matrix-runtime-shared";',
|
|
'export { formatZonedTimestamp } from "openclaw/plugin-sdk/matrix-runtime-shared";',
|
|
'export function chunkTextForOutbound(text: string, limit: number): string[] { const chunks: string[] = []; let remaining = text; while (remaining.length > limit) { const window = remaining.slice(0, limit); const splitAt = Math.max(window.lastIndexOf("\\n"), window.lastIndexOf(" ")); const breakAt = splitAt > 0 ? splitAt : limit; chunks.push(remaining.slice(0, breakAt).trimEnd()); remaining = remaining.slice(breakAt).trimStart(); } if (remaining.length > 0 || text.length === 0) { chunks.push(remaining); } return chunks; }',
|
|
],
|
|
[bundledPluginFile("nextcloud-talk", "runtime-api.ts")]: [
|
|
'export * from "openclaw/plugin-sdk/nextcloud-talk";',
|
|
'export { setNextcloudTalkRuntime } from "./src/runtime.js";',
|
|
],
|
|
[bundledPluginFile("signal", "runtime-api.ts")]: [
|
|
'export * from "./src/runtime-api.js";',
|
|
'export { setSignalRuntime } from "./src/runtime.js";',
|
|
],
|
|
[bundledPluginFile("slack", "runtime-api.ts")]: [
|
|
'export * from "./src/action-runtime.js";',
|
|
'export * from "./src/directory-live.js";',
|
|
'export * from "./src/index.js";',
|
|
'export * from "./src/resolve-channels.js";',
|
|
'export * from "./src/resolve-users.js";',
|
|
'export { registerSlackPluginHttpRoutes } from "./src/http/plugin-routes.js";',
|
|
'export { setSlackRuntime } from "./src/runtime.js";',
|
|
],
|
|
[bundledPluginFile("telegram", "runtime-api.ts")]: [
|
|
'export type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-entry";',
|
|
'export type { ChannelMessageActionAdapter } from "openclaw/plugin-sdk/channel-contract";',
|
|
'export type { TelegramApiOverride } from "./src/send.js";',
|
|
'export type { OpenClawPluginService, OpenClawPluginServiceContext, PluginLogger } from "openclaw/plugin-sdk/plugin-entry";',
|
|
'export type { PluginRuntime } from "openclaw/plugin-sdk/runtime-store";',
|
|
'export type { AcpRuntime, AcpRuntimeCapabilities, AcpRuntimeDoctorReport, AcpRuntimeEnsureInput, AcpRuntimeEvent, AcpRuntimeHandle, AcpRuntimeStatus, AcpRuntimeTurnInput, AcpRuntimeErrorCode, AcpSessionUpdateTag } from "openclaw/plugin-sdk/acp-runtime";',
|
|
'export { AcpRuntimeError } from "openclaw/plugin-sdk/acp-runtime";',
|
|
'export { emptyPluginConfigSchema, formatPairingApproveHint, getChatChannelMeta } from "openclaw/plugin-sdk/channel-plugin-common";',
|
|
'export { clearAccountEntryFields } from "openclaw/plugin-sdk/channel-core";',
|
|
'export { buildChannelConfigSchema, TelegramConfigSchema } from "./config-api.js";',
|
|
'export { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/account-id";',
|
|
'export { PAIRING_APPROVED_MESSAGE, buildTokenChannelStatusSummary, projectCredentialSnapshotFields, resolveConfiguredFromCredentialStatuses } from "openclaw/plugin-sdk/channel-status";',
|
|
'export { jsonResult, readNumberParam, readReactionParams, readStringArrayParam, readStringOrNumberParam, readStringParam, resolvePollMaxSelections } from "openclaw/plugin-sdk/channel-actions";',
|
|
'export type { TelegramProbe } from "./src/probe.js";',
|
|
'export { auditTelegramGroupMembership, collectTelegramUnmentionedGroupIds } from "./src/audit.js";',
|
|
'export { resolveTelegramRuntimeGroupPolicy } from "./src/group-access.js";',
|
|
'export { buildTelegramExecApprovalPendingPayload, shouldSuppressTelegramExecApprovalForwardingFallback } from "./src/exec-approval-forwarding.js";',
|
|
'export { telegramMessageActions } from "./src/channel-actions.js";',
|
|
'export { monitorTelegramProvider } from "./src/monitor.js";',
|
|
'export { probeTelegram } from "./src/probe.js";',
|
|
'export { resolveTelegramFetch, resolveTelegramTransport, shouldRetryTelegramTransportFallback } from "./src/fetch.js";',
|
|
'export { makeProxyFetch } from "./src/proxy.js";',
|
|
'export { createForumTopicTelegram, deleteMessageTelegram, editForumTopicTelegram, editMessageReplyMarkupTelegram, editMessageTelegram, pinMessageTelegram, reactMessageTelegram, renameForumTopicTelegram, sendMessageTelegram, sendPollTelegram, sendStickerTelegram, sendTypingTelegram, unpinMessageTelegram } from "./src/send.js";',
|
|
'export { createTelegramThreadBindingManager, getTelegramThreadBindingManager, resetTelegramThreadBindingsForTests, setTelegramThreadBindingIdleTimeoutBySessionKey, setTelegramThreadBindingMaxAgeBySessionKey } from "./src/thread-bindings.js";',
|
|
'export { resolveTelegramToken } from "./src/token.js";',
|
|
'export { setTelegramRuntime } from "./src/runtime.js";',
|
|
'export type { ChannelPlugin } from "openclaw/plugin-sdk/channel-core";',
|
|
'export type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime";',
|
|
'export type TelegramAccountConfig = NonNullable< NonNullable<RuntimeOpenClawConfig["channels"]>["telegram"] >;',
|
|
'export type TelegramActionConfig = NonNullable<TelegramAccountConfig["actions"]>;',
|
|
'export type TelegramNetworkConfig = NonNullable<TelegramAccountConfig["network"]>;',
|
|
'export { parseTelegramTopicConversation } from "./src/topic-conversation.js";',
|
|
'export { resolveTelegramPollVisibility } from "./src/poll-visibility.js";',
|
|
],
|
|
[bundledPluginFile("whatsapp", "runtime-api.ts")]: [
|
|
'export * from "./src/active-listener.js";',
|
|
'export * from "./src/action-runtime.js";',
|
|
'export * from "./src/agent-tools-login.js";',
|
|
'export * from "./src/auth-store.js";',
|
|
'export * from "./src/auto-reply.js";',
|
|
'export * from "./src/inbound.js";',
|
|
'export * from "./src/login.js";',
|
|
'export * from "./src/media.js";',
|
|
'export * from "./src/send.js";',
|
|
'export * from "./src/session.js";',
|
|
'export { setWhatsAppRuntime } from "./src/runtime.js";',
|
|
'export { startWebLoginWithQr, waitForWebLogin } from "./login-qr-runtime.js";',
|
|
],
|
|
} as const;
|
|
|
|
function collectRuntimeApiFiles(): string[] {
|
|
return [...bundledPluginRoots.values()]
|
|
.map((rootDir) => resolve(rootDir, "runtime-api.ts"))
|
|
.filter((path) => existsSync(path))
|
|
.map((path) => relative(resolve(ROOT_DIR, ".."), path).replaceAll("\\", "/"));
|
|
}
|
|
|
|
function readExportStatements(path: string): string[] {
|
|
const sourceText = readFileSync(resolve(ROOT_DIR, "..", path), "utf8");
|
|
const sourceFile = ts.createSourceFile(path, sourceText, ts.ScriptTarget.Latest, true);
|
|
|
|
return sourceFile.statements.flatMap((statement) => {
|
|
if (!ts.isExportDeclaration(statement)) {
|
|
const modifiers = ts.canHaveModifiers(statement) ? ts.getModifiers(statement) : undefined;
|
|
if (!modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.ExportKeyword)) {
|
|
return [];
|
|
}
|
|
return [statement.getText(sourceFile).replaceAll(/\s+/g, " ").trim()];
|
|
}
|
|
|
|
const moduleSpecifier = statement.moduleSpecifier;
|
|
if (!moduleSpecifier || !ts.isStringLiteral(moduleSpecifier)) {
|
|
return [statement.getText(sourceFile).replaceAll(/\s+/g, " ").trim()];
|
|
}
|
|
|
|
if (!statement.exportClause) {
|
|
const prefix = statement.isTypeOnly ? "export type *" : "export *";
|
|
return [`${prefix} from ${moduleSpecifier.getText(sourceFile)};`];
|
|
}
|
|
|
|
if (!ts.isNamedExports(statement.exportClause)) {
|
|
return [statement.getText(sourceFile).replaceAll(/\s+/g, " ").trim()];
|
|
}
|
|
|
|
const specifiers = statement.exportClause.elements.map((element) => {
|
|
const imported = element.propertyName?.text;
|
|
const exported = element.name.text;
|
|
const alias = imported ? `${imported} as ${exported}` : exported;
|
|
return element.isTypeOnly ? `type ${alias}` : alias;
|
|
});
|
|
const exportPrefix = statement.isTypeOnly ? "export type" : "export";
|
|
return [
|
|
`${exportPrefix} { ${specifiers.join(", ")} } from ${moduleSpecifier.getText(sourceFile)};`,
|
|
];
|
|
});
|
|
}
|
|
|
|
describe("runtime api guardrails", () => {
|
|
it("keeps runtime api surfaces on an explicit export allowlist", () => {
|
|
const runtimeApiFiles = collectRuntimeApiFiles();
|
|
expect(runtimeApiFiles).toEqual(
|
|
expect.arrayContaining(Object.keys(RUNTIME_API_EXPORT_GUARDS).toSorted()),
|
|
);
|
|
|
|
for (const file of Object.keys(RUNTIME_API_EXPORT_GUARDS).toSorted()) {
|
|
expect(readExportStatements(file), `${file} runtime api exports changed`).toEqual(
|
|
RUNTIME_API_EXPORT_GUARDS[file],
|
|
);
|
|
}
|
|
});
|
|
});
|