@thepalaceproject/circulation-admin 1.41.0 → 1.42.0-post.6

package/tests/browser/redirect.js

@@ -1,44 +1,30 @@
-const http = require('follow-redirects').http
+const http = require("follow-redirects").http;
 
-const fetchGroupPage = (browser) => {
+const fetchGroupPage = () => {
   return new Promise((resolve, reject) => {
-    http.get({
-      host: "localhost",
-      port: 6500,
-      path: "/groups/"
-    }, (response) => {
-      let body = "";
+    http.get(
+      {
+        host: "localhost",
+        port: 6500,
+        path: "/groups/",
+      },
+      (response) => {
+        let body = "";
 
-      response.on("data", (chunk) => {
-        body += chunk;
-      });
+        response.on("data", (chunk) => {
+          body += chunk;
+        });
 
-      response.on("error", (err) => {
-        reject(err);
-      });
+        response.on("error", (err) => {
+          reject(err);
+        });
 
-      response.on("end", () => {
-        resolve(body);
-      });
-    });
-  });
-}
-const getAdminBookUrlAndTitle = (body, browser) => {
-  const bookTitle = body.match(/<entry [\s\S]+?<title>([^<]+)<\/title>/i)[1];
-  const link = body.match(/<link [^>]*rel="alternate[^>]+\/>/i)[0];
-  const id = body.match(/<id>[\s\S]+?<\/id>/i)[0];
-  const lib = id.match(/\/[\w]+/i)[0]; // includes forward slash
-  const bookUrl = link.match(/href="([^"]+)"/)[1];
-  const entryBaseUrl = browser.globals.homeUrl.replace("/admin/web/", lib + "/works");
-
-  // transform the book url into an admin book url
-  const adminBookUrl =
-    browser.globals.homeUrl + "collection" + lib + "/book" + lib +
-    encodeURIComponent(
-      bookUrl.replace(entryBaseUrl, "")
+        response.on("end", () => {
+          resolve(body);
+        });
+      }
     );
-
-  return { adminBookUrl, bookTitle };
+  });
 };
 const getAdminListUrl = (body, browser) => {
   const listBaseUrl = `${browser.globals.homeUrl}lists`;
@@ -56,11 +42,10 @@ module.exports = {
     loginPage = browser.page.login();
     loadingSelector = browser.page.catalog().elements.loadingSelector;
 
-    fetchGroupPage(browser)
-      .then(data => {
-        body = data
-        done();
-      });
+    fetchGroupPage(browser).then((data) => {
+      body = data;
+      done();
+    });
   },
 
   "attempt to view the admin list page before signing in": (browser) => {
@@ -100,5 +85,5 @@ module.exports = {
 
   afterEach: (browser) => {
     browser.end();
-  }
+  },
 };

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

@@ -5,7 +5,7 @@ import AdvancedSearchBuilder from "../../../src/components/AdvancedSearchBuilder
 
 describe("AdvancedSearchBuilder", () => {
   it("renders a placeholder and help text when the publication date filter is selected", async () => {
-    const user = userEvent.setup();
+    userEvent.setup();
 
     const query = {
       id: "0",

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

@@ -0,0 +1,240 @@
+import * as React from "react";
+import { render, screen, waitFor } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import CollectionReapButton, {
+  CollectionReapButtonProps,
+} from "../../../src/components/CollectionReapButton";
+import { CollectionData, ProtocolData } from "../../../src/interfaces";
+
+const protocolWithReap: ProtocolData = {
+  name: "OPDS 2.0",
+  label: "OPDS 2.0",
+  supports_reap: true,
+  settings: [],
+};
+
+const protocolWithoutReap: ProtocolData = {
+  name: "Boundless",
+  label: "Boundless",
+  supports_reap: false,
+  settings: [],
+};
+
+const savedCollection: CollectionData = {
+  id: 42,
+  protocol: "OPDS 2.0",
+  name: "Test Collection",
+};
+
+const unsavedCollection: CollectionData = {
+  protocol: "OPDS 2.0",
+  name: "Unsaved Collection",
+};
+
+function renderButton(overrides: Partial<CollectionReapButtonProps> = {}) {
+  const defaultProps: CollectionReapButtonProps = {
+    collection: savedCollection,
+    protocols: [protocolWithReap, protocolWithoutReap],
+    reapCollection: jest.fn().mockResolvedValue(undefined),
+    disabled: false,
+    ...overrides,
+  };
+  return {
+    ...render(<CollectionReapButton {...defaultProps} />),
+    reapCollection: defaultProps.reapCollection as jest.Mock,
+  };
+}
+
+/** Expand the collapsed Reap panel by clicking its header. */
+async function expandPanel(user: ReturnType<typeof userEvent.setup>) {
+  await user.click(screen.getByText("Reap"));
+}
+
+describe("CollectionReapButton", () => {
+  it("does not render when protocol lacks supports_reap", () => {
+    const collection: CollectionData = {
+      id: 1,
+      protocol: "Boundless",
+      name: "Boundless Collection",
+    };
+    const { container } = renderButton({ collection });
+    expect(container.innerHTML).toBe("");
+  });
+
+  it("does not render for unsaved collection (no id)", () => {
+    const { container } = renderButton({ collection: unsavedCollection });
+    expect(container.innerHTML).toBe("");
+  });
+
+  it("does not render when the backend omits supports_reap (older CM)", () => {
+    // A circulation manager that predates reaping won't include the
+    // supports_reap flag at all. The admin must degrade gracefully and hide
+    // the panel rather than offering a button that would 404.
+    const legacyProtocol: ProtocolData = {
+      name: "OPDS 2.0",
+      label: "OPDS 2.0",
+      settings: [],
+    };
+    const { container } = renderButton({ protocols: [legacyProtocol] });
+    expect(container.innerHTML).toBe("");
+  });
+
+  it("renders panel header when supported", () => {
+    renderButton();
+    expect(screen.getByText("Reap")).toBeInTheDocument();
+  });
+
+  it("renders button when panel is expanded and has no force checkbox", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+    expect(
+      screen.getByRole("button", { name: "Queue Reap" })
+    ).toBeInTheDocument();
+    expect(screen.queryByRole("checkbox")).not.toBeInTheDocument();
+  });
+
+  it("shows compact summary by default; detailed docs are hidden", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+    expect(
+      screen.getByText(/queue reap removes titles that are no longer/i)
+    ).toBeInTheDocument();
+    expect(
+      screen.getByText(/schedules a background job that re-reads/i)
+    ).not.toBeVisible();
+  });
+
+  it("clicking 'More details' reveals the detailed docs", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+
+    const details = screen.getByText("More details").closest("details");
+    expect(details).not.toHaveAttribute("open");
+
+    await user.click(screen.getByText("More details"));
+
+    expect(details).toHaveAttribute("open");
+    expect(
+      screen.getByText(/schedules a background job that re-reads/i)
+    ).toBeVisible();
+  });
+
+  it("button triggers reap with the collection id", async () => {
+    const user = userEvent.setup();
+    const { reapCollection } = renderButton();
+    await expandPanel(user);
+    await user.click(screen.getByRole("button", { name: "Queue Reap" }));
+    expect(reapCollection).toHaveBeenCalledWith(42);
+  });
+
+  it("keeps both feedback live regions mounted before any feedback appears", async () => {
+    const user = userEvent.setup();
+    const { container } = renderButton();
+    await expandPanel(user);
+    // Both regions must already exist at a fixed politeness when their content
+    // mutates; several screen readers won't announce a region inserted
+    // alongside its text, nor a politeness change on an already-mounted node.
+    const politeRegion = container.querySelector('[aria-live="polite"]');
+    const assertiveRegion = container.querySelector('[aria-live="assertive"]');
+    expect(politeRegion).toBeInTheDocument();
+    expect(politeRegion).toBeEmptyDOMElement();
+    expect(assertiveRegion).toBeInTheDocument();
+    expect(assertiveRegion).toBeEmptyDOMElement();
+  });
+
+  it("shows success feedback after queuing", async () => {
+    const user = userEvent.setup();
+    renderButton();
+    await expandPanel(user);
+    await user.click(screen.getByRole("button", { name: "Queue Reap" }));
+    await waitFor(() => {
+      const feedback = screen.getByText(/reap task queued\./i);
+      expect(feedback).toBeInTheDocument();
+      expect(feedback).toHaveClass("alert", "alert-success");
+      // Success routes to the permanently-polite region.
+      expect(feedback.closest("[aria-live]")).toHaveAttribute(
+        "aria-live",
+        "polite"
+      );
+    });
+  });
+
+  it("shows error feedback with alert-danger styling on failure", async () => {
+    const user = userEvent.setup();
+    const mockReap = jest
+      .fn()
+      .mockRejectedValue({ response: "Something went wrong" });
+    renderButton({ reapCollection: mockReap });
+    await expandPanel(user);
+    await user.click(screen.getByRole("button", { name: "Queue Reap" }));
+    await waitFor(() => {
+      const feedback = screen.getByText("Something went wrong");
+      expect(feedback).toBeInTheDocument();
+      expect(feedback).toHaveClass("alert", "alert-danger");
+      // Errors route to the permanently-assertive region.
+      expect(feedback.closest("[aria-live]")).toHaveAttribute(
+        "aria-live",
+        "assertive"
+      );
+    });
+  });
+
+  it("resets feedback when switching collections", async () => {
+    const user = userEvent.setup();
+    const { rerender, reapCollection } = renderButton();
+    await expandPanel(user);
+
+    await user.click(screen.getByRole("button", { name: "Queue Reap" }));
+    await waitFor(() => {
+      expect(screen.getByText(/reap task queued\./i)).toBeInTheDocument();
+    });
+
+    const nextCollection: CollectionData = {
+      id: 99,
+      protocol: "OPDS 2.0",
+      name: "Another Collection",
+    };
+    rerender(
+      <CollectionReapButton
+        collection={nextCollection}
+        protocols={[protocolWithReap, protocolWithoutReap]}
+        reapCollection={reapCollection}
+        disabled={false}
+      />
+    );
+
+    await waitFor(() => {
+      expect(screen.queryByText(/reap task queued\./i)).not.toBeInTheDocument();
+    });
+  });
+
+  it("disables button when disabled prop is true", async () => {
+    const user = userEvent.setup();
+    renderButton({ disabled: true });
+    await expandPanel(user);
+    expect(screen.getByRole("button", { name: "Queue Reap" })).toBeDisabled();
+  });
+
+  it("shows 'Queuing...' text while reaping", async () => {
+    const user = userEvent.setup();
+    let resolveReap: () => void;
+    const pendingReap = new Promise<void>((resolve) => {
+      resolveReap = resolve;
+    });
+    const mockReap = jest.fn().mockReturnValue(pendingReap);
+    renderButton({ reapCollection: mockReap });
+    await expandPanel(user);
+
+    await user.click(screen.getByRole("button", { name: "Queue Reap" }));
+
+    expect(screen.getByRole("button", { name: "Queuing..." })).toBeDisabled();
+
+    resolveReap();
+    await waitFor(() => {
+      expect(screen.getByRole("button", { name: "Queue Reap" })).toBeEnabled();
+    });
+  });
+});

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

@@ -46,6 +46,7 @@ describe("Collections - associated library disclosure", () => {
         deleteItem={jest.fn().mockResolvedValue(undefined)}
         registerLibrary={jest.fn().mockResolvedValue(undefined)}
         importCollection={jest.fn().mockResolvedValue(undefined)}
+        reapCollection={jest.fn().mockResolvedValue(undefined)}
         csrfToken="token"
         isFetching={false}
       />,

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

@@ -11,7 +11,6 @@ import { ConfigurationSettings } from "../../../src/interfaces";
 describe("CustomLists", () => {
   // Stub scrollTo, since a component in the render tree will try to call it, and it is not
   // provided by JSDOM.
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
   Element.prototype.scrollTo = () => {};
 
   const server = setupServer(

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

@@ -56,7 +56,6 @@ const MOCK_DEBUG_RESULTS: PatronDebugResponse = {
 };
 
 describe("DebugAuthentication", () => {
-  /* eslint-disable @typescript-eslint/no-empty-function */
   const queryClient = new QueryClient({
     defaultOptions: {
       queries: {
@@ -69,7 +68,6 @@ describe("DebugAuthentication", () => {
       error: process.env.NODE_ENV === "test" ? () => {} : console.error,
     },
   });
-  /* eslint-enable @typescript-eslint/no-empty-function */
 
   const server = setupServer(
     http.get(AUTH_METHODS_PATH, () =>

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

@@ -55,7 +55,6 @@ const setupMockServer = () => {
 };
 
 describe("InventoryReportRequestModal", () => {
-  /* eslint-disable @typescript-eslint/no-empty-function */
   const queryClient = new QueryClient({
     defaultOptions: {
       queries: {
@@ -68,7 +67,6 @@ describe("InventoryReportRequestModal", () => {
       error: process.env.NODE_ENV === "test" ? () => {} : console.error,
     },
   });
-  /* eslint-enable @typescript-eslint/no-empty-function */
 
   describe("query hooks call correct api methods", () => {
     const wrapper = componentWithProviders({ queryClient });
@@ -90,7 +88,7 @@ describe("InventoryReportRequestModal", () => {
           () => useReportInfo(show, API_ENDPOINT_PARAMS),
           { wrapper }
         );
-        await waitFor(() => result.current.fetchStatus == "idle");
+        await waitFor(() => result.current.fetchStatus === "idle");
         const { isSuccess, isError, error, collections } = result.current;
 
         expect(mock_info_api).toHaveBeenCalledWith(API_ENDPOINT_PARAMS);
@@ -109,7 +107,7 @@ describe("InventoryReportRequestModal", () => {
           () => useReportInfo(show, API_ENDPOINT_PARAMS),
           { wrapper }
         );
-        await waitFor(() => result.current.fetchStatus == "idle");
+        await waitFor(() => result.current.fetchStatus === "idle");
         const { isSuccess, isError, error, collections } = result.current;
 
         expect(mock_info_api).not.toHaveBeenCalled();
@@ -129,7 +127,7 @@ describe("InventoryReportRequestModal", () => {
           () => useReportInfo(show, API_ENDPOINT_PARAMS),
           { wrapper }
         );
-        await waitFor(() => result.current.fetchStatus == "idle");
+        await waitFor(() => result.current.fetchStatus === "idle");
         const { isSuccess, isError, error, collections } = result.current;
 
         expect(mock_info_api).toHaveBeenCalledWith(API_ENDPOINT_PARAMS);

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

@@ -1,6 +1,5 @@
 import * as React from "react";
 import { render, screen, act, fireEvent } from "@testing-library/react";
-import userEvent from "@testing-library/user-event";
 import JsonField, { JsonFieldHandle } from "../../../src/components/JsonField";
 
 const setting = {

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

@@ -12,7 +12,7 @@ import LaneEditor from "../../../src/components/LaneEditor";
 
 jest.mock("../../../src/components/LaneCustomListsEditor", () => ({
   __esModule: true,
-  default: (props) => <div data-testid="LaneCustomListsEditor" />,
+  default: () => <div data-testid="LaneCustomListsEditor" />,
 }));
 
 const customListsData = [

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

@@ -1,5 +1,5 @@
 import * as React from "react";
-import { render, screen, waitFor } from "@testing-library/react";
+import { render, screen } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
 import { PatronBlockingRulesHelpModal } from "../../../src/components/PatronBlockingRulesHelpModal";
 
@@ -29,9 +29,7 @@ describe("PatronBlockingRulesHelpModal", () => {
 
   it("does not render when show is false", () => {
     render(<PatronBlockingRulesHelpModal {...baseProps} show={false} />);
-    expect(
-      screen.queryByText(/Patron Blocking Rules — Help/i)
-    ).toBeNull();
+    expect(screen.queryByText(/Patron Blocking Rules — Help/i)).toBeNull();
   });
 
   it("shows a loading indicator when fieldsLoading is true", () => {
@@ -84,7 +82,9 @@ describe("PatronBlockingRulesHelpModal", () => {
       />
     );
     expect(
-      screen.getByText(/Save the service before template variables can be fetched/i)
+      screen.getByText(
+        /Save the service before template variables can be fetched/i
+      )
     ).toBeTruthy();
     expect(screen.queryByText("fines")).toBeNull();
   });
@@ -97,9 +97,7 @@ describe("PatronBlockingRulesHelpModal", () => {
         fieldsError={null}
       />
     );
-    expect(
-      screen.getByText(/No field data available/i)
-    ).toBeTruthy();
+    expect(screen.getByText(/No field data available/i)).toBeTruthy();
   });
 
   it("renders null values as italic 'null'", () => {

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

@@ -6,7 +6,6 @@ import { LibrariesData } from "../../../src/interfaces";
 import buildStore from "../../../src/store";
 import { setupServer } from "msw/node";
 import { http, HttpResponse } from "msw";
-import renderWithContext from "../testUtils/renderWithContext";
 import { renderWithProviders } from "../testUtils/withProviders";
 import QuicksightDashboardPage from "../../../src/components/QuicksightDashboardPage";
 

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

@@ -21,11 +21,7 @@ import { renderHook } from "@testing-library/react-hooks";
 import { FetchErrorData } from "@thepalaceproject/web-opds-client/lib/interfaces";
 import { store } from "../../../src/store";
 import { api } from "../../../src/features/api/apiSlice";
-import {
-  AdminRoleData,
-  ConfigurationSettings,
-  RolesData,
-} from "../../../src/interfaces";
+import { AdminRoleData, ConfigurationSettings } from "../../../src/interfaces";
 
 const normalizedData = normalizeStatistics(statisticsApiResponseData);
 
@@ -442,14 +438,12 @@ describe("Dashboard Statistics", () => {
             roles,
             quicksightPagePath: fakeQuickSightHref,
           };
-          const {
-            container,
-            getByRole,
-            queryByRole,
-            queryByText,
-          } = renderWithProviders(<Stats library={sampleLibraryKey} />, {
-            appConfigSettings,
-          });
+          const { container, getByRole, queryByRole } = renderWithProviders(
+            <Stats library={sampleLibraryKey} />,
+            {
+              appConfigSettings,
+            }
+          );
 
           // We should always render a Usage reports group when a library is specified.
           getByRole("heading", {

package/tests/jest/features/book.test.ts

@@ -1,15 +1,12 @@
 import reducer, {
   initialState,
   getBookData,
-  GetBookDataArgs,
   submitBookData,
 } from "../../../src/features/book/bookEditorSlice";
 import { expect } from "chai";
 import * as fetchMock from "fetch-mock-jest";
-import { store } from "../../../src/store";
 import { BookData } from "@thepalaceproject/web-opds-client/lib/interfaces";
 import { RequestError } from "@thepalaceproject/web-opds-client/lib/DataFetcher";
-import { AsyncThunkAction, Dispatch } from "@reduxjs/toolkit";
 import ActionCreator from "@thepalaceproject/web-opds-client/lib/actions";
 
 const SAMPLE_BOOK_ADMIN_DETAIL = `
@@ -274,8 +271,6 @@ describe("Redux bookEditorSlice...", () => {
     describe("submitBookData...", () => {
       const goodBookUrl = "https://example.com/book";
       const editBookUrl = `${goodBookUrl}/edit`;
-      const brokenBookUrl = "https://example.com/broken-book";
-      const errorBookUrl = "https://example.com/error-book";
       const csrfTokenHeader = "X-CSRF-Token";
       const validCsrfToken = "valid-csrf-token";
 
@@ -328,7 +323,7 @@ describe("Redux bookEditorSlice...", () => {
           csrfToken,
         });
 
-        const result = await action(dispatch, getState, undefined);
+        await action(dispatch, getState, undefined);
         const dispatchCalls = dispatch.mock.calls;
         const fetchCalls = fetchMock.calls();
 
@@ -366,7 +361,7 @@ describe("Redux bookEditorSlice...", () => {
           csrfToken,
         });
 
-        const result = await action(dispatch, getState, undefined);
+        await action(dispatch, getState, undefined);
         const dispatchCalls = dispatch.mock.calls;
         const fetchCalls = fetchMock.calls();
 

package/webpack.common.js

@@ -1,11 +1,9 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
 const path = require("path");
 const CleanWebpackPlugin = require("clean-webpack-plugin");
 const webpack = require("webpack");
 const MiniCssExtractPlugin = require("mini-css-extract-plugin");
 const TerserPlugin = require("terser-webpack-plugin");
 const CopyPlugin = require("copy-webpack-plugin");
-/* eslint-enable @typescript-eslint/no-var-requires */
 
 module.exports = {
   entry: {

package/webpack.dev-server.config.js

@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-
 /**
  * This webpack config establishes a proxy server to enable a local build of circulation-admin to
  * connect to a remote Circulation Manager back-end. Requests for webpack assets are served from
@@ -87,7 +85,7 @@ module.exports = (env) => {
     if (redirectParam) {
       const redirectUrl = new URL(redirectParam);
 
-      if (redirectUrl.host == backendUrl.host) {
+      if (redirectUrl.host === backendUrl.host) {
         redirectUrl.protocol = "http";
         redirectUrl.host = requestHost;
 

package/webpack.dev.config.js

@@ -1,7 +1,7 @@
-const { merge } = require('webpack-merge');
-const common = require('./webpack.common.js');
+const { merge } = require("webpack-merge");
+const common = require("./webpack.common.js");
 
-var config = merge(common, {
+const config = merge(common, {
   mode: "development",
   devtool: "eval-source-map",
 });

package/webpack.prod.config.js

@@ -1,8 +1,8 @@
-const { merge } = require('webpack-merge');
-const common = require('./webpack.common.js');
+const { merge } = require("webpack-merge");
+const common = require("./webpack.common.js");
 
-var config = merge(common, {
-  mode: "production"
+const config = merge(common, {
+  mode: "production",
 });
 
 module.exports = config;