@thepalaceproject/circulation-admin 1.43.0-post.9 → 1.44.0

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

@@ -0,0 +1,134 @@
+import * as React from "react";
+import { installFormDataShim, FormDataShim } from "../testUtils/formDataShim";
+import { screen, waitFor } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders } from "../testUtils/withProviders";
+import buildStore from "../../../src/store";
+// Render the CONNECTED default export so that mapStateToProps / mapDispatchToProps
+// are exercised. The panel fetches its announcements on mount; the fetched data
+// flows back in through the Redux store.
+import SitewideAnnouncements from "../../../src/components/SitewideAnnouncements";
+
+const data = {
+  announcements: [
+    {
+      id: "dcf036d9-106b-426c-838f-ce7c57d53801",
+      content: "There is nothing to see here.",
+      start: "2022-08-31",
+      finish: "2022-10-31",
+    },
+  ],
+  settings: [
+    {
+      category: "Announcements",
+      description: "Announcements will be displayed to authenticated patrons.",
+      key: "global_announcements",
+      label: "Scheduled announcements",
+      level: 3,
+      type: "announcements",
+    },
+  ],
+};
+installFormDataShim();
+
+const jsonResponse = (body: unknown) =>
+  new Response(JSON.stringify(body), {
+    status: 200,
+    headers: { "Content-Type": "application/json" },
+  });
+
+const renderConnected = (
+  element: React.ReactElement,
+  appConfigSettings: Record<string, unknown> = {}
+) =>
+  renderWithProviders(element, {
+    reduxProviderProps: { store: buildStore() },
+    appConfigSettings,
+  });
+
+describe("SitewideAnnouncements", () => {
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it("renders a form containing the announcements section", async () => {
+    jest
+      .spyOn(globalThis, "fetch")
+      .mockImplementation(async () => jsonResponse(data));
+    const { container } = renderConnected(
+      <SitewideAnnouncements csrfToken="token" />
+    );
+
+    // Once the on-mount fetch resolves, the form renders with the announcement
+    // supplied through the store (proving the AnnouncementsSection received the
+    // data as its value).
+    expect(
+      await screen.findByText("There is nothing to see here.")
+    ).toBeInTheDocument();
+    expect(screen.getByText("Scheduled Announcements:")).toBeInTheDocument();
+    expect(container.querySelector("form")).toBeInTheDocument();
+  });
+
+  it("renders a loading indicator instead of a form while data is loading", () => {
+    // A never-resolving fetch keeps the panel in its fetching state.
+    jest
+      .spyOn(globalThis, "fetch")
+      .mockImplementation(() => new Promise(() => {}));
+    const { container } = renderConnected(
+      <SitewideAnnouncements csrfToken="token" />
+    );
+
+    expect(container.querySelector(".loading")).toBeInTheDocument();
+    expect(container.querySelector("form")).not.toBeInTheDocument();
+  });
+
+  it("submits the announcements to editItem when the form is submitted", async () => {
+    const user = userEvent.setup();
+    const fetchSpy = jest
+      .spyOn(globalThis, "fetch")
+      .mockImplementation(async (_url, opts?: RequestInit) => {
+        if (opts?.method === "POST") {
+          return new Response("success", { status: 200 });
+        }
+        return jsonResponse(data);
+      });
+
+    // System admin so the settings' required permission level is satisfied and
+    // the submit button is enabled.
+    renderConnected(<SitewideAnnouncements csrfToken="token" />, {
+      roles: [{ role: "system" }],
+    });
+
+    await screen.findByText("There is nothing to see here.");
+
+    await user.click(screen.getByRole("button", { name: "Submit" }));
+
+    // The submit dispatches editSitewideAnnouncements, which POSTs the form.
+    await waitFor(() => {
+      const postCall = fetchSpy.mock.calls.find(
+        ([, opts]) => (opts as RequestInit)?.method === "POST"
+      );
+      expect(postCall).toBeDefined();
+    });
+
+    const postCall = fetchSpy.mock.calls.find(
+      ([, opts]) => (opts as RequestInit)?.method === "POST"
+    );
+    const body = (postCall[1] as RequestInit).body as unknown as FormDataShim;
+    expect(JSON.parse(body.get("announcements"))).toStrictEqual(
+      data.announcements
+    );
+  });
+
+  it("disables the submit button when the admin lacks the required permission level", async () => {
+    jest
+      .spyOn(globalThis, "fetch")
+      .mockImplementation(async () => jsonResponse(data));
+    // No roles => admin level 1, below the settings' required level of 3.
+    renderConnected(<SitewideAnnouncements csrfToken="token" />);
+
+    await screen.findByText("There is nothing to see here.");
+    expect(screen.getByRole("button", { name: "Submit" })).toBeDisabled();
+  });
+});

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

@@ -28,13 +28,6 @@ const normalizedData = normalizeStatistics(statisticsApiResponseData);
 global.ResizeObserver = require("resize-observer-polyfill");
 
 describe("Dashboard Statistics", () => {
-  // NB: This adds test to the already existing tests in:
-  // - `src/components/__tests__/LibraryStats-test.tsx`.
-  // - `src/components/__tests__/SingleStatListItem-test.tsx`.
-  //
-  // Those tests should eventually be migrated here and
-  // adapted to the Jest/React Testing Library paradigm.
-
   // Configure standard constructors so that RTK Query works in tests with FetchMockJest
   Object.assign(fetchMock.config, {
     fetch,

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

@@ -0,0 +1,218 @@
+import * as React from "react";
+import { render, screen, act } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import TextWithEditMode from "../../../src/components/TextWithEditMode";
+
+describe("TextWithEditMode", () => {
+  it("renders text", () => {
+    const { rerender } = render(
+      <TextWithEditMode
+        text="test"
+        placeholder="editable thing"
+        aria-label="label"
+      />
+    );
+    expect(screen.getByText("test")).toBeInTheDocument();
+    expect(
+      screen.getByRole("button", { name: /Edit editable thing/ })
+    ).toBeInTheDocument();
+
+    rerender(
+      <TextWithEditMode
+        text="other text"
+        placeholder="editable thing"
+        aria-label="label"
+      />
+    );
+    expect(screen.queryByText("test")).not.toBeInTheDocument();
+    expect(screen.getByText("other text")).toBeInTheDocument();
+  });
+
+  it("starts in edit mode if there's no text", () => {
+    render(
+      <TextWithEditMode placeholder="editable thing" aria-label="label" />
+    );
+    const input = screen.getByRole("textbox");
+    expect(input).toHaveAttribute("placeholder", "editable thing");
+    expect(input).toHaveValue("");
+    expect(
+      screen.getByRole("button", { name: /Save editable thing/ })
+    ).toBeInTheDocument();
+  });
+
+  it("switches to edit mode", async () => {
+    const user = userEvent.setup();
+    render(
+      <TextWithEditMode
+        text="test"
+        placeholder="editable thing"
+        aria-label="label"
+      />
+    );
+    expect(screen.queryByRole("textbox")).not.toBeInTheDocument();
+
+    await user.click(
+      screen.getByRole("button", { name: /Edit editable thing/ })
+    );
+
+    const input = screen.getByRole("textbox");
+    expect(input).toHaveAttribute("placeholder", "editable thing");
+    expect(input).toHaveValue("test");
+    expect(screen.getByRole("button", { name: /Save/ })).toBeInTheDocument();
+    expect(
+      screen.queryByRole("button", { name: /Edit/ })
+    ).not.toBeInTheDocument();
+  });
+
+  it("switches out of edit mode", async () => {
+    const user = userEvent.setup();
+    const onUpdate = jest.fn();
+    render(
+      <TextWithEditMode
+        placeholder="editable thing"
+        onUpdate={onUpdate}
+        aria-label="label"
+      />
+    );
+    // Type the new value into the field; the component reads the real input
+    // value back through its ref on save (no prototype stubbing).
+    await user.type(screen.getByRole("textbox"), "new value");
+    await user.click(
+      screen.getByRole("button", { name: /Save editable thing/ })
+    );
+
+    expect(screen.queryByRole("textbox")).not.toBeInTheDocument();
+    expect(onUpdate).toHaveBeenCalledTimes(1);
+    expect(onUpdate).toHaveBeenCalledWith("new value");
+    expect(screen.getByText("new value")).toBeInTheDocument();
+    expect(screen.getByRole("button", { name: /Edit/ })).toBeInTheDocument();
+    expect(
+      screen.queryByRole("button", { name: /Save/ })
+    ).not.toBeInTheDocument();
+  });
+
+  it("gets text via the ref API", async () => {
+    const user = userEvent.setup();
+    // In display mode, getText() returns the current text.
+    const displayRef = React.createRef<TextWithEditMode>();
+    const { unmount } = render(
+      <TextWithEditMode
+        text="test"
+        placeholder="editable thing"
+        aria-label="label"
+        ref={displayRef}
+      />
+    );
+    expect(displayRef.current!.getText()).toBe("test");
+    unmount();
+
+    // From edit mode, getText() returns the current input value and exits edit mode.
+    const editRef = React.createRef<TextWithEditMode>();
+    render(
+      <TextWithEditMode
+        placeholder="editable thing"
+        aria-label="label"
+        ref={editRef}
+      />
+    );
+    await user.type(screen.getByRole("textbox"), "new value");
+    let value = "";
+    act(() => {
+      value = editRef.current!.getText();
+    });
+    expect(value).toBe("new value");
+    expect(screen.queryByRole("textbox")).not.toBeInTheDocument();
+  });
+
+  it("resets via the ref API", async () => {
+    const user = userEvent.setup();
+    const onUpdate = jest.fn();
+
+    // With no text prop, reset() returns to a blank edit mode.
+    const blankRef = React.createRef<TextWithEditMode>();
+    const { unmount } = render(
+      <TextWithEditMode
+        placeholder="editable thing"
+        onUpdate={onUpdate}
+        aria-label="label"
+        ref={blankRef}
+      />
+    );
+    await user.type(screen.getByRole("textbox"), "new value");
+    await user.click(
+      screen.getByRole("button", { name: /Save editable thing/ })
+    );
+    expect(screen.getByText("new value")).toBeInTheDocument();
+    expect(onUpdate).toHaveBeenCalledTimes(1);
+
+    act(() => {
+      blankRef.current!.reset();
+    });
+    expect(screen.queryByText("new value")).not.toBeInTheDocument();
+    expect(screen.getByRole("textbox")).toBeInTheDocument();
+    expect(onUpdate).toHaveBeenCalledTimes(2);
+    expect(onUpdate.mock.calls[1][0]).toBeUndefined();
+    unmount();
+
+    // With a text prop, reset() returns to displaying that text.
+    const textRef = React.createRef<TextWithEditMode>();
+    render(
+      <TextWithEditMode
+        text="test"
+        placeholder="editable thing"
+        onUpdate={onUpdate}
+        aria-label="label"
+        ref={textRef}
+      />
+    );
+    await user.click(
+      screen.getByRole("button", { name: /Edit editable thing/ })
+    );
+    const input = screen.getByRole("textbox");
+    await user.clear(input);
+    await user.type(input, "new value");
+    await user.click(
+      screen.getByRole("button", { name: /Save editable thing/ })
+    );
+    expect(screen.queryByText("test")).not.toBeInTheDocument();
+    expect(screen.getByText("new value")).toBeInTheDocument();
+    expect(onUpdate).toHaveBeenCalledTimes(3);
+
+    act(() => {
+      textRef.current!.reset();
+    });
+    expect(screen.queryByText("new value")).not.toBeInTheDocument();
+    expect(screen.getByText("test")).toBeInTheDocument();
+    expect(onUpdate).toHaveBeenCalledTimes(4);
+    expect(onUpdate.mock.calls[3][0]).toBe("test");
+  });
+
+  it("optionally disables the save button if the text is blank", async () => {
+    const user = userEvent.setup();
+    render(
+      <TextWithEditMode
+        placeholder="editable thing"
+        aria-label="label"
+        disableIfBlank
+      />
+    );
+    const saveButton = screen.getByRole("button", {
+      name: /Save editable thing/,
+    });
+    expect(saveButton).toBeDisabled();
+
+    await user.type(screen.getByRole("textbox"), "test");
+    expect(saveButton).toBeEnabled();
+  });
+
+  it("updates the displayed value as the user types", async () => {
+    const user = userEvent.setup();
+    render(
+      <TextWithEditMode placeholder="editable thing" aria-label="label" />
+    );
+    const input = screen.getByRole("textbox");
+    expect(input).toHaveValue("");
+    await user.type(input, "test");
+    expect(input).toHaveValue("test");
+  });
+});

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

@@ -0,0 +1,46 @@
+import * as React from "react";
+import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import ToolTip from "../../../src/components/ToolTip";
+
+describe("ToolTip", () => {
+  const renderToolTip = () =>
+    render(<ToolTip trigger={<h1>Hover</h1>} text="ToolTip Content" />);
+
+  it("renders the trigger element", () => {
+    renderToolTip();
+    expect(screen.getByRole("heading", { name: "Hover" })).toBeInTheDocument();
+  });
+
+  it("renders the tooltip", () => {
+    const { container } = renderToolTip();
+    const tooltip = container.querySelector<HTMLElement>(".tool-tip")!;
+    expect(tooltip).toBeInTheDocument();
+    expect(tooltip).toHaveTextContent("ToolTip Content");
+    expect(tooltip.innerHTML).toContain("ToolTip Content");
+  });
+
+  it("initially hides the tooltip", () => {
+    const { container } = renderToolTip();
+    expect(container.querySelector(".tool-tip")).toHaveClass("hide");
+  });
+
+  it("shows the tooltip on mouseEnter", async () => {
+    const user = userEvent.setup();
+    const { container } = renderToolTip();
+    await user.hover(screen.getByRole("tooltip"));
+    expect(container.querySelector(".tool-tip")).not.toHaveClass("hide");
+  });
+
+  it("hides the tooltip on mouseLeave", async () => {
+    const user = userEvent.setup();
+    const { container } = renderToolTip();
+    const toolTipContainer = screen.getByRole("tooltip");
+
+    await user.hover(toolTipContainer);
+    expect(container.querySelector(".tool-tip")).not.toHaveClass("hide");
+
+    await user.unhover(toolTipContainer);
+    expect(container.querySelector(".tool-tip")).toHaveClass("hide");
+  });
+});

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

@@ -0,0 +1,69 @@
+import * as React from "react";
+import { screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders } from "../testUtils/withProviders";
+
+// The tab containers are connected components that fetch on mount and require
+// react-router context; TroubleshootingCategoryPage only chooses between them
+// and hands them a `tab` and `goToTab`. Mock them to markers that surface the
+// `tab` they receive and let us drive `goToTab`.
+jest.mock("../../../src/components/DiagnosticsTabContainer", () => ({
+  __esModule: true,
+  default: (props: any) => (
+    <div data-testid="diagnostics-tab-container" data-tab={props.tab}>
+      <button type="button" onClick={() => props.goToTab("monitor")}>
+        go-to-monitor
+      </button>
+    </div>
+  ),
+}));
+jest.mock("../../../src/components/SelfTestsTabContainer", () => ({
+  __esModule: true,
+  default: (props: any) => (
+    <div data-testid="self-tests-tab-container" data-tab={props.tab} />
+  ),
+}));
+
+import TroubleshootingCategoryPage from "../../../src/components/TroubleshootingCategoryPage";
+
+describe("TroubleshootingCategoryPage", () => {
+  it("renders a tab container", () => {
+    renderWithProviders(<TroubleshootingCategoryPage type="diagnostics" />);
+
+    expect(screen.getByTestId("diagnostics-tab-container")).toBeInTheDocument();
+    expect(
+      screen.queryByTestId("self-tests-tab-container")
+    ).not.toBeInTheDocument();
+  });
+
+  it("switches tabs", async () => {
+    const user = userEvent.setup();
+    renderWithProviders(<TroubleshootingCategoryPage type="diagnostics" />);
+
+    expect(screen.getByTestId("diagnostics-tab-container")).toHaveAttribute(
+      "data-tab",
+      "coverage_provider"
+    );
+
+    await user.click(screen.getByRole("button", { name: "go-to-monitor" }));
+
+    expect(screen.getByTestId("diagnostics-tab-container")).toHaveAttribute(
+      "data-tab",
+      "monitor"
+    );
+  });
+
+  it("renders a different tab container", () => {
+    const { rerender } = renderWithProviders(
+      <TroubleshootingCategoryPage type="diagnostics" />
+    );
+
+    rerender(<TroubleshootingCategoryPage type="self-tests" />);
+
+    expect(
+      screen.queryByTestId("diagnostics-tab-container")
+    ).not.toBeInTheDocument();
+    expect(screen.getByTestId("self-tests-tab-container")).toBeInTheDocument();
+  });
+});

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

@@ -0,0 +1,94 @@
+import * as React from "react";
+import { screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders } from "../testUtils/withProviders";
+import title from "../../../src/utils/title";
+
+// Header needs react-router v3 context that renderWithProviders does not supply,
+// and both Header and Footer are page chrome, so mock them to markers.
+jest.mock("../../../src/components/Header", () => ({
+  __esModule: true,
+  default: () => <div data-testid="header" />,
+}));
+jest.mock("../../../src/components/Footer", () => ({
+  __esModule: true,
+  default: () => <div data-testid="footer" />,
+}));
+
+// The real TroubleshootingTabContainer requires router/pathFor context and
+// mounts self-test/diagnostic pages that fetch on mount. TroubleshootingPage's
+// own behavior is to own the active tab and pass it (and a goToTab callback)
+// down, so mock the container to a marker that exposes its `tab`/`subtab` props
+// and a control that invokes `goToTab` — exactly the contract under test.
+jest.mock("../../../src/components/TroubleshootingTabContainer", () => ({
+  __esModule: true,
+  default: ({
+    tab,
+    subtab,
+    goToTab,
+  }: {
+    tab: string;
+    subtab: string;
+    goToTab: (tab: string) => void;
+  }) => (
+    <div data-testid="tab-container" data-tab={tab} data-subtab={subtab}>
+      <button type="button" onClick={() => goToTab("self-tests")}>
+        Go to self-tests
+      </button>
+    </div>
+  ),
+}));
+
+import TroubleshootingPage from "../../../src/components/TroubleshootingPage";
+
+const renderPage = () =>
+  renderWithProviders(<TroubleshootingPage params={{ tab: "", subtab: "" }} />);
+
+describe("TroubleshootingPage", () => {
+  it("renders a header", () => {
+    renderPage();
+    expect(screen.getByTestId("header")).toBeInTheDocument();
+  });
+
+  it("renders a heading", () => {
+    renderPage();
+    expect(
+      screen.getByRole("heading", { name: "Troubleshooting" })
+    ).toBeInTheDocument();
+  });
+
+  it("renders a tab container starting on the diagnostics tab", () => {
+    renderPage();
+    const tabContainer = screen.getByTestId("tab-container");
+    expect(tabContainer).toBeInTheDocument();
+    expect(tabContainer).toHaveAttribute("data-tab", "diagnostics");
+  });
+
+  it("switches tabs", async () => {
+    const user = userEvent.setup();
+    renderPage();
+
+    expect(screen.getByTestId("tab-container")).toHaveAttribute(
+      "data-tab",
+      "diagnostics"
+    );
+
+    await user.click(screen.getByRole("button", { name: "Go to self-tests" }));
+
+    expect(screen.getByTestId("tab-container")).toHaveAttribute(
+      "data-tab",
+      "self-tests"
+    );
+  });
+
+  it("sets the document title", () => {
+    renderPage();
+    expect(document.title).toBe(title("Troubleshooting"));
+  });
+
+  it("shows a footer", () => {
+    renderPage();
+    expect(screen.getByTestId("footer")).toBeInTheDocument();
+  });
+});