Make user bounding box updates more efficient

frontend/javascripts/oxalis/model/helpers/compaction/compact_save_queue.ts

@@ -70,6 +70,39 @@ function removeSubsequentUpdateNodeActions(updateActionsBatches: Array<SaveQueue
   return _.without(updateActionsBatches, ...obsoleteUpdateActions);
 }
 
+function removeSubsequentUpdateBBoxActions(updateActionsBatches: Array<SaveQueueEntry>) {
+  const obsoleteUpdateActions = [];
+
+  // Actions are obsolete, if they are for the same bounding box and for the same prop.
+  // The given action is always compared to the next next one, as usually an
+  // updateUserBoundingBoxInSkeletonTracingAction and updateUserBoundingBoxInVolumeTracingAction
+  // is sent at the same time.
+  for (let i = 0; i < updateActionsBatches.length - 2; i++) {
+    const actions1 = updateActionsBatches[i].actions;
+    const actions2 = updateActionsBatches[i + 2].actions;
+
+    if (
+      actions1.length === 1 &&
+      actions2.length === 1 &&
+      (actions1[0].name === "updateUserBoundingBoxInSkeletonTracing" ||
+        actions1[0].name === "updateUserBoundingBoxInVolumeTracing") &&
+      actions1[0].name === actions2[0].name &&
+      actions1[0].value.boundingBoxId === actions2[0].value.boundingBoxId &&
+      _.isEqual(actions1[0].value.updatedPropKeys, actions2[0].value.updatedPropKeys)
+    ) {
+      obsoleteUpdateActions.push(updateActionsBatches[i]);
+      console.log(
+        actions1[0].value.boundingBoxId,
+        actions1[0].value.updatedProps,
+        actions2[0].value.boundingBoxId,
+        actions2[0].value.updatedProps,
+      ); // TODO_c remove
+    }
+  }
+
+  return _.without(updateActionsBatches, ...obsoleteUpdateActions);
+}
+
 function removeSubsequentUpdateSegmentActions(updateActionsBatches: Array<SaveQueueEntry>) {
   const obsoleteUpdateActions = [];
 
@@ -100,10 +133,12 @@ export default function compactSaveQueue(
     (updateActionsBatch) => updateActionsBatch.actions.length > 0,
   );
 
-  return removeSubsequentUpdateSegmentActions(
-    removeSubsequentUpdateTreeActions(
-      removeSubsequentUpdateNodeActions(
-        removeAllButLastUpdateTdCameraAction(removeAllButLastUpdateTracingAction(result)),
+  return removeSubsequentUpdateBBoxActions(
+    removeSubsequentUpdateSegmentActions(
+      removeSubsequentUpdateTreeActions(
+        removeSubsequentUpdateNodeActions(
+          removeAllButLastUpdateTdCameraAction(removeAllButLastUpdateTracingAction(result)),
+        ),
       ),
     ),
   );

frontend/javascripts/oxalis/model/reducers/reducer_helpers.ts

@@ -55,13 +55,12 @@ export function convertUserBoundingBoxesFromServerToFrontend(
     };
   });
 }
+
 export function convertUserBoundingBoxesFromFrontendToServer(
-  boundingBoxes: Array<UserBoundingBox>,
-): Array<UserBoundingBoxToServer> {
-  return boundingBoxes.map((bb) => {
-    const { boundingBox, ...rest } = bb;
-    return { ...rest, boundingBox: Utils.computeBoundingBoxObjectFromBoundingBox(boundingBox) };
-  });
+  boundingBox: UserBoundingBox,
+): UserBoundingBoxToServer {
+  const { boundingBox: bb, ...rest } = boundingBox;
+  return { ...rest, boundingBox: Utils.computeBoundingBoxObjectFromBoundingBox(bb) };
 }
 export function convertFrontendBoundingBoxToServer(
   boundingBox: BoundingBoxType,

frontend/javascripts/oxalis/model/sagas/skeletontracing_saga.ts

@@ -48,19 +48,26 @@ import type { Saga } from "oxalis/model/sagas/effect-generators";
 import { select } from "oxalis/model/sagas/effect-generators";
 import type { UpdateActionWithoutIsolationRequirement } from "oxalis/model/sagas/update_actions";
 import {
+  addUserBoundingBoxInSkeletonTracingAction,
+  addUserBoundingBoxInVolumeTracingAction,
   createEdge,
   createNode,
   createTree,
   deleteEdge,
   deleteNode,
   deleteTree,
+  deleteUserBoundingBoxInSkeletonTracingAction,
+  deleteUserBoundingBoxInVolumeTracingAction,
   updateNode,
   updateSkeletonTracing,
   updateTree,
   updateTreeEdgesVisibility,
   updateTreeGroups,
   updateTreeVisibility,
-  updateUserBoundingBoxesInSkeletonTracing,
+  updateUserBoundingBoxInSkeletonTracingAction,
+  updateUserBoundingBoxInVolumeTracingAction,
+  updateUserBoundingBoxVisibilityInSkeletonTracingAction,
+  updateUserBoundingBoxVisibilityInVolumeTracingAction,
 } from "oxalis/model/sagas/update_actions";
 import { api } from "oxalis/singletons";
 import type {
@@ -70,6 +77,7 @@ import type {
   SkeletonTracing,
   Tree,
   TreeMap,
+  UserBoundingBox,
   WebknossosState,
 } from "oxalis/store";
 import Store from "oxalis/store";
@@ -84,7 +92,7 @@ import {
   takeEvery,
   throttle,
 } from "typed-redux-saga";
-import type { ServerSkeletonTracing } from "types/api_types";
+import { AnnotationLayerEnum, type ServerSkeletonTracing } from "types/api_types";
 import { ensureWkReady } from "./ready_sagas";
 import { takeWithBatchActionSupport } from "./saga_helpers";
 
@@ -607,6 +615,71 @@ export const cachedDiffTrees = memoizeOne((tracingId: string, prevTrees: TreeMap
   Array.from(diffTrees(tracingId, prevTrees, trees)),
 );
 
+export function* diffBoundingBoxes(
+  prevBoundingBoxes: UserBoundingBox[],
+  currentBoundingBoxes: UserBoundingBox[],
+  tracingId: string,
+  tracingType: AnnotationLayerEnum,
+) {
+  const {
+    onlyA: deletedBBoxIds,
+    onlyB: addedBBoxIds,
+    both: maybeChangedBBoxIds,
+  } = Utils.diffArrays(
+    _.map(prevBoundingBoxes, (bbox) => bbox.id),
+    _.map(currentBoundingBoxes, (bbox) => bbox.id),
+  );
+  const addBBoxAction =
+    tracingType === AnnotationLayerEnum.Skeleton
+      ? addUserBoundingBoxInSkeletonTracingAction
+      : addUserBoundingBoxInVolumeTracingAction;
+  const deleteBBoxAction =
+    tracingType === AnnotationLayerEnum.Skeleton
+      ? deleteUserBoundingBoxInSkeletonTracingAction
+      : deleteUserBoundingBoxInVolumeTracingAction;
+  const updateBBoxAction =
+    tracingType === AnnotationLayerEnum.Skeleton
+      ? updateUserBoundingBoxInSkeletonTracingAction
+      : updateUserBoundingBoxInVolumeTracingAction;
+  const updateBBoxVisibilityAction =
+    tracingType === AnnotationLayerEnum.Skeleton
+      ? updateUserBoundingBoxVisibilityInSkeletonTracingAction
+      : updateUserBoundingBoxVisibilityInVolumeTracingAction;
+  const getErrorMessage = (id: number) =>
+    `User bounding box with id ${id} not found in ${tracingType} tracing.`;
+  for (const id of deletedBBoxIds) {
+    yield deleteBBoxAction(id, tracingId);
+  }
+  for (const id of addedBBoxIds) {
+    const bbox = currentBoundingBoxes.find((bbox) => bbox.id === id);
+    if (bbox) {
+      yield addBBoxAction(bbox, tracingId);
+    } else {
+      Toast.error(getErrorMessage(id));
+    }
+  }
+  for (const id of maybeChangedBBoxIds) {
+    const currentBbox = currentBoundingBoxes.find((bbox) => bbox.id === id);
+    const prevBbox = prevBoundingBoxes.find((bbox) => bbox.id === id);
+    if (currentBbox == null || prevBbox == null) {
+      Toast.error(getErrorMessage(id));
+      continue;
+    }
+    const diffBBox = Utils.diffObjects(currentBbox, prevBbox);
+    if (_.isEmpty(diffBBox)) continue;
+    const changedKeys = Object.keys(diffBBox);
+    if (changedKeys.includes("isVisible")) {
+      yield updateBBoxVisibilityAction(currentBbox.id, currentBbox.isVisible, tracingId);
+      continue;
+    }
+    if (changedKeys.includes("boundingBox")) {
+      diffBBox.boundingBox.min = currentBbox.boundingBox.min;
+      diffBBox.boundingBox.max = currentBbox.boundingBox.max;
+    }
+    yield updateBBoxAction(currentBbox.id, diffBBox, tracingId);
+  }
+}
+
 export function* diffSkeletonTracing(
   prevSkeletonTracing: SkeletonTracing,
   skeletonTracing: SkeletonTracing,
@@ -637,12 +710,12 @@ export function* diffSkeletonTracing(
     );
   }
 
-  if (!_.isEqual(prevSkeletonTracing.userBoundingBoxes, skeletonTracing.userBoundingBoxes)) {
-    yield updateUserBoundingBoxesInSkeletonTracing(
-      skeletonTracing.userBoundingBoxes,
-      skeletonTracing.tracingId,
-    );
-  }
+  yield* diffBoundingBoxes(
+    prevSkeletonTracing.userBoundingBoxes,
+    skeletonTracing.userBoundingBoxes,
+    skeletonTracing.tracingId,
+    AnnotationLayerEnum.Skeleton,
+  );
 }
 export default [
   watchSkeletonTracingAsync,