promptfoo/test/constants.test.ts

import { jest } from '@jest/globals';
import {
  VERSION,
  DEFAULT_QUERY_LIMIT,
  DEFAULT_API_BASE_URL,
  getShareApiBaseUrl,
  getDefaultShareViewBaseUrl,
  getShareViewBaseUrl,
  getDefaultPort,
  TERMINAL_MAX_WIDTH,
  CLOUD_PROVIDER_PREFIX,
} from '../src/constants';

describe('constants', () => {
  beforeEach(() => {
    jest.clearAllMocks();
    process.env = {};
  });

  it('should export VERSION from package.json', () => {
    expect(VERSION).toBeDefined();
  });

  it('should have DEFAULT_QUERY_LIMIT set to 100', () => {
    expect(DEFAULT_QUERY_LIMIT).toBe(100);
  });

  it('should have DEFAULT_API_BASE_URL set to api.promptfoo.app', () => {
    expect(DEFAULT_API_BASE_URL).toBe('https://api.promptfoo.app');
  });

  describe('getShareApiBaseUrl', () => {
    it('should return DEFAULT_API_BASE_URL by default', () => {
      expect(getShareApiBaseUrl()).toBe(DEFAULT_API_BASE_URL);
    });

    it('should return NEXT_PUBLIC_PROMPTFOO_REMOTE_API_BASE_URL if set', () => {
      process.env.NEXT_PUBLIC_PROMPTFOO_REMOTE_API_BASE_URL = 'https://custom.api.com';
      expect(getShareApiBaseUrl()).toBe('https://custom.api.com');
    });

    it('should return NEXT_PUBLIC_PROMPTFOO_BASE_URL if set', () => {
      process.env.NEXT_PUBLIC_PROMPTFOO_BASE_URL = 'https://custom.base.com';
      expect(getShareApiBaseUrl()).toBe('https://custom.base.com');
    });

    it('should return PROMPTFOO_REMOTE_API_BASE_URL if set', () => {
      process.env.PROMPTFOO_REMOTE_API_BASE_URL = 'https://remote.api.com';
      expect(getShareApiBaseUrl()).toBe('https://remote.api.com');
    });

    it('should prioritize NEXT_PUBLIC_PROMPTFOO_REMOTE_API_BASE_URL over others', () => {
      process.env.NEXT_PUBLIC_PROMPTFOO_REMOTE_API_BASE_URL = 'https://custom.api.com';
      process.env.NEXT_PUBLIC_PROMPTFOO_BASE_URL = 'https://custom.base.com';
      process.env.PROMPTFOO_REMOTE_API_BASE_URL = 'https://remote.api.com';
      expect(getShareApiBaseUrl()).toBe('https://custom.api.com');
    });
  });

  describe('getDefaultShareViewBaseUrl', () => {
    it('should return promptfoo.app by default', () => {
      expect(getDefaultShareViewBaseUrl()).toBe('https://promptfoo.app');
    });

    it('should return PROMPTFOO_SHARING_APP_BASE_URL if set', () => {
      process.env.PROMPTFOO_SHARING_APP_BASE_URL = 'https://custom.share.com';
      expect(getDefaultShareViewBaseUrl()).toBe('https://custom.share.com');
    });
  });

  describe('getShareViewBaseUrl', () => {
    it('should return promptfoo.app by default', () => {
      expect(getShareViewBaseUrl()).toBe('https://promptfoo.app');
    });

    it('should return NEXT_PUBLIC_PROMPTFOO_BASE_URL if set', () => {
      process.env.NEXT_PUBLIC_PROMPTFOO_BASE_URL = 'https://custom.base.com';
      expect(getShareViewBaseUrl()).toBe('https://custom.base.com');
    });

    it('should return PROMPTFOO_REMOTE_APP_BASE_URL if set', () => {
      process.env.PROMPTFOO_REMOTE_APP_BASE_URL = 'https://remote.app.com';
      expect(getShareViewBaseUrl()).toBe('https://remote.app.com');
    });

    it('should prioritize NEXT_PUBLIC_PROMPTFOO_BASE_URL over others', () => {
      process.env.NEXT_PUBLIC_PROMPTFOO_BASE_URL = 'https://custom.base.com';
      process.env.PROMPTFOO_REMOTE_APP_BASE_URL = 'https://remote.app.com';
      expect(getShareViewBaseUrl()).toBe('https://custom.base.com');
    });
  });

  describe('getDefaultPort', () => {
    it('should return 15500 by default', () => {
      expect(getDefaultPort()).toBe(15500);
    });

    it('should return API_PORT if set', () => {
      process.env.API_PORT = '3000';
      expect(getDefaultPort()).toBe(3000);
    });

    it('should handle invalid API_PORT value', () => {
      process.env.API_PORT = 'invalid';
      expect(getDefaultPort()).toBe(15500);
    });
  });

  describe('TERMINAL_MAX_WIDTH', () => {
    it('should match expected terminal width', () => {
      const expectedWidth =
        process?.stdout?.isTTY && process?.stdout?.columns && process?.stdout?.columns > 10
          ? process.stdout.columns - 10
          : 120;

      expect(TERMINAL_MAX_WIDTH).toBe(expectedWidth);
    });
  });

  it('should have CLOUD_PROVIDER_PREFIX set correctly', () => {
    expect(CLOUD_PROVIDER_PREFIX).toBe('promptfoo://provider/');
  });
});