@pmelab/gtd 24.0.0 → 24.2.0

package/src/workflows/review/review.test.ts

@@ -1,36 +1,92 @@
-import { afterEach, describe, expect, it } from "vitest"
-import { installContext, type StepRequest } from "../../flows/index.js"
-import { fixtureContext } from "../shared/text.fixture.js"
-import { base, reviewFlow } from "./review.js"
+import { describe, expect, it } from "vitest"
+import { runsItsScript, testRepo, type TestRepo } from "../../testkit/index.js"
+import { CONFIG_SCAFFOLD } from "../../install/index.js"
+import { reviewDoc } from "../shared/config.fixture.js"
+import { base } from "./review.js"
 
-afterEach(() => installContext(undefined))
+const REVIEW = ".gtd/REVIEW.md"
+const ORIG = ".gtd/REVIEW.orig.md"
+
+/** A repository with one commit to review, the review run until the human holds `.gtd/REVIEW.md`. */
+const reviewed = async (): Promise<TestRepo> => {
+  const repo = testRepo({ workflow: CONFIG_SCAFFOLD, env: { GTD_QUALITYREVIEWS: "" } })
+  repo.write("src/calc.ts", "export const add = (a: number, b: number) => a + b\n")
+  repo.commit("feat: add calculator")
+  await repo.door("review", "HEAD~1")
+  const rest = await repo.drive({
+    "review-gate.check": () => undefined,
+    "build.health.check": () => undefined,
+    "build.review.reviewing": (beat, r) => {
+      expect(beat.file).toBe(REVIEW)
+      r.write(REVIEW, reviewDoc("new add function"))
+    },
+  })
+  expect(rest).toMatchObject({ state: "build.review.await-review", actor: "human" })
+  return repo
+}
 
 describe("the review workflow", () => {
-  it("refuses a pending hand-off before requesting any step, the gate's check included", async () => {
-    const requested: string[] = []
-    const files = new Map([
-      [".gtd/REVIEW.md", "notes"],
-      [".gtd/REVIEW.orig.md", "orig"],
+  it("checks, reviews and hands the review to the human", async () => {
+    const repo = await reviewed()
+    expect(repo.subjects().slice(2)).toEqual([
+      "gtd(human): review-gate.check",
+      "gtd(check): review-gate.check → build.health.check",
+      "gtd(check): build.health.check → build.review.reviewing",
+      "gtd(agent): build.review.reviewing → build.review.await-review",
+    ])
+  })
+
+  it("closes a review the human signs off", async () => {
+    const repo = await reviewed()
+    repo.write(REVIEW, reviewDoc("new add function").replace("- [ ]", "- [x]"))
+    await repo.land()
+    const rest = await repo.drive({ "build.review.closing": runsItsScript })
+    expect(rest.state).toBe("idle")
+    expect(repo.subjects().slice(-2)).toEqual([
+      "gtd(human): build.review.await-review → build.review.closing",
+      "gtd(check): build.review.closing → idle",
+    ])
+    expect(repo.read(REVIEW)).toBeUndefined()
+  })
+
+  it("never lands a review the review format rejects", async () => {
+    const repo = testRepo({ workflow: CONFIG_SCAFFOLD, env: { GTD_QUALITYREVIEWS: "" } })
+    repo.write("src/calc.ts", "export const add = (a: number, b: number) => a + b\n")
+    repo.commit("feat: add calculator")
+    await repo.door("review", "HEAD~1")
+    await expect(
+      repo.drive({
+        "review-gate.check": () => undefined,
+        "build.health.check": () => undefined,
+        "build.review.reviewing": (_, r) => r.write(REVIEW, "not a review\n"),
+      }),
+    ).rejects.toThrow(/validating \.gtd\/REVIEW\.md/)
+    expect(repo.subjects().at(-1)).toBe("gtd(check): build.health.check → build.review.reviewing")
+  })
+
+  it("ends with the review and the reviewer's copy kept when the human leaves a note", async () => {
+    const repo = await reviewed()
+    repo.write(REVIEW, reviewDoc("new add function — rename it to sum"))
+    await repo.land()
+    const rest = await repo.drive({
+      "build.review.handing-off": runsItsScript,
+    })
+    expect(rest.state).toBe("idle")
+    expect(repo.subjects().slice(-2)).toEqual([
+      "gtd(human): build.review.await-review → build.review.handing-off",
+      "gtd(check): build.review.handing-off → idle",
     ])
-    installContext(
-      fixtureContext(
-        {},
-        {
-          step: (request: StepRequest) => {
-            requested.push(request.kind)
-            return Promise.resolve()
-          },
-          refuse: (message: string): never => {
-            throw new Error(message)
-          },
-          pushScope: () => undefined,
-          popScope: () => undefined,
-          read: (path) => files.get(path),
-        },
-      ),
-    )
-    await expect(reviewFlow()).rejects.toThrow(".gtd/REVIEW.orig.md is a pending hand-off")
-    expect(requested).toEqual([])
+    expect(repo.read(REVIEW)).toContain("rename it to sum")
+    expect(repo.read(ORIG)).toBe(reviewDoc("new add function"))
+  })
+
+  it("refuses a pending hand-off before requesting any step, the gate's check included", async () => {
+    const repo = testRepo({
+      workflow: CONFIG_SCAFFOLD,
+      files: { [REVIEW]: reviewDoc("note"), [ORIG]: reviewDoc("orig") },
+    })
+    await expect(repo.door("review")).rejects.toThrow(".gtd/REVIEW.orig.md is a pending hand-off")
+    expect(repo.subjects()).toEqual(["chore: initial commit"])
   })
 })
 

package/src/workflows/review/review.ts

@@ -20,7 +20,9 @@ export const review = shipped(
   {
     review: {
       args: [{ name: "base", optional: true }],
-      vars: ({ base }) => (base === undefined ? {} : { reviewBase: base }),
+      // Annotated: inferred, the literal union only fits under exactOptionalPropertyTypes.
+      vars: ({ base }): Readonly<Record<string, string>> =>
+        base === undefined ? {} : { reviewBase: base },
     },
   },
   (_workflow, vars) => vars.reviewBase || "",

package/src/workflows/shared/config.fixture.ts

@@ -0,0 +1,12 @@
+/** A `.gtd/REVIEW.md` on the fixture calculator, one hunk per note. */
+export const reviewDoc = (...notes: string[]): string =>
+  [
+    "# Review: abc1234",
+    "",
+    "<!-- base: 0000000 -->",
+    "",
+    "## calc",
+    "",
+    ...notes.flatMap((note, i) => [`- [ ] ./src/calc.ts#${i + 1}-${i + 1}`, `  ${note}`]),
+    "",
+  ].join("\n")

package/src/workflows/shared/reserved.ts

@@ -0,0 +1,11 @@
+import type { Summary } from "../../flows/index.js"
+import * as t from "./text.js"
+import { ARCHITECTURE, REQUIREMENTS, REVIEW } from "./steps.js"
+
+export { defaults, envDefaults } from "./vars.js"
+export { skills } from "./skills.js"
+export { access } from "./access.js"
+
+export const summary: Summary = t.summaryPrompt
+
+export const steering = { [REQUIREMENTS]: "qa", [ARCHITECTURE]: "qa", [REVIEW]: "review" }

package/src/workflows/shared/workflows.steps.ts

@@ -0,0 +1,7 @@
+import { Given } from "quickpickle"
+import { CONFIG_SCAFFOLD } from "../../install/index.js"
+import type { TestkitWorld } from "../../testkit/index.js"
+
+Given("the shipped workflows, as gtd install scaffolds them", (world: TestkitWorld) => {
+  world.configure(CONFIG_SCAFFOLD)
+})