@thepalaceproject/circulation-admin 1.43.0 → 1.44.0

package/tests/jest/components/DiagnosticsServiceTabs.test.tsx

@@ -0,0 +1,141 @@
+import * as React from "react";
+import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import DiagnosticsServiceTabs from "../../../src/components/DiagnosticsServiceTabs";
+
+describe("DiagnosticsServiceTabs", () => {
+  let goToTab: jest.Mock;
+
+  const ts1 = {
+    service: "test_service_1",
+    id: "1",
+    start: "start_time_string_1",
+    duration: "0",
+    collection_name: "collection1",
+  };
+  const ts2 = {
+    service: "test_service_2",
+    id: "2",
+    start: "start_time_string_2",
+    duration: "0",
+    collection_name: "collection2",
+    exception: "Stack trace",
+  };
+
+  const content: any = {
+    test_service_1: { collection1: [ts1] },
+    test_service_2: { collection2: [ts2] },
+  };
+
+  const renderTabs = () => {
+    goToTab = jest.fn();
+    return render(
+      <DiagnosticsServiceTabs
+        goToTab={goToTab}
+        content={content}
+        tab="test_service_1"
+      />
+    );
+  };
+
+  // Find the collapsible `.panel` whose header text matches `title`. The
+  // collection panels are titled by collection name; the timestamp panels nested
+  // inside them are titled by their start time.
+  const panelByTitle = (container: HTMLElement, title: string) => {
+    const titleEl = Array.from(container.querySelectorAll(".panel-title")).find(
+      (el) => el.textContent === title
+    );
+    return titleEl ? titleEl.closest(".panel") : null;
+  };
+
+  describe("nav", () => {
+    it("renders a tab for each service", () => {
+      const { container } = renderTabs();
+      expect(container.querySelectorAll("ul.nav-tabs")).toHaveLength(1);
+      const tabs = container.querySelectorAll("ul.nav-tabs li a");
+      expect(tabs).toHaveLength(2);
+      expect(tabs[0]).toHaveTextContent("Test_service_1");
+      expect(tabs[1]).toHaveTextContent("Test_service_2");
+    });
+
+    it("displays a badge", () => {
+      const { container } = renderTabs();
+      const tabs = container.querySelectorAll("ul.nav-tabs li");
+
+      // The first service has no exception: a plain count badge with a tooltip.
+      const tabWithoutException = tabs[0];
+      expect(tabWithoutException.querySelector(".danger")).toBeNull();
+      const badge = tabWithoutException.querySelector(".badge");
+      expect(badge).toHaveTextContent("1");
+      const toolTip = tabWithoutException.querySelector(".tool-tip");
+      expect(toolTip).toHaveTextContent(
+        "Total number of timestamps for this service"
+      );
+
+      // The second service contains a timestamp with an exception, so it shows a
+      // danger badge (a warning) and no tooltip.
+      const tabWithException = tabs[1];
+      const dangerBadge = tabWithException.querySelector(".badge.danger");
+      expect(dangerBadge).toHaveTextContent("!");
+      expect(tabWithException.querySelector(".tool-tip")).toBeNull();
+    });
+
+    it("defaults to showing the first tab", () => {
+      const { container } = renderTabs();
+      const tabs = container.querySelectorAll("ul.nav-tabs li");
+      expect(tabs[0]).toHaveClass("active");
+      expect(tabs[1]).not.toHaveClass("active");
+    });
+  });
+
+  describe("content", () => {
+    it("renders collections", () => {
+      const { container } = renderTabs();
+      expect(container.querySelectorAll(".tab-content")).toHaveLength(1);
+
+      // collection1 has no exception, so its panel starts collapsed.
+      const collection1 = panelByTitle(container, "collection1");
+      expect(collection1).toBeInTheDocument();
+      expect(collection1.querySelector(".panel-heading")).toHaveAttribute(
+        "aria-expanded",
+        "false"
+      );
+
+      // collection2 contains a timestamp with an exception, so its panel starts
+      // expanded.
+      const collection2 = panelByTitle(container, "collection2");
+      expect(collection2).toBeInTheDocument();
+      expect(collection2.querySelector(".panel-heading")).toHaveAttribute(
+        "aria-expanded",
+        "true"
+      );
+    });
+
+    it("renders timestamps", () => {
+      const { container } = renderTabs();
+      // Each timestamp renders as a panel headed by its start time.
+      expect(
+        panelByTitle(container, "start_time_string_1")
+      ).toBeInTheDocument();
+      expect(
+        panelByTitle(container, "start_time_string_2")
+      ).toBeInTheDocument();
+      // Both timestamps render their duration.
+      expect(screen.getAllByText("Duration: 0 seconds")).toHaveLength(2);
+    });
+  });
+
+  describe("behavior", () => {
+    it("switches tabs", async () => {
+      const user = userEvent.setup();
+      const { container } = renderTabs();
+      const tabLinks = container.querySelectorAll("ul.nav-tabs li a");
+
+      await user.click(tabLinks[1]);
+
+      expect(goToTab).toHaveBeenCalledTimes(1);
+      expect(goToTab).toHaveBeenCalledWith("test_service_2");
+    });
+  });
+});

package/tests/jest/components/DiagnosticsServiceType.test.tsx

@@ -0,0 +1,75 @@
+import * as React from "react";
+import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import DiagnosticsServiceType from "../../../src/components/DiagnosticsServiceType";
+
+describe("DiagnosticsServiceType", () => {
+  const ts1 = {
+    service: "test_service_1",
+    id: "1",
+    start: "start_time_string_1",
+    duration: "0",
+    collection_name: "collection1",
+  };
+  const ts2 = {
+    service: "test_service_2",
+    id: "2",
+    start: "start_time_string_2",
+    duration: "0",
+    collection_name: "collection2",
+  };
+
+  const services: any = {
+    test_service_1: { collection1: [ts1] },
+    test_service_2: { collection2: [ts2] },
+  };
+
+  it("renders service tabs", () => {
+    const { container } = render(
+      <DiagnosticsServiceType type="monitor" services={services} />
+    );
+
+    expect(container.firstChild).toHaveClass("config");
+    expect(container.firstChild).toHaveClass("services");
+
+    // The service tabs are rendered, one per service, defaulting to the first.
+    const tabs = container.querySelectorAll("ul.nav-tabs li");
+    expect(tabs).toHaveLength(2);
+    expect(tabs[0]).toHaveTextContent("Test_service_1");
+    expect(tabs[0]).toHaveClass("active");
+    expect(tabs[1]).toHaveTextContent("Test_service_2");
+    expect(tabs[1]).not.toHaveClass("active");
+  });
+
+  it("switches tabs", async () => {
+    const user = userEvent.setup();
+    const { container } = render(
+      <DiagnosticsServiceType type="monitor" services={services} />
+    );
+
+    // Starts on the first service tab.
+    let tabs = container.querySelectorAll("ul.nav-tabs li");
+    expect(tabs[0]).toHaveClass("active");
+    expect(tabs[1]).not.toHaveClass("active");
+
+    // Clicking the second service tab selects it (goToTab updates the state that
+    // drives which tab is active).
+    await user.click(container.querySelectorAll("ul.nav-tabs li a")[1]);
+
+    tabs = container.querySelectorAll("ul.nav-tabs li");
+    expect(tabs[0]).not.toHaveClass("active");
+    expect(tabs[1]).toHaveClass("active");
+  });
+
+  it("displays a message if there are no services", () => {
+    const { container } = render(
+      <DiagnosticsServiceType type="monitor" services={null} />
+    );
+
+    expect(container.querySelector("ul.nav-tabs")).toBeNull();
+    expect(
+      screen.getByText("There are currently no monitor services.")
+    ).toBeInTheDocument();
+  });
+});

package/tests/jest/components/DiagnosticsTabContainer.test.tsx

@@ -0,0 +1,147 @@
+import * as React from "react";
+import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import buildStore from "../../../src/store";
+
+// The active tab renders DiagnosticsServiceType, which recurses into the service
+// tab machinery. The legacy test only asserted the `type`/`services` props it
+// received, so mock it to a marker that echoes those.
+jest.mock("../../../src/components/DiagnosticsServiceType", () => ({
+  __esModule: true,
+  default: (props: any) => (
+    <div
+      data-testid="service-type"
+      data-type={props.type}
+      data-has-services={String(props.services !== undefined)}
+    />
+  ),
+}));
+
+import { DiagnosticsTabContainer } from "../../../src/components/DiagnosticsTabContainer";
+
+describe("DiagnosticsTabContainer", () => {
+  let goToTab: jest.Mock;
+  let fetchDiagnostics: jest.Mock;
+
+  const ts1 = {
+    service: "test_service",
+    id: "1",
+    start: "start_time_string",
+    duration: "0",
+    collection_name: "collection1",
+  };
+
+  const diagnostics = {
+    monitor: [{ test_service_1: [{ collection1: [ts1] }] }],
+  };
+
+  beforeEach(() => {
+    goToTab = jest.fn();
+    fetchDiagnostics = jest.fn();
+  });
+
+  const element = (overrides = {}) => {
+    const props = {
+      goToTab,
+      tab: "coverage_provider",
+      store: buildStore(),
+      fetchDiagnostics,
+      diagnostics: { coverage_provider: [] },
+      isLoaded: true,
+      ...overrides,
+    };
+    return <DiagnosticsTabContainer {...props} />;
+  };
+
+  const renderContainer = (overrides = {}) => render(element(overrides));
+
+  describe("rendering", () => {
+    it("renders a tab container", () => {
+      const { container } = renderContainer();
+      expect(container.firstChild).toHaveClass("tab-container");
+    });
+
+    it("renders tabs and defaults to showing the Coverage Providers tab", () => {
+      const { container } = renderContainer();
+      const tabs = container.querySelectorAll("ul.nav-tabs li");
+      expect(tabs).toHaveLength(4);
+
+      expect(tabs[0]).toHaveTextContent("Coverage Providers");
+      expect(tabs[0]).toHaveClass("active");
+
+      expect(tabs[1]).toHaveTextContent("Monitors");
+      expect(tabs[1]).not.toHaveClass("active");
+
+      expect(tabs[2]).toHaveTextContent("Scripts");
+      expect(tabs[2]).not.toHaveClass("active");
+
+      expect(tabs[3]).toHaveTextContent("Other");
+      expect(tabs[3]).not.toHaveClass("active");
+    });
+
+    it("renders tab content", () => {
+      renderContainer({ diagnostics });
+      const serviceTypes = screen.getAllByTestId("service-type");
+      expect(serviceTypes).toHaveLength(4);
+
+      expect(serviceTypes[0]).toHaveAttribute("data-type", "coverage_provider");
+      expect(serviceTypes[0]).toHaveAttribute("data-has-services", "false");
+
+      expect(serviceTypes[1]).toHaveAttribute("data-type", "monitor");
+      expect(serviceTypes[1]).toHaveAttribute("data-has-services", "true");
+
+      expect(serviceTypes[2]).toHaveAttribute("data-type", "script");
+      expect(serviceTypes[2]).toHaveAttribute("data-has-services", "false");
+
+      expect(serviceTypes[3]).toHaveAttribute("data-type", "other");
+      expect(serviceTypes[3]).toHaveAttribute("data-has-services", "false");
+    });
+  });
+
+  describe("behavior", () => {
+    it("calls fetchDiagnostics on mount", () => {
+      renderContainer();
+      expect(fetchDiagnostics).toHaveBeenCalled();
+    });
+
+    it("shows the loading indicator", () => {
+      const { container, rerender } = renderContainer();
+      expect(container.querySelectorAll(".loading")).toHaveLength(0);
+      rerender(element({ isLoaded: false }));
+      expect(container.querySelectorAll(".loading")).toHaveLength(4);
+    });
+
+    it("shows an error message", () => {
+      const { container, rerender } = renderContainer();
+      expect(container.querySelectorAll(".alert-danger")).toHaveLength(0);
+      rerender(
+        element({
+          fetchError: { status: 401, response: "error fetching diagnostics" },
+        })
+      );
+      expect(container.querySelectorAll(".alert-danger")).toHaveLength(4);
+    });
+
+    it("calls goToTab when a tab is clicked", async () => {
+      const user = userEvent.setup();
+      renderContainer({ diagnostics });
+      await user.click(screen.getByRole("link", { name: "Monitors" }));
+      expect(goToTab).toHaveBeenCalledTimes(1);
+      expect(goToTab).toHaveBeenCalledWith("monitor");
+    });
+
+    it("switches tabs when the tab prop changes", () => {
+      const { container, rerender } = renderContainer();
+      let tabs = container.querySelectorAll("ul.nav-tabs li");
+      expect(tabs[0]).toHaveClass("active");
+      expect(tabs[1]).not.toHaveClass("active");
+
+      rerender(element({ tab: "monitor" }));
+
+      tabs = container.querySelectorAll("ul.nav-tabs li");
+      expect(tabs[0]).not.toHaveClass("active");
+      expect(tabs[1]).toHaveClass("active");
+    });
+  });
+});

package/tests/jest/components/DiscoveryServices.test.tsx

@@ -1,19 +1,18 @@
 import * as React from "react";
-import { fireEvent } from "@testing-library/react";
+import { installFormDataShim } from "../testUtils/formDataShim";
+import { fireEvent, screen, waitFor } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
 import { DiscoveryServices } from "../../../src/components/DiscoveryServices";
+import DiscoveryServicesConnected from "../../../src/components/DiscoveryServices";
 import renderWithContext from "../testUtils/renderWithContext";
+import { renderWithProviders } from "../testUtils/withProviders";
+import buildStore from "../../../src/store";
 import {
   ConfigurationSettings,
   DiscoveryServicesData,
 } from "../../../src/interfaces";
 import { defaultFeatureFlags } from "../../../src/utils/featureFlags";
 
-// NB: This adds tests to the already existing tests in:
-// - `src/components/__tests__/DiscoveryServices-test.tsx`.
-//
-// Those tests should eventually be migrated here and
-// adapted to the Jest/React Testing Library paradigm.
-
 describe("DiscoveryServices - registered library disclosure", () => {
   // ── Shared fixtures ───────────────────────────────────────────────────────
 
@@ -543,3 +542,151 @@ describe("DiscoveryServices - registered library disclosure", () => {
     expect(container.querySelectorAll(".associated-items")).toHaveLength(0);
   });
 });
+
+// These exercise behavior the disclosure tests above do not: the connect()
+// wiring (mapStateToProps / mapDispatchToProps, which only run when the CONNECTED
+// default export mounts) and the getChildContext().registerLibrary closure
+// (which only runs when a library is registered from the edit form).
+
+describe("DiscoveryServices - connected wiring and registration", () => {
+  const allLibraries = [
+    { short_name: "nypl", name: "NYPL", uuid: "uuid-nypl" },
+  ];
+
+  const sysAdminConfig: Partial<ConfigurationSettings> = {
+    csrfToken: "",
+    featureFlags: defaultFeatureFlags,
+    roles: [{ role: "system" }],
+  };
+
+  // A loaded `libraries` slice persists through the on-mount discovery fetches
+  // (the libraries reducer ignores those actions), so mapStateToProps takes its
+  // `data.allLibraries` branch on every render.
+  const loadedLibrariesState = {
+    data: { libraries: allLibraries },
+    isFetching: false,
+    isEditing: false,
+    fetchError: null,
+    formError: null,
+    isLoaded: true,
+    responseBody: null,
+    successMessage: null,
+  };
+
+  /**
+   * Stub `fetch` so the panel's on-mount fetches resolve with `body`. A fresh
+   * Response per call avoids "body already used" when several fetches run.
+   */
+  const stubFetch = (body: unknown) =>
+    jest.spyOn(globalThis, "fetch").mockImplementation(
+      async () =>
+        new Response(JSON.stringify(body), {
+          status: 200,
+          headers: { "Content-Type": "application/json" },
+        })
+    );
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  describe("connected default export", () => {
+    it("wires mapStateToProps/mapDispatchToProps: fetches on mount and renders the list", async () => {
+      const listData = {
+        discovery_services: [
+          { id: 2, protocol: "test protocol", name: "Test Discovery" },
+        ],
+        protocols: [{ name: "test protocol", label: "TP", settings: [] }],
+      };
+      stubFetch(listData);
+      // A fresh store, preloaded with a loaded libraries slice, isolates this
+      // test and exercises mapStateToProps' allLibraries branch.
+      const store = buildStore({
+        editor: { libraries: loadedLibrariesState },
+      } as any);
+
+      const { container } = renderWithProviders(
+        <DiscoveryServicesConnected csrfToken="token" />,
+        { reduxProviderProps: { store } }
+      );
+
+      // The list appears once the connected component's on-mount fetch resolves
+      // and mapStateToProps feeds the fetched data back in as props.
+      expect(
+        await screen.findByRole("heading", { level: 3, name: "Test Discovery" })
+      ).toBeInTheDocument();
+
+      const editLink = container.querySelector("a.edit-item");
+      expect(editLink).not.toBeNull();
+      expect(editLink.getAttribute("href")).toBe(
+        "/admin/web/config/discovery/edit/2"
+      );
+    });
+  });
+
+  describe("registerLibrary child context (edit mode)", () => {
+    // The reusable-components `Form` builds `new FormData(formElement)` on
+    // submit, which the unit jsdom env's undici FormData rejects; install the
+    // shared shim that reads the form's successful controls.
+    installFormDataShim();
+    const renderEditMode = (
+      registerLibrary: jest.Mock,
+      fetchLibraryRegistrations: jest.Mock
+    ) =>
+      renderWithContext(
+        <DiscoveryServices
+          data={
+            {
+              discovery_services: [
+                { id: "2", protocol: "test protocol", name: "Test Discovery" },
+              ],
+              protocols: [
+                {
+                  name: "test protocol",
+                  supports_registration: true,
+                  settings: [],
+                  library_settings: [],
+                },
+              ],
+              allLibraries,
+            } as any
+          }
+          editOrCreate="edit"
+          identifier="2"
+          fetchData={jest.fn()}
+          editItem={jest.fn().mockResolvedValue(undefined)}
+          deleteItem={jest.fn().mockResolvedValue(undefined)}
+          registerLibrary={registerLibrary}
+          fetchLibraryRegistrations={fetchLibraryRegistrations}
+          csrfToken="token"
+          isFetching={false}
+        />,
+        sysAdminConfig
+      );
+
+    it("fetches library registrations on mount, and registers a library (building the right FormData) and refetches on click", async () => {
+      const user = userEvent.setup();
+      const registerLibrary = jest.fn().mockResolvedValue(undefined);
+      const fetchLibraryRegistrations = jest.fn().mockResolvedValue(undefined);
+      renderEditMode(registerLibrary, fetchLibraryRegistrations);
+
+      // getChildContext supplies registerLibrary to the edit form; the edit form
+      // surfaces a "Register" button for each library.
+      expect(fetchLibraryRegistrations).toHaveBeenCalledTimes(1);
+      expect(registerLibrary).not.toHaveBeenCalled();
+
+      await user.click(screen.getByRole("button", { name: "Register" }));
+
+      expect(registerLibrary).toHaveBeenCalledTimes(1);
+      const formData = registerLibrary.mock.calls[0][0];
+      expect(formData.get("library_short_name")).toBe("nypl");
+      expect(formData.get("integration_id")).toBe("2");
+      expect(formData.get("registration_stage")).toBe("testing");
+
+      // After a successful registration, the child context refetches.
+      await waitFor(() =>
+        expect(fetchLibraryRegistrations).toHaveBeenCalledTimes(2)
+      );
+    });
+  });
+});