feat: Validate dataset properties in jobs (#1473)

## Description
Allows jobs to validate properties of the dataset.

## Motivation
The `validate` action currently allows operators to enforce attributes
of the DTO.

However, many jobs depend on `jobParams.datasetLists` to link a job to
certain datasets. This allows validation of properties on datasets
associated with the dataset.

The motivating example would be checking datasetLifecycle properties for
certain jobs. These are currently hard-coded for special job types. This
would allow them to be applied to custom job types as well.

```
configVersion: v1.0
jobs:
  - jobType: custom_archive
    create:
      auth: "#datasetAccess"
      actions:
        - actionType: validate
          datasets:
            datasetlifecycle.archivable:
              const: true
```

## Changes:

* Add `datasets` property to validate actions (only in `create`
operations) to validate linked dataset properties

## Tests included

(WIP pending tests and documentation)

- [x] Included for each change/fix?
- [x] Passing? <!-- Merge will not be approved unless tests pass -->

## Documentation
- [x] swagger documentation updated (required for API changes)
- [x] official documentation updated

### official documentation info
Docs are included in
SciCatProject/documentation#56

Author: sbliven

jobConfig.example.yaml

@@ -2,9 +2,12 @@ configVersion: v1.0 2024-03-01 6f3f38
 jobs:
   - jobType: archive
     create:
-      auth: "#all"
+      auth: "#datasetOwner"
       actions:
-        - actionType: log
+        - actionType: validate
+          datasets:
+            "datasetlifecycle.archivable":
+              const: true
         - actionType: url
           url: http://localhost:3000/api/v3/health?jobid={{id}}
           headers:
@@ -28,6 +31,17 @@ jobs:
           exchange: jobs.write
           queue: client.jobs.write
           key: jobqueue
+  - jobType: retrieve
+    create:
+      auth: "#datasetOwner"
+      actions:
+      - actionType: validate
+        datasets:
+          "datasetlifecycle.retrievable":
+            const: true
+    statusUpdate:
+      auth: "archivemanager"
+      actions: []
   - jobType: public
     create:
       auth: "#all"
@@ -39,5 +53,8 @@ jobs:
               required:
                 - pid
                 - files
+          datasets:
+            isPublished:
+              const: true
     statusUpdate:
-      auth: "#all"
+      auth: "archivemanager"

src/config/job-config/actions/corejobactioncreators.module.ts

@@ -7,7 +7,10 @@ import { actionType as logActionType } from "./logaction/logaction.interface";
 import { actionType as emailActionType } from "./emailaction/emailaction.interface";
 import { ValidateJobActionModule } from "./validateaction/validateaction.module";
 import { actionType as validateActionType } from "./validateaction/validateaction.interface";
-import { ValidateJobActionCreator } from "./validateaction/validateaction.service";
+import {
+  ValidateCreateJobActionCreator,
+  ValidateJobActionCreator,
+} from "./validateaction/validateaction.service";
 import { URLJobActionModule } from "./urlaction/urlaction.module";
 import { URLJobActionCreator } from "./urlaction/urlaction.service";
 import { actionType as urlActionType } from "./urlaction/urlaction.interface";
@@ -39,22 +42,22 @@ import {
       useFactory: (
         logJobActionCreator,
         emailJobActionCreator,
-        validateJobActionCreator,
+        validateCreateJobActionCreator,
         urlJobActionCreator,
         rabbitMQJobActionCreator,
       ) => {
         return {
           [logActionType]: logJobActionCreator,
           [emailActionType]: emailJobActionCreator,
-          [validateActionType]: validateJobActionCreator,
+          [validateActionType]: validateCreateJobActionCreator,
           [urlActionType]: urlJobActionCreator,
           [rabbitmqActionType]: rabbitMQJobActionCreator,
         };
       },
       inject: [
         LogJobActionCreator,
         EmailJobActionCreator,
-        ValidateJobActionCreator,
+        ValidateCreateJobActionCreator,
         URLJobActionCreator,
         RabbitMQJobActionCreator,
       ],

src/config/job-config/actions/validateaction/validateaction.interface.ts

@@ -4,7 +4,14 @@ export const actionType = "validate";
 
 export interface ValidateJobActionOptions extends JobActionOptions {
   actionType: typeof actionType;
-  request: Record<string, unknown>;
+  request?: Record<string, unknown>;
+}
+
+export interface ValidateCreateJobActionOptions
+  extends ValidateJobActionOptions {
+  actionType: typeof actionType;
+  request?: Record<string, unknown>;
+  datasets?: Record<string, unknown>;
 }
 
 /**
@@ -15,7 +22,27 @@ export function isValidateJobActionOptions(
 ): options is ValidateJobActionOptions {
   if (typeof options === "object" && options !== null) {
     const opts = options as ValidateJobActionOptions;
-    return opts.actionType === actionType && typeof opts.request === "object";
+    return (
+      opts.actionType === actionType &&
+      (opts.request === undefined || typeof opts.request === "object")
+    );
+  }
+  return false;
+}
+
+/**
+ * Type guard for EmailJobActionOptions
+ */
+export function isValidateCreateJobActionOptions(
+  options: unknown,
+): options is ValidateJobActionOptions {
+  if (typeof options === "object" && options !== null) {
+    const opts = options as ValidateCreateJobActionOptions;
+    return (
+      opts.actionType === actionType &&
+      (opts.request === undefined || typeof opts.request === "object") &&
+      (opts.datasets === undefined || typeof opts.datasets === "object")
+    );
   }
   return false;
 }

src/config/job-config/actions/validateaction/validateaction.module.ts

@@ -1,8 +1,11 @@
 import { Module } from "@nestjs/common";
-import { ValidateJobActionCreator } from "./validateaction.service";
+import {
+  ValidateCreateJobActionCreator,
+  ValidateJobActionCreator,
+} from "./validateaction.service";
 
 @Module({
-  providers: [ValidateJobActionCreator],
-  exports: [ValidateJobActionCreator],
+  providers: [ValidateJobActionCreator, ValidateCreateJobActionCreator],
+  exports: [ValidateJobActionCreator, ValidateCreateJobActionCreator],
 })
 export class ValidateJobActionModule {}

src/config/job-config/actions/validateaction/validateaction.service.ts

@@ -4,8 +4,11 @@ import {
   JobActionOptions,
   JobDto,
 } from "../../jobconfig.interface";
-import { ValidateJobAction } from "./validateaction";
+import { ValidateCreateJobAction, ValidateJobAction } from "./validateaction";
 import { isValidateJobActionOptions } from "./validateaction.interface";
+import { DatasetsService } from "src/datasets/datasets.service";
+import { CreateJobDto } from "src/jobs/dto/create-job.dto";
+import { ModuleRef } from "@nestjs/core";
 
 @Injectable()
 export class ValidateJobActionCreator implements JobActionCreator<JobDto> {
@@ -20,3 +23,18 @@ export class ValidateJobActionCreator implements JobActionCreator<JobDto> {
     return new ValidateJobAction(options);
   }
 }
+
+@Injectable()
+export class ValidateCreateJobActionCreator
+  implements JobActionCreator<CreateJobDto>
+{
+  private datasetsService: DatasetsService;
+  constructor(private moduleRef: ModuleRef) {}
+
+  public create<Options extends JobActionOptions>(options: Options) {
+    if (!isValidateJobActionOptions(options)) {
+      throw new Error("Invalid options for ValidateJobAction.");
+    }
+    return new ValidateCreateJobAction(this.moduleRef, options);
+  }
+}