mirror of
https://github.com/morluto/rea.git
synced 2026-11-14 18:52:48 +00:00
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>
322 lines
10 KiB
TypeScript
322 lines
10 KiB
TypeScript
import { execFile, spawn } from "node:child_process";
|
|
import { access, readFile, writeFile } from "node:fs/promises";
|
|
import { join } from "node:path";
|
|
import { setTimeout as delay } from "node:timers/promises";
|
|
import { fileURLToPath } from "node:url";
|
|
import { promisify } from "node:util";
|
|
import { Client, InMemoryTransport } from "@modelcontextprotocol/client";
|
|
import pino from "pino";
|
|
import { expect, onTestFinished } from "vitest";
|
|
import { z } from "zod";
|
|
import { analysisCliErrorEnvelopeSchema } from "../../../src/contracts/errorSchemas.js";
|
|
import { cleanupOwnedProcessGroup } from "../../../src/process/ProcessOwnership.js";
|
|
import { createServer } from "../../../src/server/createServer.js";
|
|
import {
|
|
createDeferred,
|
|
createTestBinarySession,
|
|
} from "../../fixtures/binarySession.js";
|
|
import { createTestTempDirectory } from "../../fixtures/temporaryDirectory.js";
|
|
import { itWithCaptureCapability } from "./processCaptureCapability.js";
|
|
|
|
const fixture = fileURLToPath(
|
|
new URL("../../fixtures/processCaptureCancellation.mjs", import.meta.url),
|
|
);
|
|
const exec = promisify(execFile);
|
|
const markerSchema = z.object({
|
|
rootPid: z.number().int().positive(),
|
|
childPid: z.number().int().positive().optional(),
|
|
runId: z.string().min(1),
|
|
});
|
|
type Marker = z.infer<typeof markerSchema>;
|
|
|
|
const readMarker = async (root: string): Promise<Marker> => {
|
|
const deadline = Date.now() + 10_000;
|
|
while (Date.now() < deadline) {
|
|
try {
|
|
return markerSchema.parse(
|
|
JSON.parse(await readFile(join(root, "ready.json"), "utf8")),
|
|
);
|
|
} catch (cause: unknown) {
|
|
if (
|
|
!(cause instanceof Error && "code" in cause && cause.code === "ENOENT")
|
|
)
|
|
throw cause;
|
|
}
|
|
await delay(25);
|
|
}
|
|
throw new Error("Owned capture fixture did not become ready");
|
|
};
|
|
|
|
const isRunning = async (pid: number): Promise<boolean> => {
|
|
try {
|
|
const { stdout } = await exec("ps", ["-o", "stat=", "-p", String(pid)]);
|
|
return stdout.trim().length > 0 && !stdout.trim().startsWith("Z");
|
|
} catch (cause: unknown) {
|
|
if (cause instanceof Error && "code" in cause && cause.code === 1)
|
|
return false;
|
|
throw cause;
|
|
}
|
|
};
|
|
|
|
const waitForExit = async (pid: number): Promise<void> => {
|
|
await expect.poll(() => isRunning(pid), { interval: 25 }).toBe(false);
|
|
};
|
|
|
|
const cleanupFixture = async (marker: Marker | undefined): Promise<void> => {
|
|
if (marker === undefined) return;
|
|
// Teardown uses the fixture's capture run token, never a bare PID kill.
|
|
const result = await cleanupOwnedProcessGroup({
|
|
runId: marker.runId,
|
|
leaderPid: marker.rootPid,
|
|
processGroupId: marker.rootPid,
|
|
});
|
|
if (!result.cleaned)
|
|
throw new Error(`Fixture cleanup failed: ${result.reason}`);
|
|
};
|
|
|
|
const finishCleanup = async (steps: readonly (() => Promise<unknown>)[]) => {
|
|
const failures: unknown[] = [];
|
|
for (const step of steps) {
|
|
try {
|
|
await step();
|
|
} catch (cause: unknown) {
|
|
failures.push(cause);
|
|
}
|
|
}
|
|
if (failures.length > 0)
|
|
throw new AggregateError(failures, "Fixture cleanup failed");
|
|
};
|
|
|
|
itWithCaptureCapability.each(["SIGINT", "SIGTERM"] as const)(
|
|
"awaits owned workload cleanup and emits a typed CLI cancellation after %s",
|
|
async (signal) => {
|
|
const root = await createTestTempDirectory("rea-process-cli-cancel-");
|
|
const scenario = join(root, "scenario.json");
|
|
await writeFile(
|
|
scenario,
|
|
JSON.stringify({
|
|
executable: process.execPath,
|
|
arguments: [fixture, "active", root],
|
|
working_directory: root,
|
|
timeout_ms: 15_000,
|
|
idle_timeout_ms: 15_000,
|
|
}),
|
|
);
|
|
const cli = spawn(
|
|
process.execPath,
|
|
["scripts/rea.mjs", "capture-process", scenario, "--format", "json"],
|
|
{ stdio: ["ignore", "pipe", "pipe"] },
|
|
);
|
|
let stdout = "";
|
|
cli.stdout.on("data", (chunk: Buffer) => {
|
|
stdout += chunk.toString();
|
|
});
|
|
cli.stderr.resume();
|
|
const closed = new Promise<{
|
|
code: number | null;
|
|
signal: NodeJS.Signals | null;
|
|
}>((resolve, reject) => {
|
|
cli.once("error", reject);
|
|
cli.once("close", (code, exitSignal) =>
|
|
resolve({ code, signal: exitSignal }),
|
|
);
|
|
});
|
|
let marker: Marker | undefined;
|
|
onTestFinished(async () => {
|
|
await finishCleanup([
|
|
() => cleanupFixture(marker),
|
|
async () => {
|
|
if (cli.exitCode === null && cli.signalCode === null)
|
|
cli.kill("SIGKILL");
|
|
await closed;
|
|
},
|
|
]);
|
|
});
|
|
marker = await readMarker(root);
|
|
expect(await isRunning(marker.rootPid)).toBe(true);
|
|
cli.kill(signal);
|
|
expect(await closed).toEqual({
|
|
code: signal === "SIGINT" ? 130 : 143,
|
|
signal: null,
|
|
});
|
|
await waitForExit(marker.rootPid);
|
|
await expect(access(join(root, "late-write"))).rejects.toMatchObject({
|
|
code: "ENOENT",
|
|
});
|
|
const result = analysisCliErrorEnvelopeSchema.parse(JSON.parse(stdout));
|
|
expect(result, JSON.stringify(result.details)).toMatchObject({
|
|
code: "cancelled",
|
|
details: { operation: "process_capture", cleanup: "complete" },
|
|
});
|
|
},
|
|
20_000,
|
|
);
|
|
|
|
itWithCaptureCapability(
|
|
"preserves completed observations as partial evidence when SIGINT arrives during CLI cleanup",
|
|
async () => {
|
|
const root = await createTestTempDirectory("rea-process-cleanup-cancel-");
|
|
const scenario = join(root, "scenario.json");
|
|
const cleanupMarker = join(root, "cleanup.json");
|
|
await writeFile(
|
|
scenario,
|
|
JSON.stringify({
|
|
executable: process.execPath,
|
|
arguments: ["-e", "console.log('completed-before-cleanup')"],
|
|
timeout_ms: 5_000,
|
|
}),
|
|
);
|
|
const hook = fileURLToPath(
|
|
new URL("../../fixtures/processCleanupCancellation.mjs", import.meta.url),
|
|
);
|
|
for (const cancel of [false, true]) {
|
|
const cli = spawn(
|
|
process.execPath,
|
|
[
|
|
"--import",
|
|
hook,
|
|
"scripts/rea.mjs",
|
|
"capture-process",
|
|
scenario,
|
|
"--format",
|
|
"json",
|
|
],
|
|
{
|
|
env: {
|
|
...process.env,
|
|
TMPDIR: root,
|
|
REA_TEST_CANCEL_DURING_CLEANUP: cancel ? "1" : "0",
|
|
REA_TEST_CLEANUP_MARKER: cleanupMarker,
|
|
},
|
|
stdio: ["ignore", "pipe", "pipe"],
|
|
},
|
|
);
|
|
let stdout = "";
|
|
cli.stdout.on("data", (chunk: Buffer) => {
|
|
stdout += chunk.toString();
|
|
});
|
|
cli.stderr.resume();
|
|
const closed = new Promise<number | null>((resolve, reject) => {
|
|
cli.once("error", reject);
|
|
cli.once("close", resolve);
|
|
});
|
|
onTestFinished(async () => {
|
|
if (cli.exitCode === null && cli.signalCode === null)
|
|
cli.kill("SIGKILL");
|
|
await closed;
|
|
});
|
|
expect(await closed).toBe(cancel ? 130 : 0);
|
|
const marker = z
|
|
.object({ path: z.string(), removed: z.literal(true) })
|
|
.parse(JSON.parse(await readFile(cleanupMarker, "utf8")));
|
|
await expect(access(marker.path)).rejects.toMatchObject({
|
|
code: "ENOENT",
|
|
});
|
|
const output: unknown = JSON.parse(stdout);
|
|
if (cancel) {
|
|
expect(analysisCliErrorEnvelopeSchema.parse(output)).toMatchObject({
|
|
code: "cancelled",
|
|
details: {
|
|
cleanup: "complete",
|
|
partial_observation: {
|
|
capture: { exit: { code: 0 } },
|
|
cleanup: { temporary_root: { state: "cleaned" } },
|
|
},
|
|
},
|
|
});
|
|
} else {
|
|
expect(output).toMatchObject({
|
|
operation: "capture_process_scenario",
|
|
normalized_result: {
|
|
exit: { code: 0 },
|
|
cleanup: { temporary_root: "removed" },
|
|
},
|
|
});
|
|
}
|
|
}
|
|
},
|
|
30_000,
|
|
);
|
|
|
|
itWithCaptureCapability(
|
|
"stops the owned descendant when an MCP request is cancelled during post-exit settlement",
|
|
async () => {
|
|
const root = await createTestTempDirectory(
|
|
"rea-process-mcp-settle-cancel-",
|
|
);
|
|
const session = createTestBinarySession(() => {
|
|
throw new Error("Process capture must not launch a binary provider");
|
|
});
|
|
const completed = createDeferred<string>();
|
|
const completionSchema = z.object({
|
|
tool: z.string(),
|
|
status: z.string(),
|
|
msg: z.string(),
|
|
});
|
|
const logger = pino(
|
|
{ level: "info" },
|
|
{
|
|
write(line) {
|
|
const parsed = completionSchema.safeParse(JSON.parse(line));
|
|
if (
|
|
parsed.success &&
|
|
parsed.data.tool === "capture_process_scenario" &&
|
|
parsed.data.msg === "MCP tool execution completed"
|
|
)
|
|
completed.resolve(parsed.data.status);
|
|
},
|
|
},
|
|
);
|
|
const server = createServer({ kind: "session", session }, { logger });
|
|
const client = new Client({
|
|
name: "process-settlement-cancellation",
|
|
version: "1",
|
|
});
|
|
let marker: Marker | undefined;
|
|
onTestFinished(async () => {
|
|
await finishCleanup([
|
|
() => cleanupFixture(marker),
|
|
() => client.close(),
|
|
() => server.close(),
|
|
() => session.close(),
|
|
]);
|
|
});
|
|
const [clientTransport, serverTransport] =
|
|
InMemoryTransport.createLinkedPair();
|
|
await server.connect(serverTransport);
|
|
await client.connect(clientTransport);
|
|
const controller = new AbortController();
|
|
const call = client.callTool(
|
|
{
|
|
name: "capture_process_scenario",
|
|
arguments: {
|
|
executable: process.execPath,
|
|
arguments: [fixture, "settlement", root],
|
|
working_directory: root,
|
|
timeout_ms: 15_000,
|
|
idle_timeout_ms: 15_000,
|
|
settle_ms: 10_000,
|
|
},
|
|
},
|
|
{ signal: controller.signal },
|
|
);
|
|
const cancelled = expect(call).rejects.toThrow("cancel settlement fixture");
|
|
marker = await readMarker(root);
|
|
if (marker.childPid === undefined)
|
|
throw new Error("Settlement fixture did not report its descendant");
|
|
await waitForExit(marker.rootPid);
|
|
expect(await isRunning(marker.childPid)).toBe(true);
|
|
// The root has exited while the descendant keeps its owned group alive.
|
|
await delay(100);
|
|
controller.abort(new Error("cancel settlement fixture"));
|
|
await cancelled;
|
|
await waitForExit(marker.childPid);
|
|
expect(await completed.promise).toBe("error");
|
|
await expect(access(join(root, "late-write"))).rejects.toMatchObject({
|
|
code: "ENOENT",
|
|
});
|
|
await client.ping();
|
|
},
|
|
20_000,
|
|
);
|