promptfoo--promptfoo/test/server/routes/traces.test.ts

import type { Server } from 'node:http';

import request from 'supertest';
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import { createApp } from '../../../src/server/server';

// Mock dependencies
vi.mock('../../../src/tracing/store');

// Import after mocking
import { getTraceStore } from '../../../src/tracing/store';

const mockedGetTraceStore = vi.mocked(getTraceStore);

describe('Traces Routes', () => {
  let api: ReturnType<typeof request.agent>;
  let server: Server;
  let mockGetTracesByEvaluation: ReturnType<typeof vi.fn>;
  let mockGetTrace: ReturnType<typeof vi.fn>;

  beforeAll(async () => {
    await new Promise<void>((resolve, reject) => {
      server = createApp().listen(0, '127.0.0.1', (error?: Error) =>
        error ? reject(error) : resolve(),
      );
    });
    api = request.agent(server);
  });

  afterAll(async () => {
    if (!server.listening) {
      return;
    }
    await new Promise<void>((resolve, reject) => {
      server.close((error) => (error ? reject(error) : resolve()));
    });
  });

  beforeEach(() => {
    vi.resetAllMocks();

    // Setup mock trace store methods
    mockGetTracesByEvaluation = vi.fn();
    mockGetTrace = vi.fn();

    mockedGetTraceStore.mockReturnValue({
      getTracesByEvaluation: mockGetTracesByEvaluation,
      getTrace: mockGetTrace,
    } as any);
  });

  afterEach(() => {
    vi.resetAllMocks();
  });

  describe('GET /api/traces/evaluation/:evaluationId', () => {
    it('should return traces array when traces exist', async () => {
      const mockTraces = [
        {
          id: '1',
          traceId: 'trace-1',
          evaluationId: 'eval-123',
          testCaseId: 'test-1',
          spans: [],
        },
        {
          id: '2',
          traceId: 'trace-2',
          evaluationId: 'eval-123',
          testCaseId: 'test-2',
          spans: [],
        },
      ];

      mockGetTracesByEvaluation.mockResolvedValue(mockTraces);

      const response = await api.get('/api/traces/evaluation/eval-123');

      expect(response.status).toBe(200);
      expect(response.body).toEqual({
        traces: mockTraces,
      });
      expect(mockGetTracesByEvaluation).toHaveBeenCalledWith('eval-123');
    });

    it('should return empty array when no traces found', async () => {
      mockGetTracesByEvaluation.mockResolvedValue([]);

      const response = await api.get('/api/traces/evaluation/eval-456');

      expect(response.status).toBe(200);
      expect(response.body).toEqual({
        traces: [],
      });
      expect(mockGetTracesByEvaluation).toHaveBeenCalledWith('eval-456');
    });

    it('should return 500 on database error', async () => {
      mockGetTracesByEvaluation.mockRejectedValue(new Error('Database connection failed'));

      const response = await api.get('/api/traces/evaluation/eval-789');

      expect(response.status).toBe(500);
      expect(response.body).toEqual({
        error: 'Failed to fetch traces',
      });
    });
  });

  describe('GET /api/traces/:traceId', () => {
    it('should return trace when found', async () => {
      const mockTrace = {
        id: '1',
        traceId: 'trace-abc',
        evaluationId: 'eval-123',
        testCaseId: 'test-1',
        spans: [
          {
            id: 'span-1',
            spanId: 'span-123',
            name: 'api-call',
            startTime: 1234567890,
            endTime: 1234567900,
          },
        ],
      };

      mockGetTrace.mockResolvedValue(mockTrace);

      const response = await api.get('/api/traces/trace-abc');

      expect(response.status).toBe(200);
      expect(response.body).toEqual({
        trace: mockTrace,
      });
      expect(mockGetTrace).toHaveBeenCalledWith('trace-abc');
    });

    it('should return 404 when trace not found', async () => {
      mockGetTrace.mockResolvedValue(null);

      const response = await api.get('/api/traces/trace-nonexistent');

      expect(response.status).toBe(404);
      expect(response.body).toEqual({
        error: 'Trace not found',
      });
      expect(mockGetTrace).toHaveBeenCalledWith('trace-nonexistent');
    });

    it('should return 500 on database error', async () => {
      mockGetTrace.mockRejectedValue(new Error('Database connection failed'));

      const response = await api.get('/api/traces/trace-error');

      expect(response.status).toBe(500);
      expect(response.body).toEqual({
        error: 'Failed to fetch trace',
      });
    });
  });
});