Files
msd-core/tests/runtime-bridge-sync-smoke.test.cjs
Tom Boucher 8090456b66 feat(3555): QueryRuntimeBridge.executeForCjs synchronous primitive (Phase 5.0 of #3524)
Phase 5.0 of the CJS↔SDK hard-seam migration (parent #3524).
Foundational PR. Ships ONLY the synchronous primitive on the SDK
runtime bridge plus pinning tests. Per-family CJS router migrations
(state.*, verify.*, init.*, phase.*, phases.*, validate.*,
roadmap.*, frontmatter.*, config.*) become follow-up enhancements
that each reuse this primitive.

## What landed

- sdk/src/runtime-bridge-sync/index.ts (155 lines) — public API.
  Exports executeForCjs(input: RuntimeBridgeExecuteInput):
  RuntimeBridgeSyncResult. Synchronous; lazily creates the
  synckit sync function on first call.
- sdk/src/runtime-bridge-sync/worker.ts (167 lines) — synckit
  worker. Constructs a native-only QueryRuntimeBridge (with
  allowFallbackToSubprocess: false), awaits its async execute,
  catches GSDToolsError / GSDError, maps classification to the
  six ADR-0001 canonical error kinds plus exit code.
- sdk/src/runtime-bridge-sync/index.test.ts (197 lines, 8 vitest
  pinning fixtures) — success path; unknown_command;
  native_failure (shape); validation_error (shape); shape
  invariants; idempotency.
- tests/runtime-bridge-sync-smoke.test.cjs (99 lines, 4
  node:test cases) — proves the primitive works from CJS
  callers via require().

## Decisions

1. Synchronous-bridging mechanism: synckit. Disqualified:
   - deasync: stagnant (68 open issues, single maintainer,
     last release Nov 2025), private Node API (process.binding('uv')),
     untested on Node 22, documented deadlocks with modern
     Promise chains.
   - Sync-native SDK refactor: technically infeasible —
     acquireStateLock in state-mutation.ts uses await setTimeout
     for retry backoff; making that fully sync requires either
     Atomics.wait (which IS synckit), busy-loop (degrades
     responsiveness), or breaking 100+ SDK consumers.
   Synckit (v0.11.12) is pure JS, actively maintained (last
   push today), stable public APIs (Atomics.wait +
   SharedArrayBuffer), Node 22 compatible, no native compile.

2. Native-only transport inside the worker. The sync bridge
   uses allowFallbackToSubprocess: false. Unknown commands
   surface as unknown_command instead of spawning gsd-sdk.
   Keeps the worker self-contained and predictable.

3. Worker path resolution. resolveWorkerPath() navigates ../..
   from the loaded module URL to land at
   dist/runtime-bridge-sync/worker.js — works under both
   vitest (loads src) and CJS consumers (load dist).

4. GSDError.Blocked → validation_error. ADR-0001's 6-kind
   taxonomy has no `blocked` kind; Blocked classification is
   mapped onto validation_error since the operational shape
   matches (prerequisite missing).

## Numbers

- 8 SDK vitest pinning tests pass.
- 4 CJS smoke tests pass.
- Full suite: 9286/9286 pass (baseline 9282; +4 from the
  new smoke test cases).
- SDK vitest unit: 1860/1860 pass.
- Performance: 80ms first-call cold latency (Worker startup +
  bridge construction); 0.1ms steady-state per-call latency
  (10-call average after warmup). Well within budget for CJS
  dispatcher overhead.

## Canonical error kind coverage

- unknown_command: covered with pinning fixture
- native_failure: shape coverage (handler that throws)
- validation_error: shape coverage (GSDError.Validation +
  GSDError.Blocked)
- internal_error: shape coverage only (eliciting TypeError
  reliably from a registered handler requires elaborate fixture)
- native_timeout: NOT pinned (no registered handler genuinely
  times out; classification logic present in worker)
- fallback_failure: NOT pinned (subprocess fallback disabled
  by design in sync bridge)

The classification logic is in the worker regardless; per-family
migration PRs will exercise the unpinned kinds incidentally.

## Wiring

- sdk/package.json: synckit ^0.11.12 added as runtime
  dependency (not devDependency — it's required at runtime
  whenever a CJS caller invokes executeForCjs).
- sdk/package-lock.json: regenerated.
- CONTEXT.md: new "Sync Runtime Bridge Module" entry added
  after Dispatch Policy Module. Existing "CJS Command Router
  Adapter Module" entry amended with one sentence pointing at
  the primitive and the per-family migration roadmap.

No generator/freshness check needed for this phase — the
primitive IS the SDK (not a generated CJS mirror).

Closes #3555.
2026-05-15 11:10:03 -04:00

100 lines
3.8 KiB
JavaScript

'use strict';
/**
* CJS smoke test for the executeForCjs synchronous primitive (Phase 5.0 #3555).
*
* Verifies that the compiled dist artifact can be required from a CJS context
* and that executeForCjs returns the expected result shape synchronously.
*
* This is the critical end-to-end proof that the primitive works for CJS callers
* — the actual point of Phase 5.0.
*/
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const path = require('node:path');
const REPO_ROOT = path.join(__dirname, '..');
const BRIDGE_PATH = path.join(REPO_ROOT, 'sdk', 'dist', 'runtime-bridge-sync', 'index.js');
describe('runtime-bridge-sync CJS smoke test', () => {
test('executeForCjs is exported and is a function', async () => {
// Use dynamic import because Node 24 supports require() of ESM but
// the module is ESM (NodeNext output). Dynamic import works in all contexts.
const mod = await import(BRIDGE_PATH);
assert.strictEqual(typeof mod.executeForCjs, 'function', 'executeForCjs must be a function');
});
test('executeForCjs returns ok:true for generate-slug (success path)', async () => {
const { executeForCjs } = await import(BRIDGE_PATH);
const result = executeForCjs({
registryCommand: 'generate-slug',
registryArgs: ['My Smoke Test Phase'],
legacyCommand: 'generate-slug',
legacyArgs: ['My Smoke Test Phase'],
mode: 'json',
projectDir: '/tmp',
});
// The returned value must be a plain object, not a Promise
assert.strictEqual(typeof result, 'object', 'result must be an object');
assert.ok(!(result instanceof Promise), 'result must not be a Promise');
assert.ok('ok' in result, 'result must have ok property');
assert.strictEqual(result.ok, true, 'expected ok:true');
assert.strictEqual(result.exitCode, 0, 'expected exitCode:0');
assert.ok(result.data != null, 'expected data to be non-null');
const data = result.data;
assert.strictEqual(typeof data, 'object', 'data must be an object');
assert.strictEqual(data.slug, 'my-smoke-test-phase', 'expected slug');
});
test('executeForCjs returns ok:false for unknown command', async () => {
const { executeForCjs } = await import(BRIDGE_PATH);
const result = executeForCjs({
registryCommand: '__smoke_test_unknown_command__',
registryArgs: [],
legacyCommand: '__smoke_test_unknown_command__',
legacyArgs: [],
mode: 'json',
projectDir: '/tmp',
});
assert.strictEqual(typeof result, 'object', 'result must be an object');
assert.ok(!(result instanceof Promise), 'result must not be a Promise');
assert.strictEqual(result.ok, false, 'expected ok:false');
assert.ok(result.exitCode !== 0, 'expected non-zero exitCode');
assert.ok('errorKind' in result, 'expected errorKind property');
assert.strictEqual(result.errorKind, 'unknown_command', 'expected unknown_command errorKind');
assert.ok(Array.isArray(result.stderrLines), 'expected stderrLines array');
});
test('executeForCjs result shape matches RuntimeBridgeSyncResult discriminated union', async () => {
const { executeForCjs } = await import(BRIDGE_PATH);
// Success shape
const success = executeForCjs({
registryCommand: 'current-timestamp',
registryArgs: ['date'],
legacyCommand: 'current-timestamp',
legacyArgs: ['date'],
mode: 'json',
projectDir: '/tmp',
});
assert.ok('ok' in success, 'success result must have ok');
if (success.ok) {
assert.strictEqual(success.exitCode, 0);
assert.ok('data' in success);
} else {
// current-timestamp might fail if args aren't what it expects; just check shape
assert.ok('errorKind' in success);
assert.ok('stderrLines' in success);
assert.ok(Array.isArray(success.stderrLines));
}
});
});