Re-enables test and configuration

Author: K8Sewell

__tests__/configuration_options.js

@@ -0,0 +1,73 @@
+const { BASE_URL } = require("../scripts/testBaseUrl");
+
+const FIRST_THUMB_SRC =
+  "https://iiif.wellcomecollection.org/image/b18035723_0001.JP2/full/90,/0/default.jpg";
+
+// Applies custom config through the examples page's Configuration tab:
+// the #customConfig JSON is merged into the viewer config by a
+// uv.on("configure") handler when the Apply Configurations button
+// re-initialises the viewer.
+const applyCustomConfig = async (config) => {
+  await page.evaluate((cfg) => {
+    document.getElementById("customConfig").value = cfg;
+    document.getElementById("clearStorageCheckbox").checked = true;
+    document.getElementById("setConfigButton").click();
+  }, JSON.stringify(config));
+};
+
+describe("Configuration options", () => {
+  describe("thumb cache invalidation", () => {
+    beforeEach(async () => {
+      await page.goto(BASE_URL);
+      await page.waitForSelector("#thumb-0 img");
+    });
+
+    it("when set to false does not provide timestamp", async () => {
+      await applyCustomConfig({
+        modules: {
+          contentLeftPanel: {
+            options: { thumbsCacheInvalidation: { enabled: false } },
+          },
+        },
+      });
+
+      // wait for the viewer to re-render thumbs without the timestamp
+      await page.waitForFunction(
+        (src) => {
+          const img = document.querySelector("#thumb-0 img");
+          return img && img.src === src;
+        },
+        {},
+        FIRST_THUMB_SRC
+      );
+
+      const imageSrc = await page.$eval("#thumb-0 img", (e) => e.src);
+      expect(imageSrc).toEqual(FIRST_THUMB_SRC);
+    });
+
+    it("has a configurable parameter type", async () => {
+      await applyCustomConfig({
+        modules: {
+          contentLeftPanel: {
+            options: { thumbsCacheInvalidation: { paramType: "#" } },
+          },
+        },
+      });
+
+      // wait for the viewer to re-render thumbs with a #t= timestamp
+      await page.waitForFunction(
+        (src) => {
+          const img = document.querySelector("#thumb-0 img");
+          return img && img.src.startsWith(`${src}#t=`);
+        },
+        {},
+        FIRST_THUMB_SRC
+      );
+
+      const imageSrc = await page.$eval("#thumb-0 img", (e) => e.src);
+      expect(imageSrc).toEqual(
+        expect.stringContaining(`${FIRST_THUMB_SRC}#t=`)
+      );
+    });
+  });
+});

__tests__/configuration_tests.js

@@ -1,7 +1,7 @@
 import { ModuleConfig } from "../../BaseConfig";
 import { ExpandPanelContent, ExpandPanelOptions } from "./ExpandPanel";
 
-type ThumbsCacheInvalidation = {
+export type ThumbsCacheInvalidation = {
   /** Determines if cache invalidation is enabled */
   enabled: boolean;
   /** Type of the parameter for cache invalidation */

src/content-handlers/iiif/extensions/config/ContentLeftPanel.ts

@@ -520,6 +520,7 @@ export class ContentLeftPanel extends LeftPanel<ContentLeftPanelConfig> {
 
     this.thumbsRoot.render(
       createElement(ThumbsView, {
+        cacheInvalidation: this.config.options.thumbsCacheInvalidation,
         thumbs,
         paged,
         viewingDirection: viewingDirection || ViewingDirection.LEFT_TO_RIGHT,

src/content-handlers/iiif/modules/uv-contentleftpanel-module/ContentLeftPanel.ts

@@ -1,10 +1,13 @@
 import { ViewingDirection, ViewingHint } from "@iiif/vocabulary";
 import cx from "classnames";
 import { Thumb } from "manifesto.js";
-import React, { useEffect, useRef } from "react";
+import React, { useEffect, useMemo, useRef } from "react";
 import { useInView } from "react-intersection-observer";
+import { ThumbsCacheInvalidation } from "../../extensions/config/ContentLeftPanel";
+import { Dates } from "../../Utils";
 
 const ThumbImage = ({
+  cacheInvalidation,
   first,
   onClick,
   onKeyDown,
@@ -14,6 +17,7 @@ const ThumbImage = ({
   truncateThumbnailLabels,
   viewingDirection,
 }: {
+  cacheInvalidation?: ThumbsCacheInvalidation;
   first: boolean;
   onClick: (thumb: Thumb) => void;
   onKeyDown: (thumb: Thumb) => void;
@@ -29,6 +33,14 @@ const ThumbImage = ({
     triggerOnce: true,
   });
 
+  // memoised so re-renders don't generate a new timestamp and re-request the image
+  const src = useMemo(() => {
+    if (thumb.uri && cacheInvalidation && cacheInvalidation.enabled) {
+      return `${thumb.uri}${cacheInvalidation.paramType}t=${Dates.getTimeStamp()}`;
+    }
+    return thumb.uri;
+  }, [thumb.uri, cacheInvalidation]);
+
   var keydownHandler = (e) => {
     if (e.key === "Enter" || e.key === " ") {
       e.preventDefault();
@@ -62,7 +74,7 @@ const ThumbImage = ({
           height: thumb.height + 8 + "px",
         }}
       >
-        {inView && <img src={thumb.uri} alt={thumb.label} />}
+        {inView && <img src={src} alt={thumb.label} />}
       </div>
       <div className="info">
         <span className="label" title={thumb.label}>
@@ -77,6 +89,7 @@ const ThumbImage = ({
 };
 
 const Thumbnails = ({
+  cacheInvalidation,
   onClick,
   onKeyDown,
   paged,
@@ -86,6 +99,7 @@ const Thumbnails = ({
   viewingDirection,
   truncateThumbnailLabels,
 }: {
+  cacheInvalidation?: ThumbsCacheInvalidation;
   onClick: (thumb: Thumb) => void;
   onKeyDown: (thumb: Thumb) => void;
   paged: boolean;
@@ -149,6 +163,7 @@ const Thumbnails = ({
           className="thumb-container"
         >
           <ThumbImage
+            cacheInvalidation={cacheInvalidation}
             first={index === firstNonPagedIndex}
             onClick={onClick}
             onKeyDown={onKeyDown}