Jobs: rename statusUpdate to update

src/casl/action.enum.ts

@@ -5,7 +5,6 @@ export enum Action {
   ReadOwn = "readown",
   ReadAll = "readall",
   Update = "update",
-  StatusUpdate = "statusUpdate",
   Delete = "delete",
   ListOwn = "listown",
   ListAll = "listall",
@@ -182,17 +181,17 @@ export enum Action {
   // endpoint authorization
   JobCreate = "jobs_create",
   JobRead = "jobs_read",
-  JobStatusUpdate = "job_update",
+  JobUpdate = "job_update",
   JobDelete = "job_delete",
   // data instance authorization
   JobCreateConfiguration = "job_create_configuration",
   JobCreateOwner = "job_create_owner",
   JobCreateAny = "job_create_any",
   JobReadAccess = "job_read_access",
   JobReadAny = "job_read_any",
-  JobStatusUpdateConfiguration = "job_status_update_configuration",
-  JobStatusUpdateOwner = "job_status_update_owner",
-  JobStatusUpdateAny = "job_status_update_any",
+  JobUpdateConfiguration = "job_update_configuration",
+  JobUpdateOwner = "job_update_owner",
+  JobUpdateAny = "job_update_any",
   //JobDeleteAny = "job_delete_any",
 
   // -------------

src/casl/casl-ability.factory.ts

@@ -26,11 +26,7 @@ import { UserSettings } from "src/users/schemas/user-settings.schema";
 import { User } from "src/users/schemas/user.schema";
 import { Action } from "./action.enum";
 import configuration from "src/config/configuration";
-import {
-  CreateJobAuth,
-  StatusUpdateJobAuth,
-} from "src/jobs/types/jobs-auth.enum";
-
+import { CreateJobAuth, UpdateJobAuth } from "src/jobs/types/jobs-auth.enum";
 import { JobConfig } from "src/jobs/config/jobconfig";
 
 type Subjects =
@@ -367,12 +363,12 @@ export class CaslAbilityFactory {
       cannot(Action.JobRead, JobClass);
       if (
         configuration().jobConfiguration.some(
-          (j) => j.statusUpdate.auth == StatusUpdateJobAuth.All,
+          (j) => j.update.auth == UpdateJobAuth.All,
         )
       ) {
-        can(Action.JobStatusUpdate, JobClass);
+        can(Action.JobUpdate, JobClass);
       } else {
-        cannot(Action.JobStatusUpdate, JobClass);
+        cannot(Action.JobUpdate, JobClass);
       }
       cannot(Action.JobDelete, JobClass);
     } else {
@@ -388,7 +384,7 @@ export class CaslAbilityFactory {
          */
         can(Action.JobRead, JobClass);
         can(Action.JobCreate, JobClass);
-        can(Action.JobStatusUpdate, JobClass);
+        can(Action.JobUpdate, JobClass);
         cannot(Action.JobDelete, JobClass);
       } else if (
         user.currentGroups.some((g) =>
@@ -437,26 +433,26 @@ export class CaslAbilityFactory {
           }
         }
         const jobUpdateEndPointAuthorizationValues = [
-          ...Object.values(StatusUpdateJobAuth),
+          ...Object.values(UpdateJobAuth),
           ...jobUserAuthorizationValues,
         ];
         if (
           user.currentGroups.some((g) =>
-            configuration().statusUpdateJobGroups.includes(g),
+            configuration().updateJobGroups.includes(g),
           )
         ) {
-          can(Action.JobStatusUpdate, JobClass);
+          can(Action.JobUpdate, JobClass);
         } else {
           if (
             configuration().jobConfiguration.some(
               (j) =>
-                j.statusUpdate.auth &&
+                j.update.auth &&
                 jobUpdateEndPointAuthorizationValues.includes(
-                  j.statusUpdate.auth as string,
+                  j.update.auth as string,
                 ),
             )
           ) {
-            can(Action.JobStatusUpdate, JobClass);
+            can(Action.JobUpdate, JobClass);
           }
         }
         cannot(Action.JobDelete, JobClass);
@@ -1375,8 +1371,8 @@ export class CaslAbilityFactory {
           datasetsValidation: true,
         });
       }
-      if (jobConfiguration.statusUpdate.auth === StatusUpdateJobAuth.All) {
-        can(Action.JobStatusUpdateConfiguration, JobClass, {
+      if (jobConfiguration.update.auth === UpdateJobAuth.All) {
+        can(Action.JobUpdateConfiguration, JobClass, {
           ownerGroup: undefined,
         });
       }
@@ -1393,7 +1389,7 @@ export class CaslAbilityFactory {
          */
         can(Action.JobReadAny, JobClass);
         can(Action.JobCreateAny, JobClass);
-        can(Action.JobStatusUpdateAny, JobClass);
+        can(Action.JobUpdateAny, JobClass);
       } else {
         const jobUserAuthorizationValues = [
           ...user.currentGroups.map((g) => "@" + g),
@@ -1452,45 +1448,45 @@ export class CaslAbilityFactory {
           }
         }
         const jobUpdateInstanceAuthorizationValues = [
-          ...Object.values(StatusUpdateJobAuth).filter(
+          ...Object.values(UpdateJobAuth).filter(
             (v) => !String(v).includes("#job"),
           ),
           ...jobUserAuthorizationValues,
         ];
 
         if (
           user.currentGroups.some((g) =>
-            configuration().statusUpdateJobGroups.includes(g),
+            configuration().updateJobGroups.includes(g),
           )
         ) {
           if (
             jobUpdateInstanceAuthorizationValues.some(
-              (a) => jobConfiguration.statusUpdate.auth === a,
+              (a) => jobConfiguration.update.auth === a,
             )
           ) {
-            can(Action.JobStatusUpdateConfiguration, JobClass);
+            can(Action.JobUpdateConfiguration, JobClass);
           }
-          can(Action.JobStatusUpdateOwner, JobClass, {
+          can(Action.JobUpdateOwner, JobClass, {
             ownerUser: user.username,
           });
-          can(Action.JobStatusUpdateOwner, JobClass, {
+          can(Action.JobUpdateOwner, JobClass, {
             ownerGroup: { $in: user.currentGroups },
           });
         } else {
           if (
             jobUpdateInstanceAuthorizationValues.some(
-              (a) => jobConfiguration.statusUpdate.auth === a,
+              (a) => jobConfiguration.update.auth === a,
             )
           ) {
-            can(Action.JobStatusUpdateConfiguration, JobClass);
+            can(Action.JobUpdateConfiguration, JobClass);
           }
-          if (jobConfiguration.statusUpdate.auth === "#jobOwnerUser") {
-            can(Action.JobStatusUpdateConfiguration, JobClass, {
+          if (jobConfiguration.update.auth === "#jobOwnerUser") {
+            can(Action.JobUpdateConfiguration, JobClass, {
               ownerUser: user.username,
             });
           }
-          if (jobConfiguration.statusUpdate.auth === "#jobOwnerGroup") {
-            can(Action.JobStatusUpdateConfiguration, JobClass, {
+          if (jobConfiguration.update.auth === "#jobOwnerGroup") {
+            can(Action.JobUpdateConfiguration, JobClass, {
               ownerGroup: { $in: user.currentGroups },
             });
           }

src/config/configuration.ts

@@ -1,7 +1,7 @@
 import {
   loadJobConfig,
   registerCreateAction,
-  registerStatusUpdateAction,
+  registerUpdateAction,
 } from "../jobs/config/jobconfig";
 import { LogJobAction } from "../jobs/actions/logaction";
 import { EmailJobAction } from "../jobs/actions/emailaction";
@@ -29,7 +29,7 @@ const configuration = () => {
     process.env.DATASET_CREATION_VALIDATION_REGEX || ("" as string);
 
   const createJobGroups = process.env.CREATE_JOB_GROUPS || ("" as string);
-  const statusUpdateJobGroups = process.env.UPDATE_JOB_GROUPS || ("" as string);
+  const updateJobGroups = process.env.UPDATE_JOB_GROUPS || ("" as string);
   const deleteJobGroups = process.env.DELETE_JOB_GROUPS || ("" as string);
 
   const proposalGroups = process.env.PROPOSAL_GROUPS || ("" as string);
@@ -98,7 +98,7 @@ const configuration = () => {
     datasetCreationValidationEnabled: datasetCreationValidationEnabled,
     datasetCreationValidationRegex: datasetCreationValidationRegex,
     createJobGroups: createJobGroups,
-    statusUpdateJobGroups: statusUpdateJobGroups,
+    updateJobGroups: updateJobGroups,
     deleteJobGroups: deleteJobGroups,
     logoutURL: process.env.LOGOUT_URL ?? "", // Example: http://localhost:3000/
     accessGroupsGraphQlConfig: {
@@ -230,10 +230,10 @@ export function registerDefaultActions() {
   registerCreateAction(EmailJobAction);
   registerCreateAction(URLAction);
   registerCreateAction(RabbitMQJobAction);
-  // Status Update
-  registerStatusUpdateAction(LogJobAction);
-  registerStatusUpdateAction(EmailJobAction);
-  registerStatusUpdateAction(RabbitMQJobAction);
+  // Update
+  registerUpdateAction(LogJobAction);
+  registerUpdateAction(EmailJobAction);
+  registerUpdateAction(RabbitMQJobAction);
 }
 
 export type OidcConfig = ReturnType<typeof configuration>["oidc"];

src/jobs/config/jobConfig.example.json

@@ -39,7 +39,7 @@
           }
         ]
       },
-      "statusUpdate": {
+      "update": {
         "auth": "archivemanager",
         "actions": [
           {
@@ -60,7 +60,7 @@
       "create": {
         "auth": "#all"
       },
-      "statusUpdate": {
+      "update": {
         "auth": "#all"
       }
     }

src/jobs/config/jobConfig.schema.ts

@@ -28,7 +28,7 @@ export const JobConfigSchema = {
             },
             additionalProperties: true,
           },
-          statusUpdate: {
+          update: {
             type: "object",
             properties: {
               auth: { type: "string" },

src/jobs/config/jobconfig.ts

@@ -16,7 +16,7 @@
 import * as fs from "fs";
 import { JobClass } from "../schemas/job.schema";
 import { CreateJobDto } from "../dto/create-job.dto";
-import { StatusUpdateJobDto } from "../dto/status-update-job.dto";
+import { UpdateJobDto } from "../dto/update-job.dto";
 import { JobsConfigSchema } from "../types/jobs-config-schema.enum";
 import { Action } from "src/casl/action.enum";
 import { CreateJobAuth, JobsAuth } from "../types/jobs-auth.enum";
@@ -30,18 +30,18 @@
   jobType: string;
   configVersion: string;
   create: JobOperation<CreateJobDto>;
-  statusUpdate: JobOperation<StatusUpdateJobDto>;
+  update: JobOperation<UpdateJobDto>;
 
   constructor(
     jobType: string,
     configVersion: string,
     create: JobOperation<CreateJobDto>,
-    statusUpdate: JobOperation<StatusUpdateJobDto>,
+    update: JobOperation<UpdateJobDto>,
   ) {
     this.jobType = jobType;
     this.configVersion = configVersion;
     this.create = create;
-    this.statusUpdate = statusUpdate;
+    this.update = update;
   }
 
   /**
@@ -64,25 +64,23 @@
     if (!(Action.Create in jobData)) {
       throw new Error(`No ${Action.Create} configured for job type "${type}"`);
     }
-    if (!(Action.StatusUpdate in jobData)) {
-      throw new Error(
-        `No ${Action.StatusUpdate} configured for job type "${type}"`,
-      );
+    if (!(Action.Update in jobData)) {
+      throw new Error(`No ${Action.Update} configured for job type "${type}"`);
     }
     const create = JobOperation.parse<CreateJobDto>(
       createActions,
       jobData[Action.Create] as Record<string, unknown>,
     );
-    const statusUpdate = JobOperation.parse<StatusUpdateJobDto>(
-      statusUpdateActions,
-      jobData[Action.StatusUpdate] as Record<string, unknown>,
+    const update = JobOperation.parse<UpdateJobDto>(
+      updateActions,
+      jobData[Action.Update] as Record<string, unknown>,
     );
-    return new JobConfig(type, configVersion, create, statusUpdate);
+    return new JobConfig(type, configVersion, create, update);
   }
 }
 
 /**
- * Encapsulates all information for a particular job operation (eg "create", "statusUpdate")
+ * Encapsulates all information for a particular job operation (eg "create", "update")
  */
 export class JobOperation<DtoType> {
   auth: JobsAuth | undefined;
@@ -154,7 +152,7 @@
 /**
  * Superclass for all responses to Job changes
  */
 export interface JobAction<DtoType> {
   /**
    * Respond to the action
    */
@@ -180,16 +178,13 @@
 
 export type JobCreateAction = JobAction<CreateJobDto>;
 // export type JobReadAction = JobAction<ReadJobDto>;
-export type JobStatusUpdateAction = JobAction<StatusUpdateJobDto>;
+export type JobUpdateAction = JobAction<UpdateJobDto>;
 
 /**
  * Action registration
  */
 const createActions: Record<string, JobActionClass<CreateJobDto>> = {};
-const statusUpdateActions: Record<
-  string,
-  JobActionClass<StatusUpdateJobDto>
-> = {};
+const updateActions: Record<string, JobActionClass<UpdateJobDto>> = {};
 
 /**
  * Registers an action to handle jobs of a particular type
@@ -199,10 +194,8 @@
   createActions[action.actionType] = action;
 }
 
-export function registerStatusUpdateAction(
-  action: JobActionClass<StatusUpdateJobDto>,
-) {
-  statusUpdateActions[action.actionType] = action;
+export function registerUpdateAction(action: JobActionClass<UpdateJobDto>) {
+  updateActions[action.actionType] = action;
 }
 
 /**
@@ -213,8 +206,8 @@
   return Object.keys(createActions);
 }
 
-export function getRegisteredStatusUpdateActions(): string[] {
-  return Object.keys(statusUpdateActions);
+export function getRegisteredUpdateActions(): string[] {
+  return Object.keys(updateActions);
 }
 
 /**

src/jobs/dto/status-update-job.dto.ts → src/jobs/dto/update-job.dto.ts

@@ -2,7 +2,7 @@ import { ApiProperty, ApiTags } from "@nestjs/swagger";
 import { IsOptional, IsString, IsObject } from "class-validator";
 
 @ApiTags("jobs")
-export class StatusUpdateJobDto {
+export class UpdateJobDto {
   @ApiProperty({
     type: String,
     required: true,