fix(#2620): inject the reference DispatchLogger on the live dispatch seam when observability is enabled (#2621)

* fix(#2620): inject the reference DispatchLogger on the live dispatch seam when observability is enabled

The Command Routing Hub defaulted to createNoOpLogger and no caller ever
injected createDefaultLogger, so GSD_AUDIT=1 wrote nothing and failed
dispatches emitted no structured JSON to stderr — contradicting ADR-0174
§5/§6, CONTEXT.md's Dispatch Observability Module contract, and
docs/CONFIGURATION.md.

Inject the reference logger at both live createHub() sites, gated on the
existing opt-in signal (newly exported isAuditEnabled). When observability
is off no logger is injected, so the Hub keeps its no-op fallback and
default output stays byte-for-byte identical. Enabling stderr-on-error
unconditionally adds a second line to the --json-errors envelope that
callers parse as exactly one JSON line, so that is deferred to its own
increment under #2619.

* chore(#2620): add changeset for the dispatch logger wiring fix

* test(#2620): cover the phase seam and drop try/finally from the adapter test

Two review findings from the #2621 round-1 review.

The fix wires the logger at BOTH live createHub() seams, but only
cjs-command-router-adapter was exercised. Adds a fail-first regression test
for src/phase-command-router.cts:258 — verified RED against a tree with that
hunk reverted (1 fail, exact assertion) and GREEN with it restored — plus a
negative pin that no trace file appears when GSD_AUDIT is unset. The negative
case passes pre-fix and is a pin, not fail-first.

CONTRIBUTING.md:344 forbids try/finally inside test bodies; the new adapter
test used it. Converted to the Pattern-2 t.after() form, switched to the
centralized createTempDir helper, and removed the now-unused os require.

* chore(#2620): scope the changeset to the activation path that actually ships

The fragment claimed config.audit.enabled activates the audit trail. It
cannot: both seams call isAuditEnabled() with zero arguments, so the
config branch in _isAuditEnabled is unreachable from production, and
src/config-schema.cts registers no audit key at all — a user setting it
would be silently dropped. That string ships in the user-facing CHANGELOG.

Scoped to GSD_AUDIT=1, which is what actually works. The missing schema key
stays a disclosed deferred sub-defect on #2620. Also adds the (#2620) issue
backlink the other fragments carry.

* docs(#2620): correct the fork-leaked issue reference in the wiring comments

Four files cited this fix as #26, the issue number from the fork where the
change was first written. Upstream #26 is an unrelated closed SDK issue, and
next already uses #26 with that meaning in src/validate.cts:17,29,42 and
src/config.cts:474, so these references pointed somewhere real and wrong
rather than merely dangling. Baked into permanent doc comments, they reach
users compiled via the ADR-457 build-at-publish path.

The changeset and tests/phase-command-router.test.cjs already cited #2620;
this brings the remaining four files into line.

Comment-only, no behaviour change. build:lib produces no generated drift. The
rename is scoped to these four files so the pre-existing SDK #26 references in
validate.cts, config.cts, health-validation.test.cjs and config.test.cjs are
deliberately left untouched.

---------

Co-authored-by: CI Rebase Check <ci@gsd-redux>
This commit is contained in:
Rezolv
2026-07-28 18:02:17 -04:00
committed by GitHub
parent 16e59d0db5
commit 0997d4f443
6 changed files with 167 additions and 4 deletions

View File

@@ -0,0 +1,5 @@
---
type: Fixed
pr: 2621
---
**`GSD_AUDIT=1` now actually produces an audit trail** — the reference dispatch logger is wired onto the live command seam, so opting in yields the documented structured stderr line and the `.planning/.gsd-trace.jsonl` audit trail. Previously the seam built its dispatch hub without a logger, so it fell back to a no-op and the opt-in signal was inert with no indication why. With observability off, dispatch output is byte-for-byte unchanged. (#2620)

View File

@@ -13,6 +13,17 @@
// eslint-disable-next-line @typescript-eslint/no-require-imports
import commandRoutingHub = require('./command-routing-hub.cjs');
const { createHub, ERROR_KINDS } = commandRoutingHub;
// #2620 (ADR-0174 §6): the Hub defaults to a no-op logger and the live CLI
// dispatch path never injected the reference DispatchLogger, so GSD_AUDIT and
// config.audit.enabled were inert. Inject the reference logger ONLY when
// observability is opt-in enabled; when off, inject nothing so the Hub stays
// byte-for-byte silent (preserving the default dispatch output contract, incl.
// --json-errors). Enabling stderr-on-error unconditionally by default is a
// separate, blast-radius-bearing change (it adds a second stderr line to the
// --json-errors envelope) — deferred as its own follow-up.
// eslint-disable-next-line @typescript-eslint/no-require-imports
import observabilityLogger = require('./observability/logger.cjs');
const { createDefaultLogger, isAuditEnabled } = observabilityLogger;
// Phase 2 (#1646): import ERROR_REASON so the UnknownCommand translation can
// pass `sdk_unknown_command` as the second arg to error(), preserving the
// JSON-error envelope contract that capability routers' tests assert on.
@@ -134,6 +145,10 @@ function routeHubCommandFamily({
const hub = createHub({
cjsRegistry: { [family]: registryHandlers },
manifest: { [family]: available },
// #2620: wire the reference logger onto the live dispatch path (ADR-0174 §6),
// but only when observability is opt-in enabled — otherwise leave it unset
// so the Hub falls back to the no-op logger and stays byte-for-byte silent.
logger: isAuditEnabled() ? createDefaultLogger({ cwd }) : undefined,
});
const result = hub.dispatch({

View File

@@ -42,9 +42,14 @@ function _safeStringify(value: unknown): string {
}
/**
* Determine whether the audit file should be written to.
* Determine whether observability is opt-in enabled — via the GSD_AUDIT env var
* or config.audit.enabled. Exported (#2620) so the live dispatch seam can decide
* whether to inject the reference logger at all: when observability is off we
* inject nothing (the Hub stays byte-for-byte silent, preserving the default
* dispatch output contract, incl. --json-errors); when on, the caller injects
* createDefaultLogger and gets the stderr-on-error line + opt-in file audit.
*/
function _isAuditEnabled(config: { audit?: { enabled?: boolean } } | undefined): boolean {
function _isAuditEnabled(config?: { audit?: { enabled?: boolean } }): boolean {
if (process.env['GSD_AUDIT'] === '1') return true;
if (config && config.audit && config.audit.enabled === true) return true;
return false;
@@ -163,4 +168,4 @@ function createDefaultLogger({ cwd = process.cwd(), config }: DefaultLoggerOptio
};
}
export = { createDefaultLogger, createNoOpLogger };
export = { createDefaultLogger, createNoOpLogger, isAuditEnabled: _isAuditEnabled };

View File

@@ -21,6 +21,12 @@ import { PHASE_SUBCOMMANDS } from './command-aliases.cjs';
// eslint-disable-next-line @typescript-eslint/no-require-imports
import commandRoutingHub = require('./command-routing-hub.cjs');
const { createHub, ERROR_KINDS, makeInvalidArgs } = commandRoutingHub;
// #2620 (ADR-0174 §6): inject the reference DispatchLogger on the live phase
// dispatch path, but only when observability is opt-in enabled; otherwise the
// Hub stays byte-for-byte silent via its no-op fallback.
// eslint-disable-next-line @typescript-eslint/no-require-imports
import observabilityLogger = require('./observability/logger.cjs');
const { createDefaultLogger, isAuditEnabled } = observabilityLogger;
// ─── Types ────────────────────────────────────────────────────────────────────
@@ -246,7 +252,10 @@ function routePhaseCommand({ phase, args, cwd, raw, error }: RoutePhaseCommandOp
// ── Construct hub ──────────────────────────────────────────────────────────
// #175: Hub is CJS-only — no mode param, no sdkLoader.
const hub = createHub({ cjsRegistry, manifest });
// #2620: wire the reference logger (ADR-0174 §6) only when observability is
// opt-in enabled; otherwise leave it unset so the Hub stays byte-for-byte
// silent via its no-op fallback.
const hub = createHub({ cjsRegistry, manifest, logger: isAuditEnabled() ? createDefaultLogger({ cwd }) : undefined });
// ── Dispatch ────────────────────────────────────────────────────────────────
const result = hub.dispatch({

View File

@@ -629,3 +629,56 @@ describe('bug #3631 — SDK family routers forward --raw to output()', () => {
});
});
}
// ────────────────────────────────────────────────────────────────────────
// Regression for #2620 — the live adapter must inject a real DispatchLogger
// (ADR-0174 §6: "DispatchLogger is injected; the Hub emits DispatchEvent on
// every dispatch path"). Before the fix, routeHubCommandFamily built the Hub
// with no logger, so it fell back to createNoOpLogger and GSD_AUDIT was inert.
// ────────────────────────────────────────────────────────────────────────
{
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const { routeHubCommandFamily } = require('../gsd-core/bin/lib/cjs-command-router-adapter.cjs');
const { createTempDir, cleanup } = require('./helpers.cjs');
describe('cjs-command-router-adapter — observability logger wiring (#2620)', () => {
test('a dispatch through the live adapter writes the opt-in audit trail when GSD_AUDIT=1', (t) => {
const tmp = createTempDir('gsd-obs-wire-');
const prev = process.env.GSD_AUDIT;
t.after(() => {
if (prev === undefined) delete process.env.GSD_AUDIT;
else process.env.GSD_AUDIT = prev;
cleanup(tmp);
});
process.env.GSD_AUDIT = '1';
routeHubCommandFamily({
family: 'unit',
args: ['unit', 'ok'],
subcommands: ['ok'],
handlers: { ok: () => {} },
unknownMessage: (subcommand, available) => `Unknown ${subcommand}. Available: ${available.join(', ')}`,
error: () => {},
cwd: tmp,
raw: false,
});
const auditPath = path.join(tmp, '.planning', '.gsd-trace.jsonl');
assert.ok(
fs.existsSync(auditPath),
'GSD_AUDIT=1 must produce .planning/.gsd-trace.jsonl — the adapter must build the Hub with a real DispatchLogger (ADR-0174 §6), not createNoOpLogger'
);
const lines = fs.readFileSync(auditPath, 'utf8').trim().split(/\r?\n/).filter(Boolean);
assert.ok(lines.length > 0, 'at least one dispatch event must be recorded');
assert.equal(lines.length, 1, 'exactly one dispatch event must be recorded');
const event = JSON.parse(lines[0]);
assert.equal(event.result.kind, 'ok', 'a successful dispatch is recorded with result.kind === "ok"');
assert.ok(typeof event.command === 'string' && event.command.length > 0, 'event carries the dispatched command');
assert.ok(typeof event.traceId === 'string' && event.traceId.length > 0, 'event carries a traceId');
assert.ok(typeof event.timestamp === 'string' && event.timestamp.length > 0, 'event carries an ISO timestamp');
});
});
}

View File

@@ -564,3 +564,79 @@ describe('bug-1437 — phase.list-plans is wired in gsd-tools', () => {
});
});
}
// ─── 6. Observability logger wiring (#2620) ──────────────────────────────────
//
// The fix wires the reference DispatchLogger at BOTH live createHub() seams.
// The sibling seam (cjs-command-router-adapter) is covered in its own file;
// this pins the phase seam so a later refactor that drops the isAuditEnabled()
// gate or the injection here cannot reintroduce the #2620 defect silently.
{
const fs = require('node:fs');
const path = require('node:path');
const { createTempDir, cleanup } = require('./helpers.cjs');
describe('phase-command-router — observability logger wiring (#2620)', () => {
test('a dispatch through the phase seam writes the opt-in audit trail when GSD_AUDIT=1', (t) => {
const tmp = createTempDir('gsd-obs-phase-');
const prevAudit = process.env.GSD_AUDIT;
t.after(() => {
if (prevAudit === undefined) delete process.env.GSD_AUDIT;
else process.env.GSD_AUDIT = prevAudit;
cleanup(tmp);
});
process.env.GSD_AUDIT = '1';
const phase = makePhase({ cmdPhaseNextDecimal: () => {} });
routePhaseCommand({
phase,
args: ['phase', 'next-decimal', '5'],
cwd: tmp,
raw: false,
error: (m) => { throw new Error(m); },
});
const auditPath = path.join(tmp, '.planning', '.gsd-trace.jsonl');
assert.ok(
fs.existsSync(auditPath),
'GSD_AUDIT=1 must produce .planning/.gsd-trace.jsonl — the phase router must build the Hub with a real DispatchLogger (ADR-0174 §6), not createNoOpLogger'
);
const lines = fs.readFileSync(auditPath, 'utf8').trim().split(/\r?\n/).filter(Boolean);
assert.ok(lines.length > 0, 'at least one dispatch event must be recorded');
assert.equal(lines.length, 1, 'exactly one dispatch event must be recorded');
const event = JSON.parse(lines[0]);
assert.equal(event.result.kind, 'ok', 'a successful dispatch is recorded with result.kind === "ok"');
assert.ok(typeof event.command === 'string' && event.command.length > 0, 'event carries the dispatched command');
assert.ok(typeof event.traceId === 'string' && event.traceId.length > 0, 'event carries a traceId');
assert.ok(typeof event.timestamp === 'string' && event.timestamp.length > 0, 'event carries an ISO timestamp');
});
test('no audit trail is written when GSD_AUDIT is unset (Hub stays silent via the no-op fallback)', (t) => {
const tmp = createTempDir('gsd-obs-phase-off-');
const prevAudit = process.env.GSD_AUDIT;
t.after(() => {
if (prevAudit === undefined) delete process.env.GSD_AUDIT;
else process.env.GSD_AUDIT = prevAudit;
cleanup(tmp);
});
delete process.env.GSD_AUDIT;
const phase = makePhase({ cmdPhaseNextDecimal: () => {} });
routePhaseCommand({
phase,
args: ['phase', 'next-decimal', '5'],
cwd: tmp,
raw: false,
error: (m) => { throw new Error(m); },
});
assert.equal(
fs.existsSync(path.join(tmp, '.planning', '.gsd-trace.jsonl')),
false,
'without the opt-in signal the seam must leave no audit artifact'
);
});
});
}