Encourage coarser mags when annotating a high number of voxels

docs/volume_annotation/import_export.md

@@ -16,4 +16,19 @@ After finishing the annotation of a volume layer with a fallback layer, the comb
 Icon to open the materialize volume annotation dialog
 ///
 
-This button opens up a dialog that starts a long-running job which will materialize the volume annotation.
+This button opens up a dialog that starts a long-running job which will materialize the volume annotation.
+
+## Restricting magnifications
+
+WEBKNOSSOS allows data annotation in different magnifications.
+Restricting the available magnifications can greatly improve the performance when annotating large structures, such as nuclei, since the volume data does not need to be stored in all quality levels. 
+How to read: Mag 1 is the most detailed, 4-4-2 is downsampled by factor 4 in x and y, and by factor 2 in z.
+When annotating large structures, consider restricting the available magnifications in this specific annotation or in this volume annotation layer.
+
+### Restricting magnifications for a whole annotation
+
+Go to the dataset dashboard. Click on the three dots next to `New Annotation` for the dataset you want to annotate. Use the slider to restrict the volume magnifications, e.g. by omitting the finest magnification, which is usually 1-1-1, or the two finest magnifications.
+
+### Restricting magnifications for volume annotation layers
+
+Within an existing annotation, go to the `Layers` tab on the left. Click `Add Volume Annotation Layer` at the bottom of the list of all layers in this annotation. Restrict the magnifications as explained above.

frontend/javascripts/viewer/model/sagas/saving/save_saga.ts → frontend/javascripts/viewer/model/sagas/saving/save_saga.tsx

@@ -23,6 +23,7 @@ import {
 } from "../volume/proofread_saga";
 import { pushSaveQueueAsync } from "./save_queue_draining";
 import { setupSavingForAnnotation, setupSavingForTracingType } from "./save_queue_filling";
+import { BUCKET_COUNT_PER_SAVE_WARNING_THRESHOLD } from "./save_saga_constants";
 
 export function* setupSavingToServer(): Saga<void> {
   // This saga continuously drains the save queue by sending its content to the server.
@@ -31,6 +32,7 @@ export function* setupSavingToServer(): Saga<void> {
   yield* takeEvery("INITIALIZE_ANNOTATION_WITH_TRACINGS", setupSavingForAnnotation);
   yield* takeEveryWithBatchActionSupport("INITIALIZE_SKELETONTRACING", setupSavingForTracingType);
   yield* takeEveryWithBatchActionSupport("INITIALIZE_VOLUMETRACING", setupSavingForTracingType);
+  yield* takeEvery("WK_READY", checkNumberOfBucketsInQueue);
 }
 
 const VERSION_POLL_INTERVAL_COLLAB = 10 * 1000;
@@ -137,23 +139,6 @@ function* watchForSaveConflicts(): Saga<void> {
     return false;
   }
 
-  function* getPollInterval(): Saga<number> {
-    const allowSave = yield* select((state) => state.annotation.restrictions.allowSave);
-    if (!allowSave) {
-      // The current user may not edit/save the annotation.
-      return VERSION_POLL_INTERVAL_READ_ONLY;
-    }
-
-    const othersMayEdit = yield* select((state) => state.annotation.othersMayEdit);
-    if (othersMayEdit) {
-      // Other users may edit the annotation.
-      return VERSION_POLL_INTERVAL_COLLAB;
-    }
-
-    // The current user is the only one who can edit the annotation.
-    return VERSION_POLL_INTERVAL_SINGLE_EDITOR;
-  }
-
   yield* call(ensureWkReady);
 
   while (true) {
@@ -184,6 +169,62 @@ function* watchForSaveConflicts(): Saga<void> {
   }
 }
 
+function* getPollInterval(): Saga<number> {
+  const allowSave = yield* select((state) => state.annotation.restrictions.allowSave);
+  if (!allowSave) {
+    // The current user may not edit/save the annotation.
+    return VERSION_POLL_INTERVAL_READ_ONLY;
+  }
+
+  const othersMayEdit = yield* select((state) => state.annotation.othersMayEdit);
+  if (othersMayEdit) {
+    // Other users may edit the annotation.
+    return VERSION_POLL_INTERVAL_COLLAB;
+  }
+
+  // The current user is the only one who can edit the annotation.
+  return VERSION_POLL_INTERVAL_SINGLE_EDITOR;
+}
+
+function* checkNumberOfBucketsInQueue(): Saga<void> {
+  //yield* call(ensureWkReady);
+  while (true) {
+    console.log("Checking number of buckets in save queue...");
+    const interval = yield* call(getPollInterval);
+    yield* call(sleep, interval);
+    const saveQueue = yield* select((state) => state.save.queue); //TODO_C remove
+    const saveQueueLength = yield* select((state) => {
+      return state.save.queue.reduce(
+        (sum, queueEntry) =>
+          sum + queueEntry.actions.filter((action) => action.name === "updateBucket").length,
+        0,
+      );
+    });
+
+    if (saveQueueLength > BUCKET_COUNT_PER_SAVE_WARNING_THRESHOLD) {
+      const warningMessage =
+        "You are annotating a large area which puts a high load on the server. Consider creating an annotation or annotation layer with restricted volume magnifications.";
+      const linkToDocs =
+        "https://docs.webknossos.org/volume_annotation/import_export.html#restricting-magnifications";
+      Toast.warning(
+        <>
+          {warningMessage}
+          <br />
+          See the{" "}
+          <a href={linkToDocs} target="_blank" rel="noopener noreferrer">
+            docs
+          </a>
+          .
+        </>,
+        { sticky: true },
+      );
+      console.warn(warningMessage + " For more info, visit: " + linkToDocs);
+    }
+
+    console.log(`Save queue length: ${saveQueueLength}`, saveQueue);
+  }
+}
+
 export function* tryToIncorporateActions(
   newerActions: APIUpdateActionBatch[],
 ): Saga<{ success: boolean }> {

frontend/javascripts/viewer/model/sagas/saving/save_saga_constants.ts

@@ -21,3 +21,5 @@ export const MAXIMUM_ACTION_COUNT_PER_BATCH = 1000;
 //   mapping: Number.POSITIVE_INFINITY, // The back-end does not accept transactions for mappings.
 // } as const;
 export const MAXIMUM_ACTION_COUNT_PER_SAVE = 3000;
+
+export const BUCKET_COUNT_PER_SAVE_WARNING_THRESHOLD = 4000;