ontime/apps/client/src/views/teleprompter/__tests__/teleprompter.options.test.ts

import { getOptionsFromParams, getTeleprompterOptions } from '../teleprompter.options';
import { DEFAULT_SPEED, MAX_SPEED, MIN_SPEED } from '../teleprompter.scroll';

describe('getOptionsFromParams()', () => {
  test('provides sensible defaults with no params', () => {
    const options = getOptionsFromParams(new URLSearchParams());

    expect(options).toMatchObject({
      scriptSource: 'none',
      heading: 'title',
      hideEmpty: true,
      showGroups: true,
      speed: DEFAULT_SPEED,
      autoplay: false,
      followLoaded: true,
      fontSize: 64,
      lineHeight: 1.5,
      textWidth: 90,
      align: 'left',
      dimPast: true,
      readingLine: 'line',
      readingLinePos: 40,
      flipH: false,
      flipV: false,
    });
  });

  test('reads the script source verbatim so it can be handed to getPropertyValue', () => {
    const options = getOptionsFromParams(new URLSearchParams('script=custom-prompter'));
    expect(options.scriptSource).toBe('custom-prompter');
  });

  test('booleans which default to true can be turned off', () => {
    const options = getOptionsFromParams(
      new URLSearchParams('hideEmpty=false&showGroups=false&followLoaded=false&dimPast=false'),
    );

    expect(options).toMatchObject({
      hideEmpty: false,
      showGroups: false,
      followLoaded: false,
      dimPast: false,
    });
  });

  test('booleans which default to false can be turned on', () => {
    const options = getOptionsFromParams(new URLSearchParams('autoplay=true&flipH=true&flipV=true'));

    expect(options).toMatchObject({
      autoplay: true,
      flipH: true,
      flipV: true,
    });
  });

  test('clamps the speed to the usable range', () => {
    expect(getOptionsFromParams(new URLSearchParams('speed=1000')).speed).toBe(MAX_SPEED);
    expect(getOptionsFromParams(new URLSearchParams('speed=0')).speed).toBe(MIN_SPEED);
  });

  test('falls back to the default for a non numeric value', () => {
    // Number(null) is 0, so a naive parse would silently produce a speed of zero
    expect(getOptionsFromParams(new URLSearchParams('speed=fast')).speed).toBe(DEFAULT_SPEED);
    expect(getOptionsFromParams(new URLSearchParams('speed=')).speed).toBe(DEFAULT_SPEED);
    expect(getOptionsFromParams(new URLSearchParams('fontSize=huge')).fontSize).toBe(64);
  });

  test('rejects an unknown value for an enumerated option', () => {
    expect(getOptionsFromParams(new URLSearchParams('heading=banana')).heading).toBe('title');
    expect(getOptionsFromParams(new URLSearchParams('readingLine=banana')).readingLine).toBe('line');
    expect(getOptionsFromParams(new URLSearchParams('align=banana')).align).toBe('left');
  });

  test('adds the hash back to colour params', () => {
    const options = getOptionsFromParams(new URLSearchParams('keyColour=112233&textColour=ffee00'));
    expect(options.keyColour).toBe('#112233');
    expect(options.textColour).toBe('#ffee00');
  });

  test('preset values take precedence over the search params', () => {
    const options = getOptionsFromParams(
      new URLSearchParams('speed=10&script=custom-a'),
      new URLSearchParams('speed=50&script=custom-b'),
    );

    expect(options.speed).toBe(50);
    expect(options.scriptSource).toBe('custom-b');
  });
});

describe('getTeleprompterOptions()', () => {
  /**
   * The params editor renders the declared defaults while the view runs the
   * parsed ones. If they drift the editor shows a value the view is not using,
   * and nothing else would notice.
   */
  test('every declared default is what parsing an empty query produces', () => {
    const parsed = getOptionsFromParams(new URLSearchParams()) as Record<string, unknown>;
    // the parser exposes the script source under a different name to its param
    const parsedByParamId: Record<string, unknown> = { ...parsed, script: parsed.scriptSource };

    const declared = getTeleprompterOptions({}).flatMap((section) => section.options);
    expect(declared.length).toBeGreaterThan(0);

    for (const field of declared) {
      if (!('defaultValue' in field) || field.defaultValue === undefined) continue;
      // colours are declared bare and parsed with the hash added back
      const expected = field.type === 'colour' ? `#${field.defaultValue}` : field.defaultValue;
      expect({ id: field.id, value: parsedByParamId[field.id] }).toEqual({ id: field.id, value: expected });
    }
  });
});