frontitygit/src/libraries/__tests__/route-utils.test.ts

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

import { parse, stringify, normalize } from "../route-utils";

describe("route utils - parse", () => {
  test("from path", () => {
    expect(parse("/some/path/")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 1,
      query: {},
      queryString: "",
    });
  });

  test("from path (contains 'page')", () => {
    expect(parse("/some-page/page/2")).toEqual({
      path: "/some-page/",
      route: "/some-page/",
      page: 2,
      query: {},
      queryString: "",
    });
  });

  test("from path (fixes path)", () => {
    expect(parse("/some/path")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 1,
      query: {},
      queryString: "",
    });
  });

  test("from path and page", () => {
    expect(parse("/some/path/page/2/")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 2,
      query: {},
      queryString: "",
    });
  });

  test("from path and query", () => {
    expect(parse("/some/path/?k1=v1&k2=v2")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 1,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from path and reversed query", () => {
    expect(parse("/some/path/?k2=v2&k1=v1")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 1,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from path, page and query", () => {
    expect(parse("/some/path/page/2?k1=v1&k2=v2")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 2,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from path, page and reversed query", () => {
    expect(parse("/some/path/page/2?k2=v2&k1=v1")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 2,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from root path", () => {
    expect(parse("/")).toEqual({
      path: "/",
      route: "/",
      page: 1,
      query: {},
      queryString: "",
    });
  });

  test("from root path and page", () => {
    expect(parse("/page/2/")).toEqual({
      path: "/",
      route: "/",
      page: 2,
      query: {},
      queryString: "",
    });
  });

  test("from root path, page and query", () => {
    expect(parse("/page/2?k1=v1&k2=v2")).toEqual({
      path: "/",
      route: "/",
      page: 2,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from root path, page and reversed query", () => {
    expect(parse("/page/2?k2=v2&k1=v1")).toEqual({
      path: "/",
      route: "/",
      page: 2,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from full URL", () => {
    expect(parse("https://test.frontity.org/some/path/?k1=v1&k2=v2")).toEqual({
      path: "/some/path/",
      route: "/some/path/",
      page: 1,
      query: {
        k1: "v1",
        k2: "v2",
      },
      queryString: "?k1=v1&k2=v2",
    });
  });

  test("from name", () => {
    expect(parse("custom-list")).toEqual({
      path: "custom-list/",
      route: "custom-list/",
      page: 1,
      query: {},
      queryString: "",
    });
  });

  test("from name (page)", () => {
    expect(parse("custom-list/page/2")).toEqual({
      path: "custom-list/",
      route: "custom-list/",
      page: 2,
      query: {},
      queryString: "",
    });
  });
});

describe("route utils - stringify", () => {
  describe("using only the `path` parameter", () => {
    test("from params (fixes path)", () => {
      expect(stringify({ path: "/some/path" })).toBe("/some/path/");
    });

    test("from params (path is a name)", () => {
      expect(stringify({ path: "custom-list" })).toBe("custom-list/");
    });

    test("from params (path, page)", () => {
      expect(stringify({ path: "/some/path/", page: 2 })).toBe(
        "/some/path/page/2/"
      );
    });

    test("from params (path, page, query)", () => {
      expect(
        stringify({
          path: "/some/path",
          page: 2,
          query: {
            k1: "v1",
            k2: "v2",
          },
        })
      ).toBe("/some/path/page/2/?k1=v1&k2=v2");
    });

    test("from params (root, page, query)", () => {
      expect(
        stringify({
          path: "/",
          page: 2,
          query: {
            k1: "v1",
            k2: "v2",
          },
        })
      ).toBe("/page/2/?k1=v1&k2=v2");
    });
  });

  describe("Using only the `route` parameter", () => {
    test("from params (fixes path)", () => {
      expect(stringify({ route: "/some/path" })).toBe("/some/path/");
    });

    test("from params (path is a name)", () => {
      expect(stringify({ route: "custom-list" })).toBe("custom-list/");
    });

    test("from params (path, page)", () => {
      expect(stringify({ route: "/some/path/", page: 2 })).toBe(
        "/some/path/page/2/"
      );
    });

    test("from params (path, page, query)", () => {
      expect(
        stringify({
          route: "/some/path",
          page: 2,
          query: {
            k1: "v1",
            k2: "v2",
          },
        })
      ).toBe("/some/path/page/2/?k1=v1&k2=v2");
    });

    test("from params (root, page, query)", () => {
      expect(
        stringify({
          route: "/",
          page: 2,
          query: {
            k1: "v1",
            k2: "v2",
          },
        })
      ).toBe("/page/2/?k1=v1&k2=v2");
    });
  });
});

describe("route utils - normalize", () => {
  test("from path", () => {
    expect(normalize("/some/path/")).toBe("/some/path/");
  });

  test("from path (contains 'page')", () => {
    expect(normalize("/some-page/")).toBe("/some-page/");
  });

  test("from path (fixes path)", () => {
    expect(normalize("/some/path")).toBe("/some/path/");
  });

  test("from path (upper case)", () => {
    expect(normalize("/SOME/PATH/")).toBe("/some/path/");
  });

  test("from path and page", () => {
    expect(normalize("/some/path/page/2")).toBe("/some/path/page/2/");
  });

  test("from path and query", () => {
    expect(normalize("/some/path?k1=v1&k2=v2")).toBe("/some/path/?k1=v1&k2=v2");
  });

  test("from path and query (upper case)", () => {
    expect(normalize("/some/PATH?K1=V1&k2=v2")).toBe("/some/path/?K1=V1&k2=v2");
  });

  test("from path, page and query", () => {
    expect(normalize("/some/path/page/2?k1=v1&k2=v2")).toBe(
      "/some/path/page/2/?k1=v1&k2=v2"
    );
  });

  test("from path, query and hash", () => {
    expect(normalize("/some/path/?id=1&search=value#element")).toBe(
      "/some/path/?id=1&search=value#element"
    );
  });

  test("from root path", () => {
    expect(normalize("/")).toEqual("/");
  });

  test("from root path and page", () => {
    expect(normalize("/page/2")).toEqual("/page/2/");
  });

  test("from root path, page and query", () => {
    expect(normalize("/page/2?k1=v1&k2=v2")).toEqual("/page/2/?k1=v1&k2=v2");
  });

  test("from full URL", () => {
    expect(
      normalize("https://test.frontity.org/some/path/page/2?k1=v1&k2=v2")
    ).toBe("/some/path/page/2/?k1=v1&k2=v2");
  });

  test("from root URL", () => {
    expect(normalize("https://test.frontity.org?k1=v1&k2=v2")).toBe(
      "/?k1=v1&k2=v2"
    );
  });

  test("from name", () => {
    expect(normalize("custom-list")).toBe("custom-list/");
  });

  test("from name (page)", () => {
    expect(normalize("custom-list/page/2/")).toBe("custom-list/page/2/");
  });

  test("final `/amp` path is not removed by default", () => {
    expect(normalize("/amp")).toBe("/amp/");
    expect(normalize("/category/amp/")).toBe("/category/amp/");
    expect(normalize("/tag/amp/")).toBe("/tag/amp/");
    expect(normalize("/taxonomy/amp/")).toBe("/taxonomy/amp/");
    expect(normalize("/posts/amp/")).toBe("/posts/amp/");
    expect(normalize("/parent/some-page/amp/")).toBe("/parent/some-page/amp/");
    expect(normalize("/amp/?a=1&b=1#some-hash")).toBe(
      "/amp/?a=1&b=1#some-hash"
    );
    expect(normalize("/amp/page/3/?a=1&b=1#some-hash")).toBe(
      "/amp/page/3/?a=1&b=1#some-hash"
    );
  });
});