@opengsd/gsd-pi 1.2.0-dev.9ad8ae33 → 1.2.0-dev.a6376d75

package/src/resources/extensions/gsd/tests/engine-interfaces-contract.test.ts

@@ -1,10 +1,11 @@
 /**
- * engine-interfaces-contract.test.ts — Source-level contract tests for the
- * engine abstraction layer (S01).
+ * engine-interfaces-contract.test.ts — Runtime and type-level contract tests for
+ * the engine abstraction layer (S01).
  *
- * TypeScript interfaces are erased by --experimental-strip-types, so these
- * tests use source-level regex assertions on the .ts files to verify shapes.
- * Runtime assertions cover AutoSession.activeEngineId and resolveEngine().
+ * TypeScript interfaces are erased by --experimental-strip-types, so shape
+ * contracts are verified by constructing values that satisfy the types and
+ * asserting on their runtime fields. Type-level assertions guard compile-time
+ * contracts; pnpm run typecheck:extensions validates those.
  *
  * Follows the same conventions as auto-session-encapsulation.test.ts.
  */
@@ -15,15 +16,21 @@ import { readFileSync } from "node:fs";
 import { join, dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 
+import type {
+  EngineState,
+  EngineDispatchAction,
+  StepContract,
+  ReconcileResult,
+  RecoveryAction,
+  CloseoutResult,
+  DisplayMetadata,
+} from "../engine-types.js";
+import type { WorkflowEngine } from "../workflow-engine.js";
+import type { ExecutionPolicy } from "../execution-policy.js";
+import type { ResolvedEngine } from "../engine-resolver.js";
+
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const ENGINE_TYPES_PATH = join(__dirname, "..", "engine-types.ts");
-const WORKFLOW_ENGINE_PATH = join(__dirname, "..", "workflow-engine.ts");
-const EXECUTION_POLICY_PATH = join(__dirname, "..", "execution-policy.ts");
-const ENGINE_RESOLVER_PATH = join(__dirname, "..", "engine-resolver.ts");
-
-function readSource(path: string): string {
-  return readFileSync(path, "utf-8");
-}
 
 // ── Import smoke tests ──────────────────────────────────────────────────────
 
@@ -55,9 +62,10 @@ describe("Import smoke tests", () => {
 
 // ── Leaf-node constraint ────────────────────────────────────────────────────
 
+// allow-source-grep: verifies engine-types.ts is a leaf node by design
 describe("Leaf-node constraint", () => {
   test("engine-types.ts has zero imports from GSD modules (only node: allowed)", () => {
-    const source = readSource(ENGINE_TYPES_PATH);
+    const source = readFileSync(ENGINE_TYPES_PATH, "utf-8");
     const lines = source.split("\n");
     const violations: string[] = [];
 
@@ -81,97 +89,111 @@ describe("Leaf-node constraint", () => {
 // ── EngineState shape ───────────────────────────────────────────────────────
 
 describe("EngineState shape", () => {
-  test("EngineState has all required fields with correct types", () => {
-    const source = readSource(ENGINE_TYPES_PATH);
-
-    const requiredFields = [
-      "phase",
-      "currentMilestoneId",
-      "activeSliceId",
-      "activeTaskId",
-      "isComplete",
-      "raw",
-    ];
-
-    for (const field of requiredFields) {
-      assert.ok(
-        source.includes(field),
-        `EngineState must contain field: ${field}`,
-      );
-    }
+  test("EngineState accepts all required fields with correct runtime types", () => {
+    const state: EngineState = {
+      phase: "research",
+      currentMilestoneId: "M001",
+      activeSliceId: "S01",
+      activeTaskId: "T01",
+      isComplete: false,
+      raw: { arbitrary: "engine-specific-state" },
+    };
+
+    assert.equal(state.phase, "research");
+    assert.equal(state.currentMilestoneId, "M001");
+    assert.equal(state.activeSliceId, "S01");
+    assert.equal(state.activeTaskId, "T01");
+    assert.equal(state.isComplete, false);
+    assert.deepEqual(state.raw, { arbitrary: "engine-specific-state" });
+  });
 
-    // raw must be typed unknown — not a GSD-specific type
-    assert.ok(
-      /raw:\s*unknown/.test(source),
-      "EngineState.raw must be typed 'unknown', not a GSD-specific type",
-    );
+  test("EngineState.raw accepts unknown opaque values", () => {
+    const state: EngineState = {
+      phase: "planning",
+      currentMilestoneId: null,
+      activeSliceId: null,
+      activeTaskId: null,
+      isComplete: true,
+      raw: null,
+    };
+
+    assert.equal(state.raw, null);
   });
 });
 
 // ── EngineDispatchAction shape ──────────────────────────────────────────────
 
 describe("EngineDispatchAction shape", () => {
-  test("EngineDispatchAction has dispatch, stop, and skip variants", () => {
-    const source = readSource(ENGINE_TYPES_PATH);
-
-    assert.ok(
-      /action:\s*"dispatch"/.test(source),
-      'EngineDispatchAction must have action: "dispatch" variant',
-    );
-    assert.ok(
-      /action:\s*"stop"/.test(source),
-      'EngineDispatchAction must have action: "stop" variant',
-    );
-    assert.ok(
-      /action:\s*"skip"/.test(source),
-      'EngineDispatchAction must have action: "skip" variant',
-    );
+  test("EngineDispatchAction supports dispatch, stop, and skip variants at runtime", () => {
+    const step: StepContract = {
+      unitType: "execute-task",
+      unitId: "M001/S01/T01",
+      prompt: "execute the task",
+    };
+
+    const dispatchAction: EngineDispatchAction = { action: "dispatch", step };
+    assert.equal(dispatchAction.action, "dispatch");
+    assert.deepEqual(dispatchAction.step, step);
+
+    const stopAction: EngineDispatchAction = { action: "stop", reason: "blocked", level: "error" };
+    assert.equal(stopAction.action, "stop");
+    assert.equal(stopAction.reason, "blocked");
+    assert.equal(stopAction.level, "error");
+
+    const skipAction: EngineDispatchAction = { action: "skip" };
+    assert.equal(skipAction.action, "skip");
   });
 });
 
 // ── WorkflowEngine interface shape ──────────────────────────────────────────
 
 describe("WorkflowEngine interface shape", () => {
-  test("WorkflowEngine has engineId and all required methods", () => {
-    const source = readSource(WORKFLOW_ENGINE_PATH);
-
-    const requiredMembers = [
-      "engineId",
-      "deriveState",
-      "resolveDispatch",
-      "reconcile",
-      "getDisplayMetadata",
-    ];
-
-    for (const member of requiredMembers) {
-      assert.ok(
-        source.includes(member),
-        `WorkflowEngine must contain member: ${member}`,
-      );
-    }
+  test("WorkflowEngine accepts an object with engineId and all required methods", () => {
+    const engine: WorkflowEngine = {
+      engineId: "test-engine",
+      deriveState: async () => ({
+        phase: "test",
+        currentMilestoneId: null,
+        activeSliceId: null,
+        activeTaskId: null,
+        isComplete: false,
+        raw: null,
+      }),
+      resolveDispatch: async () => ({ action: "skip" }),
+      reconcile: async () => ({ outcome: "continue" }),
+      getDisplayMetadata: () => ({
+        engineLabel: "Test Engine",
+        currentPhase: "test",
+        progressSummary: "testing",
+        stepCount: null,
+      }),
+    };
+
+    assert.equal(engine.engineId, "test-engine");
+    assert.equal(typeof engine.deriveState, "function");
+    assert.equal(typeof engine.resolveDispatch, "function");
+    assert.equal(typeof engine.reconcile, "function");
+    assert.equal(typeof engine.getDisplayMetadata, "function");
   });
 });
 
 // ── ExecutionPolicy interface shape ─────────────────────────────────────────
 
 describe("ExecutionPolicy interface shape", () => {
-  test("ExecutionPolicy has all required methods", () => {
-    const source = readSource(EXECUTION_POLICY_PATH);
-
-    const requiredMethods = [
-      "prepareWorkspace",
-      "selectModel",
-      "verify",
-      "recover",
-      "closeout",
-    ];
-
-    for (const method of requiredMethods) {
-      assert.ok(
-        source.includes(method),
-        `ExecutionPolicy must contain method: ${method}`,
-      );
-    }
+  test("ExecutionPolicy accepts an object with all required methods", () => {
+    const policy: ExecutionPolicy = {
+      prepareWorkspace: async () => {},
+      selectModel: async () => null,
+      verify: async () => "continue",
+      recover: async () => ({ outcome: "retry" } as RecoveryAction),
+      closeout: async () => ({ committed: true, artifacts: [] } as CloseoutResult),
+    };
+
+    assert.equal(typeof policy.prepareWorkspace, "function");
+    assert.equal(typeof policy.selectModel, "function");
+    assert.equal(typeof policy.verify, "function");
+    assert.equal(typeof policy.recover, "function");
+    assert.equal(typeof policy.closeout, "function");
   });
 });
 
@@ -220,12 +242,16 @@ describe("Resolver stub behavior", () => {
     );
   });
 
-  test("ResolvedEngine type is exported (source check)", () => {
-    const source = readSource(ENGINE_RESOLVER_PATH);
-    assert.ok(
-      /export\s+(interface|type)\s+ResolvedEngine/.test(source),
-      "engine-resolver.ts must export ResolvedEngine type",
-    );
+  test("ResolvedEngine type is exported and has the expected shape", () => {
+    // Type-level assertion: ResolvedEngine must be { engine: WorkflowEngine; policy: ExecutionPolicy }.
+    // If the export or shape changes, the typecheck step fails.
+    type _AssertResolvedEngine = ResolvedEngine extends { engine: WorkflowEngine; policy: ExecutionPolicy }
+      ? true
+      : false;
+    const _assertResolvedEngine: true = {} as _AssertResolvedEngine;
+
+    // Runtime sanity check that the import path resolves.
+    assert.ok(_assertResolvedEngine === undefined || true);
   });
 });
 

package/src/resources/extensions/gsd/tests/ensure-db-open.test.ts

@@ -11,7 +11,10 @@ import * as path from 'node:path';
 import * as os from 'node:os';
 import * as fs from 'node:fs';
 import { createRequire } from 'node:module';
+import { spawnSync } from 'node:child_process';
+import { fileURLToPath, pathToFileURL } from 'node:url';
 import { closeDatabase, isDbAvailable, getDecisionById, SCHEMA_VERSION, _getAdapter } from '../gsd-db.ts';
+import { formatWorkflowDatabaseOpenFailure } from '../bootstrap/dynamic-tools.ts';
 
 const _require = createRequire(import.meta.url);
 
@@ -288,6 +291,116 @@ function createLegacyV15Db(dbPath: string): void {
 // ═══════════════════════════════════════════════════════════════════════════
 
 describe('ensure-db-open', () => {
+  test('formatWorkflowDatabaseOpenFailure: open failure without provider gives actionable SQLite guidance', () => {
+    const message = formatWorkflowDatabaseOpenFailure(
+      {
+        ok: false,
+        reason: 'open-failed',
+        location: {
+          projectRoot: '/tmp/example',
+          projectGsd: '/tmp/example/.gsd',
+          projectDb: '/tmp/example/.gsd/gsd.db',
+        },
+      },
+      {
+        available: false,
+        provider: null,
+        attempted: true,
+        lastError: null,
+        lastPhase: null,
+      },
+      '22.15.0',
+    );
+
+    assert.match(message, /\/tmp\/example\/\.gsd\/gsd\.db/);
+    assert.match(message, /No SQLite provider available/);
+    assert.match(message, /node:sqlite/);
+    assert.match(message, /better-sqlite3/);
+  });
+
+  test('formatWorkflowDatabaseOpenFailure: old Node includes upgrade guidance', () => {
+    const message = formatWorkflowDatabaseOpenFailure(
+      {
+        ok: false,
+        reason: 'open-failed',
+        location: {
+          projectRoot: '/tmp/example',
+          projectGsd: '/tmp/example/.gsd',
+          projectDb: '/tmp/example/.gsd/gsd.db',
+        },
+      },
+      {
+        available: false,
+        provider: null,
+        attempted: true,
+        lastError: null,
+        lastPhase: null,
+      },
+      '20.11.1',
+    );
+
+    assert.match(message, />= 22\.0\.0/);
+    assert.match(message, /current: v20\.11\.1/);
+  });
+
+  test('ensureDbOpen: source-mode runtime without node:sqlite records actionable guidance', () => {
+    const loaderPath = fileURLToPath(new URL('./resolve-ts.mjs', import.meta.url));
+    const runningFromDistTest = fileURLToPath(import.meta.url).includes(`${path.sep}dist-test${path.sep}`);
+    const dynamicToolsImportUrl = pathToFileURL(
+      path.resolve(
+        runningFromDistTest
+          ? 'dist-test/src/resources/extensions/gsd/bootstrap/dynamic-tools.js'
+          : 'src/resources/extensions/gsd/bootstrap/dynamic-tools.ts',
+      ),
+    ).href;
+    const loggerImportUrl = pathToFileURL(
+      path.resolve(
+        runningFromDistTest
+          ? 'dist-test/src/resources/extensions/gsd/workflow-logger.ts'
+          : 'src/resources/extensions/gsd/workflow-logger.ts',
+      ),
+    ).href;
+    const script = `
+      const fs = require('node:fs');
+      const os = require('node:os');
+      const path = require('node:path');
+      (async () => {
+        const base = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-missing-sqlite-'));
+        try {
+          fs.mkdirSync(path.join(base, '.gsd'), { recursive: true });
+          const dynamicTools = await import(${JSON.stringify(dynamicToolsImportUrl)});
+          const logger = await import(${JSON.stringify(loggerImportUrl)});
+          await dynamicTools.ensureDbOpen(base);
+          const messages = logger.peekLogs().map((entry) => entry.message);
+          console.log(JSON.stringify(messages));
+        } finally {
+          fs.rmSync(base, { recursive: true, force: true });
+        }
+      })().catch((error) => {
+        console.error(error.stack || error.message || String(error));
+        process.exit(1);
+      });
+    `;
+    const result = spawnSync(
+      process.execPath,
+      [
+        '--no-experimental-sqlite',
+        '--import',
+        loaderPath,
+        '--experimental-strip-types',
+        '-e',
+        script,
+      ],
+      { cwd: process.cwd(), encoding: 'utf-8' },
+    );
+
+    assert.equal(result.status, 0, result.stderr);
+    const messages = JSON.parse(result.stdout.trim()) as string[];
+    assert.ok(messages.some((message) => /No SQLite provider available/.test(message)), result.stdout);
+    assert.ok(messages.some((message) => /node:sqlite/.test(message)), result.stdout);
+    assert.ok(messages.some((message) => /better-sqlite3/.test(message)), result.stdout);
+  });
+
   test('ensureDbOpen: creates empty DB without importing Markdown', async () => {
     const tmpDir = makeTmpDir();
     const gsdDir = path.join(tmpDir, '.gsd');

package/src/resources/extensions/gsd/tests/guided-dispatch-root.test.ts

@@ -11,6 +11,7 @@ import {
   _dispatchWorkflowForTest,
   resolveGuidedDispatchProjectRoot,
 } from "../guided-flow.ts";
+import { getRequiredWorkflowToolsForUnit } from "../unit-tool-contracts.ts";
 
 test("guided dispatch falls back to cwd only when no project root is supplied", () => {
   const cwd = process.cwd();
@@ -115,6 +116,7 @@ test("guided dispatch accepts workflow MCP tools absent from parent active tool
       getProviderAuthMode: () => "externalCli",
     },
     ui: {
+      setStatus: () => {},
       notify: (message: string) => {
         notifications.push(message);
       },
@@ -130,8 +132,22 @@ test("guided dispatch accepts workflow MCP tools absent from parent active tool
     "write",
   ];
 
+  // The workflow MCP server registers its tools out of band, so the unit's
+  // required workflow tools show up in the registered tool snapshot
+  // (getAllTools) under the MCP server prefix without ever entering the parent
+  // session's active tool surface (getActiveTools). This is exactly the shape
+  // the readiness gate must accept. Derive the surface from the unit contract
+  // so this test stays correct if discuss-milestone's required tools change.
+  const registeredTools = [
+    ...activeTools,
+    ...getRequiredWorkflowToolsForUnit("discuss-milestone").map(
+      (tool) => `mcp__gsd-workflow__${tool}`,
+    ),
+  ];
+
   const pi = {
     getActiveTools: () => [...activeTools],
+    getAllTools: () => registeredTools.map((name) => ({ name })),
     setActiveTools: (tools: string[]) => {
       activeTools = [...tools];
     },

package/src/resources/extensions/gsd/tests/integration/auto-worktree.test.ts

@@ -134,6 +134,21 @@ describe("auto-worktree lifecycle", () => {
     teardownAutoWorktree(tempDir, "M003");
   });
 
+  test("isInAutoWorktree returns false when ambient cwd was deleted", (t) => {
+    const cwd = t.mock.method(process, "cwd", () => {
+      const err = new Error("process.cwd failed") as NodeJS.ErrnoException;
+      err.code = "ENOENT";
+      err.syscall = "uv_cwd";
+      throw err;
+    });
+
+    try {
+      assert.equal(isInAutoWorktree("/repo"), false);
+    } finally {
+      cwd.mock.restore();
+    }
+  });
+
   test("symlink-resolved auto worktree is detected after module state reset", () => {
     tempDir = createTempRepo();
     const savedGsdHome = process.env.GSD_HOME;

package/src/resources/extensions/gsd/tests/integration/doctor-environment-async.test.ts

@@ -0,0 +1,104 @@
+// Project/App: gsd-pi
+// File Purpose: Verify the non-blocking runEnvironmentChecksAsync is behaviourally
+// identical to the synchronous runEnvironmentChecks (the health-widget render
+// path was moved onto the async variant for performance), and that the single-
+// scan checkPortConflicts still detects a real in-use port.
+
+import test, { type TestContext } from "node:test";
+import assert from "node:assert/strict";
+import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
+import { join, dirname } from "node:path";
+import { tmpdir } from "node:os";
+import { createServer } from "node:net";
+
+import {
+  runEnvironmentChecks,
+  runEnvironmentChecksAsync,
+  type EnvironmentCheckResult,
+} from "../../doctor-environment.ts";
+
+function makeProject(t: TestContext, files: Record<string, string>): string {
+  const dir = mkdtempSync(join(tmpdir(), "gsd-env-async-"));
+  t.after(() => {
+    try {
+      rmSync(dir, { recursive: true, force: true });
+    } catch {
+      /* ignore */
+    }
+  });
+  for (const [name, content] of Object.entries(files)) {
+    const filePath = join(dir, name);
+    mkdirSync(dirname(filePath), { recursive: true });
+    writeFileSync(filePath, content);
+  }
+  return dir;
+}
+
+// Stable, order-independent signature of a check-result set for comparison.
+function normalize(results: EnvironmentCheckResult[]): string[] {
+  return results.map((r) => `${r.name}|${r.status}|${r.message}|${r.detail ?? ""}`).sort();
+}
+
+test("runEnvironmentChecksAsync returns the same results as runEnvironmentChecks", async (t) => {
+  const dir = makeProject(t, {
+    "package.json": JSON.stringify({
+      name: "fixture",
+      engines: { node: ">=18" },
+      scripts: { dev: "vite --port 4321", build: "tsc" },
+      devDependencies: { typescript: "^5.0.0" },
+    }),
+    ".env.example": "API_KEY=\n",
+    Dockerfile: "FROM node:20\n",
+  });
+  mkdirSync(join(dir, "node_modules"), { recursive: true });
+
+  const sync = runEnvironmentChecks(dir);
+  const asyncResults = await runEnvironmentChecksAsync(dir);
+
+  assert.deepEqual(
+    normalize(asyncResults),
+    normalize(sync),
+    "async checks must produce the identical result set as the sync checks",
+  );
+  // Sanity: the fixture is rich enough that the suite actually produced checks.
+  assert.ok(sync.length > 0, "expected the fixture to yield environment checks");
+});
+
+test("runEnvironmentChecksAsync matches sync on a bare directory (no package.json)", async (t) => {
+  const dir = makeProject(t, {});
+  const sync = runEnvironmentChecks(dir);
+  const asyncResults = await runEnvironmentChecksAsync(dir);
+  assert.deepEqual(normalize(asyncResults), normalize(sync));
+});
+
+test(
+  "single-scan port check detects a real in-use port, identically sync and async",
+  { skip: process.platform === "win32" ? "lsof-based port check is macOS/Linux only" : false },
+  async (t) => {
+    // Bind a real listener, then reference its port from package.json scripts so
+    // collectPortsToCheck picks it up. The server stays up across both check runs.
+    const server = createServer();
+    const port = await new Promise<number>((resolve, reject) => {
+      server.once("error", reject);
+      server.listen(0, "127.0.0.1", () => {
+        const addr = server.address();
+        resolve(typeof addr === "object" && addr ? addr.port : 0);
+      });
+    });
+    t.after(() => new Promise<void>((resolve) => server.close(() => resolve())));
+    assert.ok(port >= 1024 && port <= 65535, "ephemeral port should be in the checked range");
+
+    const dir = makeProject(t, {
+      "package.json": JSON.stringify({ name: "fixture", scripts: { dev: `serve --port ${port}` } }),
+    });
+
+    const syncConflicts = runEnvironmentChecks(dir).filter((r) => r.name === "port_conflict");
+    const asyncConflicts = (await runEnvironmentChecksAsync(dir)).filter((r) => r.name === "port_conflict");
+
+    // Equivalence holds regardless of whether lsof is present on the runner.
+    assert.deepEqual(normalize(asyncConflicts), normalize(syncConflicts), "sync and async must agree on port conflicts");
+    // On macOS/Linux lsof is standard, so the listener must be reported and named.
+    assert.equal(syncConflicts.length, 1, "expected exactly one port conflict for the in-use port");
+    assert.match(syncConflicts[0]!.message, new RegExp(`\\b${port}\\b`), "conflict message must name the in-use port");
+  },
+);

package/src/resources/extensions/gsd/tests/integration/run-uat.test.ts

@@ -317,6 +317,24 @@ test('(k2) run-uat prompt references gsd_uat_result_save, not direct write', ()
   );
 });
 
+test('(k3) run-uat prompt warns that .gsd glob misses can be symlink traversal artifacts', async () => {
+  const base = createFixtureBase();
+  try {
+    const uatRel = '.gsd/milestones/M001/slices/S01/S01-UAT.md';
+    const uatContent = makeUatContent('runtime-executable');
+    writeSliceFile(base, 'M001', 'S01', 'UAT', uatContent);
+
+    const prompt = await buildRunUatPrompt('M001', 'S01', uatRel, uatContent, base);
+
+    assert.match(prompt, /\.gsd\/\*\*/);
+    assert.match(prompt, /symlink-backed/i);
+    assert.match(prompt, /do not infer that the GSD harness is missing/i);
+    assert.match(prompt, /use the preloaded UAT context/i);
+  } finally {
+    cleanup(base);
+  }
+});
+
 test('(l) dispatch preconditions via resolveSliceFile', () => {
     const base = createFixtureBase();
     const uatContent = makeUatContent('artifact-driven');