2d14eb8873
* test(#177): add DispatchEvent factory failing tests Red tests for makeDispatchEvent shape, traceId UUID v4, uniqueness, parentTraceId-always-undefined (P1.3), args redaction toggle, ISO 8601 timestamp, and all result variant passthrough. * feat(#177): introduce DispatchEvent factory makeDispatchEvent produces an immutable event record per dispatch: - traceId: crypto.randomUUID() (UUID v4) - parentTraceId: always undefined (P1.4 wires composer) - command, result, timestamp (ISO 8601) - args only included when includeArgs === true (default: omitted) * test(#177): add arg redaction policy failing tests Red tests for shouldIncludeArgs (GSD_AUDIT_ARGS env gating) and redactEvent (strips args from frozen events, preserves all other fields, returns a new object, never mutates the source). * feat(#177): introduce arg redaction policy shouldIncludeArgs(): only GSD_AUDIT_ARGS==='1' opts in; all other values (unset, '', '0', 'true') default to omitting args. redactEvent(event): returns a shallow copy of the event, dropping the args field unless opted in. Never mutates the (frozen) source event. * test(#177): add DispatchLogger interface failing tests Red tests covering: - no-op logger: silent on all events, never throws - default logger: silent on ok, one flattened JSON line to stderr on error - default logger: audit file creation + append-only + redaction + config gate - GSD_AUDIT env var and config.audit.enabled config gate - GSD_AUDIT_ARGS opt-in for args inclusion All tests use real fs under os.tmpdir() — no mocked appendFileSync. * feat(#177): introduce DispatchLogger with default and no-op implementations createNoOpLogger(): silent on all events — Hub default when no logger injected. createDefaultLogger({ cwd, config }): - Silent on ok result - Flattened JSON line to stderr on error: { kind, traceId, ...typedPayload } - Append-only audit at .planning/.gsd-trace.jsonl when GSD_AUDIT=1 or config.audit.enabled - Args redacted by default; GSD_AUDIT_ARGS=1 opts in - Logger errors caught internally; never break dispatch callers * test(#177): add Hub+logger integration failing tests Red tests verifying: - onEvent called exactly once per dispatch (ok, error, handler-throw, unknown) - DispatchEvent shape: traceId uniqueness, command, result.kind, parentTraceId - Logger errors contained (dispatch still returns Result, warn line to stderr) - Hub defaults to no-op when no logger injected - End-to-end with createDefaultLogger: silent on success, stderr on error, audit file * feat(#177): wire DispatchLogger into CommandRoutingHub Add optional logger param to createHub({ ..., logger }). Defaults to createNoOpLogger() — silent, no behaviour change for callers that don't inject a logger. After every dispatch (success and error): - Normalises HubResult { ok } to DispatchEvent { kind: 'ok'|error-kind } - Calls makeDispatchEvent({ command, args, result }) to mint the event - Calls logger.onEvent(event) exactly once - Wraps in try/catch: logger errors emit { level:'warn', source:'DispatchLogger' } to stderr but never propagate to dispatch callers * chore(#177): gitignore .planning/.gsd-trace.jsonl audit file The audit trail is local-only, append-only, and must never be committed. Slotted under the existing "Local scratch + Claude-test artifacts" block. * docs(#177): document GSD_AUDIT, GSD_AUDIT_ARGS, config.audit.enabled New ## Observability section at end of CONFIGURATION.md covering: - Default silent/stderr behaviour overview - Stderr error JSON format - Audit file opt-in (env var and config key) - Args redaction policy and GSD_AUDIT_ARGS opt-in Also slots GSD_AUDIT and GSD_AUDIT_ARGS into the existing ## Environment Variables table (alphabetical order). * chore(#177): add changeset for observability seam type: Added — new DispatchLogger seam with default silent/stderr/audit behaviour.
48 lines
1.6 KiB
JavaScript
48 lines
1.6 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* DispatchEvent shape factory — issue #177 (ADR-0174 P1.3).
|
|
*
|
|
* Creates a structured event record for every Hub dispatch, used by
|
|
* DispatchLogger to emit stderr errors and opt-in file audit trails.
|
|
*
|
|
* Shape:
|
|
* traceId: string — UUID v4, generated per dispatch
|
|
* parentTraceId: undefined — always undefined in P1.3; P1.4 wires the composer
|
|
* command: string — the dispatched verb
|
|
* args?: unknown — only present when includeArgs === true
|
|
* result: { kind: 'ok' | 'UnknownCommand' | 'InvalidArgs' | 'HandlerRefusal' | 'HandlerFailure', ...payload }
|
|
* timestamp: string — ISO 8601
|
|
*/
|
|
|
|
const { randomUUID } = require('crypto');
|
|
|
|
/**
|
|
* Create a DispatchEvent.
|
|
*
|
|
* @param {object} opts
|
|
* @param {string} opts.command - The dispatched command verb.
|
|
* @param {unknown} [opts.args] - Raw args passed to the hub.
|
|
* @param {object} opts.result - The HubResult returned by the hub.
|
|
* @param {boolean} [opts.includeArgs=false] - When true, include args in the event.
|
|
* @param {string} [opts.parentTraceId] - Ignored in P1.3; always yields undefined.
|
|
* @returns {object} Immutable DispatchEvent record.
|
|
*/
|
|
function makeDispatchEvent({ command, args, result, includeArgs = false, parentTraceId: _ignored }) {
|
|
const event = {
|
|
traceId: randomUUID(),
|
|
parentTraceId: undefined,
|
|
command: String(command),
|
|
result,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
if (includeArgs && args !== undefined) {
|
|
event.args = args;
|
|
}
|
|
|
|
return Object.freeze(event);
|
|
}
|
|
|
|
module.exports = { makeDispatchEvent };
|