Retry failed recordings

api/api/V1/Reprocess.ts

@@ -28,7 +28,7 @@ import {
 import { idOf } from "../validation-middleware.js";
 import { successResponse } from "./responseUtil.js";
 import type { NextFunction } from "express-serve-static-core";
-import { ClientError } from "../customErrors.js";
+import { ClientError, BadRequestError } from "../customErrors.js";
 import { arrayOf, jsonSchemaOf } from "../schema-validation.js";
 import lodash from "lodash";
 import RecordingIdSchema from "@schemas/api/common/RecordingId.schema.json" assert { type: "json" };
@@ -38,12 +38,50 @@ const { uniq: dedupe } = lodash;
 export default (app: Application, baseUrl: string) => {
   const apiUrl = `${baseUrl}/reprocess`;
 
+  /**
+   * @api {get} /api/v1/reprocess/retryFailed/:id Retry processing a single recording which is in a failed state
+   * @apiName Reprocess
+   * @apiGroup Recordings
+   * @apiParam {Integer} id of recording to retry
+   * @apiDescription Retries processing a recording thats in a failed state
+   *
+   * @apiUse V1UserAuthorizationHeader
+   *
+   * @apiUse V1ResponseSuccess
+   * @apiUse V1ResponseError
+   */
+  app.get(
+    `${apiUrl}/retryFailed/:id`,
+    extractJwtAuthorizedUser,
+    validateFields([idOf(param("id"))]),
+    fetchAuthorizedRequiredRecordingById(param("id")),
+    async (request: Request, response: Response, next) => {
+      if (!response.locals.recording.isFailed()) {
+        return next(
+          new BadRequestError(
+            `Recording is not in a failed state '${response.locals.recording.processingState}'`
+          )
+        );
+      }
+      if (await response.locals.recording.retryFailed()) {
+        return successResponse(response, "Recording reprocessed");
+      } else {
+        return next(
+          new BadRequestError(
+            `Could not retry processing of recordings ${response.locals.recording.id}`
+          )
+        );
+      }
+    }
+  );
+
   /**
    * @api {get} /api/v1/reprocess/:id Reprocess a single recording
    * @apiName Reprocess
    * @apiGroup Recordings
    * @apiParam {Integer} id of recording to reprocess
-   * @apiDescription Marks a recording for reprocessing and archives existing tracks
+   * @apiDescription Marks a recording for reprocessing (tracking), and archives existing tracks.
+   * Used if tracking algorithms have changed
    *
    * @apiUse V1UserAuthorizationHeader
    *

api/classifications/classifications.js

@@ -1,37 +1,33 @@
 import Classifications from "@/classifications/classification.json" assert { type: "json" };
 const flattenNodes = (acc, node, parentPath) => {
-  for (const child of node.children || []) {
-    acc[child.label] = {
-      label: child.label,
-      display: child.display || child.label,
-      path: `${parentPath}.${child.label}`,
-    };
-    flattenNodes(acc, child, acc[child.label].path);
-  }
-  return acc;
+    for (const child of node.children || []) {
+        acc[child.label] = {
+            label: child.label,
+            display: child.display || child.label,
+            path: `${parentPath}.${child.label}`,
+        };
+        flattenNodes(acc, child, acc[child.label].path);
+    }
+    return acc;
 };
 export const flatClassifications = (() => {
-  const nodes = flattenNodes({}, Classifications, "all");
-  if (nodes.unknown) {
-    nodes["unidentified"] = nodes["unknown"];
-  }
-  return nodes;
+    const nodes = flattenNodes({}, Classifications, "all");
+    if (nodes.unknown) {
+        nodes["unidentified"] = nodes["unknown"];
+    }
+    return nodes;
 })();
-export const displayLabelForClassificationLabel = (
-  label,
-  aiTag = false,
-  isAudioContext = false
-) => {
-  label = label.toLowerCase();
-  if (label === "unclassified") {
-    return "AI Queued";
-  }
-  if (label === "unidentified" && aiTag) {
-    return "Unidentified";
-  }
-  const classifications = flatClassifications;
-  if ((label === "human" || label === "person") && !isAudioContext) {
-    return "human";
-  }
-  return (classifications[label] && classifications[label].display) || label;
+export const displayLabelForClassificationLabel = (label, aiTag = false, isAudioContext = false) => {
+    label = label.toLowerCase();
+    if (label === "unclassified") {
+        return "AI Queued";
+    }
+    if (label === "unidentified" && aiTag) {
+        return "Unidentified";
+    }
+    const classifications = flatClassifications;
+    if ((label === "human" || label === "person") && !isAudioContext) {
+        return "human";
+    }
+    return (classifications[label] && classifications[label].display) || label;
 };

api/models/Recording.ts

@@ -209,7 +209,7 @@ export interface Recording extends Sequelize.Model, ModelCommon<Recording> {
   getGroup: () => Promise<Group>;
 
   getActiveTracksTagsAndTagger: () => Promise<any>;
-
+  retryFailed: () => Promise<Recording>;
   reprocess: () => Promise<Recording>;
   filterData: (options: any) => void;
   // NOTE: Implicitly created by sequelize associations (along with other
@@ -787,6 +787,17 @@ from (
     };
   }
 
+  // retry processing this recording
+  Recording.prototype.retryFailed = async function () {
+    if (!this.processingState.endsWith(".failed")) {
+      return false;
+    }
+    await this.update({
+      processingState: this.processingState.replace(".failed", ""),
+    });
+    return true;
+  };
+
   // reprocess a recording and set all active tracks to archived
   Recording.prototype.reprocess = async function () {
     const tags = await this.getTags();

browse/src/api/Recording.api.ts

@@ -546,8 +546,8 @@ function deleteRecordingTag(
   return CacophonyApi.delete(`${apiPath}/${id}/tags/${tagId}`);
 }
 
-function reprocess(id: RecordingId): Promise<FetchResult<void>> {
-  return CacophonyApi.get(`/api/v1/reprocess/${id}`);
+function retryFailed(id: RecordingId): Promise<FetchResult<void>> {
+  return CacophonyApi.get(`/api/v1/reprocess/retryFailed/${id}`);
 }
 
 function thumbnail(id: RecordingId): string {
@@ -641,7 +641,7 @@ export default {
   deleteTrack,
   undeleteTrack,
   updateTrack,
-  reprocess,
+  retryFailed,
   addTrackTag,
   deleteTrackTag,
   replaceTrackTag,

browse/src/components/Video/VideoRecording.vue

@@ -329,7 +329,7 @@ export default {
   },
   methods: {
     async reprocess() {
-      const { success } = await api.recording.reprocess(this.recordingId);
+      const { success } = await api.recording.retryFailed(this.recordingId);
       if (success) {
         this.$emit("recording-updated", {
           id: this.recordingId,