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

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

@@ -0,0 +1,59 @@
+import * as React from "react";
+import { screen, within } from "@testing-library/react";
+import { MetadataServices } from "../../../src/components/MetadataServices";
+import renderWithContext from "../testUtils/renderWithContext";
+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"
+    );
+  });
+});

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

@@ -612,7 +612,9 @@ describe("PatronBlockingRulesEditor", () => {
   });
 
   it("disables all editing inputs and buttons when disabled prop is true", () => {
-    renderEditor(<PatronBlockingRulesEditor value={existingRules} disabled={true} />);
+    renderEditor(
+      <PatronBlockingRulesEditor value={existingRules} disabled={true} />
+    );
 
     // The Help button stays enabled even in disabled mode (read-only affordance).
     const editingButtons = screen

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

@@ -0,0 +1,54 @@
+import * as React from "react";
+import { render } from "@testing-library/react";
+
+import PatronInfo from "../../../src/components/PatronInfo";
+import { PatronData } from "../../../src/interfaces";
+
+const patrons: 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: "",
+  },
+  {
+    authorization_expires: "",
+    personal_name: "Personal Name2",
+    authorization_identifier: "5678",
+    authorization_identifiers: [""],
+    block_reason: "",
+    external_type: "",
+    fines: "",
+    permanent_id: "",
+  },
+];
+
+describe("PatronInfo", () => {
+  it("should display the patron's information", () => {
+    const { container } = render(<PatronInfo patron={patrons[0]} />);
+
+    const items = container.querySelectorAll("ul.patron-data-list > li");
+    expect(items).toHaveLength(4);
+    expect(items[0]).toHaveTextContent("Username:User Name");
+    expect(items[1]).toHaveTextContent("Personal Name:Personal Name");
+    expect(items[2]).toHaveTextContent("Email Address:user@email.com");
+    expect(items[3]).toHaveTextContent("Identifier:1234");
+  });
+
+  it("should update the patron's information if a new patron was searched and found", () => {
+    const { container, rerender } = render(<PatronInfo patron={patrons[0]} />);
+
+    rerender(<PatronInfo patron={patrons[1]} />);
+
+    const items = container.querySelectorAll("ul.patron-data-list > li");
+    expect(items).toHaveLength(2);
+    expect(items[0]).toHaveTextContent("Personal Name:Personal Name2");
+    expect(items[1]).toHaveTextContent("Identifier:5678");
+  });
+});

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

@@ -0,0 +1,164 @@
+import * as React from "react";
+import { render, screen } from "@testing-library/react";
+
+import SelfTestResult from "../../../src/components/SelfTestResult";
+import { SelfTestsResult } from "../../../src/interfaces";
+
+const stringResult: SelfTestsResult = {
+  duration: 0,
+  end: "",
+  name: "Test Result",
+  result: "abc",
+  start: "",
+  success: true,
+};
+
+describe("SelfTestResult", () => {
+  it("displays a result with a string", () => {
+    const { container } = render(
+      <SelfTestResult result={stringResult} isFetching={false} />
+    );
+
+    expect(container.querySelector("li")).toHaveClass("success");
+
+    expect(screen.getByRole("heading", { level: 4 })).toHaveTextContent(
+      "Test Result"
+    );
+
+    const testResult = container.querySelector("pre");
+    expect(testResult).toHaveClass("result-description");
+    expect(testResult).toHaveTextContent("abc");
+
+    expect(screen.getByText("success: true")).toHaveClass(
+      "success-description"
+    );
+
+    // A single-line string result is not shown in a collapsible panel.
+    expect(container.querySelector(".panel")).not.toBeInTheDocument();
+  });
+
+  it("displays a result with a multi-line string", () => {
+    const longStringResult: SelfTestsResult = {
+      ...stringResult,
+      result: "abc \n def",
+    };
+    const { container } = render(
+      <SelfTestResult result={longStringResult} isFetching={false} />
+    );
+
+    const panel = container.querySelector(".panel");
+    expect(panel).toBeInTheDocument();
+    expect(panel).toHaveClass("panel-success");
+    expect(screen.getByText("Results")).toBeInTheDocument();
+
+    expect(container.querySelector("pre")?.textContent).toBe("abc \n def");
+  });
+
+  it("displays a result with an array", () => {
+    const arrayResult: SelfTestsResult = {
+      ...stringResult,
+      result: ["Thing 1", "Thing 2"],
+    };
+    const { container } = render(
+      <SelfTestResult result={arrayResult} isFetching={false} />
+    );
+
+    const panel = container.querySelector(".panel");
+    expect(panel).toBeInTheDocument();
+    expect(panel).toHaveClass("panel-success");
+    expect(screen.getByText("Results (2)")).toBeInTheDocument();
+
+    const items = container.querySelectorAll("ol li");
+    expect(items).toHaveLength(2);
+    expect(items[0]).toHaveTextContent("Thing 1");
+    expect(items[1]).toHaveTextContent("Thing 2");
+  });
+
+  it("displays a result with an empty array", () => {
+    const emptyArrayResult: SelfTestsResult = { ...stringResult, result: [] };
+    const { container } = render(
+      <SelfTestResult result={emptyArrayResult} isFetching={false} />
+    );
+
+    expect(container.querySelector(".panel")).not.toBeInTheDocument();
+    expect(
+      screen.getByText("The test ran successfully, but no results were found.")
+    ).toHaveClass("warning");
+  });
+
+  it("displays a result with an exception", () => {
+    const exceptionResult: SelfTestsResult = {
+      ...stringResult,
+      success: false,
+      exception: { class: "IntegrationException", message: "Problem!" },
+    };
+    const { container } = render(
+      <SelfTestResult result={exceptionResult} isFetching={false} />
+    );
+
+    expect(container.querySelector("li")).toHaveClass("failure");
+    expect(screen.getByText("success: false")).toHaveClass(
+      "success-description"
+    );
+    expect(screen.getByText("exception: Problem!")).toHaveClass(
+      "exception-description"
+    );
+  });
+
+  it("displays debug_message when present", () => {
+    const exceptionResult: SelfTestsResult = {
+      ...stringResult,
+      success: false,
+      exception: {
+        class: "IntegrationException",
+        debug_message: "debug message...",
+        message: "Problem!",
+      },
+    };
+    render(<SelfTestResult result={exceptionResult} isFetching={false} />);
+
+    expect(screen.getByText("debug: debug message...")).toHaveClass(
+      "debug-description"
+    );
+  });
+
+  it("does not display debug_message when it is empty", () => {
+    const exceptionResult: SelfTestsResult = {
+      ...stringResult,
+      success: false,
+      exception: {
+        class: "IntegrationException",
+        debug_message: "",
+        message: "Problem!",
+      },
+    };
+    const { container } = render(
+      <SelfTestResult result={exceptionResult} isFetching={false} />
+    );
+
+    expect(
+      container.querySelector(".exception-description")
+    ).toBeInTheDocument();
+    expect(
+      container.querySelector(".debug-description")
+    ).not.toBeInTheDocument();
+  });
+
+  it("does not display debug_message when it is absent", () => {
+    const exceptionResult: SelfTestsResult = {
+      ...stringResult,
+      success: false,
+      exception: { class: "IntegrationException", message: "Problem!" },
+    };
+    const { container } = render(
+      <SelfTestResult result={exceptionResult} isFetching={false} />
+    );
+
+    expect(
+      container.querySelector(".exception-description")
+    ).toBeInTheDocument();
+    expect(
+      container.querySelector(".debug-description")
+    ).not.toBeInTheDocument();
+  });
+});

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

@@ -0,0 +1,200 @@
+import * as React from "react";
+import { screen } from "@testing-library/react";
+
+import { renderWithProviders } from "../testUtils/withProviders";
+import buildStore from "../../../src/store";
+
+// `SelfTests` is a connected component that fetches self-test results on mount.
+// It is incidental to what `SelfTestsCategory` itself does (build one panel per
+// item, color-code them, decide `openByDefault`, and compute `sortByCollection`),
+// so mock it to a marker that exposes the props the category passes down.
+jest.mock("../../../src/components/SelfTests", () => ({
+  __esModule: true,
+  default: (props: any) => (
+    <div
+      data-testid="self-tests"
+      data-type={props.type}
+      data-item-id={props.item?.id}
+      data-item-name={props.item?.name}
+      data-sort-by-collection={String(props.sortByCollection)}
+    />
+  ),
+}));
+
+import SelfTestsCategory from "../../../src/components/SelfTestsCategory";
+
+const initialSetupResult = {
+  duration: 0.000119,
+  end: "2018-08-07T19:34:54Z",
+  exception: null,
+  name: "Initial setup.",
+  result: null,
+  start: "2018-08-07T19:34:54Z",
+  success: true,
+};
+
+const collections: any[] = [
+  {
+    id: 1,
+    name: "collection with success",
+    protocol: "protocol",
+    self_test_results: {
+      duration: 1.75,
+      start: "2018-08-07T19:34:54Z",
+      end: "2018-08-07T19:34:55Z",
+      results: [initialSetupResult],
+    },
+  },
+  {
+    id: 2,
+    name: "collection with failure",
+    protocol: "protocol",
+    self_test_results: {
+      duration: 1.75,
+      start: "2018-08-07T19:34:54Z",
+      end: "2018-08-07T19:34:55Z",
+      results: [
+        initialSetupResult,
+        {
+          duration: 0,
+          end: "2018-08-07T19:34:55Z",
+          exception: {
+            class: "IntegrationException",
+            debug_message:
+              "Add the collection to a library that has a patron authentication service.",
+            message: "Collection is not associated with any libraries.",
+          },
+          name: "Acquiring test patron credentials.",
+          result: null,
+          start: "2018-08-07T19:34:55Z",
+          success: false,
+        },
+      ],
+    },
+  },
+  {
+    id: 3,
+    name: "collection with no results",
+    protocol: "protocol",
+  },
+];
+
+const renderCategory = (items: any[] = collections) =>
+  renderWithProviders(
+    <SelfTestsCategory
+      type="collection"
+      linkName="collections"
+      csrfToken="token"
+      items={items}
+      store={buildStore()}
+    />
+  );
+
+describe("SelfTestsCategory", () => {
+  it("renders a list of items", () => {
+    const { container } = renderCategory();
+
+    const root = container.querySelector(".self-tests-category");
+    expect(root).toBeInTheDocument();
+    expect(root).toHaveClass("has-additional-content");
+
+    const titles = Array.from(
+      container.querySelectorAll("ul .panel-title")
+    ).map((el) => el.textContent);
+    expect(titles).toStrictEqual([
+      "collection with success",
+      "collection with failure",
+      "collection with no results",
+    ]);
+
+    // One SelfTests per item, each carrying the category's type and its item.
+    const selfTests = screen.getAllByTestId("self-tests");
+    expect(selfTests).toHaveLength(3);
+    selfTests.forEach((el, idx) => {
+      expect(el).toHaveAttribute("data-type", "collection");
+      expect(el).toHaveAttribute("data-item-id", String(collections[idx].id));
+    });
+  });
+
+  it("color-codes", () => {
+    const { container } = renderCategory();
+    const panels = container.querySelectorAll(".panel");
+    expect(panels[0]).toHaveClass("panel-success");
+    expect(panels[1]).toHaveClass("panel-danger");
+    expect(panels[2]).toHaveClass("panel-default");
+  });
+
+  it("opens the panel by default if there's only one", () => {
+    // With multiple items, none are open by default.
+    const multi = renderCategory();
+    expect(
+      Array.from(multi.container.querySelectorAll(".panel-heading")).some(
+        (h) => h.getAttribute("aria-expanded") === "true"
+      )
+    ).toBe(false);
+    multi.unmount();
+
+    // A fresh render with a single item opens that panel by default.
+    // (`openByDefault` seeds the panel's initial state, so a new mount is needed.)
+    const single = renderCategory([collections[0]]);
+    const singleHeaders = single.container.querySelectorAll(".panel-heading");
+    expect(singleHeaders).toHaveLength(1);
+    expect(singleHeaders[0]).toHaveAttribute("aria-expanded", "true");
+  });
+
+  it("passes the sortByCollection prop to SelfTests", () => {
+    const { rerender } = renderCategory();
+    expect(screen.getAllByTestId("self-tests")[0]).toHaveAttribute(
+      "data-sort-by-collection",
+      "false"
+    );
+
+    const withCollection = {
+      id: 99,
+      name: "collection with sorting",
+      protocol: "protocol",
+      self_test_results: {
+        duration: 1.75,
+        start: "2018-08-07T19:34:54Z",
+        end: "2018-08-07T19:34:55Z",
+        results: [{ ...initialSetupResult, collection: "sort!" }],
+      },
+    };
+
+    rerender(
+      <SelfTestsCategory
+        type="collection"
+        linkName="collections"
+        csrfToken="token"
+        items={[withCollection, ...collections]}
+        store={buildStore()}
+      />
+    );
+
+    expect(screen.getAllByTestId("self-tests")[0]).toHaveAttribute(
+      "data-sort-by-collection",
+      "true"
+    );
+  });
+
+  it("handles unnamed items", () => {
+    const nameless: any = {
+      id: 1,
+      name: null,
+      protocol: "protocol",
+      self_test_results: {
+        duration: 1.75,
+        start: "2018-08-07T19:34:54Z",
+        end: "2018-08-07T19:34:55Z",
+        results: [initialSetupResult],
+      },
+    };
+    const { container } = renderCategory([nameless]);
+
+    expect(screen.getByText("Unnamed collection")).toHaveClass("panel-title");
+    // Panel id becomes `${name-without-spaces}-${id}`; its body id appends "-panel".
+    expect(
+      container.querySelector("#Unnamedcollection-1-panel")
+    ).toBeInTheDocument();
+  });
+});

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

@@ -0,0 +1,110 @@
+import * as React from "react";
+import { render, screen } from "@testing-library/react";
+
+import { DiscoveryServicesData } from "../../../src/interfaces";
+import ServiceWithRegistrationsEditForm from "../../../src/components/ServiceWithRegistrationsEditForm";
+
+// `ServiceWithRegistrationsEditForm` is generic/abstract over its data type;
+// the legacy test subclassed it to bind the discovery-services data type.
+class DiscoveryServiceEditForm extends ServiceWithRegistrationsEditForm<DiscoveryServicesData> {}
+
+const serviceData = {
+  id: 1,
+  protocol: "protocol 1",
+};
+const protocolsData = [
+  {
+    name: "protocol 1",
+    label: "protocol 1 label",
+    supports_registration: true,
+    settings: [],
+    library_settings: [],
+  },
+];
+const allLibraries = [
+  { short_name: "nypl", name: "New York Public Library" },
+  { short_name: "bpl", name: "Brooklyn Public Library" },
+  { short_name: "qpl", name: "Queens Public Library" },
+];
+const libraryRegistrationsData = [
+  {
+    id: 1,
+    libraries: [
+      { short_name: "nypl", status: "success", stage: "production" },
+      { short_name: "bpl", status: "failure", stage: "testing" },
+    ],
+  },
+];
+const servicesData: any = {
+  discovery_services: [serviceData],
+  protocols: protocolsData,
+  allLibraries: allLibraries,
+  libraryRegistrations: libraryRegistrationsData,
+};
+
+const renderForm = (save = jest.fn()) =>
+  render(
+    <DiscoveryServiceEditForm
+      disabled={false}
+      data={servicesData}
+      item={serviceData as any}
+      save={save}
+      urlBase="url base"
+      listDataKey="discovery_services"
+    />
+  );
+
+describe("ServiceWithRegistrationsEditForm", () => {
+  it("renders the underlying service edit form fields", () => {
+    renderForm();
+
+    // The base ServiceEditForm (via `super.render()`) contributes the Name text
+    // field and the Required Fields section.
+    expect(screen.getByRole("textbox")).toBeInTheDocument();
+    expect(
+      screen.getByRole("heading", { name: "Required Fields" })
+    ).toBeInTheDocument();
+  });
+
+  it("renders a registration section reflecting each library's status", () => {
+    renderForm();
+
+    // The registration UI only renders when the protocol supports registration
+    // and the data carries libraries — i.e. those props flowed to LibraryRegistration.
+    expect(
+      screen.getByRole("heading", { name: "Register libraries" })
+    ).toBeInTheDocument();
+
+    expect(
+      screen.getByRole("link", { name: "New York Public Library" })
+    ).toBeInTheDocument();
+    expect(
+      screen.getByRole("link", { name: "Brooklyn Public Library" })
+    ).toBeInTheDocument();
+    expect(
+      screen.getByRole("link", { name: "Queens Public Library" })
+    ).toBeInTheDocument();
+
+    // Statuses come from `data.libraryRegistrations`.
+    expect(screen.getByText("Registered")).toHaveClass("bg-success");
+    expect(screen.getByText("Registration failed")).toHaveClass("bg-danger");
+    expect(screen.getByText("Not registered")).toHaveClass("bg-warning");
+  });
+
+  it("enables the per-library registration actions when not disabled", () => {
+    renderForm();
+
+    // `disabled={false}` flows through to each registration button.
+    const updateButton = screen.getByRole("button", {
+      name: "Update registration",
+    });
+    const retryButton = screen.getByRole("button", {
+      name: "Retry registration",
+    });
+    const registerButton = screen.getByRole("button", { name: "Register" });
+
+    expect(updateButton).not.toBeDisabled();
+    expect(retryButton).not.toBeDisabled();
+    expect(registerButton).not.toBeDisabled();
+  });
+});

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

@@ -0,0 +1,41 @@
+import * as React from "react";
+import { screen } from "@testing-library/react";
+
+import { renderWithProviders } from "../testUtils/withProviders";
+import SetupPage from "../../../src/components/SetupPage";
+
+describe("SetupPage", () => {
+  beforeEach(() => {
+    // SetupPage renders the connected IndividualAdmins list, which fetches the
+    // admin list on mount. Stub fetch so mounting does not hit the network.
+    jest.spyOn(globalThis, "fetch").mockResolvedValue(
+      new Response(JSON.stringify({ individualAdmins: [] }), {
+        status: 200,
+        headers: { "Content-Type": "application/json" },
+      })
+    );
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it("shows the individual-admins setup (create) form", async () => {
+    renderWithProviders(<SetupPage />);
+
+    // SetupPage wires IndividualAdmins with settingUp + editOrCreate="create".
+    // That combination renders the "Welcome!" heading and the
+    // "Set up your system admin account" create-form heading; their presence in
+    // the real DOM proves the child received those props (the original shallow
+    // test asserted the props directly). No identifier is passed, so there is no
+    // per-item "Edit ..." heading — only the create form shows.
+    expect(
+      await screen.findByRole("heading", { name: "Welcome!" })
+    ).toBeInTheDocument();
+    expect(
+      screen.getByRole("heading", {
+        name: "Set up your system admin account",
+      })
+    ).toBeInTheDocument();
+  });
+});