lens/src/extensions/registries/__tests__/page-registry.test.ts

import { getExtensionPageUrl, globalPageRegistry, PageTargetParams } from "../page-registry";
import { LensExtension } from "../../lens-extension";
import React from "react";

let ext: LensExtension = null;

describe("getPageUrl", () => {
  beforeEach(async () => {
    ext = new LensExtension({
      manifest: {
        name: "foo-bar",
        version: "0.1.1"
      },
      id: "/this/is/fake/package.json",
      absolutePath: "/absolute/fake/",
      manifestPath: "/this/is/fake/package.json",
      isBundled: false,
      isEnabled: true
    });
    globalPageRegistry.add({
      id: "page-with-params",
      components: {
        Page: () => React.createElement("Page with params")
      },
      params: {
        test1: "test1-default",
        test2: "" // no default value, just declaration
      },
    }, ext);
  });

  it("returns a page url for extension", () => {
    expect(getExtensionPageUrl({ extensionId: ext.name })).toBe("/extension/foo-bar");
  });

  it("allows to pass base url as parameter", () => {
    expect(getExtensionPageUrl({ extensionId: ext.name, pageId: "/test" })).toBe("/extension/foo-bar/test");
  });

  it("removes @ and replace `/` to `--`", () => {
    expect(getExtensionPageUrl({ extensionId: "@foo/bar" })).toBe("/extension/foo--bar");
  });

  it("adds / prefix", () => {
    expect(getExtensionPageUrl({ extensionId: ext.name, pageId: "test" })).toBe("/extension/foo-bar/test");
  });

  it("normalize possible multi-slashes in page.id", () => {
    expect(getExtensionPageUrl({ extensionId: ext.name, pageId: "//test/" })).toBe("/extension/foo-bar/test");
  });

  it("gets page url with custom params", () => {
    const params: PageTargetParams<string> = { test1: "one", test2: "2" };
    const searchParams = new URLSearchParams(params);
    const pageUrl = getExtensionPageUrl({ extensionId: ext.name, pageId: "page-with-params", params });

    expect(pageUrl).toBe(`/extension/foo-bar/page-with-params?${searchParams}`);
  });

  it("gets page url with default custom params", () => {
    const defaultPageUrl = getExtensionPageUrl({ extensionId: ext.name, pageId: "page-with-params", });

    expect(defaultPageUrl).toBe(`/extension/foo-bar/page-with-params?test1=test1-default`);
  });
});

describe("globalPageRegistry", () => {
  beforeEach(async () => {
    ext = new LensExtension({
      manifest: {
        name: "@acme/foo-bar",
        version: "0.1.1"
      },
      id: "/this/is/fake/package.json",
      absolutePath: "/absolute/fake/",
      manifestPath: "/this/is/fake/package.json",
      isBundled: false,
      isEnabled: true
    });
    globalPageRegistry.add([
      {
        id: "test-page",
        components: {
          Page: () => React.createElement("Text")
        }
      },
      {
        id: "another-page",
        components: {
          Page: () => React.createElement("Text")
        },
      },
      {
        components: {
          Page: () => React.createElement("Default")
        }
      },
    ], ext);
  });

  describe("getByPageTarget", () => {
    it("matching to first registered page without id", () => {
      const page = globalPageRegistry.getByPageTarget({ extensionId: ext.name });

      expect(page.id).toEqual(undefined);
      expect(page.extensionId).toEqual(ext.name);
      expect(page.url).toEqual(getExtensionPageUrl({ extensionId: ext.name }));
    });

    it("returns matching page", () => {
      const page = globalPageRegistry.getByPageTarget({
        pageId: "test-page",
        extensionId: ext.name
      });

      expect(page.id).toEqual("test-page");
    });

    it("returns null if target not found", () => {
      const page = globalPageRegistry.getByPageTarget({
        pageId: "wrong-page",
        extensionId: ext.name
      });

      expect(page).toBeNull();
    });
  });
});