If initialViewerConfig is set, override the preserveViewport: false default

Author: marlo-longley

.eslintrc

@@ -77,7 +77,7 @@
     "import/no-anonymous-default-export": "off",
     "import/no-extraneous-dependencies": "off",
     "max-len": ["error", {
-      "code": 120,
+      "code": 130,
       "ignoreComments": true,
       "ignoreStrings": true,
       "ignoreTemplateLiterals": true,

__tests__/src/sagas/windows.test.js

@@ -148,6 +148,29 @@ describe('window-level sagas', () => {
         .run();
     });
 
+    it('overrides default preserveViewport: false when initialViewerConfig is set', () => {
+      const action = {
+        window: {
+          canvasId: '1',
+          id: 'x',
+          initialViewerConfig: {
+            x: 934,
+            y: 782,
+            zoom: 0.0007,
+          },
+          manifestId: 'manifest.json',
+        },
+      };
+
+      return expectSaga(setWindowStartingCanvas, action)
+        .provide([
+          [select(getManifests), { 'manifest.json': {} }],
+          [call(setCanvas, 'x', '1', null, { preserveViewport: true }), { type: 'setCanvasThunk' }],
+        ])
+        .put({ type: 'setCanvasThunk' })
+        .run();
+    });
+
     it('calculates the starting canvas and calls setCanvas', () => {
       const action = {
         window: {

src/state/actions/canvas.js

@@ -25,9 +25,8 @@ export function setCanvas(windowId, canvasId, newGroup = undefined, options = {}
     }
 
     dispatch({
-      ...options,
       canvasId,
-      preserveViewport,
+      preserveViewport: options?.preserveViewport ?? preserveViewport,
       type: ActionTypes.SET_CANVAS,
       visibleCanvases,
       windowId,

src/state/sagas/windows.js

@@ -95,7 +95,10 @@ export function* setWindowStartingCanvas(action) {
   const windowId = action.id || action.window.id;
 
   if (canvasId) {
-    const thunk = yield call(setCanvas, windowId, canvasId, null, { preserveViewport: !!action.payload });
+    // Preserve viewport when initialViewerConfig exists, event if the preserveViewport OSD setting is set to false
+    const preserveViewport = !!action.payload || !!(action.window?.initialViewerConfig);
+    // When canvasId is explicitly provided, always pass preserveViewport flag
+    const thunk = yield call(setCanvas, windowId, canvasId, null, { preserveViewport });
     yield put(thunk);
   } else {
     const getMiradorManifest = yield select(getMiradorManifestWrapper);
@@ -107,7 +110,11 @@ export function* setWindowStartingCanvas(action) {
         || miradorManifest.canvasAt(canvasIndex || 0)
         || miradorManifest.canvasAt(0);
       if (startCanvas) {
-        const thunk = yield call(setCanvas, windowId, startCanvas.id);
+        const preserveViewport = !!action.payload || !!(action.window?.initialViewerConfig);
+        // When canvas is calculated, only pass preserveViewport when true
+        const thunk = preserveViewport
+          ? yield call(setCanvas, windowId, startCanvas.id, null, { preserveViewport })
+          : yield call(setCanvas, windowId, startCanvas.id);
         yield put(thunk);
       }
     }