msd-core/tests/observability/event.test.cjs

'use strict';

/**
 * Tests for DispatchEvent shape factory (issue #177).
 *
 * Each test exercises the real module code path and asserts on
 * observable behaviour (return values). No mocks, no vacuous truths.
 */

const { describe, test, beforeEach, afterEach } = require('node:test');
const assert = require('node:assert/strict');

const {
  makeDispatchEvent,
} = require('../../gsd-core/bin/lib/observability/event.cjs');

describe('makeDispatchEvent — shape', () => {
  test('returns an object with required top-level fields', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      args: ['--tdd'],
      result: { kind: 'ok', data: null },
    });

    assert.ok(typeof event.traceId === 'string', 'traceId must be a string');
    assert.ok(typeof event.command === 'string', 'command must be a string');
    assert.ok(typeof event.timestamp === 'string', 'timestamp must be a string');
    assert.ok('result' in event, 'result must be present');
  });

  test('traceId is a UUID v4 (format check)', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
    });
    // UUID v4: xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx
    const uuidV4Re = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
    assert.match(event.traceId, uuidV4Re, `traceId '${event.traceId}' is not a valid UUID v4`);
  });

  test('each call produces a unique traceId', () => {
    const a = makeDispatchEvent({ command: 'plan', result: { kind: 'ok', data: null } });
    const b = makeDispatchEvent({ command: 'plan', result: { kind: 'ok', data: null } });
    assert.notEqual(a.traceId, b.traceId, 'consecutive calls must produce different traceIds');
  });

  test('parentTraceId is undefined when not provided (default, backward-compat with P1.3)', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
    });
    // P1.4: when no parentTraceId supplied, field is still undefined
    assert.strictEqual(event.parentTraceId, undefined, 'parentTraceId must be undefined when not provided');
  });

  test('parentTraceId propagates when provided as a string (P1.4)', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: 'aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee',
    });
    assert.strictEqual(event.parentTraceId, 'aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee',
      'parentTraceId must be propagated when provided as a string');
  });

  test('parentTraceId is undefined when null is passed (defensive normalization)', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: null,
    });
    assert.strictEqual(event.parentTraceId, undefined,
      'null parentTraceId must be normalised to undefined');
  });

  test('non-string parentTraceId is set to undefined for defensive safety', () => {
    // Style choice: surrounding code uses undefined for absent/invalid optional fields
    // (e.g. args is omitted rather than coerced). Consistent policy: non-string → undefined.
    const eventNum = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: 42,
    });
    assert.strictEqual(eventNum.parentTraceId, undefined,
      'number parentTraceId must be normalised to undefined');

    const eventObj = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: { id: 'x' },
    });
    assert.strictEqual(eventObj.parentTraceId, undefined,
      'object parentTraceId must be normalised to undefined');
  });

  test('command is set from input', () => {
    const event = makeDispatchEvent({
      command: 'discuss',
      result: { kind: 'ok', data: null },
    });
    assert.equal(event.command, 'discuss');
  });

  test('timestamp is a valid ISO 8601 string', () => {
    const before = Date.now();
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
    });
    const after = Date.now();
    const parsed = Date.parse(event.timestamp);
    assert.ok(!isNaN(parsed), `timestamp '${event.timestamp}' must parse as a date`);
    assert.ok(parsed >= before, 'timestamp must not be in the past');
    assert.ok(parsed <= after + 5, 'timestamp must not be in the future');
  });

  test('result field is passed through', () => {
    const result = { kind: 'UnknownCommand', command: 'bogus' };
    const event = makeDispatchEvent({ command: 'bogus', result });
    assert.deepStrictEqual(event.result, result);
  });
});

describe('makeDispatchEvent — args field', () => {
  test('args is omitted when not provided', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
    });
    assert.ok(!('args' in event), 'args must not be present when not supplied');
  });

  test('args is omitted when provided (default redaction)', () => {
    // The event factory itself does NOT decide to include args — that is the
    // redaction layer's job. makeDispatchEvent simply stores args as supplied.
    // By default (no includeArgs), args should NOT appear in the returned event.
    const event = makeDispatchEvent({
      command: 'plan',
      args: ['--foo', 'bar'],
      result: { kind: 'ok', data: null },
      includeArgs: false,
    });
    assert.ok(!('args' in event), 'args must be absent when includeArgs is false');
  });

  test('args is included when includeArgs is true', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      args: ['--foo', 'bar'],
      result: { kind: 'ok', data: null },
      includeArgs: true,
    });
    assert.ok('args' in event, 'args must be present when includeArgs is true');
    assert.deepStrictEqual(event.args, ['--foo', 'bar']);
  });
});

describe('makeDispatchEvent — parentTraceId UUID v4 validation', () => {
  const { randomUUID } = require('crypto');

  test('invalid empty string parentTraceId is dropped to undefined', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: '',
    });
    assert.strictEqual(event.parentTraceId, undefined,
      'empty string parentTraceId must be coerced to undefined');
  });

  test('invalid whitespace-only parentTraceId is dropped to undefined', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: '   ',
    });
    assert.strictEqual(event.parentTraceId, undefined,
      'whitespace-only parentTraceId must be coerced to undefined');
  });

  test('invalid non-UUID string parentTraceId is dropped to undefined', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: 'junk',
    });
    assert.strictEqual(event.parentTraceId, undefined,
      '"junk" parentTraceId must be coerced to undefined');
  });

  test('invalid oversized string parentTraceId is dropped to undefined', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: 'a'.repeat(10000),
    });
    assert.strictEqual(event.parentTraceId, undefined,
      '10000-char string parentTraceId must be coerced to undefined');
  });

  test('invalid UUID v1 parentTraceId is dropped to undefined', () => {
    // Version nibble is 1, not 4 — rejected by UUID v4 regex
    const uuidV1Like = 'aaaaaaaa-bbbb-1ccc-8ddd-eeeeeeeeeeee';
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: uuidV1Like,
    });
    assert.strictEqual(event.parentTraceId, undefined,
      'UUID v1 parentTraceId must be dropped to undefined');
  });

  test('invalid UUID v4 missing hyphens parentTraceId is dropped to undefined', () => {
    // 32 hex chars, no hyphens
    const noHyphens = '1234567812345678123456781234567812';
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: noHyphens,
    });
    assert.strictEqual(event.parentTraceId, undefined,
      'UUID v4 missing hyphens must be coerced to undefined');
  });

  test('invalid UUID v4 with extra chars parentTraceId is dropped to undefined', () => {
    const withExtra = randomUUID() + 'x';
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: withExtra,
    });
    assert.strictEqual(event.parentTraceId, undefined,
      'UUID v4 with trailing extra char must be coerced to undefined');
  });

  test('valid UPPERCASE UUID v4 parentTraceId is propagated (case-insensitive)', () => {
    const upperUUID = randomUUID().toUpperCase();
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: upperUUID,
    });
    assert.strictEqual(event.parentTraceId, upperUUID,
      'uppercase UUID v4 parentTraceId must be propagated as-is');
  });

  test('valid lowercase UUID v4 parentTraceId is propagated', () => {
    const lowerUUID = randomUUID(); // crypto.randomUUID() is always lowercase
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: null },
      parentTraceId: lowerUUID,
    });
    assert.strictEqual(event.parentTraceId, lowerUUID,
      'lowercase UUID v4 parentTraceId must be propagated');
  });
});

describe('makeDispatchEvent — result variants', () => {
  test('ok result shape', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'ok', data: 42 },
    });
    assert.equal(event.result.kind, 'ok');
    assert.equal(event.result.data, 42);
  });

  test('UnknownCommand result shape', () => {
    const event = makeDispatchEvent({
      command: 'bogus',
      result: { kind: 'UnknownCommand', command: 'bogus' },
    });
    assert.equal(event.result.kind, 'UnknownCommand');
    assert.equal(event.result.command, 'bogus');
  });

  test('InvalidArgs result shape', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'InvalidArgs', arg: '--bad', reason: 'not recognised' },
    });
    assert.equal(event.result.kind, 'InvalidArgs');
    assert.equal(event.result.arg, '--bad');
  });

  test('HandlerFailure result shape', () => {
    const event = makeDispatchEvent({
      command: 'plan',
      result: { kind: 'HandlerFailure', message: 'boom' },
    });
    assert.equal(event.result.kind, 'HandlerFailure');
    assert.equal(event.result.message, 'boom');
  });
});