@cueloop/schema 0.1.0-alpha.63 → 0.1.0-alpha.65

package/src/history.ts

@@ -0,0 +1,419 @@
+/**
+ * A review session's history as an append-only tree of entries. Each entry
+ * points at its parent; a branch is a named tip; the active path is the chain
+ * from the current branch's tip back to the root. Nothing is ever deleted:
+ * navigating moves a tip, a comment removal is its own entry, a fork copies a
+ * path into a new history. Every view of the session - the artifact text,
+ * the open comments, the verdict history - derives from the active path.
+ *
+ * Pure: no store, no daemon. The daemon owns persistence; the client and the
+ * feedback document read what this module derives.
+ */
+
+import type { Annotation, ReviewSession, Verdict } from "./types";
+
+export type EntryAuthor = "agent" | "reviewer";
+
+interface EntryBase {
+  id: string;
+  /** null on the root entry. */
+  parentId: string | null;
+  createdAt: string;
+}
+
+export type SessionEntry =
+  | (EntryBase & { type: "revision"; by: EntryAuthor; content: string })
+  | (EntryBase & { type: "comment"; annotationId: string })
+  | (EntryBase & { type: "comment-removed"; annotationId: string })
+  | (EntryBase & { type: "verdict"; verdict: Verdict })
+  | (EntryBase & { type: "branch-summary"; text: string; abandoned: string[] });
+
+export type EntryType = SessionEntry["type"];
+
+/** Omit that keeps a discriminated union's members apart. */
+type DistributiveOmit<T, K extends keyof T> = T extends unknown ? Omit<T, K> : never;
+
+/** An entry as a caller describes it: the tree pointers are the history's business. */
+export type NewEntry = DistributiveOmit<SessionEntry, "id" | "parentId"> & { id?: string };
+
+export interface AppendResult {
+  history: SessionHistory;
+  entry: SessionEntry;
+}
+
+/** The agent's line; every other branch is the reviewer's. */
+export const MAIN_BRANCH = "main";
+
+export interface SessionHistory {
+  entries: SessionEntry[];
+  /** Named tips; `main` always exists. */
+  tips: Record<string, string>;
+  /** The branch whose path the session shows. */
+  branch: string;
+  /** Checkpoints: an entry id to the name a reviewer gave it. */
+  labels: Record<string, string>;
+}
+
+let entrySeq = 0;
+
+export function newEntryId(): string {
+  return `e_${Date.now().toString(36)}${(entrySeq++).toString(36)}_${Math.random().toString(36).slice(2, 6)}`;
+}
+
+export class HistoryError extends Error {
+  constructor(
+    readonly code:
+      | "unknown-entry"
+      | "unknown-branch"
+      | "branch-exists"
+      | "off-path"
+      | "already-there"
+      | "not-a-revision"
+      | "cycle",
+    message: string,
+  ) {
+    super(message);
+  }
+}
+
+/* ------------------------------------------------------------------ reads */
+
+export function entryOf(history: SessionHistory, id: string): SessionEntry | undefined {
+  return history.entries.find((entry) => entry.id === id);
+}
+
+export function tipOf(history: SessionHistory, branch: string = history.branch): string {
+  const tip = history.tips[branch];
+
+  if (tip === undefined) throw new HistoryError("unknown-branch", `no branch "${branch}"`);
+
+  return tip;
+}
+
+/** The entries from `fromId` (default: the current tip) back to the root, root first. */
+export function pathOf(history: SessionHistory, fromId: string = tipOf(history)): SessionEntry[] {
+  const byId = new Map(history.entries.map((entry) => [entry.id, entry]));
+  const path: SessionEntry[] = [];
+  const seen = new Set<string>();
+
+  for (
+    let entry = byId.get(fromId);
+    entry;
+    entry = entry.parentId ? byId.get(entry.parentId) : undefined
+  ) {
+    if (seen.has(entry.id))
+      throw new HistoryError("cycle", `entry "${entry.id}" is its own ancestor`);
+    seen.add(entry.id);
+    path.unshift(entry);
+  }
+
+  return path;
+}
+
+/**
+ * The graph invariants every history must hold, as one message or null: ids
+ * are unique, every parent exists, no entry is its own ancestor, every tip
+ * names an entry, `main` and the current branch exist, and every tip's path
+ * reaches a revision. Run at every boundary a history crosses.
+ */
+export function validateHistory(history: SessionHistory): string | null {
+  const ids = new Set<string>();
+
+  for (const entry of history.entries) {
+    if (ids.has(entry.id)) return `duplicate entry id "${entry.id}"`;
+    ids.add(entry.id);
+  }
+  for (const entry of history.entries) {
+    if (entry.parentId !== null && !ids.has(entry.parentId)) {
+      return `entry "${entry.id}" points at missing parent "${entry.parentId}"`;
+    }
+  }
+  if (history.tips[MAIN_BRANCH] === undefined) return `no "${MAIN_BRANCH}" branch`;
+  if (history.tips[history.branch] === undefined)
+    return `current branch "${history.branch}" has no tip`;
+  for (const [branch, tip] of Object.entries(history.tips)) {
+    if (!ids.has(tip)) return `branch "${branch}" points at missing entry "${tip}"`;
+    try {
+      if (!pathOf(history, tip).some((entry) => entry.type === "revision")) {
+        return `branch "${branch}" has no revision on its path`;
+      }
+    } catch (error) {
+      return error instanceof HistoryError ? error.message : String(error);
+    }
+  }
+  for (const entry of history.entries) {
+    // a cycle off every path still hangs a walk that starts inside it
+    try {
+      pathOf(history, entry.id);
+    } catch (error) {
+      return error instanceof HistoryError ? error.message : String(error);
+    }
+  }
+
+  return null;
+}
+
+export interface DerivedPath {
+  /** The last revision on the path: what the artifact shows. */
+  head: SessionEntry & { type: "revision" };
+  /**
+   * Comments added on the path and not removed after, in order. Whether one
+   * is addressed by a revision is the annotation's own state, not the path's.
+   */
+  annotationIds: string[];
+  /** Verdicts on the path, oldest first. */
+  verdicts: Verdict[];
+  summaries: Array<SessionEntry & { type: "branch-summary" }>;
+  /** Agent revisions on the path: one per round. */
+  rounds: number;
+}
+
+/** Everything a viewer sees on the current path, folded from its entries. */
+export function derivePath(history: SessionHistory, fromId?: string): DerivedPath {
+  const path = pathOf(history, fromId);
+  const revisions = path.filter((entry) => entry.type === "revision");
+  const head = revisions.at(-1);
+
+  if (!head) throw new HistoryError("not-a-revision", "a path without a revision has no head");
+  const open = new Set<string>();
+  const verdicts: Verdict[] = [];
+  const summaries: Array<SessionEntry & { type: "branch-summary" }> = [];
+
+  for (const entry of path) {
+    if (entry.type === "comment") open.add(entry.annotationId);
+    if (entry.type === "comment-removed") open.delete(entry.annotationId);
+    if (entry.type === "verdict") verdicts.push(entry.verdict);
+    if (entry.type === "branch-summary") summaries.push(entry);
+  }
+
+  return {
+    head,
+    annotationIds: [...open],
+    verdicts,
+    summaries,
+    rounds: revisions.filter((entry) => entry.by === "agent").length,
+  };
+}
+
+/* ----------------------------------------------------------------- writes */
+
+/** Append an entry after the current branch's tip and move the tip onto it. */
+export function appendEntry(history: SessionHistory, entry: NewEntry): AppendResult {
+  const parentId = tipOf(history);
+  // SAFETY: the spread keeps `type` and its fields intact; only the tree
+  // pointers are added, which the union's every member carries
+  const full = { ...entry, id: entry.id ?? newEntryId(), parentId } as SessionEntry;
+
+  return {
+    history: {
+      ...history,
+      entries: [...history.entries, full],
+      tips: { ...history.tips, [history.branch]: full.id },
+    },
+    entry: full,
+  };
+}
+
+/**
+ * Replace the text of the agent's current revision on `main` in place. A
+ * re-capture of a working tree is the revision the agent is still working on,
+ * not a new one, so nothing is appended.
+ */
+export function recaptureMainHead(history: SessionHistory, content: string): SessionHistory {
+  const head = pathOf(history, tipOf(history, MAIN_BRANCH))
+    .filter((entry) => entry.type === "revision" && entry.by === "agent")
+    .at(-1);
+
+  if (!head) throw new HistoryError("not-a-revision", `"${MAIN_BRANCH}" has no agent revision`);
+
+  return {
+    ...history,
+    entries: history.entries.map((entry) => (entry.id === head.id ? { ...entry, content } : entry)),
+  };
+}
+
+/** Name the current tip as a checkpoint. */
+export function labelTip(history: SessionHistory, label: string): SessionHistory {
+  return { ...history, labels: { ...history.labels, [tipOf(history)]: label } };
+}
+
+/** Start a branch at the current tip and switch to it; `main` is untouched. */
+export function createBranch(history: SessionHistory, name: string): SessionHistory {
+  if (history.tips[name] !== undefined) {
+    throw new HistoryError("branch-exists", `branch "${name}" exists`);
+  }
+
+  return { ...history, tips: { ...history.tips, [name]: tipOf(history) }, branch: name };
+}
+
+export function switchBranch(history: SessionHistory, name: string): SessionHistory {
+  tipOf(history, name);
+
+  return { ...history, branch: name };
+}
+
+export interface NavigateOptions {
+  /** Record the abandoned segment as a branch summary parented at the target. */
+  summary?: string;
+  createdAt?: string;
+}
+
+/**
+ * Move the current branch's tip to an earlier entry on its path. The entries
+ * after it stay in the tree; with a summary, a branch-summary entry that
+ * names them is appended at the target and becomes the tip.
+ */
+export function navigateTo(
+  history: SessionHistory,
+  targetId: string,
+  options: NavigateOptions = {},
+): SessionHistory {
+  if (!entryOf(history, targetId)) {
+    throw new HistoryError("unknown-entry", `no entry "${targetId}"`);
+  }
+  const tip = tipOf(history);
+
+  if (targetId === tip) throw new HistoryError("already-there", "already at that entry");
+  const path = pathOf(history);
+  const index = path.findIndex((entry) => entry.id === targetId);
+
+  if (index === -1) {
+    throw new HistoryError(
+      "off-path",
+      `"${targetId}" is not on branch "${history.branch}" - switch branch first`,
+    );
+  }
+  const abandoned = path.slice(index + 1).map((entry) => entry.id);
+  const moved: SessionHistory = {
+    ...history,
+    tips: { ...history.tips, [history.branch]: targetId },
+  };
+
+  if (options.summary === undefined) return moved;
+
+  return appendEntry(moved, {
+    type: "branch-summary",
+    text: options.summary,
+    abandoned,
+    createdAt: options.createdAt ?? new Date().toISOString(),
+  }).history;
+}
+
+/**
+ * A fork's history: the current path copied as one branch, keeping comments
+ * and labels on it, dropping verdicts and the reviewer's edits, with the tip
+ * at the copied head. The kept entries are chained anew so no entry points at
+ * one that was dropped.
+ */
+export function forkHistory(history: SessionHistory): SessionHistory {
+  const kept: SessionEntry[] = [];
+  const labels: Record<string, string> = {};
+
+  for (const entry of pathOf(history)) {
+    if (entry.type === "verdict" || (entry.type === "revision" && entry.by === "reviewer"))
+      continue;
+    kept.push({ ...entry, parentId: kept.at(-1)?.id ?? null });
+    const label = history.labels[entry.id];
+
+    if (label !== undefined) labels[entry.id] = label;
+  }
+  const tip = kept.at(-1);
+
+  if (!tip) throw new HistoryError("not-a-revision", "nothing to fork");
+
+  return { entries: kept, tips: { [MAIN_BRANCH]: tip.id }, branch: MAIN_BRANCH, labels };
+}
+
+/**
+ * The history as a share carries it: one branch's path and nothing else, so a
+ * collaborator sees that branch wherever the owner stands. Labels on the path
+ * travel; other branches and their entries do not.
+ */
+export function followBranch(history: SessionHistory, branch: string): SessionHistory {
+  const entries = pathOf(history, tipOf(history, branch));
+  const labels: Record<string, string> = {};
+
+  for (const entry of entries) {
+    const label = history.labels[entry.id];
+
+    if (label !== undefined) labels[entry.id] = label;
+  }
+
+  return { entries, tips: { [branch]: entries.at(-1)!.id }, branch, labels };
+}
+
+/** The comment removals a history records, in entry order: what a merge carries across a share. */
+export function removalEntries(
+  history: SessionHistory,
+): Array<SessionEntry & { type: "comment-removed" }> {
+  return history.entries.filter(
+    (entry): entry is SessionEntry & { type: "comment-removed" } =>
+      entry.type === "comment-removed",
+  );
+}
+
+/* -------------------------------------------------------------- migration */
+
+/**
+ * A linear session as a one-branch tree: its revisions chained on `main` as
+ * agent revisions, its comments attached after the revision that was current
+ * when they were made, its verdict (when resolved) after the last revision.
+ * Deterministic: the same record migrates to the same ids.
+ */
+export function historyFromLinear(
+  session: Pick<ReviewSession, "id" | "revisions" | "annotations" | "verdict" | "createdAt">,
+): SessionHistory {
+  const entries: SessionEntry[] = [];
+  let parentId: string | null = null;
+  const push = (entry: DistributiveOmit<SessionEntry, "parentId">): void => {
+    // SAFETY: only the parent pointer is added; the union member is untouched
+    const full = { ...entry, parentId } as SessionEntry;
+
+    entries.push(full);
+    parentId = full.id;
+  };
+  const revisions = [...session.revisions].sort((left, right) => left.revision - right.revision);
+  const comments = [...session.annotations].sort((left, right) =>
+    left.createdAt.localeCompare(right.createdAt),
+  );
+  let nextComment = 0;
+
+  revisions.forEach((revision, index) => {
+    push({
+      id: `${session.id}_rev${revision.revision}`,
+      type: "revision",
+      by: "agent",
+      content: revision.content,
+      createdAt: revision.submittedAt,
+    });
+    const until = revisions[index + 1]?.submittedAt;
+
+    while (
+      nextComment < comments.length &&
+      (until === undefined || comments[nextComment]!.createdAt < until)
+    ) {
+      const annotation: Annotation = comments[nextComment]!;
+
+      push({
+        id: `${session.id}_com_${annotation.id}`,
+        type: "comment",
+        annotationId: annotation.id,
+        createdAt: annotation.createdAt,
+      });
+      nextComment++;
+    }
+  });
+  if (session.verdict) {
+    push({
+      id: `${session.id}_verdict`,
+      type: "verdict",
+      verdict: session.verdict,
+      createdAt: session.verdict.resolvedAt,
+    });
+  }
+  const tip = entries.at(-1);
+
+  if (!tip) throw new HistoryError("not-a-revision", `session ${session.id} has no revision`);
+
+  return { entries, tips: { [MAIN_BRANCH]: tip.id }, branch: MAIN_BRANCH, labels: {} };
+}

package/src/index.ts

@@ -8,3 +8,5 @@ export * from "./anchor";
 export * from "./fuzzy";
 export * from "./feedback";
 export * from "./herdr";
+export * from "./history";
+export * from "./path-view";

package/src/path-view.test.ts

@@ -0,0 +1,201 @@
+import { describe, expect, test } from "bun:test";
+import {
+  appendEntry,
+  createBranch,
+  historyFromLinear,
+  navigateTo,
+  switchBranch,
+  type SessionHistory,
+} from "./history";
+import { applyPathView, viewFollowing, viewOfPath } from "./path-view";
+import type { Annotation, ReviewSession } from "./types";
+
+const AT = "2026-09-01T10:00:00.000Z";
+
+function annotation(id: string): Annotation {
+  return {
+    id,
+    kind: "comment",
+    anchor: { quote: "q", prefix: "", suffix: "" },
+    body: id,
+    createdAt: AT,
+  };
+}
+
+/** rev1 (agent) -> comment a1 -> reviewer edit -> comment a2, all on main. */
+function threaded(): SessionHistory {
+  let history = historyFromLinear({
+    id: "ses_1",
+    revisions: [{ revision: 1, content: "Plan v1", submittedAt: AT }],
+    annotations: [],
+    verdict: null,
+    createdAt: AT,
+  });
+
+  history = appendEntry(history, { type: "comment", annotationId: "a1", createdAt: AT }).history;
+  history = appendEntry(history, {
+    type: "revision",
+    by: "reviewer",
+    content: "Plan v1 edited",
+    createdAt: AT,
+  }).history;
+  history = appendEntry(history, { type: "comment", annotationId: "a2", createdAt: AT }).history;
+
+  return history;
+}
+
+describe("viewOfPath", () => {
+  test("the artifact is the agent's last revision and the reviewer's head is the working copy", () => {
+    // Act
+    const view = viewOfPath(threaded(), [annotation("a1"), annotation("a2")]);
+
+    // Assert
+    expect(view.content).toBe("Plan v1");
+    expect(view.workingCopy).toBe("Plan v1 edited");
+    expect(view.annotations.map((entry) => entry.id)).toEqual(["a1", "a2"]);
+    expect(view.shelvedAnnotations).toEqual([]);
+  });
+
+  test("navigating back shelves the comments the path no longer reaches, and forward again unshelves them", () => {
+    // Arrange: a branch that stays at the full path, main moved back to the first comment
+    let history = createBranch(threaded(), "full");
+    const known = [annotation("a1"), annotation("a2")];
+
+    history = switchBranch(history, "main");
+    history = navigateTo(history, history.entries[1]!.id);
+
+    // Act
+    const back = viewOfPath(history, known);
+    const forward = viewOfPath(
+      switchBranch(history, "full"),
+      back.annotations.concat(back.shelvedAnnotations),
+    );
+
+    // Assert
+    expect(back.workingCopy).toBeUndefined();
+    expect(back.annotations.map((entry) => entry.id)).toEqual(["a1"]);
+    expect(back.shelvedAnnotations.map((entry) => entry.id)).toEqual(["a2"]);
+    expect(forward.annotations.map((entry) => entry.id)).toEqual(["a1", "a2"]);
+    expect(forward.shelvedAnnotations).toEqual([]);
+  });
+
+  test("a removed comment stays shelved, not deleted", () => {
+    // Arrange
+    let history = threaded();
+
+    history = appendEntry(history, {
+      type: "comment-removed",
+      annotationId: "a1",
+      createdAt: AT,
+    }).history;
+
+    // Act
+    const view = viewOfPath(history, [annotation("a1"), annotation("a2")]);
+
+    // Assert
+    expect(view.annotations.map((entry) => entry.id)).toEqual(["a2"]);
+    expect(view.shelvedAnnotations.map((entry) => entry.id)).toEqual(["a1"]);
+  });
+});
+
+describe("applyPathView", () => {
+  test("writes the view into the record and removes the fields the view leaves empty", () => {
+    // Arrange
+    const session: ReviewSession = {
+      schemaVersion: "1",
+      id: "ses_1",
+      workspace: { repoRoot: "/repo", branch: "main" },
+      artifact: { type: "plan", content: "old", meta: {} },
+      revisions: [],
+      annotations: [annotation("a2")],
+      shelvedAnnotations: [annotation("a1")],
+      workingCopy: "edited",
+      verdict: null,
+      status: "pending",
+      createdAt: AT,
+    };
+
+    // Act
+    applyPathView(session, {
+      content: "Plan v1",
+      workingCopy: undefined,
+      annotations: [annotation("a1"), annotation("a2")],
+      shelvedAnnotations: [],
+    });
+
+    // Assert
+    expect(session.artifact.content).toBe("Plan v1");
+    expect(session.annotations.map((entry) => entry.id)).toEqual(["a1", "a2"]);
+    expect("workingCopy" in session).toBe(false);
+    expect("shelvedAnnotations" in session).toBe(false);
+  });
+});
+
+describe("viewFollowing", () => {
+  test("a share carries one branch's path: its entries, tip, labels, and open comments, nothing shelved", () => {
+    // Arrange: main has a1 and an edit; a branch off a1 has its own comment; the owner stands on the branch
+    let history = threaded();
+
+    history = navigateTo(history, history.entries[1]!.id);
+    history = createBranch(history, "alt");
+    history = appendEntry(history, { type: "comment", annotationId: "b1", createdAt: AT }).history;
+    const session: ReviewSession = {
+      schemaVersion: "1",
+      id: "ses_1",
+      workspace: { repoRoot: "/repo", branch: "main" },
+      artifact: { type: "plan", content: "Plan v1", meta: {} },
+      revisions: [],
+      annotations: [annotation("a1"), annotation("b1")],
+      shelvedAnnotations: [annotation("a2")],
+      workingCopy: "Plan v1 edited",
+      history,
+      verdict: null,
+      status: "pending",
+      createdAt: AT,
+    };
+
+    // Act
+    const shared = viewFollowing(session);
+
+    // Assert: main's path only, back at the first comment, no working copy, no shelf, the branch named
+    expect(shared.shareBranch).toBe("main");
+    expect(shared.history!.tips).toEqual({ main: history.entries[1]!.id });
+    expect(shared.history!.entries.map((entry) => entry.type)).toEqual(["revision", "comment"]);
+    expect(shared.annotations.map((entry) => entry.id)).toEqual(["a1"]);
+    expect("shelvedAnnotations" in shared).toBe(false);
+    expect("workingCopy" in shared).toBe(false);
+    // the owner's record is untouched
+    expect(session.annotations.map((entry) => entry.id)).toEqual(["a1", "b1"]);
+  });
+
+  test("a followed branch that no longer exists falls back to main", () => {
+    // Arrange: a plain main-only history, asked to follow a branch that is not there
+    const history = historyFromLinear({
+      id: "ses_1",
+      revisions: [{ revision: 1, content: "Plan v1", submittedAt: AT }],
+      annotations: [],
+      verdict: null,
+      createdAt: AT,
+    });
+    const session: ReviewSession = {
+      schemaVersion: "1",
+      id: "ses_1",
+      workspace: { repoRoot: "/repo", branch: "main" },
+      artifact: { type: "plan", content: "Plan v1", meta: {} },
+      revisions: [],
+      annotations: [],
+      shareBranch: "gone",
+      history,
+      verdict: null,
+      status: "pending",
+      createdAt: AT,
+    };
+
+    // Act
+    const shared = viewFollowing(session);
+
+    // Assert: it does not throw, and falls back to main
+    expect(shared.shareBranch).toBe("main");
+    expect(shared.history!.branch).toBe("main");
+  });
+});