@frontity/wp-source/src/__tests__/internal-redirections-handlers.tests.ts

A Frontity source package for the REST API of self-hosted and WordPress.com sites

import { createStore, InitializedStore } from "@frontity/connect";
import clone from "clone-deep";
import wpSource from "..";
import WpSource from "../../types";
import * as getMatch from "../libraries/get-match";

// Create mock for handler generators
jest.mock("../libraries/get-match");

const getMatchMock = getMatch as jest.Mocked<typeof getMatch>;

let store: InitializedStore<WpSource>;

beforeEach(() => {
  // Initialize the store
  store = createStore<WpSource>(clone(wpSource()));
  store.state.source.url = "https://test.frontity.org/";

  getMatchMock.getMatch.mockClear();
});

test("Correct handler should have been called after an internal redirection", async () => {
  const redirection = {
    name: "redirection",
    params: {},
    priority: 1,
    pattern: "/test",
    func: jest.fn(() => "/redirected"),
  };

  // We have to mock the return value of getMatch for the FIRST invocation
  // in actions.source.fetch()
  getMatchMock.getMatch.mockReturnValueOnce(redirection);

  await store.actions.source.fetch("/test");

  // The redirection func should have been called just once to get the new route
  expect(redirection.func).toHaveBeenCalledTimes(1);

  // The first call is matching the redirections
  // The second call is matching the handler
  expect(getMatchMock.getMatch).toHaveBeenCalledTimes(2);
  expect(getMatchMock.getMatch.mock.calls).toMatchInlineSnapshot(`
    Array [
      Array [
        Object {
          "link": "/test/",
          "route": "/test/",
        },
        Array [],
      ],
      Array [
        Object {
          "link": "/redirected/",
          "route": "/redirected",
        },
        Array [],
      ],
    ]
  `);
});

test("Match handler after redirection if link includes page or query", async () => {
  // We have to unmock the get-match, because it's being mocked on the module level
  getMatchMock.getMatch.mockImplementation(
    jest.requireActual("../libraries/get-match").getMatch
  );

  // A fake redirection that redirects from "/test" to "/redirected"
  const redirection = {
    name: "redirection",
    params: {},
    priority: 1,
    pattern: "/test",
    func: jest.fn(() => "/redirected"),
  };

  // Create a mock handler
  const handler = {
    name: "test",
    priority: 1,
    pattern: "RegExp:\\/redirected\\/\\?option=test",
    func: jest.fn(async ({ link, state }) => {
      await Promise.resolve();
      Object.assign(state.source.data[link], {
        isFetching: true,
        isReady: false,
        id: 1,
      });
    }),
  };

  // Add the handler and redirections
  store.libraries.source.handlers = [handler];
  store.libraries.source.redirections = [redirection];

  await store.actions.source.fetch("/test?option=test");

  // Make sure that the redirection and the handler were indeed called
  expect(redirection.func).toHaveBeenCalledTimes(1);
  expect(handler.func).toHaveBeenCalledTimes(1);

  // Should show the data assigned by our mock handler
  expect(store.state.source.data).toMatchInlineSnapshot(`
    Object {
      "/test/?option=test": Object {
        "id": 1,
        "isFetching": false,
        "isReady": true,
        "link": "/test/?option=test",
        "page": 1,
        "query": Object {
          "option": "test",
        },
        "route": "/test/",
      },
    }
  `);
});