@cueloop/daemon 0.1.0-alpha.2 → 0.1.0-alpha.21

package/src/validate.test.ts

@@ -1,7 +1,33 @@
 import { describe, expect, test } from "bun:test";
+import { mkdtempSync, rmSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { DaemonCore } from "./api";
 import { DaemonError } from "./errors";
-import { isKnownMethod, parseParams, validateSessionRecord } from "./validate";
-import { SCHEMA_VERSION } from "@cueloop/schema";
+import {
+  AnchorSchema,
+  AnnotationSchema,
+  ArtifactMetaSchema,
+  ArtifactSchema,
+  RevisionSchema,
+  SessionRecordSchema,
+  VerdictSchema,
+  WorkspaceSchema,
+  isKnownMethod,
+  parseParams,
+  validateSessionRecord,
+} from "./validate";
+import {
+  SCHEMA_VERSION,
+  type Anchor,
+  type Annotation,
+  type Artifact,
+  type ArtifactMeta,
+  type ReviewSession,
+  type Revision,
+  type Verdict,
+  type WorkspaceKey,
+} from "@cueloop/schema";
 
 describe("method allowlist", () => {
   test("known and unknown methods", () => {
@@ -12,11 +38,11 @@ describe("method allowlist", () => {
 
 describe("parseParams", () => {
   test("accepts a well-formed create and defaults meta", () => {
-    const p = parseParams("session.create", {
+    const params = parseParams("session.create", {
       workspace: { repoRoot: "/repo", branch: "main" },
       artifact: { type: "plan", content: "# P" },
     });
-    expect(p.artifact.meta).toEqual({});
+    expect(params.artifact.meta).toEqual({});
   });
 
   test("rejects a missing workspace with a pathed message", () => {
@@ -55,12 +81,22 @@ describe("parseParams", () => {
   });
 
   test("annotation kinds stay open (extension kinds are allowed)", () => {
-    const p = parseParams("session.annotate", {
+    const params = parseParams("session.annotate", {
       id: "s",
       annotation: { id: "a1", kind: "praise", anchor: { quote: "x" }, body: "nice" },
     });
-    expect(p.annotation.kind).toBe("praise");
-    expect(p.annotation.anchor.prefix).toBe("");
+    expect(params.annotation.kind).toBe("praise");
+    expect(params.annotation.anchor.prefix).toBe("");
+  });
+
+  test("setViewed takes a full path list and rejects non-string entries", () => {
+    expect(parseParams("session.setViewed", { id: "s", viewedPaths: ["src/a.ts", "src/b.ts"] }).viewedPaths).toEqual([
+      "src/a.ts",
+      "src/b.ts",
+    ]);
+    expect(parseParams("session.setViewed", { id: "s", viewedPaths: [] }).viewedPaths).toEqual([]);
+    expect(() => parseParams("session.setViewed", { id: "s", viewedPaths: [1] })).toThrow(/viewedPaths/);
+    expect(() => parseParams("session.setViewed", { id: "s" })).toThrow(/viewedPaths/);
   });
 
   test("null params are treated as empty", () => {
@@ -86,13 +122,91 @@ describe("validateSessionRecord", () => {
   });
 
   test("rejects a foreign schema version with a readable reason", () => {
-    const r = validateSessionRecord({ ...record, schemaVersion: "99" });
-    expect(r.ok).toBe(false);
-    if (!r.ok) expect(r.error).toContain("schemaVersion");
+    const result = validateSessionRecord({ ...record, schemaVersion: "99" });
+    expect(result.ok).toBe(false);
+    if (!result.ok) expect(result.error).toContain("schemaVersion");
   });
 
   test("rejects a structurally broken record", () => {
-    const r = validateSessionRecord({ ...record, revisions: "nope" });
-    expect(r.ok).toBe(false);
+    const result = validateSessionRecord({ ...record, revisions: "nope" });
+    expect(result.ok).toBe(false);
+  });
+});
+
+/**
+ * Wire pins: every schema's entries must cover exactly the keys of the
+ * schema type it mirrors. Runtime complement to the compile-time EntriesOf
+ * check - the samples are fully populated and typed, so a new field in
+ * @cueloop/schema shows up here too.
+ */
+describe("wire pins", () => {
+  const keys = (subject: object) => Object.keys(subject).sort();
+  const entryKeys = (schema: { entries: object }) => Object.keys(schema.entries).sort();
+
+  const fullMeta: Required<ArtifactMeta> = {
+    cwd: "/repo",
+    agent: "claude-code",
+    agentSessionId: "sess-1",
+    planPath: "/repo/plan.md",
+    pr: "org/repo#1",
+    herdrPane: "%7",
+    title: "Plan",
+  };
+  const fullAnchor: Required<Anchor> = { quote: "q", prefix: "p", suffix: "s", blockIndex: 0, start: 0, end: 1 };
+  const fullAnnotation: Required<Annotation> = {
+    id: "a1",
+    kind: "comment",
+    anchor: fullAnchor,
+    body: "b",
+    orphan: false,
+    createdAt: "now",
+  };
+  const fullArtifact: Required<Artifact> = { type: "plan", content: "# P", meta: fullMeta };
+  const fullVerdict: Required<Verdict> = { kind: "approve", summary: "", feedback: "", resolvedAt: "now" };
+  const fullRevision: Required<Revision> = { revision: 1, content: "# P", submittedAt: "now" };
+  const fullWorkspace: Required<WorkspaceKey> = { repoRoot: "/repo", branch: "main" };
+  const fullSession: Required<ReviewSession> = {
+    schemaVersion: SCHEMA_VERSION,
+    id: "ses_1",
+    workspace: fullWorkspace,
+    artifact: fullArtifact,
+    revisions: [fullRevision],
+    annotations: [fullAnnotation],
+    workingCopy: "# P edited",
+    viewedPaths: ["src/a.ts"],
+    verdict: fullVerdict,
+    status: "pending",
+    createdAt: "now",
+  };
+
+  test("schema key sets match the schema types", () => {
+    expect(entryKeys(WorkspaceSchema)).toEqual(keys(fullWorkspace));
+    expect(entryKeys(ArtifactMetaSchema)).toEqual(keys(fullMeta));
+    expect(entryKeys(ArtifactSchema)).toEqual(keys(fullArtifact));
+    expect(entryKeys(AnchorSchema)).toEqual(keys(fullAnchor));
+    // wire annotations arrive without createdAt; the daemon stamps it
+    const { createdAt: _stamped, ...wireAnnotation } = fullAnnotation;
+    expect(entryKeys(AnnotationSchema)).toEqual(keys(wireAnnotation));
+    expect(entryKeys(RevisionSchema)).toEqual(keys(fullRevision));
+    expect(entryKeys(VerdictSchema)).toEqual(keys(fullVerdict));
+    expect(entryKeys(SessionRecordSchema)).toEqual(keys(fullSession));
+    // persisted annotations carry the stamped createdAt
+    const stored = SessionRecordSchema.entries.annotations.item;
+    expect(entryKeys(stored)).toEqual(keys(fullAnnotation));
+  });
+
+  test("a fully-populated meta survives validation and DaemonCore unchanged", () => {
+    const home = mkdtempSync(join(tmpdir(), "cueloop-val-"));
+    try {
+      const params = parseParams("session.create", {
+        workspace: fullWorkspace,
+        artifact: { type: "plan", content: "# P", meta: fullMeta },
+      });
+      const core = new DaemonCore(home);
+      const created = core.sessionCreate(params);
+      expect(core.sessionGet(created.id).artifact.meta).toEqual(fullMeta);
+    } finally {
+      rmSync(home, { recursive: true, force: true });
+    }
   });
 });

package/src/validate.ts

@@ -1,5 +1,5 @@
 /**
- * Runtime validation of the wire boundary (#14). Everything arriving over the
+ * Runtime validation of the wire boundary. Everything arriving over the
  * socket is untrusted JSON: adapters, the CLI, extensions, and any script a
  * user writes all speak this protocol. Validating here means DaemonCore only
  * ever sees well-formed input, and a malformed request gets a precise error
@@ -10,31 +10,50 @@
  */
 
 import * as v from "valibot";
-import { SCHEMA_VERSION } from "@cueloop/schema";
+import {
+  SCHEMA_VERSION,
+  type Anchor,
+  type Annotation,
+  type Artifact,
+  type ArtifactMeta,
+  type ReviewSession,
+  type Revision,
+  type Verdict,
+  type WorkspaceKey,
+} from "@cueloop/schema";
 import { DaemonError } from "./errors";
 
+/**
+ * Drift guard for every hand-mirrored shape below. v.object strips keys it
+ * does not know, so a schema missing a field silently drops that field on
+ * the way into DaemonCore. Each entries object is checked with
+ * `satisfies EntriesOf<T>`: adding a field to the schema types without
+ * mirroring it here (or mirroring a key that does not exist) fails typecheck.
+ */
+type EntriesOf<T> = { [K in keyof T]-?: v.GenericSchema<any, any> };
+
 const NonEmpty = v.pipe(v.string(), v.minLength(1));
 
 export const WorkspaceSchema = v.object({
   repoRoot: NonEmpty,
   branch: NonEmpty,
-});
+} satisfies EntriesOf<WorkspaceKey>);
+
+export const ArtifactMetaSchema = v.object({
+  cwd: v.optional(v.string()),
+  agent: v.optional(v.string()),
+  agentSessionId: v.optional(v.string()),
+  planPath: v.optional(v.string()),
+  pr: v.optional(v.string()),
+  herdrPane: v.optional(v.string()),
+  title: v.optional(v.string()),
+} satisfies EntriesOf<ArtifactMeta>);
 
 export const ArtifactSchema = v.object({
   type: v.picklist(["plan", "diff"]),
   content: v.string(),
-  meta: v.optional(
-    v.object({
-      cwd: v.optional(v.string()),
-      agent: v.optional(v.string()),
-      agentSessionId: v.optional(v.string()),
-      planPath: v.optional(v.string()),
-      title: v.optional(v.string()),
-      pr: v.optional(v.string()),
-    }),
-    {},
-  ),
-});
+  meta: v.optional(ArtifactMetaSchema, {}),
+} satisfies EntriesOf<Artifact>);
 
 export const AnchorSchema = v.object({
   quote: v.string(),
@@ -43,16 +62,17 @@ export const AnchorSchema = v.object({
   blockIndex: v.optional(v.number()),
   start: v.optional(v.number()),
   end: v.optional(v.number()),
-});
+} satisfies EntriesOf<Anchor>);
 
+/** Wire annotations arrive without createdAt - the daemon stamps it. */
 export const AnnotationSchema = v.object({
   id: NonEmpty,
-  /** Open kind set (#2): built-ins are comment and suggestion. */
+  /** Open kind set: built-ins are comment and suggestion. */
   kind: NonEmpty,
   anchor: AnchorSchema,
   body: v.string(),
   orphan: v.optional(v.boolean()),
-});
+} satisfies EntriesOf<Omit<Annotation, "createdAt">>);
 
 const SessionId = NonEmpty;
 
@@ -75,6 +95,7 @@ export const Params = {
   "session.annotate": v.object({ id: SessionId, annotation: AnnotationSchema }),
   "session.removeAnnotation": v.object({ id: SessionId, annotationId: NonEmpty }),
   "session.setWorkingCopy": v.object({ id: SessionId, workingCopy: v.optional(v.string()) }),
+  "session.setViewed": v.object({ id: SessionId, viewedPaths: v.array(v.string()) }),
   "session.resolve": v.object({
     id: SessionId,
     verdictKind: v.picklist(["comment", "approve", "request_changes"]),
@@ -97,37 +118,44 @@ export function parseParams<M extends MethodName>(method: M, params: unknown): v
   const result = v.safeParse(Params[method], params ?? {});
   if (!result.success) {
     const issue = result.issues[0]!;
-    const path = issue.path?.map((p) => String(p.key)).join(".") ?? "";
+    const path = issue.path?.map((pathSegment) => String(pathSegment.key)).join(".") ?? "";
     throw new DaemonError("invalid_params", `${method}: ${path ? path + " - " : ""}${issue.message}`);
   }
   return result.output;
 }
 
+export const RevisionSchema = v.object({
+  revision: v.number(),
+  content: v.string(),
+  submittedAt: v.string(),
+} satisfies EntriesOf<Revision>);
+
+export const VerdictSchema = v.object({
+  kind: v.picklist(["comment", "approve", "request_changes"]),
+  summary: v.string(),
+  feedback: v.string(),
+  resolvedAt: v.string(),
+} satisfies EntriesOf<Verdict>);
+
 /** Persisted records are validated on recovery: a bad file is skipped, not fatal. */
 export const SessionRecordSchema = v.object({
   schemaVersion: v.literal(SCHEMA_VERSION),
   id: NonEmpty,
   workspace: WorkspaceSchema,
   artifact: ArtifactSchema,
-  revisions: v.array(v.object({ revision: v.number(), content: v.string(), submittedAt: v.string() })),
-  annotations: v.array(v.object({ ...AnnotationSchema.entries, createdAt: v.string() })),
+  revisions: v.array(RevisionSchema),
+  annotations: v.array(v.object({ ...AnnotationSchema.entries, createdAt: v.string() } satisfies EntriesOf<Annotation>)),
   workingCopy: v.optional(v.string()),
-  verdict: v.nullable(
-    v.object({
-      kind: v.picklist(["comment", "approve", "request_changes"]),
-      summary: v.string(),
-      feedback: v.string(),
-      resolvedAt: v.string(),
-    }),
-  ),
+  viewedPaths: v.optional(v.array(v.string())),
+  verdict: v.nullable(VerdictSchema),
   status: v.picklist(["pending", "resolved"]),
   createdAt: v.string(),
-});
+} satisfies EntriesOf<ReviewSession>);
 
 export function validateSessionRecord(raw: unknown): { ok: true; value: v.InferOutput<typeof SessionRecordSchema> } | { ok: false; error: string } {
   const result = v.safeParse(SessionRecordSchema, raw);
   if (result.success) return { ok: true, value: result.output };
   const issue = result.issues[0]!;
-  const path = issue.path?.map((p) => String(p.key)).join(".") ?? "";
+  const path = issue.path?.map((pathSegment) => String(pathSegment.key)).join(".") ?? "";
   return { ok: false, error: `${path ? path + ": " : ""}${issue.message}` };
 }