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

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

@@ -0,0 +1,180 @@
+import * as React from "react";
+import { screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders } from "../testUtils/withProviders";
+import { installFormDataShim } from "../testUtils/formDataShim";
+import buildStore from "../../../src/store";
+import { ManagePatronsForm } from "../../../src/components/ManagePatronsForm";
+import { PatronData } from "../../../src/interfaces";
+
+// The reusable-components `Form` builds `new FormData(formElement)` on submit,
+// which the unit jsdom environment's undici FormData rejects; install the shared
+// shim that reads the form's successful controls.
+installFormDataShim();
+
+const patron: PatronData = {
+  authorization_expires: "",
+  username: "User Name",
+  personal_name: "Personal Name",
+  email_address: "user@email.com",
+  authorization_identifier: "1234",
+  authorization_identifiers: [""],
+  block_reason: "",
+  external_type: "",
+  fines: "",
+  permanent_id: "",
+};
+
+// `clearPatronData` is called on unmount (RTL cleanup), so it must always be a
+// function; `patronLookup` too, so the connected dispatch props are stubbed.
+const renderForm = (props: Record<string, unknown> = {}) =>
+  renderWithProviders(
+    <ManagePatronsForm
+      store={buildStore()}
+      csrfToken="token"
+      library="nypl"
+      patronLookup={jest.fn()}
+      clearPatronData={jest.fn()}
+      {...props}
+    />
+  );
+
+describe("ManagePatronsForm", () => {
+  describe("rendering", () => {
+    it("has .manage-patrons-form class", () => {
+      const { container } = renderForm();
+      expect(
+        container.querySelector(".manage-patrons-form")
+      ).toBeInTheDocument();
+    });
+
+    it("shows an editable identifier input", () => {
+      renderForm();
+      expect(
+        screen.getByPlaceholderText("Enter the patron's identifier")
+      ).toBeInTheDocument();
+      expect(screen.getByRole("textbox")).toBeInTheDocument();
+    });
+
+    it("has a form with an input field and a button", () => {
+      const { container } = renderForm();
+      expect(container.querySelectorAll("form")).toHaveLength(1);
+      expect(container.querySelectorAll("form input")).toHaveLength(1);
+      expect(container.querySelectorAll("form button")).toHaveLength(1);
+    });
+
+    it("doesn't initially show an alert or error message", () => {
+      const { container } = renderForm();
+      expect(container.querySelector(".alert")).not.toBeInTheDocument();
+      expect(screen.queryByText(/Patron found/)).not.toBeInTheDocument();
+    });
+  });
+
+  describe("behavior", () => {
+    it("calls patronLookup on submit", async () => {
+      const user = userEvent.setup();
+      const patronLookup = jest.fn();
+      renderForm({ patronLookup });
+
+      expect(patronLookup).not.toHaveBeenCalled();
+
+      await user.type(
+        screen.getByPlaceholderText("Enter the patron's identifier"),
+        "1234"
+      );
+      await user.click(screen.getByRole("button"));
+
+      expect(patronLookup).toHaveBeenCalledTimes(1);
+      // The second argument is the library short name.
+      expect(patronLookup.mock.calls[0][1]).toBe("nypl");
+    });
+
+    it("displays an error message if there is an error", () => {
+      const fetchError = { status: 400, response: "", url: "" };
+      const { container, rerender } = renderForm();
+      expect(container.querySelector(".alert-danger")).not.toBeInTheDocument();
+
+      rerender(
+        <ManagePatronsForm
+          store={buildStore()}
+          csrfToken="token"
+          library="nypl"
+          patronLookup={jest.fn()}
+          clearPatronData={jest.fn()}
+          fetchError={fetchError}
+        />
+      );
+
+      expect(container.querySelector(".alert-danger")).toBeInTheDocument();
+      expect(screen.getByText(/Error:/)).toBeInTheDocument();
+    });
+
+    it("should display a no-identifier message if the input field is blank when searching", () => {
+      const fetchError = {
+        status: 400,
+        response: "No patron identifier provided",
+        url: "",
+      };
+      const { rerender } = renderForm();
+      expect(
+        screen.queryByText("Error: No patron identifier provided")
+      ).not.toBeInTheDocument();
+
+      rerender(
+        <ManagePatronsForm
+          store={buildStore()}
+          csrfToken="token"
+          library="nypl"
+          patronLookup={jest.fn()}
+          clearPatronData={jest.fn()}
+          fetchError={fetchError}
+        />
+      );
+
+      expect(
+        screen.getByText("Error: No patron identifier provided")
+      ).toBeInTheDocument();
+    });
+
+    it("should display a success alert message when a patron is found", () => {
+      const { container, rerender } = renderForm();
+      expect(container.querySelector(".alert-success")).not.toBeInTheDocument();
+
+      rerender(
+        <ManagePatronsForm
+          store={buildStore()}
+          csrfToken="token"
+          library="nypl"
+          patronLookup={jest.fn()}
+          clearPatronData={jest.fn()}
+          patron={patron}
+        />
+      );
+
+      const alert = container.querySelector(".alert-success");
+      expect(alert).toBeInTheDocument();
+      expect(alert).toHaveTextContent(
+        `Patron found: ${patron.authorization_identifier}`
+      );
+    });
+
+    it("should show the PatronInfo list when a patron is found", () => {
+      const { container, rerender } = renderForm();
+      expect(container.querySelector(".patron-info")).not.toBeInTheDocument();
+
+      rerender(
+        <ManagePatronsForm
+          store={buildStore()}
+          csrfToken="token"
+          library="nypl"
+          patronLookup={jest.fn()}
+          clearPatronData={jest.fn()}
+          patron={patron}
+        />
+      );
+
+      expect(container.querySelector(".patron-info")).toBeInTheDocument();
+    });
+  });
+});

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

@@ -0,0 +1,143 @@
+import * as React from "react";
+import * as PropTypes from "prop-types";
+import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import buildStore from "../../../src/store";
+import Admin from "../../../src/models/Admin";
+
+// Both tab panels fetch on mount (ResetAdobeId is a connected component; Debug
+// Authentication uses react-query). They're incidental to a tab-navigation test,
+// so mock them to markers. ResetAdobeId echoes the csrfToken asserted below.
+jest.mock("../../../src/components/ResetAdobeId", () => ({
+  __esModule: true,
+  default: (props: any) => (
+    <div data-testid="reset-adobe-id" data-csrf-token={props.csrfToken} />
+  ),
+}));
+jest.mock("../../../src/components/DebugAuthentication", () => ({
+  __esModule: true,
+  default: () => <div data-testid="debug-authentication" />,
+}));
+
+import ManagePatronsTabContainer from "../../../src/components/ManagePatronsTabContainer";
+
+// ManagePatronsTabContainer reads `admin`, `router`, and `pathFor` from the legacy
+// React context the app supplies in production. Wrap it in a small provider that
+// hands it those.
+class LegacyContextProvider extends React.Component<{ context: any }> {
+  static childContextTypes = {
+    router: PropTypes.object,
+    pathFor: PropTypes.func,
+    admin: PropTypes.object,
+  };
+  getChildContext() {
+    return this.props.context;
+  }
+  render() {
+    return this.props.children;
+  }
+}
+
+describe("ManagePatronsTabContainer", () => {
+  const systemAdmin = new Admin([{ role: "system" }]);
+  const libraryManagerNYPL = new Admin([{ role: "manager", library: "NYPL" }]);
+  const libraryManagerA = new Admin([{ role: "manager", library: "a" }]);
+  const librarian = new Admin([{ role: "librarian", library: "NYPL" }]);
+
+  const renderWithAdmin = (admin: Admin, push: jest.Mock = jest.fn()) => {
+    const context = { router: { push }, pathFor: jest.fn(), admin };
+    const result = render(
+      <LegacyContextProvider context={context}>
+        <ManagePatronsTabContainer
+          tab={null}
+          csrfToken="token"
+          store={buildStore()}
+          library="NYPL"
+        />
+      </LegacyContextProvider>
+    );
+    return { ...result, push };
+  };
+
+  describe("for system admin", () => {
+    it("shows tabs", () => {
+      renderWithAdmin(systemAdmin);
+      expect(
+        screen.getByRole("link", { name: "Reset Adobe ID" })
+      ).toBeInTheDocument();
+      expect(
+        screen.getByRole("link", { name: "Debug Authentication" })
+      ).toBeInTheDocument();
+    });
+
+    it("shows components", () => {
+      renderWithAdmin(systemAdmin);
+      expect(screen.getByTestId("reset-adobe-id")).toHaveAttribute(
+        "data-csrf-token",
+        "token"
+      );
+    });
+
+    it("uses router to navigate when tab is clicked", async () => {
+      const user = userEvent.setup();
+      const { push } = renderWithAdmin(systemAdmin);
+      await user.click(screen.getByRole("link", { name: "Reset Adobe ID" }));
+      expect(push).toHaveBeenCalledTimes(1);
+      expect(push).toHaveBeenCalledWith("/admin/web/patrons/NYPL/resetAdobeId");
+    });
+  });
+
+  describe("for right library manager", () => {
+    it("shows tabs", () => {
+      renderWithAdmin(libraryManagerNYPL);
+      expect(
+        screen.getByRole("link", { name: "Reset Adobe ID" })
+      ).toBeInTheDocument();
+      expect(
+        screen.getByRole("link", { name: "Debug Authentication" })
+      ).toBeInTheDocument();
+    });
+
+    it("marks the current tab as active", () => {
+      const { container } = renderWithAdmin(libraryManagerNYPL);
+      const tabItems = container.querySelectorAll("ul.nav-tabs li");
+      expect(tabItems).toHaveLength(2);
+      expect(tabItems[0]).toHaveClass("active");
+    });
+
+    it("shows components", () => {
+      renderWithAdmin(libraryManagerNYPL);
+      expect(screen.getByTestId("reset-adobe-id")).toHaveAttribute(
+        "data-csrf-token",
+        "token"
+      );
+    });
+
+    it("uses router to navigate when tab is clicked", async () => {
+      const user = userEvent.setup();
+      const { push } = renderWithAdmin(libraryManagerNYPL);
+      await user.click(screen.getByRole("link", { name: "Reset Adobe ID" }));
+      expect(push).toHaveBeenCalledTimes(1);
+      expect(push).toHaveBeenCalledWith("/admin/web/patrons/NYPL/resetAdobeId");
+    });
+  });
+
+  describe("for wrong library manager", () => {
+    it("doesn't show tabs", () => {
+      renderWithAdmin(libraryManagerA);
+      expect(
+        screen.queryByRole("link", { name: "Reset Adobe ID" })
+      ).not.toBeInTheDocument();
+    });
+  });
+
+  describe("for librarian", () => {
+    it("doesn't show tabs", () => {
+      renderWithAdmin(librarian);
+      expect(
+        screen.queryByRole("link", { name: "Reset Adobe ID" })
+      ).not.toBeInTheDocument();
+    });
+  });
+});

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

@@ -0,0 +1,95 @@
+import * as React from "react";
+import { screen, within } from "@testing-library/react";
+import MetadataServicesConnected, {
+  MetadataServices,
+} from "../../../src/components/MetadataServices";
+import renderWithContext from "../testUtils/renderWithContext";
+import { renderWithProviders } from "../testUtils/withProviders";
+import buildStore from "../../../src/store";
+import { defaultFeatureFlags } from "../../../src/utils/featureFlags";
+
+describe("MetadataServices", () => {
+  const data = {
+    metadata_services: [
+      {
+        id: 2,
+        protocol: "test protocol",
+        name: "sample name",
+        settings: {
+          test_setting: "test setting",
+        },
+        libraries: [{ short_name: "nypl" }],
+      },
+    ],
+    protocols: [
+      {
+        name: "test protocol",
+        label: "test protocol label",
+        sitewide: false,
+        settings: [],
+      },
+    ],
+    allLibraries: [
+      {
+        short_name: "nypl",
+      },
+    ],
+  };
+
+  const config = { csrfToken: "token", featureFlags: defaultFeatureFlags };
+
+  it("shows metadata service list", () => {
+    renderWithContext(
+      <MetadataServices
+        data={data}
+        fetchData={jest.fn()}
+        editItem={jest.fn().mockResolvedValue(undefined)}
+        csrfToken="token"
+        isFetching={false}
+      />,
+      config
+    );
+
+    const items = screen.getAllByRole("listitem");
+    expect(items).toHaveLength(1);
+    expect(items[0]).toHaveTextContent("sample name: test protocol");
+
+    const editLink = within(items[0]).getByRole("link");
+    expect(editLink).toHaveAttribute(
+      "href",
+      "/admin/web/config/metadata/edit/2"
+    );
+  });
+});
+
+describe("MetadataServices - connected wiring", () => {
+  afterEach(() => jest.restoreAllMocks());
+
+  it("wires mapStateToProps/mapDispatchToProps and renders the fetched list", async () => {
+    jest.spyOn(globalThis, "fetch").mockImplementation(
+      async () =>
+        new Response(
+          JSON.stringify({
+            metadata_services: [
+              { id: 2, protocol: "test protocol", name: "Test Metadata" },
+            ],
+            protocols: [{ name: "test protocol", label: "TP", settings: [] }],
+          }),
+          { status: 200, headers: { "Content-Type": "application/json" } }
+        )
+    );
+
+    renderWithProviders(<MetadataServicesConnected csrfToken="token" />, {
+      reduxProviderProps: { store: buildStore() },
+      appConfigSettings: { roles: [{ role: "system" }] },
+    });
+
+    // The edit link only appears once the on-mount fetch resolves and
+    // mapStateToProps feeds the fetched service back in as props.
+    const editLink = await screen.findByRole("link", { name: /edit/i });
+    expect(editLink).toHaveAttribute(
+      "href",
+      "/admin/web/config/metadata/edit/2"
+    );
+  });
+});

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

@@ -0,0 +1,167 @@
+import * as React from "react";
+import { render } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import NeighborhoodAnalyticsForm from "../../../src/components/NeighborhoodAnalyticsForm";
+import { SettingData } from "../../../src/interfaces";
+
+const patronAuthSetting: SettingData = {
+  key: "neighborhood_mode",
+  label: "Patron Auth",
+  options: [
+    { key: "disabled", label: "Off" },
+    { key: "choice1", label: "Choice 1" },
+    { key: "choice2", label: "Choice 2" },
+  ],
+};
+
+const analyticsSetting: SettingData = {
+  key: "location_source",
+  label: "Analytics",
+  options: [
+    { key: "disabled", label: "Off" },
+    { key: "choice1", label: "Choice 1" },
+    { key: "choice2", label: "Choice 2" },
+  ],
+};
+
+// The Panel renders its body collapsed and `aria-hidden` by default, so the
+// form is present in the DOM but hidden from the accessibility tree; query it
+// through the container.
+const getSelect = (container: HTMLElement) =>
+  container.querySelector("select") as HTMLSelectElement;
+const panelTitle = (container: HTMLElement) =>
+  container.querySelector(".panel-title") as HTMLElement;
+const warning = (container: HTMLElement) =>
+  container.querySelector(".bg-warning") as HTMLElement | null;
+
+describe("NeighborhoodAnalyticsForm", () => {
+  it("renders a panel with the feature name", () => {
+    const { container } = render(
+      <NeighborhoodAnalyticsForm setting={patronAuthSetting} />
+    );
+    expect(container.querySelector(".panel")).toBeInTheDocument();
+    expect(panelTitle(container)).toHaveTextContent(
+      "Patron Neighborhood Analytics: Disabled"
+    );
+  });
+
+  it("renders a select whose options reflect the setting", () => {
+    const { container } = render(
+      <NeighborhoodAnalyticsForm setting={patronAuthSetting} />
+    );
+    const options = Array.from(getSelect(container).querySelectorAll("option"));
+    expect(options).toHaveLength(patronAuthSetting.options.length);
+    options.forEach((option, idx) => {
+      expect(option).toHaveValue(patronAuthSetting.options[idx].key);
+      expect(option).toHaveTextContent(patronAuthSetting.options[idx].label);
+    });
+  });
+
+  it("renders a warning message pointing at the paired service once enabled", async () => {
+    const user = userEvent.setup();
+    const { container, rerender } = render(
+      <NeighborhoodAnalyticsForm setting={patronAuthSetting} />
+    );
+
+    // No warning while the feature is off.
+    expect(warning(container)).not.toBeInTheDocument();
+    await user.selectOptions(getSelect(container), "disabled");
+    expect(warning(container)).not.toBeInTheDocument();
+
+    // Enabling it surfaces a warning that links to the analytics config.
+    await user.selectOptions(getSelect(container), "choice1");
+    expect(warning(container)).toBeInTheDocument();
+    expect(warning(container)).toHaveTextContent(
+      "This feature will work only if it is also enabled in your local analytics service configuration settings."
+    );
+    expect(warning(container).querySelector("a")).toHaveAttribute(
+      "href",
+      "/admin/web/config/analytics"
+    );
+
+    // Switching the setting flips the paired service to patron auth.
+    rerender(<NeighborhoodAnalyticsForm setting={analyticsSetting} />);
+    expect(warning(container)).toHaveTextContent(
+      "This feature will work only if it is also enabled in your patron authentication service configuration settings."
+    );
+    expect(warning(container).querySelector("a")).toHaveAttribute(
+      "href",
+      "/admin/web/config/patronAuth"
+    );
+  });
+
+  it("updates the header when an option is chosen", async () => {
+    const user = userEvent.setup();
+    const { container } = render(
+      <NeighborhoodAnalyticsForm setting={patronAuthSetting} />
+    );
+    expect(panelTitle(container)).toHaveTextContent(
+      "Patron Neighborhood Analytics: Disabled"
+    );
+
+    await user.selectOptions(getSelect(container), "choice1");
+    expect(panelTitle(container)).toHaveTextContent(
+      "Patron Neighborhood Analytics: Enabled"
+    );
+  });
+
+  it("reflects the currentValue prop as the initial selection", () => {
+    const { container } = render(
+      <NeighborhoodAnalyticsForm
+        setting={patronAuthSetting}
+        currentValue="choice1"
+      />
+    );
+    // A non-"disabled" currentValue means the feature starts enabled.
+    expect(panelTitle(container)).toHaveTextContent(
+      "Patron Neighborhood Analytics: Enabled"
+    );
+    expect(getSelect(container)).toHaveValue("choice1");
+  });
+
+  it("tells the user whether the feature is currently enabled", async () => {
+    const user = userEvent.setup();
+    const { container } = render(
+      <NeighborhoodAnalyticsForm setting={patronAuthSetting} />
+    );
+
+    expect(panelTitle(container)).toHaveTextContent("Disabled");
+    await user.selectOptions(getSelect(container), "choice1");
+    expect(panelTitle(container)).toHaveTextContent("Enabled");
+    await user.selectOptions(getSelect(container), "choice2");
+    expect(panelTitle(container)).toHaveTextContent("Enabled");
+    await user.selectOptions(getSelect(container), "disabled");
+    expect(panelTitle(container)).toHaveTextContent("Disabled");
+  });
+
+  it("shows the warning only for enabled selections", async () => {
+    const user = userEvent.setup();
+    const { container } = render(
+      <NeighborhoodAnalyticsForm setting={patronAuthSetting} />
+    );
+
+    expect(warning(container)).not.toBeInTheDocument();
+    await user.selectOptions(getSelect(container), "choice1");
+    expect(warning(container)).toBeInTheDocument();
+    await user.selectOptions(getSelect(container), "choice2");
+    expect(warning(container)).toBeInTheDocument();
+    await user.selectOptions(getSelect(container), "disabled");
+    expect(warning(container)).not.toBeInTheDocument();
+  });
+
+  it("exposes the selected value through its getValue ref API", async () => {
+    // ServiceEditForm reads the chosen value via this imperative ref API.
+    const user = userEvent.setup();
+    const ref = React.createRef<NeighborhoodAnalyticsForm>();
+    const { container } = render(
+      <NeighborhoodAnalyticsForm ref={ref} setting={patronAuthSetting} />
+    );
+
+    expect(ref.current?.getValue()).toBe("");
+    await user.selectOptions(getSelect(container), "choice1");
+    expect(ref.current?.getValue()).toBe("choice1");
+    await user.selectOptions(getSelect(container), "choice2");
+    expect(ref.current?.getValue()).toBe("choice2");
+  });
+});