refactor transformStateAsReadOnly

Author: philippotto

frontend/javascripts/test/helpers/utils.ts

@@ -1,19 +1,19 @@
 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,
+export const transformStateAsReadOnly = (
   state: WebknossosState,
-  actionGetters: Array<Action | ((s: WebknossosState) => Action)>,
+  transformFn: (state: WebknossosState) => WebknossosState,
 ) => {
+  /*
+   * This function can be used to make a state read only before
+   * transforming it somehow (e.g., with a reducer). The result of
+   * the transformation is then made not-read-only again.
+   */
   const readOnlyState = overrideAllowUpdateInState(state, false);
-  const reappliedNewState = applyActions(readOnlyState, actionGetters);
+  const transformedState = transformFn(readOnlyState);
 
-  return overrideAllowUpdateInState(reappliedNewState, true);
+  return overrideAllowUpdateInState(transformedState, true);
 };
 
 function overrideAllowUpdateInState(state: WebknossosState, value: boolean) {

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

@@ -4,7 +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 { transformStateAsReadOnly } from "test/helpers/utils";
 import type { Vector3 } from "viewer/constants";
 import {
   enforceSkeletonTracing,
@@ -203,14 +203,12 @@ describe("Update Action Application for SkeletonTracing", () => {
             seenActionTypes.add(action.name);
           }
 
-          const reappliedNewState = applyActionsOnReadOnlyVersion(
-            applyActions,
-            state2WithoutActiveState,
-            [
+          const reappliedNewState = transformStateAsReadOnly(state2WithoutActiveState, (state) =>
+            applyActions(state, [
               SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
               SkeletonTracingActions.setActiveNodeAction(null),
               setActiveUserBoundingBoxId(null),
-            ],
+            ]),
           );
 
           expect(reappliedNewState).toEqual(state3);
@@ -242,9 +240,11 @@ describe("Update Action Application for SkeletonTracing", () => {
       ),
     ) as ApplicableSkeletonUpdateAction[];
 
-    const newState3 = applyActionsOnReadOnlyVersion(applyActions, newState, [
-      SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
-    ]);
+    const newState3 = transformStateAsReadOnly(newState, (state) =>
+      applyActions(state, [
+        SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
+      ]),
+    );
 
     const { activeNodeId } = enforceSkeletonTracing(newState3.annotation);
     expect(activeNodeId).toBeNull();
@@ -273,9 +273,11 @@ describe("Update Action Application for SkeletonTracing", () => {
       ),
     ) as ApplicableSkeletonUpdateAction[];
 
-    const newState3 = applyActionsOnReadOnlyVersion(applyActions, newState, [
-      SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
-    ]);
+    const newState3 = transformStateAsReadOnly(newState, (state) =>
+      applyActions(state, [
+        SkeletonTracingActions.applySkeletonUpdateActionsFromServerAction(updateActions),
+      ]),
+    );
 
     const { activeTreeId, activeNodeId } = enforceSkeletonTracing(newState3.annotation);
 

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

@@ -20,7 +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";
+import { transformStateAsReadOnly } from "test/helpers/utils";
 
 const enforceVolumeTracing = (state: WebknossosState) => {
   const tracing = state.annotation.volumes[0];
@@ -180,14 +180,12 @@ describe("Update Action Application for VolumeTracing", () => {
             seenActionTypes.add(action.name);
           }
 
-          const reappliedNewState = applyActionsOnReadOnlyVersion(
-            applyActions,
-            state2WithoutActiveState,
-            [
+          const reappliedNewState = transformStateAsReadOnly(state2WithoutActiveState, (state) =>
+            applyActions(state, [
               VolumeTracingActions.applyVolumeUpdateActionsFromServerAction(updateActions),
               VolumeTracingActions.setActiveCellAction(0),
               setActiveUserBoundingBoxId(null),
-            ],
+            ]),
           );
 
           expect(reappliedNewState).toEqual(state3);