@zhushanwen/pi-subagent-workflow 7.4.0 → 8.1.0

package/src/execution/__tests__/get-record-for-action-restart.test.ts

@@ -0,0 +1,254 @@
+// src/execution/__tests__/get-record-for-action-restart.test.ts
+//
+// [M10] getRecordForAction 跨重启磁盘重建分支测试（subagent-service.ts L933-951）。
+//
+// 背景：内存 miss → collectRecords(1000,"all",undefined).find(status==="running") →
+// createRecord({chatMode: true}) → register → 回填 sessionFile/round。代码注释
+// （L946-949）自设强制约束「改动此处必须带 S3 回归场景（跨重启 message 续聊验证）」
+// ——该 S3 场景此前不存在，分支零测试。该分支含多个仅此处独有的决策：
+//   - 无条件 chatMode: true（v4 A-3 跨重启恢复入口，V3 方案 A 方向）
+//   - rootSessionFilter 传 undefined 后置校验（异树仍 throw not owned）
+//   - sessionFile/round 从磁盘重建结果回填（round 无磁盘持久化 → undefined）
+//
+// fixture 构造参照 record-store.test.ts 的 writeSessionJsonl（真实 .jsonl 文件，
+// identity custom entry + assistant message；无 .alive sidecar → record-store
+// sidecar 矩阵分支 4 → status="running" 跨重启可续聊态）。
+
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+const { loggerMock } = vi.hoisted(() => ({
+  loggerMock: { debug: vi.fn(), warn: vi.fn(), error: vi.fn(), info: vi.fn() },
+}));
+vi.mock("@zhushanwen/pi-extension-logger", () => ({ getLogger: () => loggerMock }));
+
+// mock session-runner：import 链需要（getRecordForAction 本身不调 spawn，仅守卫读
+// hasLiveProcessHandle——默认无活进程，与跨重启场景一致）。
+vi.mock("../session-runner.ts", () => ({
+  runSpawn: vi.fn(),
+  killAllSpawnedChildren: vi.fn(),
+  getChildByRecord: vi.fn(() => undefined),
+  spawnedChildren: new Map(),
+}));
+
+import { writeFinalized } from "../finalized-marker.ts";
+import { ModelConfigService } from "../model-config-service.ts";
+import { getSubagentSessionDir } from "../path-encoding.ts";
+import { RecordStore } from "../record-store.ts";
+import { SubagentService } from "../subagent-service.ts";
+
+// 身份 env 名（与 subagent-service.ts 常量一致；beforeEach/afterEach 清理防泄漏——
+// 测试进程可能继承 subagent env，会污染 rootCwd 编码目录与 sessionRootId 基线）。
+const IDENTITY_ENV_KEYS = [
+  "PI_SUBAGENT_ROOT_SESSION_ID",
+  "PI_SUBAGENT_SELF_RECORD_ID",
+  "PI_SUBAGENT_DEPTH",
+  "PI_SUBAGENT_ROOT_CWD",
+  "PI_SUBAGENT_FORK_DEPTH",
+] as const;
+
+/** initSession 注入的最小 pi duck-type（同 subagent-service PiLike 形状，结构匹配即可）。 */
+interface PiStub {
+  appendEntry(customType: string, data?: unknown): void;
+  events: { emit(channel: string, data: unknown): void };
+  sendMessage(
+    message: { customType: string; content: string; display: boolean; details?: unknown },
+    options?: { triggerTurn?: boolean; deliverAs?: "steer" | "followUp" | "nextTurn" },
+  ): void;
+}
+
+function makePi(): PiStub {
+  return {
+    appendEntry: vi.fn(),
+    events: { emit: vi.fn() },
+    sendMessage: vi.fn(),
+  };
+}
+
+/** 写一个最小合法 session.jsonl（session header + identity entry + 1 条 assistant message）。
+ *  不写任何 sidecar（.alive/.cancelled/.finalized）→ sidecar 矩阵分支 4 → running。 */
+function writeSessionJsonl(
+  sessionsDir: string,
+  identity: {
+    id: string;
+    rootSessionId: string;
+    parentRecordId?: string;
+    depth?: number;
+    chatMode?: boolean;
+    worktree?: boolean;
+  },
+): string {
+  const file = path.join(sessionsDir, `${identity.id}.jsonl`);
+  const startedAt = 1_700_000_000_000;
+  const lines = [
+    JSON.stringify({
+      type: "session",
+      version: 3,
+      id: "sess-uuid",
+      timestamp: new Date(startedAt).toISOString(),
+      cwd: "/tmp",
+    }),
+    JSON.stringify({
+      type: "custom",
+      id: "id-1",
+      parentId: null,
+      timestamp: new Date(startedAt).toISOString(),
+      customType: "subagent-identity",
+      data: {
+        id: identity.id,
+        agent: "general-purpose",
+        mode: "background",
+        task: "restart recovery task",
+        slug: "restart-test",
+        startedAt,
+        rootSessionId: identity.rootSessionId,
+        ...(identity.parentRecordId !== undefined ? { parentRecordId: identity.parentRecordId } : {}),
+        ...(identity.depth !== undefined ? { depth: identity.depth } : {}),
+        ...(identity.chatMode !== undefined ? { chatMode: identity.chatMode } : {}),
+        ...(identity.worktree !== undefined ? { worktree: identity.worktree } : {}),
+      },
+    }),
+    JSON.stringify({
+      type: "message",
+      id: "msg-1",
+      parentId: "id-1",
+      timestamp: new Date(startedAt + 1000).toISOString(),
+      message: {
+        role: "assistant",
+        content: [{ type: "text", text: "first round done" }],
+        usage: { input: 10, output: 20, cacheRead: 0, cacheWrite: 0 },
+        stopReason: "stop",
+        timestamp: startedAt + 1000,
+      },
+    }),
+  ];
+  fs.writeFileSync(file, `${lines.join("\n")}\n`, "utf-8");
+  return file;
+}
+
+/** 暴露私有 store 供断言 register 副作用。 */
+interface ServiceInternals {
+  store: RecordStore;
+}
+
+describe("[M10] getRecordForAction 跨重启磁盘重建（S3 回归场景）", () => {
+  let agentDir: string;
+  let sessionsDir: string;
+  let service: SubagentService;
+  let store: RecordStore;
+
+  beforeEach(() => {
+    for (const k of IDENTITY_ENV_KEYS) delete process.env[k];
+    agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "restart-recon-"));
+    sessionsDir = getSubagentSessionDir(agentDir, agentDir);
+    fs.mkdirSync(sessionsDir, { recursive: true });
+
+    const modelService = new ModelConfigService({ agentDir, cwd: agentDir });
+    service = new SubagentService({ cwd: agentDir, modelService });
+    // 根进程身份：无 env → sessionRootId = sessionId（自己是 root）、execCtxBaseline = null
+    service.initSession({ pi: makePi(), sessionId: "root-session" });
+    store = (service as unknown as ServiceInternals).store;
+  });
+
+  afterEach(() => {
+    service.dispose();
+    // maxRetries：collectRecords 触发的 fire-and-forget sessions-index 写可能与删除
+    // 并发（ENOTEMPTY 竞态，全量并行跑时机器负载高会放大窗口）
+    fs.rmSync(agentDir, { recursive: true, force: true, maxRetries: 5, retryDelay: 20 });
+    for (const k of IDENTITY_ENV_KEYS) delete process.env[k];
+  });
+
+  it("内存 miss + 磁盘 running（无 .alive）→ 重建 record：chatMode 无条件 true、sessionFile 回填、register 进内存", () => {
+    // identity entry 故意不带 chatMode 字段——证明重建分支的无条件 chatMode:true
+    //（不依赖磁盘是否记录过对话模式标志）
+    const file = writeSessionJsonl(sessionsDir, { id: "sa-restart-1", rootSessionId: "root-session" });
+    expect(store.getMutable("sa-restart-1")).toBeUndefined(); // 前置：内存确无
+
+    const record = service.getRecordForAction("sa-restart-1");
+
+    // [v4 A-3] 无条件 chatMode=true（跨重启恢复入口）
+    expect(record.chatMode).toBe(true);
+    // sessionFile 从磁盘重建结果回填
+    expect(record.sessionFile).toBe(file);
+    // round 从 found 回填：light 磁盘重建无 round（内存态字段，跨重启不恢复）→ undefined
+    expect(record.round).toBeUndefined();
+    // 身份字段从磁盘 identity entry 回填
+    expect(record.agent).toBe("general-purpose");
+    expect(record.task).toBe("restart recovery task");
+    expect(record.slug).toBe("restart-test");
+    expect(record.rootSessionId).toBe("root-session");
+    expect(record.parentRecordId).toBeUndefined();
+    expect(record.status).toBe("running");
+    // register 生效：进内存，二次调用走内存命中（同一引用）
+    expect(store.getMutable("sa-restart-1")).toBe(record);
+    expect(service.getRecordForAction("sa-restart-1")).toBe(record);
+  });
+
+  it("rootSessionId 校验仍生效：异树 record（other-session）→ throw not found or not owned", () => {
+    // rootSessionFilter 传 undefined（扫全量磁盘），异树 record 会被 find 命中并重建，
+    // 但后置校验 record.rootSessionId !== this.sessionRootId 必须拦截
+    writeSessionJsonl(sessionsDir, { id: "sa-foreign", rootSessionId: "other-session" });
+
+    expect(() => service.getRecordForAction("sa-foreign")).toThrow(/not found or not owned/);
+  });
+
+  it("直接父校验仍生效：孙级 record（parentRecordId=sa-parent）→ 主进程 throw direct parent", () => {
+    writeSessionJsonl(sessionsDir, {
+      id: "sa-grand",
+      rootSessionId: "root-session",
+      parentRecordId: "sa-parent",
+      depth: 2,
+    });
+
+    // 重建后 parentRecordId=sa-parent ≠ 主进程 baseline(undefined) → cross-layer 守卫拦截
+    expect(() => service.getRecordForAction("sa-grand")).toThrow(/direct parent/);
+  });
+
+  it(".finalized sidecar（closed 终态）不重建 → throw not found or not owned", () => {
+    const file = writeSessionJsonl(sessionsDir, { id: "sa-fin", rootSessionId: "root-session" });
+    writeFinalized(file); // sidecar 矩阵分支 2 → status=closed → find(status==="running") miss
+
+    expect(() => service.getRecordForAction("sa-fin")).toThrow(/not found or not owned/);
+    expect(store.getMutable("sa-fin")).toBeUndefined(); // 未重建注册
+  });
+
+  // ============================================================
+  // [review round2] 跨重启 worktree 绑定丢失防护
+  // ============================================================
+  // 场景：worktree:true + conversation:true 的 subagent 在父进程重启后续聊。WorktreeHandle
+  // 不可序列化、重建后恒缺失，若无守卫 → 冷路径 resume 的 spawn cwd 静默回落主 repo
+  //（隔离失效，正是 worktree 要防的并发写冲突场景）。
+  it("[review round2] worktree record 跨重启重建 → hadWorktree 标记 + 续聊被拒（行动语言）", async () => {
+    writeSessionJsonl(sessionsDir, {
+      id: "sa-wt",
+      rootSessionId: "root-session",
+      worktree: true,
+    });
+
+    const record = service.getRecordForAction("sa-wt");
+    // hadWorktree 从磁盘 identity entry 的 worktree 标志恢复
+    expect(record.hadWorktree).toBe(true);
+    // handle 无法恢复（不可序列化）
+    expect(record.worktreeHandle).toBeUndefined();
+
+    // 冷路径续聊（无活进程）→ resumeRound 守卫拒绝，不 spawn 回落主 repo
+    await expect(service.deliverMessage(record, "resume after restart", false)).rejects.toThrow(
+      /worktree isolation.*lost when the parent process restarted/,
+    );
+  });
+
+  it("[review round2] 非 worktree record 跨重启重建 → 续聊不受 worktree 守卫拦截（向后兼容）", async () => {
+    // identity entry 无 worktree 字段（旧文件）→ found.worktree undefined → hadWorktree false
+    writeSessionJsonl(sessionsDir, { id: "sa-nowt", rootSessionId: "root-session" });
+
+    const record = service.getRecordForAction("sa-nowt");
+    expect(record.hadWorktree).toBe(false);
+
+    // deliverMessage 冷路径不被 worktree 守卫拦截（resume 正常发起；后续 spawn 编排
+    // 超出本用例关注点——runSpawn 在本文件是 no-op mock）
+    await expect(service.deliverMessage(record, "resume normal", false)).resolves.toBeUndefined();
+  });
+});

package/src/execution/__tests__/helpers/spawn-mock.ts

@@ -24,7 +24,16 @@
 //     const { FakeChild } = await import("./helpers/spawn-mock.ts");
 //     return {
 //       spawn: vi.fn(() => new FakeChild()),
-//       execFileSync: vi.fn(() => ""),
+//       // buildEnvBlock 用 execFile 异步取 git branch：默认 err-first 兜底（catch → branch=""），
+//       // 形态同 worktree-manager.test.ts 的 setupExecFile
+//       execFile: vi.fn(
+//         (
+//           _cmd: string,
+//           _args: readonly string[],
+//           _opts: unknown,
+//           cb: (err: Error | null, stdout?: string, stderr?: string) => void,
+//         ) => cb(new Error("execFile not configured in this test")),
+//       ),
 //     };
 //   });
 //   vi.mock("node:fs", async () => {
@@ -54,6 +63,15 @@ import { PassThrough } from "node:stream";
 import { createRecord } from "../../execution-record.ts";
 import type { RunOptions, SessionRunnerContext } from "../../session-runner.ts";
 
+/** FakeChild 的假 pid（满足 ChildProcess.pid 形状，无真实进程语义）。 */
+const FAKE_PID = 12345;
+
+/** waitForSpawn 默认超时（ms），超时说明 spawn 未被调（runSpawn 前置 await 卡死）。 */
+const WAIT_SPAWN_TIMEOUT_MS = 1000;
+
+/** waitForSpawn 轮询间隔（ms），微任务级等待的粒度。 */
+const SPAWN_POLL_INTERVAL_MS = 5;
+
 /**
  * FakeChild：模拟 ChildProcess（EventEmitter + PassThrough streams）。
  *
@@ -65,7 +83,7 @@ import type { RunOptions, SessionRunnerContext } from "../../session-runner.ts";
  *   2. C13 e2e 测试可直接 `new FakeChild()` 手动构造 child 喂给 ui-request-queue（不经 spawn）。
  */
 export class FakeChild extends EventEmitter {
-  pid = 12345;
+  pid = FAKE_PID;
   stdout = new PassThrough();
   stderr = new PassThrough();
   stdin = new PassThrough();
@@ -111,21 +129,30 @@ export function lastSpawnedChild<
 /**
  * 等待 runSpawn 内部调到 spawn（拿到 child 控制器）。
  *
- * runSpawn 是 async，spawn 在 mkdirSync + writePromptToTempFile 之后才调（均有微任务/
- * I/O 延迟）。用 setTimeout 轮询 mockSpawn.mock.results，比 vi.waitFor 在该 vitest 版本
- * 下更可靠（vi.waitFor 偶发过早 resolve 导致后续读取竞态）。
+ * runSpawn 是 async，spawn 在 buildEnvBlock + writePromptToTempFile 两个 await 之后才调
+ *（均为微任务级延迟）。用 setTimeout 轮询 mockSpawn.mock.results，比 vi.waitFor 在该
+ * vitest 版本下更可靠（vi.waitFor 偶发过早 resolve 导致后续读取竞态）。
+ *
+ * [快照语义] 等待的是「调用时刻之后**新发生**的一次 spawn」，而非「任意历史 spawn」。
+ * 旧实现只在 results 为空时等待（即只在文件/测试内首次 spawn 有效）：同一文件第二次
+ * runSpawn 时立即返回，而新 runSpawn 尚未跨过 await 到达 spawn → lastSpawnedChild 取回
+ * **上一次**的 child，stdout/close 事件发给已死的旧 child，当前 runSpawn 永远收不到
+ * close → 测试超时。buildEnvBlock 异步化（多一个 await 微任务）后该隐式时序假设失效，
+ * 故改为快照 baseline：等待 results.length 超过调用时的快照值，天然对「每测试/每文件
+ * N 次 spawn」都正确（调用前先记 baseline，本次 runSpawn 的 spawn 必然使 length 增长）。
  *
  * @param mockSpawn 调用方用 `vi.mocked(spawn)` 取回的 mock 引用
  */
 export async function waitForSpawn<
   T extends { mock: { results: unknown[] } },
->(mockSpawn: T, timeoutMs = 1000): Promise<void> {
+>(mockSpawn: T, timeoutMs: number = WAIT_SPAWN_TIMEOUT_MS): Promise<void> {
   const start = Date.now();
-  while (mockSpawn.mock.results.length === 0) {
+  const baseline = mockSpawn.mock.results.length;
+  while (mockSpawn.mock.results.length <= baseline) {
     if (Date.now() - start > timeoutMs) {
       throw new Error(`spawn was not called within ${timeoutMs}ms`);
     }
-    await new Promise((r) => setTimeout(r, 5));
+    await new Promise((r) => setTimeout(r, SPAWN_POLL_INTERVAL_MS));
   }
 }
 
@@ -159,8 +186,8 @@ export function mockSessionFileExists(
 // ── record / opts / ctx 构造（3 文件一致的最小合法形状）──
 
 /** 构造最小合法的 ExecutionRecord（runSpawn 入参）。 */
-export function makeRecord() {
-  return createRecord("run-1", {
+export function makeRecord(id = "run-1") {
+  return createRecord(id, {
     agent: "general-purpose",
     model: "test-model",
     mode: "sync",