Improve time tracking overview

CHANGELOG.unreleased.md

@@ -14,7 +14,8 @@ For upgrade instructions, please check the [migration guide](MIGRATIONS.released
 - Within the proofreading tool, the user can now interact with the super voxels of a mesh in the 3D viewport. For example, this allows to merge or cut super voxels from another. As before, the proofreading tool requires an agglomerate file. [#7742](https://github.com/scalableminds/webknossos/pull/7742)
 
 ### Changed
-- Non admin or manager user can no longer start long running jobs creating datasets. This includes annotation materialization and AI inferrals. [#7753](https://github.com/scalableminds/webknossos/pull/7753)
+- Non-admin or -manager users can no longer start long-running jobs that create datasets. This includes annotation materialization and AI inferrals. [#7753](https://github.com/scalableminds/webknossos/pull/7753)
+- In the time tracking view, all annotations and tasks can be shown for each user by expanding the table. The individual time spans spent with a task or annotating an explorative annotation can be accessed via CSV export. The detail view including a chart for the individual spans has been removed. [#7733](https://github.com/scalableminds/webknossos/pull/7733)
 
 ### Fixed
 

app/controllers/TimeController.scala

@@ -47,9 +47,30 @@ class TimeController @Inject()(userService: UserService,
       }
     }
 
+  def timeSummedByAnnotationForUser(userId: String,
+                                    start: Long,
+                                    end: Long,
+                                    annotationTypes: String,
+                                    projectIds: Option[String]): Action[AnyContent] = sil.SecuredAction.async {
+    implicit request =>
+      for {
+        userIdValidated <- ObjectId.fromString(userId)
+        projectIdsValidated <- ObjectId.fromCommaSeparated(projectIds)
+        annotationTypesValidated <- AnnotationType.fromCommaSeparated(annotationTypes) ?~> "invalidAnnotationType"
+        user <- userService.findOneCached(userIdValidated) ?~> "user.notFound" ~> NOT_FOUND
+        isTeamManagerOrAdmin <- userService.isTeamManagerOrAdminOf(request.identity, user)
+        _ <- bool2Fox(isTeamManagerOrAdmin || user._id == request.identity._id) ?~> "user.notAuthorised" ~> FORBIDDEN
+        timesByAnnotation <- timeSpanDAO.summedByAnnotationForUser(user._id,
+                                                                   Instant(start),
+                                                                   Instant(end),
+                                                                   annotationTypesValidated,
+                                                                   projectIdsValidated)
+      } yield Ok(timesByAnnotation)
+  }
+
   def timeSpansOfUser(userId: String,
-                      startDate: Long,
-                      endDate: Long,
+                      start: Long,
+                      end: Long,
                       annotationTypes: String,
                       projectIds: Option[String]): Action[AnyContent] =
     sil.SecuredAction.async { implicit request =>
@@ -60,13 +81,12 @@ class TimeController @Inject()(userService: UserService,
         user <- userService.findOneCached(userIdValidated) ?~> "user.notFound" ~> NOT_FOUND
         isTeamManagerOrAdmin <- userService.isTeamManagerOrAdminOf(request.identity, user)
         _ <- bool2Fox(isTeamManagerOrAdmin || user._id == request.identity._id) ?~> "user.notAuthorised" ~> FORBIDDEN
-        userJs <- userService.compactWrites(user)
         timeSpansJs <- timeSpanDAO.findAllByUserWithTask(user._id,
-                                                         Instant(startDate),
-                                                         Instant(endDate),
+                                                         Instant(start),
+                                                         Instant(end),
                                                          annotationTypesValidated,
                                                          projectIdsValidated)
-      } yield Ok(Json.obj("user" -> userJs, "timelogs" -> timeSpansJs))
+      } yield Ok(timeSpansJs)
     }
 
   def timeOverview(start: Long,
@@ -76,7 +96,6 @@ class TimeController @Inject()(userService: UserService,
                    projectIds: Option[String]): Action[AnyContent] =
     sil.SecuredAction.async { implicit request =>
       for {
-        _ <- Fox.assertTrue(userService.isTeamManagerOrAdminOfOrg(request.identity, request.identity._organization)) ?~> "notAllowed" ~> FORBIDDEN
         teamIdsValidated <- ObjectId.fromCommaSeparated(teamIds) ?~> "invalidTeamId"
         annotationTypesValidated <- AnnotationType.fromCommaSeparated(annotationTypes) ?~> "invalidAnnotationType"
         _ <- bool2Fox(annotationTypesValidated.nonEmpty) ?~> "annotationTypesEmpty"
@@ -86,11 +105,11 @@ class TimeController @Inject()(userService: UserService,
         usersByTeams <- if (teamIdsValidated.isEmpty) userDAO.findAll else userDAO.findAllByTeams(teamIdsValidated)
         admins <- userDAO.findAdminsByOrg(request.identity._organization)
         usersFiltered = (usersByTeams ++ admins).distinct
-        usersWithTimesJs <- timeSpanDAO.timeSummedSearch(Instant(start),
-                                                         Instant(end),
-                                                         usersFiltered.map(_._id),
-                                                         annotationTypesValidated,
-                                                         projectIdsValidated)
+        usersWithTimesJs <- timeSpanDAO.timeOverview(Instant(start),
+                                                     Instant(end),
+                                                     usersFiltered.map(_._id),
+                                                     annotationTypesValidated,
+                                                     projectIdsValidated)
       } yield Ok(Json.toJson(usersWithTimesJs))
     }
 

app/models/user/time/TimeSpan.scala

@@ -69,6 +69,46 @@ class TimeSpanDAO @Inject()(sqlClient: SqlClient)(implicit ec: ExecutionContext)
       parsed <- parseAll(r)
     } yield parsed
 
+  def summedByAnnotationForUser(userId: ObjectId,
+                                start: Instant,
+                                end: Instant,
+                                annotationTypes: List[AnnotationType],
+                                projectIds: List[ObjectId]): Fox[JsValue] =
+    if (annotationTypes.isEmpty) Fox.successful(Json.arr())
+    else {
+      val projectQuery = projectIdsFilterQuery(projectIds)
+      for {
+        tuples <- run(
+          q"""
+          SELECT a._id, t._id, p.name, SUM(ts.time), ARRAY_REMOVE(ARRAY_AGG(al.statistics), null) AS annotation_layer_statistics
+          FROM webknossos.timespans_ ts
+          JOIN webknossos.annotations_ a on ts._annotation = a._id
+          JOIN webknossos.annotation_layers as al ON al._annotation = a._id
+          LEFT JOIN webknossos.tasks_ t on a._task = t._id
+          LEFT JOIN webknossos.projects_ p on t._project = p._id
+          WHERE ts._user = $userId
+          AND ts.time > 0
+          AND ts.created >= $start
+          AND ts.created < $end
+          AND $projectQuery
+          AND a.typ IN ${SqlToken.tupleFromList(annotationTypes)}
+          GROUP BY a._id, t._id, p.name
+          ORDER BY a._id
+         """.as[(String, Option[String], Option[String], Long, String)]
+        )
+        parsed = tuples.map { t =>
+          Json.obj(
+            "annotation" -> t._1,
+            "task" -> t._2,
+            "projectName" -> t._3,
+            "timeMillis" -> t._4,
+            "annotationLayerStats" -> parseArrayLiteral(t._5).map(layerStats =>
+              Json.parse(layerStats).validate[JsObject].getOrElse(Json.obj()))
+          )
+        }
+      } yield Json.toJson(parsed)
+    }
+
   def findAllByUserWithTask(userId: ObjectId,
                             start: Instant,
                             end: Instant,
@@ -78,9 +118,14 @@ class TimeSpanDAO @Inject()(sqlClient: SqlClient)(implicit ec: ExecutionContext)
     else {
       val projectQuery = projectIdsFilterQuery(projectIds)
       for {
-        tuples <- run(q"""SELECT ts.time, ts.created, a._id, ts._id, t._id, p.name, tt._id, tt.summary
+        tuples <- run(
+          q"""SELECT ts._user, mu.email, o.name, d.name, a._id, t._id, p.name, tt._id, tt.summary, ts._id, ts.created, ts.time
                         FROM webknossos.timespans_ ts
                         JOIN webknossos.annotations_ a on ts._annotation = a._id
+                        JOIN webknossos.users_ u on ts._user = u._id
+                        JOIN webknossos.multiUsers_ mu on u._multiUser = mu._id
+                        JOIN webknossos.datasets_ d on a._dataset = d._id
+                        JOIN webknossos.organizations_ o on d._organization = o._id
                         LEFT JOIN webknossos.tasks_ t on a._task = t._id
                         LEFT JOIN webknossos.projects_ p on t._project = p._id
                         LEFT JOIN webknossos.taskTypes_ tt on t._taskType = tt._id
@@ -90,54 +135,64 @@ class TimeSpanDAO @Inject()(sqlClient: SqlClient)(implicit ec: ExecutionContext)
                         AND ts.created < $end
                         AND $projectQuery
                         AND a.typ IN ${SqlToken.tupleFromList(annotationTypes)}
-            """.as[(Long, Instant, String, String, Option[String], Option[String], Option[String], Option[String])])
-      } yield formatTimespanTuples(tuples)
+            """.as[(String,
+                    String,
+                    String,
+                    String,
+                    String,
+                    Option[String],
+                    Option[String],
+                    Option[String],
+                    Option[String],
+                    String,
+                    Instant,
+                    Long)])
+      } yield Json.toJson(tuples.map(formatTimespanTuple))
     }
 
-  private def formatTimespanTuples(tuples: Vector[
-    (Long, Instant, String, String, Option[String], Option[String], Option[String], Option[String])]) = {
-
-    def formatTimespanTuple(
-        tuple: (Long, Instant, String, String, Option[String], Option[String], Option[String], Option[String])) = {
-      def formatDuration(millis: Long): String = {
-        // example: P3Y6M4DT12H30M5S = 3 years + 9 month + 4 days + 12 hours + 30 min + 5 sec
-        // only hours, min and sec are important in this scenario
-        val h = millis / 3600000
-        val m = (millis / 60000) % 60
-        val s = (millis.toDouble / 1000) % 60
-
-        s"PT${h}H${m}M${s}S"
-      }
-
-      Json.obj(
-        "time" -> formatDuration(tuple._1),
-        "timestamp" -> tuple._2,
-        "annotation" -> tuple._3,
-        "_id" -> tuple._4,
-        "task_id" -> tuple._5,
-        "project_name" -> tuple._6,
-        "tasktype_id" -> tuple._7,
-        "tasktype_summary" -> tuple._8
-      )
-    }
-    Json.toJson(tuples.map(formatTimespanTuple))
-  }
+  private def formatTimespanTuple(
+      tuple: (String,
+              String,
+              String,
+              String,
+              String,
+              Option[String],
+              Option[String],
+              Option[String],
+              Option[String],
+              String,
+              Instant,
+              Long)) =
+    Json.obj(
+      "userId" -> tuple._1,
+      "userEmail" -> tuple._2,
+      "datasetOrganization" -> tuple._3,
+      "datasetName" -> tuple._4,
+      "annotationId" -> tuple._5,
+      "taskId" -> tuple._6,
+      "projectName" -> tuple._7,
+      "taskTypeId" -> tuple._8,
+      "taskTypeSummary" -> tuple._9,
+      "timeSpanId" -> tuple._10,
+      "timeSpanCreated" -> tuple._11,
+      "timeSpanTimeMillis" -> tuple._12
+    )
 
   private def projectIdsFilterQuery(projectIds: List[ObjectId]): SqlToken =
     if (projectIds.isEmpty) q"TRUE" // Query did not filter by project, include all
     else q"p._id IN ${SqlToken.tupleFromList(projectIds)}"
 
-  def timeSummedSearch(start: Instant,
-                       end: Instant,
-                       users: List[ObjectId],
-                       annotationTypes: List[AnnotationType],
-                       projectIds: List[ObjectId]): Fox[List[JsObject]] =
+  def timeOverview(start: Instant,
+                   end: Instant,
+                   users: List[ObjectId],
+                   annotationTypes: List[AnnotationType],
+                   projectIds: List[ObjectId]): Fox[List[JsObject]] =
     if (users.isEmpty || annotationTypes.isEmpty) Fox.successful(List.empty)
     else {
       val projectQuery = projectIdsFilterQuery(projectIds)
       val query =
         q"""
-          SELECT u._id, u.firstName, u.lastName, mu.email, SUM(ts.time)
+          SELECT u._id, u.firstName, u.lastName, mu.email, SUM(ts.time), COUNT(a._id)
           FROM webknossos.timespans_ ts
           JOIN webknossos.annotations_ a ON ts._annotation = a._id
           JOIN webknossos.users_ u ON ts._user = u._id
@@ -153,11 +208,11 @@ class TimeSpanDAO @Inject()(sqlClient: SqlClient)(implicit ec: ExecutionContext)
           GROUP BY u._id, u.firstName, u.lastName, mu.email
          """
       for {
-        tuples <- run(query.as[(ObjectId, String, String, String, Long)])
+        tuples <- run(query.as[(ObjectId, String, String, String, Long, Int)])
       } yield formatSummedSearchTuples(tuples)
     }
 
-  private def formatSummedSearchTuples(tuples: Seq[(ObjectId, String, String, String, Long)]): List[JsObject] =
+  private def formatSummedSearchTuples(tuples: Seq[(ObjectId, String, String, String, Long, Int)]): List[JsObject] =
     tuples.map { tuple =>
       Json.obj(
         "user" -> Json.obj(
@@ -166,7 +221,8 @@ class TimeSpanDAO @Inject()(sqlClient: SqlClient)(implicit ec: ExecutionContext)
           "lastName" -> tuple._3,
           "email" -> tuple._4
         ),
-        "timeMillis" -> tuple._5
+        "timeMillis" -> tuple._5,
+        "annotationCount" -> tuple._6
       )
     }.toList
 

conf/webknossos.latest.routes

@@ -250,7 +250,8 @@ GET           /termsOfService/acceptanceNeeded
 
 # Time Tracking
 # Note, there is also /users/:id/loggedTime
-GET           /time/user/:userId                                                                controllers.TimeController.timeSpansOfUser(userId: String, startDate: Long, endDate: Long, annotationTypes: String, projectIds: Option[String])
+GET           /time/user/:userId/spans                                                          controllers.TimeController.timeSpansOfUser(userId: String, start: Long, end: Long, annotationTypes: String, projectIds: Option[String])
+GET           /time/user/:userId/summedByAnnotation                                             controllers.TimeController.timeSummedByAnnotationForUser(userId: String, start: Long, end: Long, annotationTypes: String, projectIds: Option[String])
 GET           /time/overview                                                                    controllers.TimeController.timeOverview(start: Long, end: Long, annotationTypes: String, teamIds: Option[String], projectIds: Option[String])
 
 # Long-Running Jobs

frontend/javascripts/admin/admin_rest_api.ts

@@ -41,7 +41,8 @@ import type {
   APITaskType,
   APITeam,
   APITimeInterval,
-  APITimeTracking,
+  APITimeTrackingPerAnnotation,
+  APITimeTrackingSpan,
   APITracingStore,
   APIUpdateActionBatch,
   APIUser,
@@ -68,6 +69,7 @@ import type {
   AdditionalCoordinate,
   RenderAnimationOptions,
   LayerLink,
+  APITimeTrackingPerUser,
 } from "types/api_flow_types";
 import { APIAnnotationTypeEnum } from "types/api_flow_types";
 import type { LOG_LEVELS, Vector2, Vector3, Vector6 } from "oxalis/constants";
@@ -2000,24 +2002,42 @@ export function updateUserConfiguration(
   });
 }
 
-export async function getTimeTrackingForUser(
+export async function getTimeTrackingForUserSummedPerAnnotation(
   userId: string,
   startDate: dayjs.Dayjs,
   endDate: dayjs.Dayjs,
   annotationTypes: "Explorational" | "Task" | "Task,Explorational",
   projectIds?: string[] | null,
-): Promise<Array<APITimeTracking>> {
+): Promise<Array<APITimeTrackingPerAnnotation>> {
   const params = new URLSearchParams({
-    startDate: startDate.valueOf().toString(),
-    endDate: endDate.valueOf().toString(),
+    start: startDate.valueOf().toString(),
+    end: endDate.valueOf().toString(),
   });
   if (annotationTypes != null) params.append("annotationTypes", annotationTypes);
   if (projectIds != null && projectIds.length > 0)
     params.append("projectIds", projectIds.join(","));
-  const timeTrackingData = await Request.receiveJSON(`/api/time/user/${userId}?${params}`);
-  const { timelogs } = timeTrackingData;
-  assertResponseLimit(timelogs);
-  return timelogs;
+  const timeTrackingData = await Request.receiveJSON(
+    `/api/time/user/${userId}/summedByAnnotation?${params}`,
+  );
+  assertResponseLimit(timeTrackingData);
+  return timeTrackingData;
+}
+
+export async function getTimeTrackingForUserSpans(
+  userId: string,
+  startDate: number,
+  endDate: number,
+  annotationTypes: "Explorational" | "Task" | "Task,Explorational",
+  projectIds?: string[] | null,
+): Promise<Array<APITimeTrackingSpan>> {
+  const params = new URLSearchParams({
+    start: startDate.toString(),
+    end: endDate.toString(),
+  });
+  if (annotationTypes != null) params.append("annotationTypes", annotationTypes);
+  if (projectIds != null && projectIds.length > 0)
+    params.append("projectIds", projectIds.join(","));
+  return await Request.receiveJSON(`/api/time/user/${userId}/spans?${params}`);
 }
 
 export async function getTimeEntries(
@@ -2026,7 +2046,7 @@ export async function getTimeEntries(
   teamIds: string[],
   selectedTypes: AnnotationTypeFilterEnum,
   projectIds: string[],
-) {
+): Promise<Array<APITimeTrackingPerUser>> {
   const params = new URLSearchParams({
     start: startMs.toString(),
     end: endMs.toString(),