vercel__workflow/packages/web-shared/test/trace-builder-v1.test.ts

import type { Event, WorkflowRun } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import {
  buildTrace,
  groupEventsByCorrelation,
} from '../src/lib/trace-builder.js';
import type { Span } from '../src/lib/trace-types.js';

/** Spans carry `[seconds, nanoseconds]`; assertions below are in milliseconds. */
function durationMs(span: Span): number {
  return span.duration[0] * 1000 + span.duration[1] / 1_000_000;
}

const BASE_TIME = new Date('2026-03-16T00:00:00Z');
const STARTED_TIME = new Date('2026-03-16T00:00:01Z');
const COMPLETED_TIME = new Date('2026-03-16T00:00:10Z');

function makeV1Run(overrides: Partial<WorkflowRun> = {}): WorkflowRun {
  return {
    runId: 'wrun_v1test',
    deploymentId: 'dep_1',
    workflowName: 'v1-workflow',
    specVersion: 1,
    input: {},
    createdAt: BASE_TIME,
    updatedAt: COMPLETED_TIME,
    startedAt: STARTED_TIME,
    completedAt: COMPLETED_TIME,
    status: 'completed',
    output: { result: 'ok' },
    error: undefined,
    executionContext: {},
    expiredAt: undefined,
    ...overrides,
  } as WorkflowRun;
}

/** V2-style step events (includes step_created) */
function makeStepEvents(
  correlationId: string,
  stepName: string,
  startOffset: number,
  endOffset: number
): Event[] {
  return [
    {
      eventId: `evnt_${correlationId}_created`,
      runId: 'wrun_v1test',
      eventType: 'step_created',
      correlationId,
      createdAt: new Date(BASE_TIME.getTime() + startOffset),
      specVersion: 1,
      eventData: { stepName, input: {} },
    },
    {
      eventId: `evnt_${correlationId}_started`,
      runId: 'wrun_v1test',
      eventType: 'step_started',
      correlationId,
      createdAt: new Date(BASE_TIME.getTime() + startOffset + 100),
      specVersion: 1,
    },
    {
      eventId: `evnt_${correlationId}_completed`,
      runId: 'wrun_v1test',
      eventType: 'step_completed',
      correlationId,
      createdAt: new Date(BASE_TIME.getTime() + endOffset),
      specVersion: 1,
      eventData: { result: 42 },
    },
  ] as Event[];
}

/** V1-style step events (no step_created — only step_started + step_completed) */
function makeV1StepEvents(
  correlationId: string,
  startOffset: number,
  endOffset: number
): Event[] {
  return [
    {
      eventId: `evnt_${correlationId}_started`,
      runId: 'wrun_v1test',
      eventType: 'step_started',
      correlationId,
      createdAt: new Date(BASE_TIME.getTime() + startOffset),
      specVersion: 1,
    },
    {
      eventId: `evnt_${correlationId}_completed`,
      runId: 'wrun_v1test',
      eventType: 'step_completed',
      correlationId,
      createdAt: new Date(BASE_TIME.getTime() + endOffset),
      specVersion: 1,
      eventData: { result: 42 },
    },
  ] as Event[];
}

describe('Trace viewer with v1 events (no run lifecycle events)', () => {
  describe('groupEventsByCorrelation', () => {
    it('groups step events with no run-level events for v1', () => {
      const events = makeStepEvents('step_1', 'add', 1000, 3000);
      const grouped = groupEventsByCorrelation(events);

      expect(grouped.runLevelEvents).toHaveLength(0);
      expect(grouped.eventsByStepId.size).toBe(1);
      expect(grouped.eventsByStepId.get('step_1')).toHaveLength(3);
    });
  });

  describe('buildTrace', () => {
    it('builds a valid trace for a completed v1 run with step events', () => {
      const run = makeV1Run({ status: 'completed' });
      const events = makeStepEvents('step_1', 'add', 1000, 3000);
      const now = new Date('2026-03-16T00:01:00Z');
      const trace = buildTrace(run, events, now);

      expect(trace.traceId).toBe('wrun_v1test');
      expect(trace.rootSpanId).toBe('wrun_v1test');
      expect(trace.spans).toHaveLength(2);

      const runSpan = trace.spans.find((s) => s.spanId === 'wrun_v1test');
      expect(runSpan).toBeDefined();
      expect(runSpan!.attributes.resource).toBe('run');
      expect(runSpan!.attributes.data).toMatchObject({
        status: 'completed',
        completedAt: COMPLETED_TIME,
      });
    });

    it('builds a valid trace for a failed v1 run', () => {
      const run = makeV1Run({
        status: 'failed',
        output: undefined,
        error: { message: 'boom' },
      });
      const events = makeStepEvents('step_1', 'add', 1000, 3000);
      const trace = buildTrace(run, events, new Date());

      const runSpan = trace.spans.find((s) => s.spanId === 'wrun_v1test');
      expect(runSpan!.attributes.data).toMatchObject({ status: 'failed' });
    });

    it('builds a valid trace for a v1 run with no events at all', () => {
      const run = makeV1Run({ status: 'completed' });
      const trace = buildTrace(run, [], new Date());

      expect(trace.spans).toHaveLength(1);
      expect(trace.spans[0].spanId).toBe('wrun_v1test');
      expect(trace.spans[0].attributes.resource).toBe('run');
    });

    it('builds step spans from v1 events (no step_created)', () => {
      const run = makeV1Run({ status: 'completed' });
      const events = [
        ...makeV1StepEvents('step_1', 1000, 3000),
        ...makeV1StepEvents('step_2', 4000, 6000),
      ];
      const trace = buildTrace(run, events, new Date());

      // Run span + 2 step spans
      expect(trace.spans).toHaveLength(3);

      const stepSpans = trace.spans.filter(
        (s) => s.attributes.resource === 'step'
      );
      expect(stepSpans).toHaveLength(2);
      expect(stepSpans[0].spanId).toBe('step_1');
      expect(stepSpans[1].spanId).toBe('step_2');
    });

    it('derives step status from v1 events without step_created', () => {
      const run = makeV1Run({ status: 'completed' });
      const events = makeV1StepEvents('step_1', 1000, 3000);
      const trace = buildTrace(run, events, new Date());

      const stepSpan = trace.spans.find((s) => s.spanId === 'step_1');
      expect(stepSpan).toBeDefined();
      expect(stepSpan!.attributes.data).toMatchObject({
        status: 'completed',
        stepName: '',
      });
    });

    it('uses correlationId for step span when stepName is unavailable', () => {
      const run = makeV1Run({ status: 'completed' });
      const events = makeV1StepEvents('step_1', 1000, 3000);
      const trace = buildTrace(run, events, new Date());

      const stepSpan = trace.spans.find((s) => s.spanId === 'step_1');
      expect(stepSpan).toBeDefined();
      // Without step_created, stepName is empty; the span name comes from
      // parseStepName which returns the correlationId as fallback
      expect(stepSpan!.spanId).toBe('step_1');
    });

    it('uses resumeAt for pending sleep span duration', () => {
      const run = makeV1Run({
        status: 'running',
        completedAt: undefined,
        output: undefined,
      });
      const waitCreatedAt = new Date(BASE_TIME.getTime() + 1_000);
      const resumeAt = new Date(BASE_TIME.getTime() + 61_000);
      const events = [
        {
          eventId: 'evnt_wait_created',
          runId: 'wrun_v1test',
          eventType: 'wait_created',
          correlationId: 'wait_1',
          createdAt: waitCreatedAt,
          specVersion: 1,
          eventData: { resumeAt },
        },
      ] as Event[];

      const trace = buildTrace(
        run,
        events,
        new Date(BASE_TIME.getTime() + 11_000)
      );
      const sleepSpan = trace.spans.find((s) => s.resource === 'sleep');

      expect(sleepSpan).toBeDefined();
      expect(durationMs(sleepSpan!)).toBe(10_000);
    });

    it('caps pending sleep spans at the latest known event before resumeAt', () => {
      const run = makeV1Run({
        status: 'completed',
        completedAt: new Date(BASE_TIME.getTime() + 86_400_000),
      });
      const waitCreatedAt = new Date(BASE_TIME.getTime() + 1_000);
      const latestKnownAt = new Date(BASE_TIME.getTime() + 86_401_000);
      const resumeAt = new Date(BASE_TIME.getTime() + 6 * 86_400_000 + 1_000);
      const events = [
        {
          eventId: 'evnt_wait_created',
          runId: 'wrun_v1test',
          eventType: 'wait_created',
          correlationId: 'wait_1',
          createdAt: waitCreatedAt,
          specVersion: 1,
          eventData: { resumeAt },
        },
        {
          eventId: 'evnt_run_completed',
          runId: 'wrun_v1test',
          eventType: 'run_completed',
          createdAt: latestKnownAt,
          specVersion: 1,
          eventData: { output: { result: 'ok' } },
        },
      ] as Event[];

      const trace = buildTrace(run, events, latestKnownAt);
      const sleepSpan = trace.spans.find((s) => s.resource === 'sleep');

      expect(sleepSpan).toBeDefined();
      expect(durationMs(sleepSpan!)).toBe(86_399_000);
    });
  });
});