@thepalaceproject/circulation-admin 1.43.0-post.11 → 1.43.0-post.15

package/tests/jest/components/Collections.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 { Collections } from "../../../src/components/Collections";
+import CollectionsConnected from "../../../src/components/Collections";
 import renderWithContext from "../testUtils/renderWithContext";
+import { renderWithProviders } from "../testUtils/withProviders";
+import buildStore from "../../../src/store";
 import {
   CollectionsData,
   ConfigurationSettings,
 } from "../../../src/interfaces";
 import { defaultFeatureFlags } from "../../../src/utils/featureFlags";
 
-// NB: This adds tests to the already existing tests in:
-// - `src/components/__tests__/Collections-test.tsx`.
-//
-// Those tests should eventually be migrated here and
-// adapted to the Jest/React Testing Library paradigm.
-
 describe("Collections - associated library disclosure", () => {
   // ── Shared fixtures ───────────────────────────────────────────────────────
 
@@ -219,3 +218,332 @@ describe("Collections - associated library disclosure", () => {
     );
   });
 });
+
+// These exercise behavior the disclosure tests above do not: the connect()
+// wiring (mapStateToProps / mapDispatchToProps, which only run when the CONNECTED
+// default export mounts), the marked-for-deletion list item, the
+// confirm-before-disassociating-libraries behavior, the
+// getChildContext().registerLibrary closure, the on-mount registrations fetch,
+// and the delete flow.
+
+describe("Collections - connected wiring, deletion, and registration", () => {
+  const allLibraries = [
+    { short_name: "nypl", name: "NYPL", uuid: "uuid-nypl" },
+  ];
+
+  const sysAdminConfig: Partial<ConfigurationSettings> = {
+    csrfToken: "",
+    featureFlags: defaultFeatureFlags,
+    roles: [{ role: "system" }],
+  };
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  describe("connected default export", () => {
+    // A loaded `libraries` slice persists through the on-mount collections fetch
+    // (the libraries reducer ignores that action), 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,
+    };
+
+    const stubFetch = (body: unknown) =>
+      jest.spyOn(globalThis, "fetch").mockImplementation(
+        async () =>
+          new Response(JSON.stringify(body), {
+            status: 200,
+            headers: { "Content-Type": "application/json" },
+          })
+      );
+
+    it("wires mapStateToProps/mapDispatchToProps and marks a collection for deletion", async () => {
+      const listData = {
+        collections: [
+          { id: 2, protocol: "test protocol", name: "ODL" },
+          {
+            id: 3,
+            protocol: "test protocol",
+            name: "Enki",
+            marked_for_deletion: true,
+          },
+        ],
+        protocols: [{ name: "test protocol", label: "TP", settings: [] }],
+      };
+      stubFetch(listData);
+      const store = buildStore({
+        editor: { libraries: loadedLibrariesState },
+      } as any);
+
+      const { container } = renderWithProviders(
+        <CollectionsConnected csrfToken="token" />,
+        {
+          reduxProviderProps: { store },
+          appConfigSettings: sysAdminConfig,
+        }
+      );
+
+      // 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: "ODL" })
+      ).toBeInTheDocument();
+
+      // The non-deleted collection has edit and delete controls.
+      const editLink = container.querySelector("a.edit-item");
+      expect(editLink.getAttribute("href")).toBe(
+        "/admin/web/config/collections/edit/2"
+      );
+
+      // The deleted collection renders a special item with no edit/delete
+      // controls and an explanatory message.
+      const deleted = container.querySelector(".deleted-collection");
+      expect(deleted).not.toBeNull();
+      expect(deleted).toHaveTextContent("Enki");
+      expect(deleted).toHaveTextContent(/cannot be edited/);
+      expect(deleted.querySelector("a.edit-item")).toBeNull();
+      expect(deleted.querySelector("button.delete-item")).toBeNull();
+    });
+  });
+
+  describe("edit mode: registration and additional content", () => {
+    // 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();
+    it("fetches registrations on mount, renders task controls, and registers a library on click", async () => {
+      const user = userEvent.setup();
+      const registerLibrary = jest.fn().mockResolvedValue(undefined);
+      const fetchLibraryRegistrations = jest.fn().mockResolvedValue(undefined);
+      renderWithContext(
+        <Collections
+          data={
+            {
+              collections: [
+                {
+                  id: 7,
+                  protocol: "OPDS Import",
+                  name: "An OPDS Collection",
+                  libraries: [],
+                },
+              ],
+              protocols: [
+                {
+                  name: "OPDS Import",
+                  supports_registration: true,
+                  supports_import: true,
+                  settings: [],
+                  library_settings: [],
+                },
+              ],
+              allLibraries,
+            } as any
+          }
+          editOrCreate="edit"
+          identifier="7"
+          fetchData={jest.fn()}
+          editItem={jest.fn().mockResolvedValue(undefined)}
+          deleteItem={jest.fn().mockResolvedValue(undefined)}
+          registerLibrary={registerLibrary}
+          fetchLibraryRegistrations={fetchLibraryRegistrations}
+          importCollection={jest.fn().mockResolvedValue(undefined)}
+          reapCollection={jest.fn().mockResolvedValue(undefined)}
+          csrfToken="token"
+          isFetching={false}
+        />,
+        sysAdminConfig
+      );
+
+      // componentDidMount fetches the registrations once. (CollectionEditForm's
+      // renderAdditionalContent also runs here, since the edited collection has
+      // an id, injecting the import/reap task panels into the form.)
+      expect(fetchLibraryRegistrations).toHaveBeenCalledTimes(1);
+
+      // Registering a library goes through getChildContext().registerLibrary.
+      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("collection_id")).toBe("7");
+
+      // After a successful registration, the child context refetches.
+      await waitFor(() =>
+        expect(fetchLibraryRegistrations).toHaveBeenCalledTimes(2)
+      );
+    });
+  });
+
+  describe("confirm before disassociating libraries", () => {
+    const initialLibraries = [
+      { short_name: "palace", name: "Palace" },
+      { short_name: "another-library", name: "Another Library" },
+    ];
+
+    const renderEditForm = (
+      libraries: Array<{ short_name: string }>,
+      libraryMeta: Array<{ short_name: string; name?: string }>
+    ) =>
+      renderWithContext(
+        <Collections
+          data={
+            {
+              collections: [
+                {
+                  id: 7,
+                  protocol: "OPDS Import",
+                  name: "An OPDS Collection",
+                  libraries,
+                },
+              ],
+              protocols: [
+                { name: "OPDS Import", settings: [], library_settings: [] },
+              ],
+              allLibraries: libraryMeta,
+            } as any
+          }
+          editOrCreate="edit"
+          identifier="7"
+          fetchData={jest.fn()}
+          editItem={jest.fn().mockResolvedValue(undefined)}
+          deleteItem={jest.fn().mockResolvedValue(undefined)}
+          registerLibrary={jest.fn().mockResolvedValue(undefined)}
+          importCollection={jest.fn().mockResolvedValue(undefined)}
+          reapCollection={jest.fn().mockResolvedValue(undefined)}
+          csrfToken="token"
+          isFetching={false}
+        />,
+        sysAdminConfig
+      );
+
+    it("removes the library when the confirmation is accepted", () => {
+      const confirmSpy = jest.spyOn(window, "confirm").mockReturnValue(true);
+      const { container } = renderEditForm(
+        [...initialLibraries],
+        [...initialLibraries]
+      );
+
+      // One remove button per associated library.
+      expect(container.querySelectorAll("button.remove-btn")).toHaveLength(2);
+
+      fireEvent.click(container.querySelectorAll("button.remove-btn")[0]);
+
+      // The prompt names the (full) library being removed.
+      expect(confirmSpy).toHaveBeenCalledTimes(1);
+      expect(confirmSpy.mock.calls[0][0]).toBe(
+        'Disassociating library "Palace" from this collection will ' +
+          "remove all loans and holds for its patrons. Do you wish to continue?"
+      );
+
+      // The association (and its remove button) is gone.
+      expect(container.querySelectorAll("button.remove-btn")).toHaveLength(1);
+    });
+
+    it("keeps the library when the confirmation is canceled", () => {
+      jest.spyOn(window, "confirm").mockReturnValue(false);
+      const { container } = renderEditForm(
+        [...initialLibraries],
+        [...initialLibraries]
+      );
+
+      expect(container.querySelectorAll("button.remove-btn")).toHaveLength(2);
+      fireEvent.click(container.querySelectorAll("button.remove-btn")[0]);
+      // Nothing was removed.
+      expect(container.querySelectorAll("button.remove-btn")).toHaveLength(2);
+    });
+
+    it("uses the library short_name in the prompt when the full name is unavailable", () => {
+      const confirmSpy = jest.spyOn(window, "confirm").mockReturnValue(false);
+      // The library is not present in allLibraries, so getLibrary() returns null.
+      const { container } = renderEditForm([{ short_name: "orphan" }], []);
+
+      fireEvent.click(container.querySelector("button.remove-btn"));
+
+      expect(confirmSpy).toHaveBeenCalledTimes(1);
+      expect(confirmSpy.mock.calls[0][0]).toBe(
+        'Disassociating library "orphan" from this collection will ' +
+          "remove all loans and holds for its patrons. Do you wish to continue?"
+      );
+    });
+  });
+
+  describe("create mode", () => {
+    it("renders the create form without import/reap task panels", () => {
+      // In create mode there is no saved collection, so CollectionEditForm's
+      // renderAdditionalContent short-circuits and injects no task panels.
+      renderWithContext(
+        <Collections
+          data={
+            {
+              collections: [],
+              protocols: [
+                { name: "OPDS Import", settings: [], library_settings: [] },
+              ],
+              allLibraries,
+            } as any
+          }
+          editOrCreate="create"
+          fetchData={jest.fn()}
+          editItem={jest.fn().mockResolvedValue(undefined)}
+          deleteItem={jest.fn().mockResolvedValue(undefined)}
+          registerLibrary={jest.fn().mockResolvedValue(undefined)}
+          importCollection={jest.fn().mockResolvedValue(undefined)}
+          reapCollection={jest.fn().mockResolvedValue(undefined)}
+          csrfToken="token"
+          isFetching={false}
+        />,
+        sysAdminConfig
+      );
+
+      expect(
+        screen.getByRole("heading", { name: "Create a new collection" })
+      ).toBeInTheDocument();
+    });
+  });
+
+  describe("deletion", () => {
+    it("deletes a collection and refetches after confirmation", async () => {
+      const deleteItem = jest.fn().mockResolvedValue(undefined);
+      const fetchData = jest.fn();
+      const confirmSpy = jest.spyOn(window, "confirm").mockReturnValue(true);
+
+      const { container } = renderWithContext(
+        <Collections
+          data={
+            {
+              collections: [{ id: 1, protocol: "p", name: "My Collection" }],
+              protocols: [],
+              allLibraries,
+            } as any
+          }
+          fetchData={fetchData}
+          editItem={jest.fn().mockResolvedValue(undefined)}
+          deleteItem={deleteItem}
+          registerLibrary={jest.fn().mockResolvedValue(undefined)}
+          importCollection={jest.fn().mockResolvedValue(undefined)}
+          reapCollection={jest.fn().mockResolvedValue(undefined)}
+          csrfToken="token"
+          isFetching={false}
+        />,
+        sysAdminConfig
+      );
+
+      fireEvent.click(container.querySelector("button.delete-item"));
+
+      expect(confirmSpy).toHaveBeenCalledTimes(1);
+      await waitFor(() => expect(deleteItem).toHaveBeenCalledWith(1));
+      // fetchData is called once on mount; the post-delete refetch is the second
+      // call, so assert the count rather than mere invocation.
+      await waitFor(() => expect(fetchData).toHaveBeenCalledTimes(2));
+    });
+  });
+});

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

@@ -0,0 +1,157 @@
+import * as React from "react";
+import { render, screen, within } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+
+import Contributors from "../../../src/components/Contributors";
+import { RolesData, ContributorData } from "../../../src/interfaces";
+
+const roles: RolesData = {
+  aut: "Author",
+  ill: "Illustrator",
+  nrt: "Narrator",
+  trl: "Translator",
+};
+
+const contributors: ContributorData[] = [
+  { name: "A Translator", role: "trl" },
+  { name: "A Narrator", role: "nrt" },
+];
+
+const renderContributors = (
+  props: Partial<React.ComponentProps<typeof Contributors>> = {}
+) =>
+  render(
+    <Contributors
+      roles={roles}
+      contributors={contributors}
+      disabled={false}
+      {...props}
+    />
+  );
+
+const existingRows = (container: HTMLElement) =>
+  Array.from(container.querySelectorAll<HTMLElement>(".with-remove-button"));
+
+const newContributorForm = () =>
+  screen
+    .getByRole("button", { name: "Add" })
+    .closest(".contributor-form") as HTMLElement;
+
+const roleSelect = (row: HTMLElement) =>
+  row.querySelector('select[name="contributor-role"]') as HTMLSelectElement;
+const nameInput = (row: HTMLElement) =>
+  row.querySelector('input[name="contributor-name"]') as HTMLInputElement;
+
+describe("Contributors", () => {
+  it("displays a label", () => {
+    renderContributors();
+    expect(screen.getByText("Authors and Contributors")).toBeInTheDocument();
+  });
+
+  it("displays a list of existing contributors", () => {
+    const { container } = renderContributors();
+    const rows = existingRows(container);
+    expect(rows).toHaveLength(2);
+
+    expect(roleSelect(rows[0])).toHaveValue("Translator");
+    expect(nameInput(rows[0])).toHaveValue("A Translator");
+    expect(roleSelect(rows[1])).toHaveValue("Narrator");
+    expect(nameInput(rows[1])).toHaveValue("A Narrator");
+
+    // Each role menu offers the full set of roles.
+    const options = within(roleSelect(rows[0]))
+      .getAllByRole("option")
+      .map((o) => (o as HTMLOptionElement).value);
+    expect(options).toStrictEqual(Object.values(roles));
+  });
+
+  it("displays a blank field for adding a new contributor", () => {
+    renderContributors();
+    const form = newContributorForm();
+    expect(roleSelect(form)).toHaveValue("Author");
+    expect(nameInput(form)).toHaveValue("");
+
+    const button = within(form).getByRole("button", { name: "Add" });
+    expect(button).toHaveClass("add-contributor");
+  });
+
+  it("deletes a contributor", async () => {
+    const user = userEvent.setup();
+    const { container } = renderContributors();
+
+    let rows = existingRows(container);
+    expect(rows).toHaveLength(2);
+
+    // Remove the first (Translator) row.
+    await user.click(within(rows[0]).getByRole("button"));
+
+    rows = existingRows(container);
+    expect(rows).toHaveLength(1);
+    expect(roleSelect(rows[0])).toHaveValue("Narrator");
+    expect(nameInput(rows[0])).toHaveValue("A Narrator");
+  });
+
+  it("adds a contributor", async () => {
+    const user = userEvent.setup();
+    const { container } = renderContributors();
+    expect(existingRows(container)).toHaveLength(2);
+
+    const form = newContributorForm();
+    await user.selectOptions(roleSelect(form), "Illustrator");
+    await user.type(nameInput(form), "An Illustrator");
+    await user.click(within(form).getByRole("button", { name: "Add" }));
+
+    const rows = existingRows(container);
+    expect(rows).toHaveLength(3);
+    expect(roleSelect(rows[2])).toHaveValue("Illustrator");
+    expect(nameInput(rows[2])).toHaveValue("An Illustrator");
+  });
+
+  it("does not add an empty string as a contributor's name", async () => {
+    const user = userEvent.setup();
+    const { container } = renderContributors();
+
+    // The Add button starts disabled, so clicking it does nothing.
+    expect(screen.getByRole("button", { name: "Add" })).toBeDisabled();
+    await user.click(screen.getByRole("button", { name: "Add" }));
+    expect(existingRows(container)).toHaveLength(2);
+
+    // Typing a name enables the button and lets us add.
+    await user.type(nameInput(newContributorForm()), "An Author");
+    expect(screen.getByRole("button", { name: "Add" })).toBeEnabled();
+    await user.click(screen.getByRole("button", { name: "Add" }));
+    expect(existingRows(container)).toHaveLength(3);
+
+    // Clearing the name disables the button again.
+    await user.clear(nameInput(newContributorForm()));
+    expect(screen.getByRole("button", { name: "Add" })).toBeDisabled();
+    await user.click(screen.getByRole("button", { name: "Add" }));
+    expect(existingRows(container)).toHaveLength(3);
+  });
+
+  it("shows the full name of a contributor's known role", () => {
+    // "trl" and "nrt" resolve to their full names in the role menus.
+    const { container } = renderContributors();
+    const rows = existingRows(container);
+    expect(roleSelect(rows[0])).toHaveValue("Translator");
+    expect(roleSelect(rows[1])).toHaveValue("Narrator");
+  });
+
+  it("resets the form after adding a contributor", async () => {
+    const user = userEvent.setup();
+    renderContributors();
+
+    const form = newContributorForm();
+    await user.selectOptions(roleSelect(form), "Illustrator");
+    await user.type(nameInput(form), "An Illustrator");
+    await user.click(within(form).getByRole("button", { name: "Add" }));
+
+    // The add form is blank again, defaulted to "Author", with a disabled button.
+    const resetForm = newContributorForm();
+    expect(nameInput(resetForm)).toHaveValue("");
+    expect(roleSelect(resetForm)).toHaveValue("Author");
+    expect(
+      within(resetForm).getByRole("button", { name: "Add" })
+    ).toBeDisabled();
+  });
+});