@cueloop/daemon 0.1.0-alpha.6 → 0.1.0-alpha.61

package/src/review.test.ts

@@ -0,0 +1,370 @@
+/** The shared review core against a real DaemonServer in a temp home: workspace resolution, title derivation, open-or-revise by agentSessionId, and both awaitVerdict shapes (one long-poll and the chunked loop with progress and abort). */
+
+import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { mkdtempSync, rmSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import type { ReviewSession } from "@cueloop/schema";
+import { DaemonServer } from "./server";
+import { DaemonClient } from "./client";
+import { awaitResolve, openReview, resolveWorkspace } from "./review";
+
+const PLAN = "# Rollout Plan\n\nShip it in two stages.\n";
+
+let home: string;
+let server: DaemonServer;
+let client: DaemonClient;
+
+beforeEach(async () => {
+  home = mkdtempSync(join(tmpdir(), "cueloop-review-core-"));
+  server = new DaemonServer({ home, idleExitMs: 0 });
+  server.start();
+  client = await DaemonClient.connect({ home });
+});
+afterEach(() => {
+  client.close();
+  server.stop();
+  rmSync(home, { recursive: true, force: true });
+});
+
+function sh(args: string[], cwd: string): void {
+  const gitResult = Bun.spawnSync(args, { cwd, stdout: "ignore", stderr: "ignore" });
+
+  if (gitResult.exitCode !== 0) throw new Error(`${args.join(" ")} failed`);
+}
+
+describe("resolveWorkspace", () => {
+  test("a git repo resolves to its root and branch", async () => {
+    const repo = mkdtempSync(join(tmpdir(), "cueloop-ws-"));
+
+    try {
+      // Arrange
+      sh(["git", "init", "-q", "-b", "main"], repo);
+      sh(["git", "config", "user.email", "t@t"], repo);
+      sh(["git", "config", "user.name", "t"], repo);
+      sh(["git", "commit", "-q", "--allow-empty", "-m", "init"], repo);
+
+      // Act
+      const ws = await resolveWorkspace(repo);
+
+      // Assert
+      expect(ws.branch).toBe("main");
+      // macOS tmpdirs can resolve through /private; compare the tail
+      expect(ws.repoRoot.endsWith(repo.split("/").at(-1)!)).toBe(true);
+    } finally {
+      rmSync(repo, { recursive: true, force: true });
+    }
+  });
+
+  test("outside a repo the cwd itself is the workspace, branch detached", async () => {
+    // Act
+    const ws = await resolveWorkspace(home);
+
+    // Assert
+    expect(ws).toEqual({ repoRoot: home, branch: "detached" });
+  });
+});
+
+describe("openReview", () => {
+  test("shapes the artifact: agent, derived title, cwd", async () => {
+    // Act
+    const review = await openReview(client, {
+      type: "plan",
+      content: PLAN,
+      cwd: home,
+      agent: "test-agent",
+    });
+
+    // Assert
+    const session = review.session;
+
+    expect(session.status).toBe("pending");
+    expect(session.artifact.type).toBe("plan");
+    expect(session.artifact.meta.agent).toBe("test-agent");
+    expect(session.artifact.meta.title).toBe("Rollout Plan");
+    expect(session.artifact.meta.cwd).toBe(home);
+    expect(session.workspace).toEqual({ repoRoot: home, branch: "detached" });
+  });
+
+  test("an explicit title wins; diffs never derive one from content", async () => {
+    // Act
+    const titled = await openReview(client, {
+      type: "plan",
+      content: PLAN,
+      cwd: home,
+      title: "Custom",
+    });
+
+    // Assert
+    expect(titled.session.artifact.meta.title).toBe("Custom");
+
+    // Act
+    const diff = await openReview(client, {
+      type: "diff",
+      content: "# not a heading\n",
+      cwd: home,
+    });
+
+    // Assert
+    expect(diff.session.artifact.meta.title).toBeUndefined();
+  });
+
+  test("a pre-resolved workspace skips git resolution", async () => {
+    // Arrange
+    const ws = { repoRoot: "/elsewhere", branch: "feature" };
+
+    // Act
+    const review = await openReview(client, {
+      type: "diff",
+      content: "d",
+      cwd: home,
+      workspace: ws,
+    });
+
+    // Assert
+    expect(review.session.workspace).toEqual(ws);
+  });
+
+  test("the same agentSessionId revises instead of opening a new session", async () => {
+    // Arrange
+    const first = await openReview(client, {
+      type: "plan",
+      content: PLAN,
+      cwd: home,
+      agentSessionId: "agent-1",
+    });
+
+    // Act
+    const second = await openReview(client, {
+      type: "plan",
+      content: PLAN + "\nStage three.\n",
+      cwd: home,
+      agentSessionId: "agent-1",
+    });
+
+    // Assert
+    expect(second.id).toBe(first.id);
+    expect(second.session.revisions.length).toBe(2);
+    expect(second.session.status).toBe("pending");
+
+    // Act
+    const other = await openReview(client, {
+      type: "plan",
+      content: PLAN,
+      cwd: home,
+      agentSessionId: "agent-2",
+    });
+
+    // Assert
+    expect(other.id).not.toBe(first.id);
+  });
+
+  test("per-file notes land as note annotations anchored at the file path", async () => {
+    // Act
+    const review = await openReview(client, {
+      type: "diff",
+      content: "d",
+      cwd: home,
+      notes: [
+        { path: "src/a.ts", body: "Renames b and adds c." },
+        { path: "src/b.ts", body: "Swaps the line." },
+      ],
+    });
+
+    // Assert
+    const notes = review.session.annotations;
+
+    expect(notes.length).toBe(2);
+    expect(notes.every((annotation) => annotation.kind === "note")).toBe(true);
+    expect(notes.map((annotation) => annotation.anchor.quote)).toEqual(["src/a.ts", "src/b.ts"]);
+    expect(notes[0]!.body).toBe("Renames b and adds c.");
+  });
+});
+
+describe("awaitVerdict: one long-poll (the hook shape)", () => {
+  test("times out to pending; a later wait collects the stored verdict", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+
+    // Assert
+    expect(await review.awaitVerdict({ timeoutMs: 50 })).toBe("pending");
+
+    // Act
+    await client.sessionResolve(review.id, "approve", "Fine.");
+    const verdict = await review.awaitVerdict({ timeoutMs: 1_000 });
+
+    // Assert
+    expect(verdict).not.toBe("pending");
+    if (verdict === "pending") throw new Error("unreachable");
+    expect(verdict.allow).toBe(true);
+    expect(verdict.feedback).toContain("Fine.");
+    expect(verdict.session.verdict!.kind).toBe("approve");
+  });
+
+  test("request_changes maps to allow=false with feedback.md attached", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+    const waiting = review.awaitVerdict({ timeoutMs: 5_000 });
+
+    // Act
+    await client.sessionResolve(review.id, "request_changes", "One stage only.");
+    const verdict = await waiting;
+
+    // Assert
+    if (verdict === "pending") throw new Error("expected a verdict");
+    expect(verdict.allow).toBe(false);
+    expect(verdict.feedback).toContain("# Review: request changes");
+    expect(verdict.feedback).toContain("One stage only.");
+  });
+});
+
+describe("awaitVerdict: chunked loop (the pi shape)", () => {
+  test("onProgress sees fresh sessions between chunks; the verdict ends the loop", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+    const seen: ReviewSession[] = [];
+    const waiting = review.awaitVerdict({
+      timeoutMs: Infinity,
+      pollMs: 100,
+      onProgress: (progress) => seen.push(progress),
+    });
+
+    // Act
+    await client.sessionAnnotate(review.id, {
+      id: "a1",
+      kind: "comment",
+      anchor: { quote: "two stages", prefix: "in ", suffix: "." },
+      body: "Name them.",
+    });
+
+    // Assert
+    // give the loop a chunk to observe the annotation before resolving
+    for (let i = 0; i < 100 && !seen.some((snapshot) => snapshot.annotations.length === 1); i++)
+      await Bun.sleep(20);
+    expect(seen.some((snapshot) => snapshot.annotations.length === 1)).toBe(true);
+
+    // Act
+    await client.sessionResolve(review.id, "request_changes", "Too vague.");
+    const verdict = await waiting;
+
+    // Assert
+    if (verdict === "pending") throw new Error("expected a verdict");
+    expect(verdict.allow).toBe(false);
+    expect(verdict.session.annotations.length).toBe(1);
+  }, 15_000);
+
+  test("abort surfaces as pending and leaves the session collectable", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+    const controller = new AbortController();
+    const waiting = review.awaitVerdict({
+      timeoutMs: Infinity,
+      pollMs: 100,
+      signal: controller.signal,
+    });
+
+    // Act
+    controller.abort();
+
+    // Assert
+    expect(await waiting).toBe("pending");
+    expect((await client.sessionGet(review.id)).status).toBe("pending");
+  });
+
+  test("a finite budget runs out to pending", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+
+    // Assert
+    expect(await review.awaitVerdict({ timeoutMs: 120, pollMs: 50 })).toBe("pending");
+  });
+});
+
+describe("awaitResolve: the adapter wake seam (session id only)", () => {
+  test("resolves to the outcome when the verdict lands during the wait", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+    const waiting = awaitResolve(client, review.id, { pollMs: 100 });
+
+    // Act
+    await client.sessionResolve(review.id, "approve", "Ship it.");
+    const verdict = await waiting;
+
+    // Assert
+    expect(verdict).not.toBeNull();
+    expect(verdict!.allow).toBe(true);
+    expect(verdict!.feedback).toContain("Ship it.");
+    expect(verdict!.session.verdict!.kind).toBe("approve");
+  });
+
+  test("returns the stored verdict immediately when the session already resolved", async () => {
+    // Arrange - a detached waiter that only attaches after the human decided
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+
+    await client.sessionResolve(review.id, "request_changes", "One stage only.");
+
+    // Act
+    const verdict = await awaitResolve(client, review.id);
+
+    // Assert
+    expect(verdict).not.toBeNull();
+    expect(verdict!.allow).toBe(false);
+    expect(verdict!.feedback).toContain("One stage only.");
+  });
+
+  test("returns null when the signal aborts first", async () => {
+    // Arrange
+    const review = await openReview(client, { type: "plan", content: PLAN, cwd: home });
+    const controller = new AbortController();
+    const waiting = awaitResolve(client, review.id, { pollMs: 100, signal: controller.signal });
+
+    // Act
+    controller.abort();
+
+    // Assert
+    expect(await waiting).toBeNull();
+    expect((await client.sessionGet(review.id)).status).toBe("pending");
+  });
+});
+
+describe("awaitResolve: the held wait keeps the daemon alive", () => {
+  test("a pending session does not idle-exit while a waiter is parked, then the verdict lands", async () => {
+    // Arrange - a daemon with an aggressive idle timer and its own home
+    const idleHome = mkdtempSync(join(tmpdir(), "cueloop-idle-"));
+    let idleExits = 0;
+    const idleServer = new DaemonServer({
+      home: idleHome,
+      idleExitMs: 30,
+      onIdleExit: () => idleExits++,
+    });
+
+    idleServer.start();
+    const waiterClient = await DaemonClient.connect({ home: idleHome });
+
+    try {
+      const review = await openReview(waiterClient, { type: "plan", content: PLAN, cwd: idleHome });
+      const waiting = awaitResolve(waiterClient, review.id, { pollMs: 40 });
+
+      // Act - wait well past the idle window while the review is still pending
+      await Bun.sleep(120);
+
+      // Assert - the parked waiter and the pending session both keep it alive
+      expect(idleExits).toBe(0);
+      expect((await waiterClient.ping()).pid).toBe(process.pid);
+
+      // Act - the human returns a verdict; the parked wait collects it
+      const resolver = await DaemonClient.connect({ home: idleHome });
+
+      await resolver.sessionResolve(review.id, "approve", "Good to go.");
+      resolver.close();
+      const verdict = await waiting;
+
+      // Assert
+      expect(verdict!.allow).toBe(true);
+    } finally {
+      waiterClient.close();
+      idleServer.stop();
+      rmSync(idleHome, { recursive: true, force: true });
+    }
+  }, 15_000);
+});

package/src/review.ts

@@ -0,0 +1,289 @@
+/**
+ * The shared review core: one open/wait/verdict path for every consumer -
+ * CLI commands and agent adapters. openReview resolves the workspace, shapes
+ * the artifact, and opens-or-revises by agentSessionId; awaitVerdict maps the
+ * wait contract onto the agent contract through verdictResponse. An
+ * adapter keeps only two bespoke parts: parsing its host's event shape and
+ * serializing the decision in its host's contract.
+ */
+
+import {
+  isMarkdownArtifact,
+  newAnnotationId,
+  type ArtifactType,
+  type DiffFileContents,
+  type ReviewSession,
+  type WorkspaceKey,
+} from "@cueloop/schema";
+import { verdictResponse } from "./api";
+import type { DaemonClient } from "./client";
+
+// Adapters and CLI verbs reach the verdict mapping through this module too,
+// so a session obtained outside a ReviewHandle maps the same way.
+export { verdictResponse };
+
+async function git(args: string[], cwd: string): Promise<string | null> {
+  try {
+    const proc = Bun.spawn(["git", ...args], { cwd, stdout: "pipe", stderr: "ignore" });
+    const out = await new Response(proc.stdout).text();
+
+    if ((await proc.exited) !== 0) return null;
+
+    return out.trim();
+  } catch {
+    return null;
+  }
+}
+
+/** Workspace key resolution: repo root + branch from the cwd. */
+export async function resolveWorkspace(cwd = process.cwd()): Promise<WorkspaceKey> {
+  const repoRoot = (await git(["rev-parse", "--show-toplevel"], cwd)) ?? cwd;
+  const branch = (await git(["rev-parse", "--abbrev-ref", "HEAD"], cwd)) ?? "detached";
+
+  return { repoRoot, branch };
+}
+
+function firstHeading(markdown: string): string | undefined {
+  const headingMatch = markdown.match(/^#\s+(.+)$/m);
+
+  return headingMatch?.[1]?.trim();
+}
+
+export interface OpenReviewOptions {
+  type: ArtifactType;
+  content: string;
+  /** Workspace resolution root and meta.cwd; defaults to process.cwd(). */
+  cwd?: string;
+  /** Pre-resolved workspace key; skips git resolution when the caller already has it. */
+  workspace?: WorkspaceKey;
+  agent?: string;
+  /** When set, a resubmit from the same agent session becomes a revision, not a new session. */
+  agentSessionId?: string;
+  planPath?: string;
+  prototypePath?: string;
+  pr?: string;
+  herdrPane?: string;
+  /**
+   * Full file contents per changed file for a working-tree diff, carried onto
+   * the artifact so hunk curation produces an exactly applyable patch.
+   */
+  files?: DiffFileContents[];
+  /** Defaults to a markdown artifact's first heading (plan, reply); diffs get no derived title. */
+  title?: string;
+  /**
+   * Per-file agent notes for diff sessions: the submitting agent's own
+   * explanation of each file's change, in dead prose. Stored as annotations
+   * with kind "note" anchored at the file path, so they render as regular
+   * rail cards and feed the guided walk's agent-note block.
+   */
+  notes?: ReviewNote[];
+}
+
+/** The note contract: one note per changed file, anchored by the file path. */
+export interface ReviewNote {
+  path: string;
+  body: string;
+}
+
+/** Anchor a note at its file: quote = the path, no context selectors. */
+async function attachNotes(
+  client: DaemonClient,
+  sessionId: string,
+  notes: ReviewNote[],
+): Promise<void> {
+  for (const note of notes) {
+    await client.sessionAnnotate(sessionId, {
+      id: newAnnotationId(),
+      kind: "note",
+      anchor: { quote: note.path, prefix: "", suffix: "" },
+      body: note.body,
+    });
+  }
+}
+
+export interface AwaitVerdictOptions {
+  /** Total wait budget; Infinity keeps polling until resolved or aborted. */
+  timeoutMs: number;
+  /** Chunk length for the poll loop; between chunks the session is re-read for progress. */
+  pollMs?: number;
+  /** Called with the fresh session after each chunk that is still pending. */
+  onProgress?: (session: ReviewSession) => void;
+  signal?: AbortSignal;
+}
+
+/** A resolved review mapped onto the agent contract, plus the full session. */
+export interface VerdictOutcome {
+  allow: boolean;
+  feedback: string;
+  session: ReviewSession;
+}
+
+/** Sentinel distinguishing an abort from any daemon response. */
+const ABORTED = Symbol("aborted");
+
+function raceAbort<T>(
+  promise: Promise<T>,
+  signal: AbortSignal | undefined,
+): Promise<T | typeof ABORTED> {
+  if (!signal) return promise;
+  if (signal.aborted) {
+    promise.catch(() => {});
+
+    return Promise.resolve(ABORTED);
+  }
+
+  return new Promise<T | typeof ABORTED>((resolve, reject) => {
+    const onAbort = () => {
+      // The daemon request keeps running until the client closes; swallow its
+      // eventual rejection so the abort path never leaks an unhandled error.
+      promise.catch(() => {});
+      resolve(ABORTED);
+    };
+
+    signal.addEventListener("abort", onAbort, { once: true });
+    promise.then(
+      (value) => {
+        signal.removeEventListener("abort", onAbort);
+        resolve(value);
+      },
+      (error) => {
+        signal.removeEventListener("abort", onAbort);
+        reject(error);
+      },
+    );
+  });
+}
+
+export class ReviewHandle {
+  constructor(
+    private readonly client: DaemonClient,
+    readonly session: ReviewSession,
+  ) {}
+
+  get id(): string {
+    return this.session.id;
+  }
+
+  /**
+   * Block on the verdict. "pending" means the budget ran out or the signal
+   * aborted - the session stays open and the verdict is collectable later
+   * (verdicts outlive waits). With only timeoutMs this is one long-poll;
+   * pollMs/onProgress/signal switch to the chunked loop.
+   */
+  async awaitVerdict(options: AwaitVerdictOptions): Promise<VerdictOutcome | "pending"> {
+    const { timeoutMs, pollMs, onProgress, signal } = options;
+
+    if (pollMs === undefined && onProgress === undefined && signal === undefined) {
+      const resolved = await this.client.sessionWait(this.session.id, timeoutMs);
+
+      return resolved === null ? "pending" : outcome(resolved);
+    }
+    const chunkMs = pollMs ?? 10_000;
+    const deadline = Number.isFinite(timeoutMs) ? Date.now() + timeoutMs : undefined;
+
+    for (;;) {
+      const budget = deadline === undefined ? chunkMs : Math.min(chunkMs, deadline - Date.now());
+
+      if (budget <= 0 || signal?.aborted) return "pending";
+      const resolved = await raceAbort(this.client.sessionWait(this.session.id, budget), signal);
+
+      if (resolved === ABORTED) return "pending";
+      if (resolved !== null) return outcome(resolved);
+      // Still pending after this chunk: re-read to surface reviewer progress.
+      const current = await raceAbort(this.client.sessionGet(this.session.id), signal);
+
+      if (current === ABORTED) return "pending";
+      onProgress?.(current);
+    }
+  }
+}
+
+function outcome(session: ReviewSession): VerdictOutcome {
+  return { ...verdictResponse(session), session };
+}
+
+export interface AwaitResolveOptions {
+  /** Long-poll chunk length; the wait re-arms each chunk until resolved or aborted. Default 30s. */
+  pollMs?: number;
+  /** Abort the wait (the harness session shut down); resolves to null. */
+  signal?: AbortSignal;
+}
+
+/**
+ * Park until a review session resolves, then return the verdict outcome; null
+ * when the signal aborts first. Where ReviewHandle.awaitVerdict needs the handle
+ * that opened the review, this needs only a session id - so a background waiter
+ * that woke on a session it did not open (a detached Claude Code / Codex waiter,
+ * or pi's session_start listener) can collect the same verdict. This is the
+ * wake seam every non-blocking adapter builds on. Loops the daemon long-poll, so
+ * a verdict that lands between chunks is never missed and a session already
+ * resolved returns on the first chunk. The held connection also keeps the daemon
+ * off its idle-exit path for the whole wait.
+ */
+export async function awaitResolve(
+  client: DaemonClient,
+  sessionId: string,
+  options: AwaitResolveOptions = {},
+): Promise<VerdictOutcome | null> {
+  const chunkMs = options.pollMs ?? 30_000;
+  const { signal } = options;
+
+  for (;;) {
+    if (signal?.aborted) return null;
+    const resolved = await raceAbort(client.sessionWait(sessionId, chunkMs), signal);
+
+    if (resolved === ABORTED) return null;
+    if (resolved !== null) return outcome(resolved);
+  }
+}
+
+/** Open a review session (or revise the agent session's existing one) and hand back the wait surface. */
+export async function openReview(
+  client: DaemonClient,
+  options: OpenReviewOptions,
+): Promise<ReviewHandle> {
+  const cwd = options.cwd ?? process.cwd();
+  const workspace = options.workspace ?? (await resolveWorkspace(cwd));
+
+  // Resubmits from the same agent session become revisions, not new sessions.
+  if (options.agentSessionId !== undefined) {
+    const existing = (await client.sessionList()).find(
+      (candidate) => candidate.artifact.meta.agentSessionId === options.agentSessionId,
+    );
+
+    if (existing !== undefined) {
+      let revised = await client.sessionSubmitRevision(existing.id, options.content);
+
+      if (options.notes?.length) {
+        await attachNotes(client, revised.id, options.notes);
+        revised = await client.sessionGet(revised.id);
+      }
+
+      return new ReviewHandle(client, revised);
+    }
+  }
+  let session = await client.sessionCreate(workspace, {
+    type: options.type,
+    content: options.content,
+    files: options.files,
+    meta: {
+      agent: options.agent,
+      agentSessionId: options.agentSessionId,
+      planPath: options.planPath,
+      prototypePath: options.prototypePath,
+      pr: options.pr,
+      herdrPane: options.herdrPane,
+      title:
+        options.title ??
+        (isMarkdownArtifact(options.type) ? firstHeading(options.content) : undefined),
+      cwd,
+    },
+  });
+
+  if (options.notes?.length) {
+    await attachNotes(client, session.id, options.notes);
+    session = await client.sessionGet(session.id);
+  }
+
+  return new ReviewHandle(client, session);
+}