Files
reverse-engineering-anything/tests/boundary/mcp/optionalProviderShutdown.test.ts
T
gensokyo-devandgensokyo-dev 07e4b700ac test: let the deadline policy own test waits
Vitest's expect.poll and vi.waitFor stop after one second by default, a
host-speed guess that the project's deadline policy does not see. Under
hosted-CI load, kunaProjectConcurrency failed that way twice on unrelated
PRs. Another 256 waits relied on the default, and 97 passed literals
picked to fit some host.

Waits now take as long as their test may run, less the reporting reserve
that children already keep. Each Vitest project sets expect.poll's
default, and the new waitFor in tests/support/testWait.ts replaces
vi.waitFor. Fixture readiness waits (awaitAcknowledgement and the provider
process waits) default to the same deadline, and their host-speed literal
arguments are removed. One remainingTestDeadline owns the arithmetic for
both children and waits.

Ten waits whose short timeout was the real check now assert it directly
(Kuna version probe, Cutter discovery, doctor and Inspector cancellation,
apktool fixture teardown, JADX disconnect): settlement before the
production deadline that would otherwise also satisfy the wait, or a
deadline pinned beyond every test deadline.

The rea/project-wait-deadline lint rule rejects vi.waitFor and explicit
expect.poll timeouts. The testing guide and the CI tests audit skill now
document the policy.

Co-Authored-By: gensokyo-dev <342580529+gensokyo-dev@users.noreply.github.com>
2026-11-14 19:28:38 +08:00

195 lines
6.4 KiB
TypeScript

import { afterAll, expect, it, vi } from "vitest";
import { mkdirSync, mkdtempSync, rmSync } from "node:fs";
import { resolve } from "node:path";
import {
createDeferred,
createTestBinarySession,
} from "../../fixtures/binarySession.js";
import { createBrowserObservationProvider } from "../../../src/composition/browserObservation.js";
import { createJavaScriptRuntimeObservationProvider } from "../../../src/composition/javascriptRuntimeObservation.js";
import { run } from "../../../src/main.js";
import { MCP_SHUTDOWN_FAILED } from "../../../src/main/messages.js";
import { createServer } from "../../../src/server/createServer.js";
import { waitFor } from "../../support/testWait.js";
mkdirSync(".cache", { recursive: true });
const root = mkdtempSync(resolve(".cache/optional-provider-shutdown-"));
const environment = {
HOME: `${root}/home`,
XDG_CONFIG_HOME: `${root}/config`,
XDG_CACHE_HOME: `${root}/cache`,
REA_LOG_LEVEL: "silent",
};
for (const path of [
environment.HOME,
environment.XDG_CONFIG_HOME,
environment.XDG_CACHE_HOME,
])
mkdirSync(path);
afterAll(() => rmSync(root, { recursive: true, force: true }));
it("refuses eager server publication after the shutdown snapshot and completed close", async () => {
const closingHandle = createDeferred<void>();
const releaseHandle = createDeferred<void>();
const acquired: ReturnType<typeof createServer>[] = [];
let publish: (() => unknown) | undefined;
let shutdown: (() => Promise<void>) | undefined;
let closing: Promise<void> | undefined;
let transportCloses = 0;
try {
expect(
await run({
env: environment,
loadOptionalProviders: async () => ({}),
createServer: (source, options) => {
const server = createServer(source, options);
acquired.push(server);
return server;
},
serve: (factory) => {
publish = () => factory({ era: "legacy" });
publish();
return {
close: async () => {
transportCloses++;
closingHandle.resolve();
await releaseHandle.promise;
},
};
},
captureShutdown: (close) => {
shutdown = close;
},
registerShutdown: () => () => {},
writeStderr: () => {},
setExitCode: () => {},
}),
).toBe(0);
if (shutdown === undefined || publish === undefined)
throw new Error("Runtime ownership hooks were not installed");
closing = shutdown();
await closingHandle.promise;
expect(publish).toThrow("MCP connection is closed");
releaseHandle.resolve();
await closing;
expect(publish).toThrow("MCP connection is closed");
await shutdown();
expect(transportCloses).toBe(1);
expect(acquired).toHaveLength(1);
} finally {
releaseHandle.resolve();
await closing;
await shutdown?.();
for (const server of acquired) await server.close();
}
});
it("retries failed process-owned optional cleanup without reclosing completed peers", async () => {
const runtime = createJavaScriptRuntimeObservationProvider({});
const browser = createBrowserObservationProvider();
const closeRuntime = runtime.close?.bind(runtime);
const runtimeClose = vi.spyOn(runtime, "close");
const browserClose = vi.spyOn(browser, "close");
if (closeRuntime === undefined) throw new Error("Runtime close hook missing");
runtimeClose.mockImplementation(async () => {
if (runtimeClose.mock.calls.length === 1)
throw new Error("controlled runtime cleanup failure");
await closeRuntime();
});
const callerOwnedSession = createTestBinarySession(() => {
throw new Error("No analysis target is allowed in this lifecycle test");
});
const callerOwnedServer = createServer(
{ kind: "session", session: callerOwnedSession },
{
environment,
javascriptRuntimeObservation: runtime,
optionalObservationProviderOwner: "caller",
},
);
try {
await callerOwnedServer.close();
expect(runtimeClose).not.toHaveBeenCalled();
} finally {
const closed = await callerOwnedSession.close();
if (!closed.ok) throw closed.error;
}
let shutdown: (() => void) | undefined;
let servers = 0;
let transportCloses = 0;
let unregisterCalls = 0;
const stderr: string[] = [];
const exitCodes: number[] = [];
const optionalProviderLoadFailures = {
browserScenarioCapture: {
providerId: "playwright-browser-scenario",
reason: "controlled optional provider load failure",
},
};
try {
const result = await run({
env: environment,
loadOptionalProviders: async () => ({
browserObservation: browser,
javascriptRuntimeObservation: runtime,
optionalProviderLoadFailures,
}),
createServer: (source, options) => {
expect(options?.optionalObservationProviderOwner).toBe("caller");
expect(options?.javascriptRuntimeObservation).toBe(runtime);
expect(options?.optionalProviderLoadFailures).toBe(
optionalProviderLoadFailures,
);
servers += 1;
return createServer(source, options);
},
serve: (factory) => {
const server = factory({ era: "legacy" });
return {
close: async () => {
transportCloses += 1;
await (await server).close();
},
};
},
registerShutdown: (handler) => {
shutdown = handler;
return () => {
unregisterCalls += 1;
};
},
writeStderr: (text) => stderr.push(text),
setExitCode: (code) => exitCodes.push(code),
});
expect(result).toBe(0);
if (shutdown === undefined)
throw new Error("Shutdown hook was not installed");
shutdown();
await waitFor(() => expect(runtimeClose).toHaveBeenCalledTimes(1));
await waitFor(() => expect(exitCodes).toEqual([1]));
expect(browserClose).toHaveBeenCalledTimes(1);
expect(transportCloses).toBe(1);
expect(servers).toBe(1);
expect(unregisterCalls).toBe(0);
shutdown();
await waitFor(() => expect(unregisterCalls).toBe(1));
expect(runtimeClose).toHaveBeenCalledTimes(2);
expect(browserClose).toHaveBeenCalledTimes(1);
expect(transportCloses).toBe(1);
expect(exitCodes).toEqual([1]);
expect(stderr).toContain(`${MCP_SHUTDOWN_FAILED}\n`);
} finally {
runtimeClose.mockRestore();
browserClose.mockRestore();
await runtime.close?.();
await browser.close?.();
}
});