@zhushanwen/pi-subagent-workflow 8.6.0 → 8.8.0

package/src/orchestration/__tests__/jsonl-run-store-loadall-sources.test.ts

@@ -1,171 +0,0 @@
-// src/orchestration/__tests__/jsonl-run-store-loadall-sources.test.ts
-//
-// loadAll entry 源扫描（collectEntrySources + loadRunFromStateFile）定向用例（R2-TC S4）。
-//
-// 防的 bug：loadAll 的多 run 重建 / 损坏 state 文件降级。W17 已覆盖单 run 的 entry 重建、
-// link 兼容与读序优先级；本文件补齐三块未定向覆盖的分支：
-// 1. 多 run 并存（多个 workflow-record entry run + link run 同批重建，无丢失）
-// 2. 损坏 state 文件降级（末行非 JSON / 空文件 / link 指向不存在路径 / link data 缺 runId）
-//    ——单文件失败返回 null 跳过，不崩 loadAll、不阻断同批其余 run 重建
-// 3. 同 runId 多条 record entry 末条胜出在多 run 场景下不串扰
-//
-// 不 mock collectEntrySources：走 loadAll 真实通路（ctx.sessionManager.getEntries 返回
-// seed entries，loadRunFromStateFile 读真实临时文件）。record entry 一律经真实 save 产出
-//（deserializeRun 的快照 schema 以真实 serializeRun 为准，手工拼快照会绕开 schema 契约）。
-
-import * as fs from "node:fs";
-import * as os from "node:os";
-import * as path from "node:path";
-
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-
-import type { CustomEntry } from "@earendil-works/pi-coding-agent";
-
-import { Budget } from "../models/budget.ts";
-import { Trace } from "../models/trace.ts";
-import type { ExecutionTraceNode } from "../models/types.ts";
-import type { RunSpec } from "../models/run-spec.ts";
-import { WorkflowRun } from "../models/workflow-run.ts";
-import { JsonlRunStore } from "../jsonl-run-store.ts";
-import { mkCtx, mkPi } from "./test-mocks.ts";
-
-function makeSpec(): RunSpec {
-  return {
-    scriptSource: "module.exports = async () => {};",
-    args: {},
-    scriptName: "test-script",
-    scriptPath: "/tmp/test.js",
-    description: "test",
-  };
-}
-
-function makeTraceNode(stepIndex: number): ExecutionTraceNode {
-  return { stepIndex, agent: "worker", task: "do thing", model: "default", status: "pending" };
-}
-
-/** running → done 的完整生命周期 save（终态快照可被 deserializeRun 重建）。 */
-async function saveDoneRun(
-  sessionDir: string,
-  entries: CustomEntry[],
-  runId: string,
-): Promise<void> {
-  const store = new JsonlRunStore({ sessionDir, pi: mkPi(entries) });
-  const run = makeRunningRun(runId);
-  await store.save(run);
-  run.transition("done", "completed");
-  await store.save(run);
-}
-
-function makeRunningRun(runId: string): WorkflowRun {
-  const trace = new Trace();
-  trace.append(makeTraceNode(0));
-  return WorkflowRun.reconstruct(runId, makeSpec(), {
-    status: "running",
-    budget: new Budget(),
-    calls: new Map(),
-    trace,
-    errorLogs: [],
-  }, { startedAt: new Date().toISOString() });
-}
-
-/** 手工构造旧 workflow-state-link 指针 entry（loadAll 的 link 兼容输入）。 */
-function linkEntry(runId: string, statePath: string): CustomEntry {
-  return {
-    type: "custom",
-    customType: "workflow-state-link",
-    data: { runId, path: statePath },
-    id: `seed-link-${runId}`,
-    parentId: null,
-    timestamp: new Date().toISOString(),
-  };
-}
-
-describe("loadAll entry 源扫描：多 run 重建与损坏 state 降级（R2-TC S4）", () => {
-  let tmpDir: string;
-
-  beforeEach(() => {
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "wf-loadall-src-"));
-  });
-
-  afterEach(() => {
-    fs.rmSync(tmpDir, { recursive: true, force: true });
-  });
-
-  it("多 run 并存：2 个 entry run + 1 个 link run 同批全部重建（无丢失）", async () => {
-    // run-a/run-b 经真实 save 通路产出终态 entry（快照形态可信）
-    const entries: CustomEntry[] = [];
-    await saveDoneRun(tmpDir, entries, "run-a");
-    await saveDoneRun(tmpDir, entries, "run-b");
-
-    // run-c：旧 link 形态（state 文件完好，无 record entry）
-    const storeC = new JsonlRunStore({ sessionDir: tmpDir });
-    const runC = makeRunningRun("run-c");
-    await storeC.save(runC);
-    runC.transition("done", "completed");
-    await storeC.save(runC);
-    const linkPath = path.join(tmpDir, "workflow-state", "run-c.jsonl");
-    expect(fs.existsSync(linkPath)).toBe(true);
-    const seedEntries: CustomEntry[] = [...entries, linkEntry("run-c", linkPath)];
-
-    const store = new JsonlRunStore({ sessionDir: tmpDir, ctx: mkCtx(seedEntries) });
-    const loaded = await store.loadAll();
-    expect(loaded.map((r) => r.runId).sort()).toEqual(["run-a", "run-b", "run-c"]);
-  });
-
-  it("损坏 state 文件（末行非 JSON）→ 该 run 跳过不崩，同批其余 run（entry run）正常返回", async () => {
-    const entries: CustomEntry[] = [];
-    await saveDoneRun(tmpDir, entries, "run-good");
-
-    const corruptPath = path.join(tmpDir, "workflow-state", "run-corrupt.jsonl");
-    fs.mkdirSync(path.dirname(corruptPath), { recursive: true });
-    fs.writeFileSync(corruptPath, "{truncated-not-json\n", "utf8");
-
-    const seedEntries: CustomEntry[] = [...entries, linkEntry("run-corrupt", corruptPath)];
-    const store = new JsonlRunStore({ sessionDir: tmpDir, ctx: mkCtx(seedEntries) });
-    const loaded = await store.loadAll();
-    expect(loaded.map((r) => r.runId)).toEqual(["run-good"]);
-  });
-
-  it("损坏形态族：空文件 / link 指向不存在路径 / link data 缺 runId → 均降级跳过，loadAll 不抛", async () => {
-    const emptyPath = path.join(tmpDir, "workflow-state", "run-empty.jsonl");
-    fs.mkdirSync(path.dirname(emptyPath), { recursive: true });
-    fs.writeFileSync(emptyPath, "", "utf8");
-    const missingPath = path.join(tmpDir, "workflow-state", "run-missing.jsonl");
-
-    const malformedLink = linkEntry("run-bad", emptyPath);
-    (malformedLink.data as Record<string, unknown>).runId = undefined; // 缺 runId 的坏指针
-
-    // 对照组：一条合法 record entry run 应正常重建（真实 save 产出）
-    const entries: CustomEntry[] = [];
-    await saveDoneRun(tmpDir, entries, "run-seeded");
-
-    const seedEntries: CustomEntry[] = [
-      ...entries,
-      linkEntry("run-empty", emptyPath),
-      linkEntry("run-missing", missingPath),
-      malformedLink,
-    ];
-    const store = new JsonlRunStore({ sessionDir: tmpDir, ctx: mkCtx(seedEntries) });
-    const loaded = await store.loadAll();
-    expect(loaded.map((r) => r.runId)).toEqual(["run-seeded"]);
-  });
-
-  it("同 runId 多条 record entry 末条胜出（running→done 收敛）+ 另一 run 不受影响（混合批不串扰）", async () => {
-    const entries: CustomEntry[] = [];
-    // run-x：两条 entry（running 中间态 + done 终态），末条胜出
-    const storeX = new JsonlRunStore({ sessionDir: tmpDir, pi: mkPi(entries) });
-    const runX = makeRunningRun("run-x");
-    await storeX.save(runX);
-    runX.transition("done", "completed");
-    await storeX.save(runX);
-    // run-y：done 终态
-    await saveDoneRun(tmpDir, entries, "run-y");
-
-    const store = new JsonlRunStore({ sessionDir: tmpDir, ctx: mkCtx(entries) });
-    const loaded = await store.loadAll();
-    const byId = new Map(loaded.map((r) => [r.runId, r]));
-    expect(loaded).toHaveLength(2);
-    expect(byId.get("run-x")?.state.status).toBe("done");
-    expect(byId.get("run-y")?.state.status).toBe("done");
-  });
-});

package/src/orchestration/__tests__/jsonl-run-store-retention.test.ts

@@ -1,202 +0,0 @@
-// src/orchestration/__tests__/jsonl-run-store-retention.test.ts
-//
-// [B1] workflow-state 磁盘保留清理（opt-in，默认关）。
-//
-// 锁定的语义：
-// - 默认关：XYZ_SUBAGENT_STATE_MAX_RUNS 未设/空/0/负数/非数值 → 永不删除
-//   （「limits 默认关」裁决基线，watchdog 风格解析）；
-// - opt-in：每次新 run state 文件首写成功后，目录内 wf-*.jsonl 按 mtime 升序
-//   裁剪到上限（删最旧）；上限 3 写 5 个 → 剩最新 3；
-// - glob 外文件（非 wf- 前缀 / 非 .jsonl）与父目录 session JSONL 永不误删；
-// - 单个删除失败（unlink 目录 → EPERM，非 ENOENT）logger.warn 留证不抛，
-//   save 主链路不受影响。
-//
-// mtime 确定性：每个文件落盘后立即 utimesSync 钉死 mtime（基线 + i 分钟，全部
-// 过去时），消除同毫秒写入的排序抖动——被删集合 = mtime 最旧的 (N - cap) 个，
-// 断言精确到文件名。
-
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-
-const { loggerMock } = vi.hoisted(() => ({
-  loggerMock: {
-    debug: vi.fn(),
-    info: vi.fn(),
-    warn: vi.fn(),
-    error: vi.fn(),
-  },
-}));
-vi.mock("@zhushanwen/pi-extension-logger", () => ({ getLogger: () => loggerMock }));
-
-import * as fs from "node:fs";
-import * as os from "node:os";
-import * as path from "node:path";
-
-import { Budget } from "../models/budget.ts";
-import { Trace } from "../models/trace.ts";
-import type { RunSpec } from "../models/run-spec.ts";
-import type { ExecutionTraceNode } from "../models/types.ts";
-import { WorkflowRun } from "../models/workflow-run.ts";
-import { JsonlRunStore, STATE_MAX_RUNS_ENV } from "../jsonl-run-store.ts";
-
-function makeSpec(): RunSpec {
-  return {
-    scriptSource: "module.exports = async () => {};",
-    args: {},
-    scriptName: "test-script",
-    scriptPath: "/tmp/test.js",
-    description: "test",
-  };
-}
-
-function makeTraceNode(stepIndex: number): ExecutionTraceNode {
-  return { stepIndex, agent: "worker", task: "do thing", model: "default", status: "pending" };
-}
-
-function makeRunningRun(runId: string): WorkflowRun {
-  const trace = new Trace();
-  trace.append(makeTraceNode(0));
-  return WorkflowRun.reconstruct(runId, makeSpec(), {
-    status: "running",
-    budget: new Budget(),
-    calls: new Map(),
-    trace,
-    errorLogs: [],
-  }, { startedAt: new Date().toISOString() });
-}
-
-/** runId 形如 lifecycle 生成器（wf-<ts>-<rand>），i 只进 ts 段保证唯一。 */
-function runIdAt(i: number): string {
-  return `wf-${1719500000000 + i * 1000}-retent`;
-}
-
-function stateFile(stateDir: string, runId: string): string {
-  return path.join(stateDir, `${runId}.jsonl`);
-}
-
-/** 把文件/目录 mtime 钉到过去（基线 + i 分钟）——排序判定不依赖真实写入时序。 */
-function pinMtime(fullPath: string, i: number, base: number): void {
-  const t = new Date(base + i * 60_000);
-  fs.utimesSync(fullPath, t, t);
-}
-
-describe("B1: workflow-state 保留清理（opt-in XYZ_SUBAGENT_STATE_MAX_RUNS）", () => {
-  let tmpDir: string;
-  let stateDir: string;
-
-  beforeEach(() => {
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "wf-retention-"));
-    stateDir = path.join(tmpDir, "workflow-state");
-    // 双保险：vitest.setup 全局净化 + 本文件显式 delete（防用例间经 stub 栈泄漏）
-    delete process.env[STATE_MAX_RUNS_ENV];
-    loggerMock.warn.mockClear();
-    loggerMock.debug.mockClear();
-  });
-
-  afterEach(() => {
-    delete process.env[STATE_MAX_RUNS_ENV];
-    fs.rmSync(tmpDir, { recursive: true, force: true });
-  });
-
-  it("上限 3 写 5 个 → 剩最新 3（mtime 最旧的 2 个被删）", async () => {
-    process.env[STATE_MAX_RUNS_ENV] = "3";
-    const store = new JsonlRunStore({ sessionDir: tmpDir });
-    const base = Date.now() - 10 * 60_000;
-
-    for (let i = 0; i < 5; i++) {
-      const runId = runIdAt(i);
-      await store.save(makeRunningRun(runId));
-      // save 返回 = 首写 flush + 本轮 prune 已执行；此刻钉 mtime 供下一轮 prune 排序
-      pinMtime(stateFile(stateDir, runId), i, base);
-    }
-
-    // 最后一轮 prune 按钉死的 mtime（0<1<2<3<4 分钟）裁到 3：留 i=2,3,4，删 i=0,1
-    expect(fs.readdirSync(stateDir).sort()).toEqual(
-      [runIdAt(2), runIdAt(3), runIdAt(4)].map((id) => `${id}.jsonl`).sort(),
-    );
-    expect(loggerMock.warn).not.toHaveBeenCalled();
-  });
-
-  it("未设 / 空 / 0 / 负数 / 非数值 → 不清理（默认关语义锁定）", async () => {
-    const store = new JsonlRunStore({ sessionDir: tmpDir });
-
-    // 未设：写 5 个全保留（无上限即无删除）
-    for (let i = 0; i < 5; i++) {
-      await store.save(makeRunningRun(runIdAt(i)));
-    }
-    expect(fs.readdirSync(stateDir)).toHaveLength(5);
-
-    // 显式非法值同样不启用（解析回落 undefined）：继续写、文件只增不减
-    for (const value of ["", "0", "-2", "abc", "NaN", "Infinity"]) {
-      process.env[STATE_MAX_RUNS_ENV] = value;
-      await store.save(makeRunningRun(runIdAt(5)));
-    }
-    // runIdAt(5) 首写（冷路径）flush 落盘第 6 个文件；后续 5 次为 running 热路径
-    // 去抖批（未 flush）——磁盘 6 个文件且全程无删除
-    expect(fs.readdirSync(stateDir)).toHaveLength(6);
-    expect(loggerMock.warn).not.toHaveBeenCalled();
-    await store.dispose();
-  });
-
-  it("glob 外文件与父目录 session JSONL 不误删（只删本目录 wf-*.jsonl）", async () => {
-    fs.mkdirSync(stateDir, { recursive: true });
-    const bystanders = [
-      "notes.txt",
-      "keep-me.jsonl",
-      "wf-truncated-noext",
-      "xwf-1719500000000-notwf.jsonl",
-    ];
-    for (const name of bystanders) {
-      fs.writeFileSync(path.join(stateDir, name), "x");
-    }
-    // session JSONL 在父目录（sessionDir），结构性不在扫描范围，实测钉住
-    const sessionFile = path.join(tmpDir, "main-session.jsonl");
-    fs.writeFileSync(sessionFile, "{}\n");
-
-    process.env[STATE_MAX_RUNS_ENV] = "1";
-    const store = new JsonlRunStore({ sessionDir: tmpDir });
-    const base = Date.now() - 10 * 60_000;
-
-    await store.save(makeRunningRun(runIdAt(0)));
-    pinMtime(stateFile(stateDir, runIdAt(0)), 0, base); // 钉成最旧
-    await store.save(makeRunningRun(runIdAt(1)));
-
-    // 2 个 state 文件裁到 1：runIdAt(0) 被删，4 个旁观文件原封不动
-    expect(fs.readdirSync(stateDir).sort()).toEqual(
-      [...bystanders, `${runIdAt(1)}.jsonl`].sort(),
-    );
-    expect(fs.existsSync(sessionFile)).toBe(true);
-    expect(loggerMock.warn).not.toHaveBeenCalled();
-  });
-
-  it("删除失败（unlink 目录 → EPERM）→ logger.warn 留证不抛，save 正常 resolve", async () => {
-    fs.mkdirSync(stateDir, { recursive: true });
-    // 用「名字命中 glob 的目录」制造确定性 unlink 失败（unlink 目录 → EPERM）
-    const blockerDir = stateFile(stateDir, runIdAt(0));
-    fs.mkdirSync(blockerDir);
-    pinMtime(blockerDir, 0, Date.now() - 10 * 60_000); // 钉成最旧 → 成为删除受害者
-
-    process.env[STATE_MAX_RUNS_ENV] = "1";
-    const store = new JsonlRunStore({ sessionDir: tmpDir });
-
-    // save 1 的 prune：受害者 = blockerDir → EPERM → warn，但 save 正常 resolve
-    await store.save(makeRunningRun(runIdAt(1)));
-    expect(fs.existsSync(stateFile(stateDir, runIdAt(1)))).toBe(true);
-    expect(fs.existsSync(blockerDir)).toBe(true);
-
-    // save 2 的 prune：3 项裁到 1，受害者 = dir（最旧，重试仍 EPERM）+ file1（次旧，删成）
-    await store.save(makeRunningRun(runIdAt(2)));
-    expect(fs.existsSync(stateFile(stateDir, runIdAt(1)))).toBe(false);
-    expect(fs.existsSync(stateFile(stateDir, runIdAt(2)))).toBe(true);
-    expect(fs.existsSync(blockerDir)).toBe(true);
-
-    // 每轮 prune 独立重试受害者：save1 与 save2 各 warn 一次（均指向 blockerDir），
-    // 不抛错、不阻断其余文件删除
-    expect(loggerMock.warn).toHaveBeenCalledTimes(2);
-    for (const call of loggerMock.warn.mock.calls) {
-      const msg = String(call[0] ?? "");
-      expect(msg).toContain("state retention");
-      expect(msg).toContain(blockerDir);
-    }
-    await store.dispose();
-  });
-});