refactor(test): remove legacy extension test seams

This commit is contained in:
Peter Steinberger
2026-04-20 13:16:36 +01:00
parent 869950564f
commit 1e4f3f2123
14 changed files with 221 additions and 282 deletions

View File

@@ -9,32 +9,6 @@ const ALLOWED_EXTENSION_PUBLIC_SURFACE_BASENAMES = new Set(
GUARDED_EXTENSION_PUBLIC_SURFACE_BASENAMES,
);
const allowedNonExtensionTests = new Set<string>([
"src/agents/pi-embedded-runner-extraparams-moonshot.test.ts",
"src/agents/pi-embedded-runner-extraparams.test.ts",
"src/agents/pi-embedded-runner-extraparams-moonshot.test.ts",
"src/channels/plugins/contracts/dm-policy.contract.test.ts",
"src/channels/plugins/contracts/group-policy.contract.test.ts",
"src/commands/channels.surfaces-signal-runtime-errors-channels-status-output.test.ts",
"src/commands/onboard-channels.e2e.test.ts",
"src/gateway/hooks.test.ts",
"src/infra/outbound/deliver.test.ts",
"src/plugins/interactive.test.ts",
"src/plugins/contracts/discovery.contract.test.ts",
"src/plugin-sdk/telegram-command-config.test.ts",
"src/security/audit-channel-slack-command-findings.test.ts",
"src/security/audit-feishu-doc-risk.test.ts",
"src/secrets/runtime-channel-inactive-variants.test.ts",
"src/secrets/runtime-discord-surface.test.ts",
"src/secrets/runtime-inactive-telegram-surfaces.test.ts",
"src/secrets/runtime-legacy-x-search.test.ts",
"src/secrets/runtime-matrix-shadowing.test.ts",
"src/secrets/runtime-matrix-top-level.test.ts",
"src/secrets/runtime-nextcloud-talk-file-precedence.test.ts",
"src/secrets/runtime-telegram-token-inheritance.test.ts",
"src/secrets/runtime-zalo-token-activity.test.ts",
]);
function walk(dir: string, entries: string[] = []): string[] {
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
const fullPath = path.join(dir, entry.name);
@@ -136,7 +110,7 @@ describe("non-extension test boundaries", () => {
if (imports.length === 0) {
return null;
}
if (allowedNonExtensionTests.has(file) || isAllowedCoreContractSuite(file, imports)) {
if (isAllowedCoreContractSuite(file, imports)) {
return null;
}
return {
@@ -170,20 +144,12 @@ describe("non-extension test boundaries", () => {
expect(imports).toEqual([]);
});
it("keeps bundled plugin public-surface imports on an explicit core allowlist", () => {
const allowed = new Set([
"src/auto-reply/reply.triggers.trigger-handling.test-harness.ts",
"src/agents/models-config.providers.ollama.test.ts",
"src/commands/channel-test-registry.ts",
"src/plugins/contracts/provider-vitest-registry.ts",
"src/plugins/contracts/web-provider-vitest-registry.ts",
"src/plugin-sdk/testing.ts",
]);
it("keeps bundled plugin public-surface imports out of core source", () => {
const files = walkCode(path.join(repoRoot, "src"));
const offenders = files.filter((file) => {
const source = fs.readFileSync(path.join(repoRoot, file), "utf8");
return findBundledPluginPublicSurfaceImports(source).length > 0 && !allowed.has(file);
return findBundledPluginPublicSurfaceImports(source).length > 0;
});
expect(offenders).toEqual([]);

View File

@@ -0,0 +1,483 @@
import { rmSync } from "node:fs";
import fs from "node:fs/promises";
import os from "node:os";
import { join } from "node:path";
import { afterAll, afterEach, beforeAll, expect, vi } from "vitest";
import { clearRuntimeAuthProfileStoreSnapshots } from "../../../src/agents/auth-profiles.js";
import { withFastReplyConfig } from "../../../src/auto-reply/reply/get-reply-fast-path.js";
import type { OpenClawConfig } from "../../../src/config/types.openclaw.js";
import { resetProviderRuntimeHookCacheForTest } from "../../../src/plugins/provider-runtime.js";
import { resolveRelativeBundledPluginPublicModuleId } from "../../../src/test-utils/bundled-plugin-public-surface.js";
// Avoid exporting vitest mock types (TS2742 under pnpm + d.ts emit).
type AnyMock = any;
type AnyMocks = Record<string, any>;
function getSharedMocks<T>(key: string, create: () => T): T {
const symbol = Symbol.for(key);
const store = globalThis as Record<symbol, T | undefined>;
if (!store[symbol]) {
store[symbol] = create();
}
return store[symbol];
}
const piEmbeddedMocks = getSharedMocks("openclaw.trigger-handling.pi-embedded-mocks", () => ({
abortEmbeddedPiRun: vi.fn().mockReturnValue(false),
compactEmbeddedPiSession: vi.fn(),
runEmbeddedPiAgent: vi.fn(),
queueEmbeddedPiMessage: vi.fn().mockReturnValue(false),
resolveActiveEmbeddedRunSessionId: vi.fn().mockReturnValue(undefined),
isEmbeddedPiRunActive: vi.fn().mockReturnValue(false),
isEmbeddedPiRunStreaming: vi.fn().mockReturnValue(false),
}));
export function getAbortEmbeddedPiRunMock(): AnyMock {
return piEmbeddedMocks.abortEmbeddedPiRun;
}
export function getCompactEmbeddedPiSessionMock(): AnyMock {
return piEmbeddedMocks.compactEmbeddedPiSession;
}
export function getRunEmbeddedPiAgentMock(): AnyMock {
return piEmbeddedMocks.runEmbeddedPiAgent;
}
export function getQueueEmbeddedPiMessageMock(): AnyMock {
return piEmbeddedMocks.queueEmbeddedPiMessage;
}
const installPiEmbeddedMock = () =>
vi.doMock("../../../src/agents/pi-embedded.js", () => ({
abortEmbeddedPiRun: (...args: unknown[]) => piEmbeddedMocks.abortEmbeddedPiRun(...args),
compactEmbeddedPiSession: (...args: unknown[]) =>
piEmbeddedMocks.compactEmbeddedPiSession(...args),
runEmbeddedPiAgent: (...args: unknown[]) => piEmbeddedMocks.runEmbeddedPiAgent(...args),
queueEmbeddedPiMessage: (...args: unknown[]) => piEmbeddedMocks.queueEmbeddedPiMessage(...args),
resolveEmbeddedSessionLane: (key: string) => `session:${key.trim() || "main"}`,
resolveActiveEmbeddedRunSessionId: (...args: unknown[]) =>
piEmbeddedMocks.resolveActiveEmbeddedRunSessionId(...args),
isEmbeddedPiRunActive: (...args: unknown[]) => piEmbeddedMocks.isEmbeddedPiRunActive(...args),
isEmbeddedPiRunStreaming: (...args: unknown[]) =>
piEmbeddedMocks.isEmbeddedPiRunStreaming(...args),
}));
installPiEmbeddedMock();
vi.doMock("../../../src/agents/pi-embedded-runner/runs.js", () => ({
abortEmbeddedPiRun: (...args: unknown[]) => piEmbeddedMocks.abortEmbeddedPiRun(...args),
}));
const providerUsageMocks = vi.hoisted(() => ({
loadProviderUsageSummary: vi.fn().mockResolvedValue({
updatedAt: 0,
providers: [],
}),
formatUsageSummaryLine: vi.fn().mockReturnValue("📊 Usage: Claude 80% left"),
formatUsageWindowSummary: vi.fn().mockReturnValue("Claude 80% left"),
resolveUsageProviderId: vi.fn((provider: string) => provider.split("/")[0]),
}));
export function getProviderUsageMocks(): AnyMocks {
return providerUsageMocks;
}
vi.mock("../../../src/infra/provider-usage.js", () => providerUsageMocks);
const modelCatalogMocks = getSharedMocks("openclaw.trigger-handling.model-catalog-mocks", () => ({
loadModelCatalog: vi.fn().mockResolvedValue([
{
provider: "anthropic",
id: "claude-opus-4-6",
name: "Claude Opus 4.5",
contextWindow: 200000,
},
{
provider: "openrouter",
id: "anthropic/claude-opus-4-6",
name: "Claude Opus 4.5 (OpenRouter)",
contextWindow: 200000,
},
{ provider: "openai", id: "gpt-4.1-mini", name: "GPT-4.1 mini" },
{ provider: "openai", id: "gpt-5.4", name: "GPT-5.2" },
{ provider: "openai-codex", id: "gpt-5.4", name: "GPT-5.2 (Codex)" },
{ provider: "minimax", id: "MiniMax-M2.7", name: "MiniMax M2.7" },
]),
resetModelCatalogCacheForTest: vi.fn(),
}));
export function getModelCatalogMocks(): AnyMocks {
return modelCatalogMocks;
}
const installModelCatalogMock = () =>
vi.doMock("../../../src/agents/model-catalog.js", () => modelCatalogMocks);
installModelCatalogMock();
vi.doMock("../../../src/agents/model-catalog.runtime.js", () => ({
loadModelCatalog: (...args: unknown[]) => modelCatalogMocks.loadModelCatalog(...args),
}));
vi.doMock("../../../src/plugins/provider-runtime.runtime.js", () => ({
augmentModelCatalogWithProviderPlugins: async (params: { catalog?: unknown[] }) =>
params.catalog ?? [],
buildProviderAuthDoctorHintWithPlugin: () => undefined,
buildProviderMissingAuthMessageWithPlugin: () => undefined,
formatProviderAuthProfileApiKeyWithPlugin: (params: { apiKey?: string }) => params.apiKey,
prepareProviderRuntimeAuth: async () => undefined,
refreshProviderOAuthCredentialWithPlugin: async () => undefined,
}));
const modelFallbackMocks = getSharedMocks("openclaw.trigger-handling.model-fallback-mocks", () => ({
runWithModelFallback: vi.fn(
async (params: {
provider: string;
model: string;
run: (provider: string, model: string, runOptions?: unknown) => Promise<unknown>;
}) => ({
result: await params.run(params.provider, params.model),
provider: params.provider,
model: params.model,
attempts: [],
}),
),
}));
export function getModelFallbackMocks(): AnyMocks {
return modelFallbackMocks;
}
const installModelFallbackMock = () =>
vi.doMock("../../../src/agents/model-fallback.js", () => modelFallbackMocks);
installModelFallbackMock();
vi.doMock("../../../src/infra/git-commit.js", () => ({
resolveCommitHash: vi.fn(() => "abcdef0"),
}));
const webSessionMocks = getSharedMocks("openclaw.trigger-handling.web-session-mocks", () => ({
webAuthExists: vi.fn().mockResolvedValue(true),
getWebAuthAgeMs: vi.fn().mockReturnValue(120_000),
readWebSelfId: vi.fn().mockReturnValue({ e164: "+1999" }),
}));
const whatsappRuntimeApiModuleId = resolveRelativeBundledPluginPublicModuleId({
fromModuleUrl: import.meta.url,
pluginId: "whatsapp",
artifactBasename: "runtime-api.js",
});
export function getWebSessionMocks(): AnyMocks {
return webSessionMocks;
}
const installWebSessionMock = () => vi.doMock(whatsappRuntimeApiModuleId, () => webSessionMocks);
installWebSessionMock();
export const MAIN_SESSION_KEY = "agent:main:main";
type TempHomeEnvSnapshot = {
home: string | undefined;
userProfile: string | undefined;
homeDrive: string | undefined;
homePath: string | undefined;
openclawHome: string | undefined;
stateDir: string | undefined;
};
let suiteTempHomeRoot = "";
let suiteTempHomeId = 0;
function snapshotTempHomeEnv(): TempHomeEnvSnapshot {
return {
home: process.env.HOME,
userProfile: process.env.USERPROFILE,
homeDrive: process.env.HOMEDRIVE,
homePath: process.env.HOMEPATH,
openclawHome: process.env.OPENCLAW_HOME,
stateDir: process.env.OPENCLAW_STATE_DIR,
};
}
function restoreTempHomeEnv(snapshot: TempHomeEnvSnapshot): void {
const restoreKey = (key: string, value: string | undefined) => {
if (value === undefined) {
delete process.env[key];
return;
}
process.env[key] = value;
};
restoreKey("HOME", snapshot.home);
restoreKey("USERPROFILE", snapshot.userProfile);
restoreKey("HOMEDRIVE", snapshot.homeDrive);
restoreKey("HOMEPATH", snapshot.homePath);
restoreKey("OPENCLAW_HOME", snapshot.openclawHome);
restoreKey("OPENCLAW_STATE_DIR", snapshot.stateDir);
}
function setTempHomeEnv(home: string): void {
process.env.HOME = home;
process.env.USERPROFILE = home;
delete process.env.OPENCLAW_HOME;
process.env.OPENCLAW_STATE_DIR = join(home, ".openclaw");
if (process.platform !== "win32") {
return;
}
const match = home.match(/^([A-Za-z]:)(.*)$/);
if (!match) {
return;
}
process.env.HOMEDRIVE = match[1];
process.env.HOMEPATH = match[2] || "\\";
}
beforeAll(async () => {
suiteTempHomeRoot = await fs.mkdtemp(join(os.tmpdir(), "openclaw-triggers-suite-"));
});
afterAll(async () => {
if (!suiteTempHomeRoot) {
return;
}
try {
rmSync(suiteTempHomeRoot, { recursive: true, force: true });
} catch {
// Best-effort temp cleanup only.
}
suiteTempHomeRoot = "";
suiteTempHomeId = 0;
});
export async function withTempHome<T>(fn: (home: string) => Promise<T>): Promise<T> {
const home = join(suiteTempHomeRoot, `case-${++suiteTempHomeId}`);
const snapshot = snapshotTempHomeEnv();
await fs.mkdir(join(home, ".openclaw", "agents", "main", "sessions"), { recursive: true });
setTempHomeEnv(home);
try {
// Hard reset shared mocks so non-isolated runs don't inherit prior behavior.
piEmbeddedMocks.runEmbeddedPiAgent.mockReset();
piEmbeddedMocks.abortEmbeddedPiRun.mockReset().mockReturnValue(false);
piEmbeddedMocks.compactEmbeddedPiSession.mockReset();
piEmbeddedMocks.queueEmbeddedPiMessage.mockReset().mockReturnValue(false);
piEmbeddedMocks.isEmbeddedPiRunActive.mockReset().mockReturnValue(false);
piEmbeddedMocks.isEmbeddedPiRunStreaming.mockReset().mockReturnValue(false);
modelFallbackMocks.runWithModelFallback.mockClear();
return await fn(home);
} finally {
restoreTempHomeEnv(snapshot);
}
}
export function makeCfg(home: string): OpenClawConfig {
return withFastReplyConfig({
agents: {
defaults: {
model: { primary: "anthropic/claude-opus-4-6" },
workspace: join(home, "openclaw"),
// Test harness: avoid 1s coalescer idle sleeps that dominate trigger suites.
blockStreamingCoalesce: { idleMs: 1 },
// Trigger tests assert routing/authorization behavior, not delivery pacing.
humanDelay: { mode: "off" },
},
},
channels: {
whatsapp: {
allowFrom: ["*"],
},
},
messages: {
queue: {
debounceMs: 0,
},
},
session: { store: join(home, "sessions.json") },
} as OpenClawConfig);
}
export async function loadGetReplyFromConfig() {
return (await import("../../../src/auto-reply/reply.js")).getReplyFromConfig;
}
export function installTriggerHandlingReplyHarness(
setGetReplyFromConfig: (
getReplyFromConfig: typeof import("../../../src/auto-reply/reply.js").getReplyFromConfig,
) => void,
): void {
beforeAll(async () => {
setGetReplyFromConfig(await loadGetReplyFromConfig());
});
installTriggerHandlingE2eTestHooks();
}
export function requireSessionStorePath(cfg: { session?: { store?: string } }): string {
const storePath = cfg.session?.store;
if (!storePath) {
throw new Error("expected session store path");
}
return storePath;
}
export async function readSessionStore(cfg: {
session?: { store?: string };
}): Promise<Record<string, { elevatedLevel?: string }>> {
const storeRaw = await fs.readFile(requireSessionStorePath(cfg), "utf-8");
return JSON.parse(storeRaw) as Record<string, { elevatedLevel?: string }>;
}
export function makeWhatsAppElevatedCfg(
home: string,
opts?: { elevatedEnabled?: boolean; requireMentionInGroups?: boolean },
): OpenClawConfig {
const cfg = makeCfg(home);
cfg.channels ??= {};
cfg.channels.whatsapp = {
...cfg.channels.whatsapp,
allowFrom: ["+1000"],
};
if (opts?.requireMentionInGroups !== undefined) {
cfg.channels.whatsapp.groups = { "*": { requireMention: opts.requireMentionInGroups } };
}
cfg.tools = {
...cfg.tools,
elevated: {
allowFrom: { whatsapp: ["+1000"] },
...(opts?.elevatedEnabled === false ? { enabled: false } : {}),
},
};
return cfg;
}
export async function runDirectElevatedToggleAndLoadStore(params: {
cfg: OpenClawConfig;
getReplyFromConfig: typeof import("../../../src/auto-reply/reply.js").getReplyFromConfig;
body?: string;
}): Promise<{
text: string | undefined;
store: Record<string, { elevatedLevel?: string }>;
}> {
const res = await params.getReplyFromConfig(
{
Body: params.body ?? "/elevated on",
From: "+1000",
To: "+2000",
Provider: "whatsapp",
SenderE164: "+1000",
CommandAuthorized: true,
},
{},
params.cfg,
);
const text = Array.isArray(res) ? res[0]?.text : res?.text;
const storePath = params.cfg.session?.store;
if (!storePath) {
throw new Error("session.store is required in test config");
}
const store = await readSessionStore(params.cfg);
return { text, store };
}
export async function expectInlineCommandHandledAndStripped(params: {
home: string;
getReplyFromConfig: typeof import("../../../src/auto-reply/reply.js").getReplyFromConfig;
body: string;
stripToken: string;
blockReplyContains: string;
requestOverrides?: Record<string, unknown>;
}) {
const runEmbeddedPiAgentMock = mockRunEmbeddedPiAgentOk();
runEmbeddedPiAgentMock.mockClear();
const { blockReplies, handlers } = createBlockReplyCollector();
const res = await params.getReplyFromConfig(
{
Body: params.body,
From: "+1002",
To: "+2000",
CommandAuthorized: true,
...params.requestOverrides,
},
handlers,
makeCfg(params.home),
);
const text = Array.isArray(res) ? res[0]?.text : res?.text;
expect(blockReplies.length).toBe(1);
expect(blockReplies[0]?.text).toContain(params.blockReplyContains);
expect(runEmbeddedPiAgentMock).toHaveBeenCalled();
const prompt = runEmbeddedPiAgentMock.mock.calls.at(-1)?.[0]?.prompt ?? "";
expect(prompt).not.toContain(params.stripToken);
expect(text).toBe("ok");
}
export async function runGreetingPromptForBareNewOrReset(params: {
home: string;
body: "/new" | "/reset";
getReplyFromConfig: typeof import("../../../src/auto-reply/reply.js").getReplyFromConfig;
}) {
const runEmbeddedPiAgentMock = getRunEmbeddedPiAgentMock();
runEmbeddedPiAgentMock.mockClear();
runEmbeddedPiAgentMock.mockResolvedValue({
payloads: [{ text: "hello" }],
meta: {
durationMs: 1,
agentMeta: { sessionId: "s", provider: "p", model: "m" },
},
});
const res = await params.getReplyFromConfig(
{
Body: params.body,
From: "+1003",
To: "+2000",
CommandAuthorized: true,
},
{},
makeCfg(params.home),
);
const text = Array.isArray(res) ? res[0]?.text : res?.text;
expect(text).toBe("hello");
expect(runEmbeddedPiAgentMock).toHaveBeenCalledOnce();
const prompt = runEmbeddedPiAgentMock.mock.calls.at(-1)?.[0]?.prompt ?? "";
expect(prompt).toContain("A new session was started via /new or /reset");
expect(prompt).toContain("Execute your Session Startup sequence now");
expect(prompt).toContain("read the required files before responding to the user");
}
export function installTriggerHandlingE2eTestHooks() {
afterEach(() => {
clearRuntimeAuthProfileStoreSnapshots();
resetProviderRuntimeHookCacheForTest();
vi.clearAllMocks();
});
}
export function mockRunEmbeddedPiAgentOk(text = "ok"): AnyMock {
const runEmbeddedPiAgentMock = getRunEmbeddedPiAgentMock();
runEmbeddedPiAgentMock.mockResolvedValue({
payloads: [{ text }],
meta: {
durationMs: 1,
agentMeta: { sessionId: "s", provider: "p", model: "m" },
},
});
return runEmbeddedPiAgentMock;
}
export function createBlockReplyCollector() {
const blockReplies: Array<{ text?: string }> = [];
return {
blockReplies,
handlers: {
onBlockReply: async (payload: { text?: string }) => {
blockReplies.push(payload);
},
},
};
}

View File

@@ -4,7 +4,7 @@ import {
providerContractLoadError,
resolveProviderContractProvidersForPluginIds,
} from "../../../src/plugins/contracts/registry.js";
import { loadBundledPluginPublicArtifactModuleSync } from "../../../src/plugins/public-surface-loader.js";
import { resolveBundledExplicitProviderContractsFromPublicArtifacts } from "../../../src/plugins/provider-contract-public-artifacts.js";
import type { ProviderPlugin } from "../../../src/plugins/types.js";
import { installProviderPluginContractSuite } from "./provider-contract-suites.js";
@@ -13,56 +13,10 @@ type ProviderContractEntry = {
provider: ProviderPlugin;
};
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}
function isProviderPlugin(value: unknown): value is ProviderPlugin {
return (
isRecord(value) &&
typeof value.id === "string" &&
typeof value.label === "string" &&
Array.isArray(value.auth)
);
}
function resolveProviderContractProvidersFromPublicArtifact(
pluginId: string,
): ProviderContractEntry[] | null {
let mod: Record<string, unknown>;
try {
mod = loadBundledPluginPublicArtifactModuleSync<Record<string, unknown>>({
dirName: pluginId,
artifactBasename: "provider-contract-api.js",
});
} catch (error) {
if (
error instanceof Error &&
error.message.startsWith("Unable to resolve bundled plugin public surface ")
) {
return null;
}
throw error;
}
const providers: ProviderContractEntry[] = [];
for (const [name, exported] of Object.entries(mod).toSorted(([left], [right]) =>
left.localeCompare(right),
)) {
if (
typeof exported !== "function" ||
exported.length !== 0 ||
!name.startsWith("create") ||
!name.endsWith("Provider")
) {
continue;
}
const provider = exported();
if (isProviderPlugin(provider)) {
providers.push({ pluginId, provider });
}
}
return providers.length > 0 ? providers : null;
return resolveBundledExplicitProviderContractsFromPublicArtifacts({ onlyPluginIds: [pluginId] });
}
export function describeProviderContracts(pluginId: string) {