privacy.sexy/tests/unit/presentation/electron/preload/ContextBridging/RendererApiProvider.spec.ts

import { describe, it, expect } from 'vitest';
import { type ApiFacadeFactory, type IpcConsumerProxyCreator, provideWindowVariables } from '@/presentation/electron/preload/ContextBridging/RendererApiProvider';
import { OperatingSystem } from '@/domain/OperatingSystem';
import type { Logger } from '@/application/Common/Log/Logger';
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
import type { PropertyKeys } from '@/TypeHelpers';
import type { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
import { IpcChannelDefinitions } from '@/presentation/electron/shared/IpcBridging/IpcChannelDefinitions';
import type { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';

describe('RendererApiProvider', () => {
  describe('provideWindowVariables', () => {
    interface WindowVariableTestCase {
      readonly description: string;
      setupContext(context: RendererApiProviderTestContext): RendererApiProviderTestContext;
      readonly expectedValue: unknown;
    }
    const testScenarios: Record<
    PropertyKeys<Required<WindowVariables>>,
    WindowVariableTestCase> = {
      isRunningAsDesktopApplication: {
        description: 'returns true',
        setupContext: (context) => context,
        expectedValue: true,
      },
      codeRunner: expectIpcConsumer(IpcChannelDefinitions.CodeRunner),
      os: (() => {
        const operatingSystem = OperatingSystem.WindowsPhone;
        return {
          description: 'returns expected',
          setupContext: (context) => context.withOs(operatingSystem),
          expectedValue: operatingSystem,
        };
      })(),
      log: expectFacade({
        instance: new LoggerStub(),
        setupContext: (c, instance) => c.withLogger(instance),
      }),
      dialog: expectIpcConsumer(IpcChannelDefinitions.Dialog),
      scriptDiagnosticsCollector: expectIpcConsumer(
        IpcChannelDefinitions.ScriptDiagnosticsCollector,
      ),
    };
    Object.entries(testScenarios).forEach((
      [property, { description, setupContext, expectedValue }],
    ) => {
      it(`${property}: ${description}`, () => {
        // arrange
        const testContext = setupContext(new RendererApiProviderTestContext());
        // act
        const variables = testContext.provideWindowVariables();
        // assert
        const actualValue = variables[property as PropertyKeys<Required<WindowVariables>>];
        expect(actualValue).to.equal(expectedValue);
      });
    });
    function expectIpcConsumer<T>(expectedDefinition: IpcChannel<T>): WindowVariableTestCase {
      const ipcConsumerCreator: IpcConsumerProxyCreator = (definition) => definition as never;
      return {
        description: 'creates correct IPC consumer',
        setupContext: (context) => context
          .withIpcConsumerCreator(ipcConsumerCreator),
        expectedValue: expectedDefinition,
      };
    }
    function expectFacade<T>(options: {
      readonly instance: T;
      setupContext: (
        context: RendererApiProviderTestContext,
        instance: T,
      ) => RendererApiProviderTestContext;
    }): WindowVariableTestCase {
      const createFacadeMock: ApiFacadeFactory = (obj) => obj;
      return {
        description: 'creates correct facade',
        setupContext: (context) => options.setupContext(
          context.withApiFacadeCreator(createFacadeMock),
          options.instance,
        ),
        expectedValue: options.instance,
      };
    }
  });
});

class RendererApiProviderTestContext {
  private os: OperatingSystem = OperatingSystem.Android;

  private log: Logger = new LoggerStub();

  private apiFacadeCreator: ApiFacadeFactory = (obj) => obj;

  private ipcConsumerCreator: IpcConsumerProxyCreator = () => { return {} as never; };

  public withOs(os: OperatingSystem): this {
    this.os = os;
    return this;
  }

  public withLogger(log: Logger): this {
    this.log = log;
    return this;
  }

  public withApiFacadeCreator(apiFacadeCreator: ApiFacadeFactory): this {
    this.apiFacadeCreator = apiFacadeCreator;
    return this;
  }

  public withIpcConsumerCreator(ipcConsumerCreator: IpcConsumerProxyCreator): this {
    this.ipcConsumerCreator = ipcConsumerCreator;
    return this;
  }

  public provideWindowVariables() {
    return provideWindowVariables(
      this.apiFacadeCreator,
      this.ipcConsumerCreator,
      () => this.os,
      () => this.log,
    );
  }
}