fix that some actions were not applied because of allowUpdate==false

Author: philippotto

frontend/javascripts/test/helpers/utils.ts

@@ -0,0 +1,29 @@
+import update from "immutability-helper";
+import type { Action } from "viewer/model/actions/actions";
+import type { WebknossosState } from "viewer/store";
+
+export const applyActionsOnReadOnlyVersion = (
+  applyActions: (
+    state: WebknossosState,
+    actionGetters: Array<Action | ((s: WebknossosState) => Action)>,
+  ) => WebknossosState,
+  state: WebknossosState,
+  actionGetters: Array<Action | ((s: WebknossosState) => Action)>,
+) => {
+  const readOnlyState = overrideAllowUpdateInState(state, false);
+  const reappliedNewState = applyActions(readOnlyState, actionGetters);
+
+  return overrideAllowUpdateInState(reappliedNewState, true);
+};
+
+function overrideAllowUpdateInState(state: WebknossosState, value: boolean) {
+  return update(state, {
+    annotation: {
+      restrictions: {
+        allowUpdate: {
+          $set: value,
+        },
+      },
+    },
+  });
+}

frontend/javascripts/test/reducers/update_action_application/skeleton.spec.ts

@@ -4,6 +4,7 @@ import { sampleTracingLayer } from "test/fixtures/dataset_server_object";
 import { initialState as defaultSkeletonState } from "test/fixtures/skeletontracing_object";
 import { chainReduce } from "test/helpers/chainReducer";
 import { withoutUpdateActiveItemTracing } from "test/helpers/saveHelpers";
+import { applyActionsOnReadOnlyVersion } from "test/helpers/utils";
 import type { Vector3 } from "viewer/constants";
 import {
   enforceSkeletonTracing,
@@ -202,11 +203,15 @@ describe("Update Action Application for SkeletonTracing", () => {
             seenActionTypes.add(action.name);
           }
 
-          const reappliedNewState = applyActions(state2WithoutActiveState, [
-            SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
-            SkeletonTracingActions.setActiveNodeAction(null),
-            setActiveUserBoundingBoxId(null),
-          ]);
+          const reappliedNewState = applyActionsOnReadOnlyVersion(
+            applyActions,
+            state2WithoutActiveState,
+            [
+              SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
+              SkeletonTracingActions.setActiveNodeAction(null),
+              setActiveUserBoundingBoxId(null),
+            ],
+          );
 
           expect(reappliedNewState).toEqual(state3);
         });
@@ -237,7 +242,7 @@ describe("Update Action Application for SkeletonTracing", () => {
       ),
     ) as ApplicableSkeletonUpdateAction[];
 
-    const newState3 = applyActions(newState, [
+    const newState3 = applyActionsOnReadOnlyVersion(applyActions, newState, [
       SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
     ]);
 
@@ -268,7 +273,7 @@ describe("Update Action Application for SkeletonTracing", () => {
       ),
     ) as ApplicableSkeletonUpdateAction[];
 
-    const newState3 = applyActions(newState, [
+    const newState3 = applyActionsOnReadOnlyVersion(applyActions, newState, [
       SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
     ]);
 

frontend/javascripts/test/reducers/update_action_application/volume.spec.ts

@@ -20,6 +20,7 @@ import type {
 import { combinedReducer, type WebknossosState } from "viewer/store";
 import { makeBasicGroupObject } from "viewer/view/right-border-tabs/trees_tab/tree_hierarchy_view_helpers";
 import { afterAll, describe, expect, test } from "vitest";
+import { applyActionsOnReadOnlyVersion } from "test/helpers/utils";
 
 const enforceVolumeTracing = (state: WebknossosState) => {
   const tracing = state.annotation.volumes[0];
@@ -179,11 +180,15 @@ describe("Update Action Application for VolumeTracing", () => {
             seenActionTypes.add(action.name);
           }
 
-          const reappliedNewState = applyActions(state2WithoutActiveState, [
-            VolumeTracingActions.applyVolumeUpdateActionsFromServerAction(updateActions),
-            VolumeTracingActions.setActiveCellAction(0),
-            setActiveUserBoundingBoxId(null),
-          ]);
+          const reappliedNewState = applyActionsOnReadOnlyVersion(
+            applyActions,
+            state2WithoutActiveState,
+            [
+              VolumeTracingActions.applyVolumeUpdateActionsFromServerAction(updateActions),
+              VolumeTracingActions.setActiveCellAction(0),
+              setActiveUserBoundingBoxId(null),
+            ],
+          );
 
           expect(reappliedNewState).toEqual(state3);
         });

frontend/javascripts/viewer/model/reducers/skeletontracing_reducer.ts

@@ -57,7 +57,11 @@ import { getUserStateForTracing } from "../accessors/annotation_accessor";
 import { max, maxBy } from "../helpers/iterator_utils";
 import { applySkeletonUpdateActionsFromServer } from "./update_action_application/skeleton";
 
-function SkeletonTracingReducer(state: WebknossosState, action: Action): WebknossosState {
+function SkeletonTracingReducer(
+  state: WebknossosState,
+  action: Action,
+  ignoreAllowUpdate: boolean = false,
+): WebknossosState {
   if (action.type === "INITIALIZE_SKELETONTRACING") {
     const userState = getUserStateForTracing(
       action.tracing,
@@ -653,7 +657,13 @@ function SkeletonTracingReducer(state: WebknossosState, action: Action): Webknos
 
     case "APPLY_SKELETON_UPDATE_ACTIONS_FROM_SERVER": {
       const { actions } = action;
-      return applySkeletonUpdateActionsFromServer(SkeletonTracingReducer, actions, state);
+      return applySkeletonUpdateActionsFromServer(
+        // Pass a SkeletonTracingReducer that ignores allowUpdate because
+        // we want to be able to apply updates even in read-only views.
+        (state: WebknossosState, action: Action) => SkeletonTracingReducer(state, action, true),
+        actions,
+        state,
+      );
     }
 
     default: // pass
@@ -664,7 +674,9 @@ function SkeletonTracingReducer(state: WebknossosState, action: Action): Webknos
    */
   const { restrictions } = state.annotation;
   const { allowUpdate } = restrictions;
-  if (!allowUpdate) return state;
+  if (!(allowUpdate || ignoreAllowUpdate)) {
+    return state;
+  }
 
   switch (action.type) {
     case "CREATE_NODE": {