@opengsd/gsd-pi 1.2.0-dev.84c56d87 → 1.2.0-dev.8e6112e9

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

@@ -0,0 +1,148 @@
+// Engine hook contract: which tool lifecycle hooks fire under which engine,
+// and the consolidated tool-name normalizer seam.
+//
+// 1. Pins the contract arrays (engine-hook-contract.ts) so a change to the
+//    fire matrix is a deliberate, reviewed act.
+// 2. Source-scans register-hooks.ts (in the style of
+//    single-writer-invariant.test.ts) to assert that the concerns documented
+//    as universally mirrored — evidence collection and write-gate (re-)arming —
+//    actually live inside a tool_execution_start handler, not only in the
+//    native-only tool_call handlers.
+// 3. Pins normalizer parity: canonicalHeadlessToolName delegates to
+//    canonicalToolName (strip-only), and canonicalWorkflowToolName adds alias
+//    resolution on top of the same strip.
+
+import test from "node:test";
+import assert from "node:assert/strict";
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+
+import {
+  UNIVERSAL_TOOL_HOOKS,
+  NATIVE_ONLY_TOOL_HOOKS,
+  canonicalToolName,
+  canonicalWorkflowToolName,
+} from "../engine-hook-contract.js";
+import { canonicalHeadlessToolName } from "../../../../headless-events.js";
+import { WORKFLOW_TOOL_ALIAS_PAIRS } from "../workflow-tool-surface.js";
+
+test("contract arrays pin the verified fire matrix", () => {
+  assert.deepEqual([...UNIVERSAL_TOOL_HOOKS], ["tool_execution_start", "tool_execution_end"]);
+  assert.deepEqual([...NATIVE_ONLY_TOOL_HOOKS], ["tool_call", "tool_result"]);
+});
+
+// ---------------------------------------------------------------------------
+// Source scan: register-hooks.ts must mirror safety concerns universally
+// ---------------------------------------------------------------------------
+
+const registerHooksSource = readFileSync(
+  join(process.cwd(), "src/resources/extensions/gsd/bootstrap/register-hooks.ts"),
+  "utf8",
+);
+
+/**
+ * Extract the body of every `pi.on("<eventName>", ...)` registration by
+ * scanning balanced parentheses from each registration site.
+ */
+function hookBodies(source: string, eventName: string): string[] {
+  const bodies: string[] = [];
+  const marker = `pi.on("${eventName}"`;
+  let from = 0;
+  for (;;) {
+    const start = source.indexOf(marker, from);
+    if (start < 0) break;
+    let depth = 0;
+    let end = -1;
+    // Scan from pi.on's own opening paren so the whole registration is balanced.
+    for (let i = start + "pi.on".length; i < source.length; i++) {
+      const ch = source[i];
+      if (ch === "(") depth++;
+      else if (ch === ")") {
+        depth--;
+        if (depth === 0) {
+          end = i;
+          break;
+        }
+      }
+    }
+    assert.ok(end > start, `unbalanced pi.on("${eventName}") registration`);
+    bodies.push(source.slice(start, end + 1));
+    from = end + 1;
+  }
+  return bodies;
+}
+
+test("tool_execution_start handler mirrors evidence collection and write-gate arming", () => {
+  const bodies = hookBodies(registerHooksSource, "tool_execution_start");
+  assert.ok(bodies.length >= 1, "register-hooks.ts must register a tool_execution_start handler");
+  const merged = bodies.join("\n");
+
+  // Evidence collection: the safety harness records the call on the universal
+  // hook (deduped by toolCallId against the native-only tool_call recording).
+  assert.match(merged, /safetyRecordToolCall\(/);
+  assert.match(merged, /saveEvidenceToDisk\(/);
+
+  // Write-gate (re-)arming: external engines never reach the tool_call
+  // deferApprovalGate path, so the durable pending gate must be armed here.
+  assert.match(merged, /hostWriteGateAdapter\.setPending\(/);
+});
+
+test("mirrored concerns also exist on the native-only tool_call side (dedup pairing)", () => {
+  const bodies = hookBodies(registerHooksSource, "tool_call");
+  assert.ok(bodies.length >= 1, "register-hooks.ts must register tool_call handlers");
+  const merged = bodies.join("\n");
+  assert.match(merged, /safetyRecordToolCall\(/);
+  assert.match(merged, /deferApprovalGate\(/);
+});
+
+test("tool_execution_end handler mirrors error classification and evidence persistence", () => {
+  const bodies = hookBodies(registerHooksSource, "tool_execution_end");
+  assert.ok(bodies.length >= 1, "register-hooks.ts must register a tool_execution_end handler");
+  const merged = bodies.join("\n");
+  assert.match(merged, /recordToolInvocationError\(/);
+  assert.match(merged, /safetyRecordToolResult\(/);
+});
+
+// ---------------------------------------------------------------------------
+// Normalizer parity
+// ---------------------------------------------------------------------------
+
+test("canonicalHeadlessToolName matches canonicalToolName on the edge-case table", () => {
+  const cases: Array<{ input: string; expected: string }> = [
+    { input: "mcp__server__tool", expected: "tool" },
+    { input: "mcp__gsd-workflow__gsd_status", expected: "gsd_status" },
+    { input: "plain", expected: "plain" },
+    { input: "ask_user_questions", expected: "ask_user_questions" },
+    // Nested underscores: only the first server/tool delimiter splits.
+    { input: "mcp__s__a__b", expected: "a__b" },
+    { input: "", expected: "" },
+    { input: "mcp__", expected: "mcp__" },
+    // Malformed names stay unchanged (strict parser: empty server/tool → no strip).
+    { input: "mcp____tool", expected: "mcp____tool" },
+    { input: "mcp__server__", expected: "mcp__server__" },
+  ];
+  for (const { input, expected } of cases) {
+    assert.equal(canonicalToolName(input), expected, `canonicalToolName(${JSON.stringify(input)})`);
+    assert.equal(
+      canonicalHeadlessToolName(input),
+      canonicalToolName(input),
+      `headless/strip parity for ${JSON.stringify(input)}`,
+    );
+  }
+  assert.equal(canonicalHeadlessToolName(undefined), "");
+});
+
+test("canonicalWorkflowToolName = prefix strip + workflow alias resolution", () => {
+  // Non-alias names behave exactly like canonicalToolName.
+  for (const name of ["mcp__server__tool", "plain", "mcp__s__a__b"]) {
+    assert.equal(canonicalWorkflowToolName(name), canonicalToolName(name));
+  }
+  // Alias names additionally resolve to the canonical workflow tool.
+  assert.ok(WORKFLOW_TOOL_ALIAS_PAIRS.length > 0, "expected at least one workflow alias");
+  for (const { alias, canonical } of WORKFLOW_TOOL_ALIAS_PAIRS) {
+    assert.equal(canonicalWorkflowToolName(alias), canonical);
+    assert.equal(canonicalWorkflowToolName(`mcp__gsd-workflow__${alias}`), canonical);
+    // Plain strip must NOT resolve aliases — that distinction is the seam.
+    assert.equal(canonicalToolName(alias), alias);
+  }
+});

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');