RELEASE 04-06-2025 (#1882)

## Description
Short description of the pull request


## Motivation
Background on use case, changes needed


## Fixes:
Please provide a list of the fixes implemented in this PR

* Items added


## Changes:
Please provide a list of the changes implemented by this PR

* changes made


## Tests included
- [ ] Included for each change/fix?
- [ ] Passing? (Merge will not be approved unless this is checked) 

## Documentation
- [ ] swagger documentation updated \[required\]
- [ ] official documentation updated \[nice-to-have\]

### official documentation info
If you have updated the official documentation, please provide PR # and
URL of the pages where the updates are included

## Backend version
- [ ] Does it require a specific version of the backend
- which version of the backend is required:

## Summary by Sourcery

Upgrade core integrations and enhance UI tables, dataset detail,
datafiles actions, and jobs workflows while standardizing authentication
flows and updating documentation and tests.

New Features:
- Add JSON-download support in DatafilesActionComponent with payload
substitution, file download flow, and error snackbar
- Switch SampleDashboard to dynamic-mat-table with persistent user table
settings, server-side pagination, sorting, and row events

Enhancements:
- Extend DatasetDetailDynamicComponent with instrument name resolution,
internal link handling, and scientific metadata extraction methods
- Migrate jobs module to use v3 API endpoints and update related
actions, selectors, reducers, and effects
- Standardize returnUrl query parameter naming and handling across
login, auth callback, and header components

Build:
- Bump @scicatproject/scicat-sdk-ts-angular to ^4.17.1 and update
OpenAPI generator scripts to v7.13.0

Documentation:
- Add comprehensive markdown documentation for Datafiles Actions
configuration

Tests:
- Add extensive unit tests for DatasetDetailDynamicComponent methods
- Update SampleDashboard and jobs tests to accommodate dynamic-mat-table
events and v3 API changes

Chores:
- Refactor SampleEffects to only trigger on fetchSamplesAction and
adjust metadata keys query logic
- Clean up backward-compatibility comments and obsolete code in admin
tab and archiving service

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Max Novelli <[email protected]>
Co-authored-by: Jay <[email protected]>
Co-authored-by: MatthMig <[email protected]>
Co-authored-by: Matthieu Migné <[email protected]>
Co-authored-by: Martin <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Garrett Birkel <[email protected]>

Author: 9 people

cypress/e2e/proposals/proposals-general.cy.js

@@ -443,9 +443,7 @@ describe("Proposals general", () => {
         .find("input[type=checkbox]")
         .uncheck();
 
-      cy.get('[role="menu"] .column-config-apply .done-setting')
-        .contains("done")
-        .click();
+      cy.contains(".column-config-apply button.done-setting", "done").click();
 
       cy.get("dynamic-mat-table table-menu button").click();
       cy.get('[role="menu"] button').contains("Save table setting").click();
@@ -454,6 +452,8 @@ describe("Proposals general", () => {
 
       cy.get("dynamic-mat-table mat-header-row.header").should("exist");
 
+      cy.finishedLoading();
+
       cy.get("dynamic-mat-table mat-header-row.header").should(
         "not.contain",
         "First Name",

package-lock.json

@@ -37,7 +37,7 @@
     "@ngrx/store": "^19.1.0",
     "@ngx-translate/core": "^16.0.4",
     "@ngxmc/datetime-picker": "^19.3.1",
-    "@scicatproject/scicat-sdk-ts-angular": "^4.16.0",
+    "@scicatproject/scicat-sdk-ts-angular": "^4.17.1",
     "autolinker": "^4.0.0",
     "deep-equal": "^2.0.5",
     "exceljs": "^4.3.0",

package.json

@@ -19,7 +19,7 @@ docker run \
 	--rm \
 	--add-host host.docker.internal:host-gateway \
 	-v "`pwd`:/local" \
-	openapitools/openapi-generator-cli:v7.12.0 generate \
+	openapitools/openapi-generator-cli:v7.13.0 generate \
 	-i http://host.docker.internal:3000/explorer-json \
 	-g typescript-angular \
 	-o local/@scicatproject/scicat-sdk-ts-angular \

scripts/generate-nestjs-sdk.bash

@@ -33,7 +33,7 @@ if (isWindows()) {
    * This should not be a risk as after the generation we can get a feedback immediately if something is broken here when we run and test the frontend.
    */
   const generationOutput = execSync(
-    `docker run --rm --add-host host.docker.internal:host-gateway -v "${getCurrentDirectory()}:/local" openapitools/openapi-generator-cli:v7.9.0 generate -i http://host.docker.internal:3000/explorer-json -g typescript-angular -o local/@scicatproject/scicat-sdk-ts-angular --additional-properties=ngVersion=19.0.0,npmName=@scicatproject/scicat-sdk-ts-angular,supportsES6=true,npmVersion=10.8.2,withInterfaces=true,paramNaming=original,modelPropertyNaming=original,enumPropertyNaming=original --skip-validate-spec`,
+    `docker run --rm --add-host host.docker.internal:host-gateway -v "${getCurrentDirectory()}:/local" openapitools/openapi-generator-cli:v7.13.0 generate -i http://host.docker.internal:3000/explorer-json -g typescript-angular -o local/@scicatproject/scicat-sdk-ts-angular --additional-properties=ngVersion=19.0.0,npmName=@scicatproject/scicat-sdk-ts-angular,supportsES6=true,withInterfaces=true,paramNaming=original,modelPropertyNaming=original,enumPropertyNaming=original --skip-validate-spec`,
     { encoding: "utf-8" },
   );
   console.log(generationOutput);

scripts/generate-nestjs-sdk.js

@@ -47,9 +47,9 @@ export class AppHeaderComponent implements OnInit {
 
   login(): void {
     if (this.config.skipSciCatLoginPageEnabled) {
-      const returnURL = encodeURIComponent(this.router.url);
+      const returnUrl = encodeURIComponent(this.router.url);
       for (const endpoint of this.oAuth2Endpoints) {
-        this.document.location.href = `${this.config.lbBaseURL}/${endpoint.authURL}?returnURL=${returnURL}`;
+        this.document.location.href = `${this.config.lbBaseURL}/${endpoint.authURL}?returnUrl=${returnUrl}`;
       }
     } else {
       this.router.navigateByUrl("/login");

src/app/_layout/app-header/app-header.component.ts

@@ -4,7 +4,7 @@ import { FileObject } from "datasets/dataset-details-dashboard/dataset-details-d
 import { Subscription } from "rxjs";
 import { take } from "rxjs/operators";
 import {
-  CreateJobDto,
+  CreateJobDtoV3,
   OutputDatasetObsoleteDto,
 } from "@scicatproject/scicat-sdk-ts-angular";
 import { submitJobAction } from "state-management/actions/jobs.actions";
@@ -48,12 +48,6 @@ export class AdminTabComponent implements OnInit, OnDestroy {
         .pipe(take(1))
         .subscribe((user) => {
           if (user && this.dataset) {
-            const job: CreateJobDto = {
-              ownerUser: user.email,
-              type: "reset",
-              jobParams: {},
-            };
-            job.jobParams["username"] = user.username;
             const fileObj: FileObject = {
               pid: "",
               files: [],
@@ -66,7 +60,14 @@ export class AdminTabComponent implements OnInit, OnDestroy {
               });
             }
             fileObj.files = fileList;
-            // job.datasetList = [fileObj];   // TODO: job release back-ward compatibility issue
+            const job: CreateJobDtoV3 = {
+              emailJobInitiator: user.email,
+              type: "reset",
+              datasetList: [fileObj],
+              jobParams: {},
+              jobStatusMessage: "jobCreated",
+            };
+            job.jobParams["username"] = user.username;
             this.store.dispatch(submitJobAction({ job }));
           }
         });

src/app/datasets/admin-tab/admin-tab.component.ts

@@ -10,7 +10,10 @@ import {
 import { JobsState } from "state-management/state/jobs.store";
 import { ArchivingService } from "./archiving.service";
 import { createMock, mockDataset } from "shared/MockStubs";
-import { ReturnedUserDto } from "@scicatproject/scicat-sdk-ts-angular";
+import {
+  ReturnedUserDto,
+  CreateJobDtoV3,
+} from "@scicatproject/scicat-sdk-ts-angular";
 
 describe("ArchivingService", () => {
   let service: ArchivingService;
@@ -70,7 +73,7 @@ describe("ArchivingService", () => {
         destinationPath,
       );
 
-      // expect(job).toBeInstanceOf(Job);
+      expect(job).toBeDefined();
       expect(job["emailJobInitiator"]).toEqual("[email protected]");
       expect(job["jobParams"]["username"]).toEqual("testName");
       expect(job["datasetList"]).toEqual(datasetList);
@@ -103,8 +106,8 @@ describe("ArchivingService", () => {
         files: [],
       }));
       const archive = true;
-      // TODO: job release back-ward compatibility issue
-      const job = createMock<any>({
+
+      const job = createMock<CreateJobDtoV3>({
         jobParams: { username: user.username },
         emailJobInitiator: user.email,
         datasetList,

src/app/datasets/archiving.service.spec.ts

@@ -18,6 +18,7 @@ import {
 import { ActionDataset } from "./datafiles-action.interfaces";
 import { UsersService } from "@scicatproject/scicat-sdk-ts-angular";
 import { AuthService } from "shared/services/auth/auth.service";
+import { MatSnackBarModule } from "@angular/material/snack-bar";
 
 describe("1000: DatafilesActionComponent", () => {
   let component: DatafilesActionComponent;
@@ -157,6 +158,7 @@ describe("1000: DatafilesActionComponent", () => {
         PipesModule,
         ReactiveFormsModule,
         MatDialogModule,
+        MatSnackBarModule,
         RouterModule,
         RouterModule.forRoot([]),
         StoreModule.forRoot({}),

src/app/datasets/datafiles-actions/datafiles-action.component.spec.ts

@@ -10,6 +10,8 @@ import { UsersService } from "@scicatproject/scicat-sdk-ts-angular";
 import { ActionConfig, ActionDataset } from "./datafiles-action.interfaces";
 import { DataFiles_File } from "datasets/datafiles/datafiles.interfaces";
 import { AuthService } from "shared/services/auth/auth.service";
+import { v4 } from "uuid";
+import { MatSnackBar } from "@angular/material/snack-bar";
 
 @Component({
   selector: "datafiles-action",
@@ -36,6 +38,7 @@ export class DatafilesActionComponent implements OnInit, OnChanges {
   constructor(
     private usersService: UsersService,
     private authService: AuthService,
+    private snackBar: MatSnackBar,
   ) {
     this.usersService.usersControllerGetUserJWTV3().subscribe((jwt) => {
       this.jwt = jwt.jwt;
@@ -118,6 +121,8 @@ export class DatafilesActionComponent implements OnInit, OnChanges {
   perform_action() {
     const action_type = this.actionConfig.type || "form";
     switch (action_type) {
+      case "json-download":
+        return this.type_json_download();
       case "form":
       default:
         return this.type_form();
@@ -166,21 +171,81 @@ export class DatafilesActionComponent implements OnInit, OnChanges {
     return true;
   }
 
-  /*
-   * future development
-   *
-  type_fetch() {
-    const data = new URLSearchParams();
-    for (const pair of new FormData(formElement)) {
-      data.append(pair[0], pair[1]);
+  type_json_download() {
+    let payload = "";
+    if (this.actionConfig.payload) {
+      payload = this.actionConfig.payload
+        .replace(/{{ auth_token }}/, `Bearer ${this.authService.getToken().id}`)
+        .replace(/{{ jwt }}/, this.jwt)
+        .replace(/{{ datasetPid }}/, this.actionDataset.pid)
+        .replace(/{{ sourceFolder }}/, this.actionDataset.sourceFolder)
+        .replace(
+          /{{ filesPath }}/,
+          JSON.stringify(
+            this.files
+              .filter(
+                (item) =>
+                  this.actionConfig.files === "all" ||
+                  (this.actionConfig.files === "selected" && item.selected),
+              )
+              .map((item) => item.path),
+          ),
+        );
+    } else {
+      const data = {
+        auth_token: `Bearer ${this.authService.getToken().id}`,
+        jwt: this.jwt,
+        dataset: this.actionDataset.pid,
+        directory: this.actionDataset.sourceFolder,
+        files: this.files
+          .filter(
+            (item) =>
+              this.actionConfig.files === "all" ||
+              (this.actionConfig.files === "selected" && item.selected),
+          )
+          .map((item) => item.path),
+      };
+      payload = JSON.stringify(data);
     }
 
-    fetch(url, {
-      method: 'post',
-      body: data,
+    const filename = this.actionConfig.filename.replace(/{{ uuid }}/, v4());
+
+    fetch(this.actionConfig.url, {
+      method: this.actionConfig.method || "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: payload,
     })
-    .then(…);
-    }
+      .then((response) => {
+        if (response.ok) {
+          return response.blob();
+        } else {
+          // http error
+          return Promise.reject(
+            new Error(`HTTP Error code: ${response.status}`),
+          );
+        }
+      })
+      .then((blob) => URL.createObjectURL(blob))
+      .then((url) => {
+        const a = document.createElement("a");
+        a.href = url;
+        a.download = filename;
+        a.click();
+        URL.revokeObjectURL(url);
+      })
+      .catch((error) => {
+        console.log("Datafile action error : ", error);
+        this.snackBar.open(
+          "There has been an error performing the action",
+          "Close",
+          {
+            duration: 2000,
+          },
+        );
+      });
+
+    return true;
   }
-   */
 }