index.test.tsx

import React, { useContext } from 'react';
import { render } from '@testing-library/react';
import { HOME_PAGE } from '#app/routes/utils/pageTypes';
import * as getStatsDestination from './getStatsDestination';
import * as getOriginContext from './getOriginContext';
import * as getEnv from './getEnv';
import * as getMetaUrls from './getMetaUrls';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const { RequestContextProvider, RequestContext } = require('./index');

const Component = () => {
  useContext(RequestContext);
  return null;
};

jest.mock('react', () => {
  const original = jest.requireActual('react');
  return {
    ...original,
    useContext: jest.fn().mockImplementation(original.useContext),
  };
});

jest.mock('./getStatsDestination');
jest.mock('./getOriginContext');
jest.mock('./getEnv');
jest.mock('./getMetaUrls');

(getStatsDestination.default as jest.Mock).mockReturnValue(
  'getStatsDestination',
);
(getOriginContext.default as jest.Mock).mockReturnValue({
  origin: 'origin',
});
(getEnv.default as jest.Mock).mockReturnValue('getEnv');
(getMetaUrls.default as jest.Mock).mockReturnValue({
  canonicalLink: 'canonicalLink',
  ampLink: 'ampLink',
  canonicalUkLink: 'canonicalUkLink',
  ampUkLink: 'ampUkLink',
  canonicalNonUkLink: 'canonicalNonUkLink',
  ampNonUkLink: 'ampNonUkLink',
});

const input = {
  bbcOrigin: 'bbcOrigin',
  id: 'id',
  isAmp: true,
  pageType: HOME_PAGE,
  service: 'service',
  statusCode: 200,
  pathname: '/current-path',
  variant: 'simp',
  showAdsBasedOnLocation: true,
  mvtExperiments: [{ experimentName: 'foo', variation: 'bar' }],
  isUK: true,
};

const expectedOutput = {
  env: 'getEnv',
  id: input.id,
  isUK: true,
  origin: 'origin',
  pageType: input.pageType,
  derivedPageType: null,
  isAmp: true,
  isNextJs: false,
  isApp: false,
  isLite: false,
  platform: 'amp',
  variant: 'simp',
  timeOnServer: null,
  statsDestination: 'getStatsDestination',
  statusCode: 200,
  canonicalLink: 'canonicalLink',
  ampLink: 'ampLink',
  canonicalUkLink: 'canonicalUkLink',
  ampUkLink: 'ampUkLink',
  canonicalNonUkLink: 'canonicalNonUkLink',
  ampNonUkLink: 'ampNonUkLink',
  showAdsBasedOnLocation: input.showAdsBasedOnLocation,
  showCookieBannerBasedOnCountry: true,
  service: 'service',
  pathname: '/current-path',
  mvtExperiments: input.mvtExperiments,
};

describe('RequestContext', () => {
  afterEach(() => {
    jest.clearAllMocks();
  });

  it('should return expected values', () => {
    render(
      <RequestContextProvider {...input}>
        <Component />
      </RequestContextProvider>,
    );

    expect(getStatsDestination.default).toHaveBeenCalledWith({
      env: 'getEnv',
      isUK: true,
      service: 'service',
    });

    expect(getOriginContext.default).toHaveBeenCalledWith('bbcOrigin');

    expect(getEnv.default).toHaveBeenCalledWith('origin');

    expect(getMetaUrls.default).toHaveBeenCalledWith('origin', '/current-path');

    expect(React.useContext).toHaveReturnedWith(expectedOutput);
  });

  it('should return expected values for app requests', () => {
    const appInput = {
      ...input,
      isAmp: false,
      isApp: true,
    };

    render(
      <RequestContextProvider {...appInput}>
        <Component />
      </RequestContextProvider>,
    );

    expect(React.useContext).toHaveReturnedWith({
      ...expectedOutput,
      isAmp: false,
      isApp: true,
      platform: 'app',
    });
  });

  describe('platform', () => {
    it('should be "amp" when isAmp is true', () => {
      render(
        <RequestContextProvider {...input} isAmp>
          <Component />
        </RequestContextProvider>,
      );

      expect(React.useContext).toHaveReturnedWith({
        ...expectedOutput,
        isAmp: true,
        platform: 'amp',
      });
    });

    it('should be "canonical" when isAmp is false', () => {
      render(
        <RequestContextProvider {...input} isAmp={false}>
          <Component />
        </RequestContextProvider>,
      );

      expect(React.useContext).toHaveReturnedWith({
        ...expectedOutput,
        isAmp: false,
        platform: 'canonical',
      });
    });

    it('should be "app" when isAmp is false and isApp is true', () => {
      render(
        <RequestContextProvider {...input} isAmp={false} isApp>
          <Component />
        </RequestContextProvider>,
      );

      expect(React.useContext).toHaveReturnedWith({
        ...expectedOutput,
        isAmp: false,
        isApp: true,
        platform: 'app',
      });
    });

    it('should be "lite" when isAmp is false and isApp is false and isLite is true', () => {
      render(
        <RequestContextProvider {...input} isAmp={false} isApp={false} isLite>
          <Component />
        </RequestContextProvider>,
      );

      expect(React.useContext).toHaveReturnedWith({
        ...expectedOutput,
        isAmp: false,
        isApp: false,
        isLite: true,
        platform: 'lite',
      });
    });

    it('should return a PS statsDestination when isAmp is true and outside the UK', () => {
      (getOriginContext.default as jest.Mock).mockReturnValue({
        origin: 'origin',
      });
      render(
        <RequestContextProvider {...input}>
          <Component />
        </RequestContextProvider>,
      );

      expect(getStatsDestination.default).toHaveBeenCalledWith({
        env: 'getEnv',
        isUK: true,
        service: 'service',
      });
    });

    it('should set isUK to false when the input isUK value is null', () => {
      (getOriginContext.default as jest.Mock).mockReturnValue({
        origin: 'origin',
      });

      const inputProps = { ...input, isUK: null };

      render(
        <RequestContextProvider {...inputProps}>
          <Component />
        </RequestContextProvider>,
      );

      expect(React.useContext).toHaveReturnedWith({
        ...expectedOutput,
        isUK: false,
      });
    });
  });
});