[WIP] Live Collab M3 - Proofreading (without segments list)

app/controllers/AnnotationController.scala

@@ -444,4 +444,12 @@ class AnnotationController @Inject()(
       }
     }
 
+  def releaseMutex(id: ObjectId): Action[AnyContent] = sil.SecuredAction.async { implicit request =>
+    logTime(slackNotificationService.noticeSlowRequest, durationThreshold = 1 second) {
+      for {
+        _ <- annotationMutexService.release(id, request.identity._id) ?~> "annotation.mutex.release.failed"
+      } yield Ok
+    }
+  }
+
 }

app/models/annotation/AnnotationMutexService.scala

@@ -68,6 +68,9 @@ class AnnotationMutexService @Inject()(val lifecycle: ApplicationLifecycle,
       _ <- annotationMutexDAO.upsertOne(mutex.copy(expiry = Instant.in(defaultExpiryTime)))
     } yield MutexResult(canEdit = true, None)
 
+  def release(annotationId: ObjectId, userId: ObjectId): Fox[Unit] =
+    annotationMutexDAO.deleteForUser(annotationId, userId)
+
   def publicWrites(mutexResult: MutexResult): Fox[JsObject] =
     for {
       userOpt <- Fox.runOptional(mutexResult.blockedByUser)(user => userDAO.findOne(user)(GlobalAccessContext))
@@ -114,4 +117,10 @@ class AnnotationMutexDAO @Inject()(sqlClient: SqlClient)(implicit ec: ExecutionC
   def deleteExpired(): Fox[Int] =
     run(q"DELETE FROM webknossos.annotation_mutexes WHERE expiry < NOW()".asUpdate)
 
+  def deleteForUser(annotationId: ObjectId, userId: ObjectId): Fox[Unit] =
+    for {
+      _ <- run(
+        q"DELETE FROM webknossos.annotation_mutexes WHERE _annotation = $annotationId AND _user = $userId".asUpdate)
+    } yield ()
+
 }

conf/messages

@@ -266,7 +266,9 @@ annotation.getNewestVersion.failed=Could not get the newest version information
 annotation.idForTracing.failed=Could not find the annotation id for this tracing id.
 annotation.editableMapping.getAgglomerateGraph.failed=Could not look up an agglomerate graph for requested agglomerate.
 annotation.editableMapping.getAgglomerateIdsForSegments.failed=Could not look up agglomerate ids for requested segments.
-annotation.duplicate.failed=Failed to duplicate annotation
+annotation.duplicate.failed=Failed to duplicate annotation.
+annotation.mutex.failed=Failed to acquire annotation editing mutex.
+annotation.mutex.release.failed=Failed to release annotation editing mutex.
 
 mesh.file.listChunks.failed=Failed to load chunk list for segment {0} from mesh file “{1}”
 mesh.file.loadChunk.failed=Failed to load mesh chunk for segment

conf/webknossos.latest.routes

@@ -173,6 +173,7 @@ DELETE        /annotations/:id
 POST          /annotations/:id/merge/:mergedTyp/:mergedId                                       controllers.AnnotationController.mergeWithoutType(id: ObjectId, mergedTyp: String, mergedId: ObjectId)
 GET           /annotations/:id/download                                                         controllers.AnnotationIOController.downloadWithoutType(id: ObjectId, version: Option[Long], skipVolumeData: Option[Boolean], volumeDataZipFormat: Option[String])
 POST          /annotations/:id/acquireMutex                                                     controllers.AnnotationController.tryAcquiringAnnotationMutex(id: ObjectId)
+DELETE        /annotations/:id/mutex                                                            controllers.AnnotationController.releaseMutex(id: ObjectId)
 
 GET           /annotations/:typ/:id/info                                                        controllers.AnnotationController.info(typ: String, id: ObjectId, timestamp: Option[Long])
 DELETE        /annotations/:typ/:id                                                             controllers.AnnotationController.cancel(typ: String, id: ObjectId)

frontend/javascripts/admin/rest_api.ts

@@ -733,6 +733,12 @@ export async function acquireAnnotationMutex(
   return { canEdit, blockedByUser };
 }
 
+export async function releaseAnnotationMutex(annotationId: string): Promise<void> {
+  await Request.receiveJSON(`/api/annotations/${annotationId}/mutex`, {
+    method: "DELETE",
+  });
+}
+
 export async function getTracingForAnnotationType(
   annotation: APIAnnotation,
   annotationLayerDescriptor: AnnotationLayerDescriptor,

frontend/javascripts/libs/diffable_map.ts

@@ -396,6 +396,39 @@ class DiffableMap<K extends number, V> implements NotEnumerableByObject {
 
     return result;
   }
+  /**
+   * Returns a human-readable string representation of this DiffableMap
+   * for debugging and comparison purposes.
+   *
+   * Example output:
+   * DiffableMap#12(size=4, batches=2) {
+   *   chunk[0]: { 1 => "A", 2 => "B" }
+   *   chunk[1]: { 3 => "C", 4 => null }
+   * }
+   */
+  toString(): string {
+    const id = this.getId?.() ?? "unknown";
+    const chunkSummaries = this.chunks.map((map, i) => {
+      // Format each chunk like: chunk[0]: { 1 => "A", 2 => "B" }
+      const entries = Array.from(map.entries())
+        .map(([k, v]) => {
+          const vStr =
+            v === null
+              ? "null"
+              : v === undefined
+                ? "undefined"
+                : typeof v === "object"
+                  ? JSON.stringify(v)
+                  : String(v);
+          return `${k} => ${vStr}`;
+        })
+        .join(", ");
+      return `  chunk[${i}]: { ${entries} }`;
+    });
+
+    const summary = `DiffableMap#${id}(size=${this.entryCount}, batches=${this.chunks.length}, itemsPerBatch=${this.itemsPerBatch})`;
+    return `${summary} {\n${chunkSummaries.join("\n")}\n}`;
+  }
 }
 
 /**

frontend/javascripts/navbar.tsx

@@ -758,8 +758,9 @@ function Navbar({ isAuthenticated }: { isAuthenticated: boolean }) {
   const isInAnnotationView = useWkSelector((state) => state.uiInformation.isInAnnotationView);
   const hasOrganizations = useWkSelector((state) => state.uiInformation.hasOrganizations);
   const othersMayEdit = useWkSelector((state) => state.annotation.othersMayEdit);
-  const blockedByUser = useWkSelector((state) => state.annotation.blockedByUser);
-  const allowUpdate = useWkSelector((state) => state.annotation.restrictions.allowUpdate);
+  const blockedByUser = useWkSelector((state) => state.save.mutexState.blockedByUser);
+
+  const allowUpdate = useWkSelector((state) => state.annotation.isUpdatingCurrentlyAllowed);
   const isLockedByOwner = useWkSelector((state) => state.annotation.isLockedByOwner);
   const annotationOwnerName = useWkSelector((state) =>
     formatUserName(state.activeUser, state.annotation.owner),

frontend/javascripts/test/api/api_skeleton_latest.spec.ts

@@ -44,7 +44,7 @@ function applyRotationInFlycamReducerSpace(
 
 describe("API Skeleton", () => {
   beforeEach<WebknossosTestContext>(async (context) => {
-    await setupWebknossosForTesting(context, "skeleton", { dontDispatchWkReady: true });
+    await setupWebknossosForTesting(context, "skeleton", undefined, { dontDispatchWkReady: true });
   });
 
   it<WebknossosTestContext>("getActiveNodeId should get the active node id", ({ api }) => {
@@ -253,15 +253,15 @@ describe("API Skeleton", () => {
 
   it<WebknossosTestContext>("getTreeName should get the name of a tree", ({ api }) => {
     const name = api.tracing.getTreeName(2);
-    expect(name).toBe("explorative_2017-08-09_SCM_Boy_002");
+    expect(name).toBe("explorative_2017-08-09_sample_user_002");
   });
 
   it<WebknossosTestContext>("getTreeName should get the name of the active tree if no treeId is specified", ({
     api,
   }) => {
     api.tracing.setActiveNode(1);
     const name = api.tracing.getTreeName();
-    expect(name).toBe("explorative_2017-08-09_SCM_Boy_001");
+    expect(name).toBe("explorative_2017-08-09_sample_user_001");
   });
 
   it<WebknossosTestContext>("getTreeName should throw an error if the supplied treeId doesn't exist", ({

frontend/javascripts/test/backend-snapshot-tests/__snapshots__/annotations.e2e.ts.snap

@@ -71,7 +71,7 @@ exports[`Annotation API (E2E) > Send complex update actions and compare resultin
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -232,7 +232,7 @@ exports[`Annotation API (E2E) > Send complex update actions and compare resultin
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -393,7 +393,7 @@ exports[`Annotation API (E2E) > Send complex update actions and compare resultin
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -554,7 +554,7 @@ exports[`Annotation API (E2E) > Send complex update actions and compare resultin
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -715,7 +715,7 @@ exports[`Annotation API (E2E) > Send complex update actions and compare resultin
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -903,7 +903,7 @@ exports[`Annotation API (E2E) > Update Metadata for Skeleton Tracing 1`] = `
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -1064,7 +1064,7 @@ exports[`Annotation API (E2E) > Update Metadata for Skeleton Tracing 1`] = `
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -1225,7 +1225,7 @@ exports[`Annotation API (E2E) > Update Metadata for Skeleton Tracing 1`] = `
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -1386,7 +1386,7 @@ exports[`Annotation API (E2E) > Update Metadata for Skeleton Tracing 1`] = `
       "edgesAreVisible": true,
       "isVisible": true,
       "metadata": [],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],
@@ -1565,7 +1565,7 @@ exports[`Annotation API (E2E) > Update Metadata for Skeleton Tracing 1`] = `
           ],
         },
       ],
-      "name": "explorative_2017-10-09_SCM_Boy_023",
+      "name": "explorative_2017-10-09_sample_user_023",
       "nodes": [
         {
           "additionalCoordinates": [],

frontend/javascripts/test/fixtures/skeletontracing_server_objects.ts

@@ -56,7 +56,7 @@ export const tracing: ServerSkeletonTracing = {
           content: "Test",
         },
       ],
-      name: "explorative_2017-08-09_SCM_Boy_002",
+      name: "explorative_2017-08-09_sample_user_002",
       isVisible: true,
       metadata: [],
     },
@@ -125,7 +125,7 @@ export const tracing: ServerSkeletonTracing = {
       ],
       comments: [],
       isVisible: true,
-      name: "explorative_2017-08-09_SCM_Boy_001",
+      name: "explorative_2017-08-09_sample_user_001",
       metadata: [],
     },
   ],

frontend/javascripts/test/fixtures/volumetracing_object.ts

@@ -1,5 +1,5 @@
 import update from "immutability-helper";
-import Constants from "viewer/constants";
+import Constants, { ViewModeValues } from "viewer/constants";
 import defaultState from "viewer/default_state";
 import { FlycamMatrixWithDefaultRotation } from "./flycam_object";
 import { combinedReducer } from "viewer/store";
@@ -32,21 +32,21 @@ const stateWithoutDatasetInitialization = update(defaultState, {
     restrictions: {
       $set: {
         branchPointsAllowed: true,
-        initialAllowUpdate: true,
         allowUpdate: true,
+        allowSave: true,
         allowFinish: true,
         allowAccess: true,
         allowDownload: true,
-        allowedModes: [],
         somaClickingAllowed: true,
-        volumeInterpolationAllowed: true,
         mergerMode: false,
-        magRestrictions: {
-          min: undefined,
-          max: undefined,
-        },
+        volumeInterpolationAllowed: true,
+        allowedModes: ViewModeValues,
+        magRestrictions: {},
       },
     },
+    isUpdatingCurrentlyAllowed: {
+      $set: true,
+    },
     volumes: {
       $set: [volumeTracing],
     },

frontend/javascripts/test/fixtures/volumetracing_server_objects.ts

@@ -69,6 +69,7 @@ export const annotation: APIAnnotation = {
     allowUpdate: true,
     allowFinish: true,
     allowDownload: true,
+    allowSave: true,
   },
   annotationLayers: [
     {