add history plugin for runtime service and reuse computeDeltaWithOriginals for sync change logging

Author: Junjiequan

src/casl/casl-ability.factory.ts

@@ -29,6 +29,7 @@ import { UserIdentity } from "src/users/schemas/user-identity.schema";
 import { UserSettings } from "src/users/schemas/user-settings.schema";
 import { User } from "src/users/schemas/user.schema";
 import { Action } from "./action.enum";
+import { RuntimeConfig } from "src/runtime-config/schemas/runtime-config.schema";
 
 type Subjects =
   | string
@@ -49,6 +50,7 @@ type Subjects =
       | typeof UserSettings
       | typeof ElasticSearchActions
       | typeof Datablock
+      | typeof RuntimeConfig
     >
   | "all";
 type PossibleAbilities = [Action, Subjects];
@@ -84,6 +86,7 @@ export class CaslAbilityFactory {
     attachments: this.attachmentEndpointAccess,
     history: this.historyEndpointAccess,
     datablocks: this.datablockEndpointAccess,
+    runtimeconfig: this.runtimeConfigEndpointAccess,
   };
 
   endpointAccess(endpoint: string, user: JWTUser) {
@@ -908,6 +911,26 @@ export class CaslAbilityFactory {
         item.constructor as ExtractSubjectType<Subjects>,
     });
   }
+  runtimeConfigEndpointAccess(user: JWTUser) {
+    const { can, build } = new AbilityBuilder(
+      createMongoAbility<PossibleAbilities, Conditions>,
+    );
+
+    can(Action.Read, RuntimeConfig);
+    if (
+      user &&
+      user.currentGroups.some((g) => this.accessGroups?.admin.includes(g))
+    ) {
+      /*
+        / user that belongs to any of the group listed in ADMIN_GROUPS
+        */
+      can(Action.Update, RuntimeConfig);
+    }
+    return build({
+      detectSubjectType: (item) =>
+        item.constructor as ExtractSubjectType<Subjects>,
+    });
+  }
 
   policyEndpointAccess(user: JWTUser) {
     const { can, build } = new AbilityBuilder(

src/config/configuration.ts

@@ -193,6 +193,12 @@ const configuration = () => {
   );
 
   const config = {
+    configSyncToDb: {
+      enabled: boolean(process.env.CONFIG_SYNC_TO_DB_ENABLED || false),
+      configList: process.env.CONFIG_SYNC_TO_DB_LIST
+        ? process.env.CONFIG_SYNC_TO_DB_LIST.split(",").map((v) => v.trim())
+        : ["frontendConfig", "frontendTheme"],
+    },
     maxFileUploadSizeInMb: process.env.MAX_FILE_UPLOAD_SIZE || "16mb", // 16MB by default
     versions: {
       api: "3",

src/config/frontend.config.json

@@ -1,16 +1,4 @@
 {
-  "defaultMainPage": {
-    "nonAuthenticatedUser": "DATASETS",
-    "authenticatedUser": "PROPOSALS"
-  },
-  "checkBoxFilterClickTrigger": false,
-  "accessTokenPrefix": "Bearer ",
-  "addDatasetEnabled": true,
-  "archiveWorkflowEnabled": false,
-  "datasetReduceEnabled": true,
-  "datasetJsonScientificMetadata": true,
-  "editDatasetEnabled": true,
-  "editDatasetSampleEnabled": true,
   "editMetadataEnabled": true,
   "addSampleEnabled": false,
   "externalAuthEndpoint": "/api/v3/auth/msad",
@@ -244,7 +232,8 @@
         "description": "Filter by creation time of the dataset",
         "enabled": true
       }
-    ]
+    ],
+    "conditions": []
   },
   "defaultProposalsListSettings": {
     "columns": [
@@ -344,13 +333,9 @@
   },
   "dateFormat": "yyyy-MM-dd HH:mm",
   "datasetDetailComponent": {
-    "enableCustomizedComponent": false,
+    "enableCustomizedComponent": true,
     "customization": [
       {
-        "type": "regular",
-        "label": "General Information",
-        "order": 0,
-        "row": 1,
         "col": 8,
         "fields": [
           {
@@ -362,129 +347,6 @@
             "element": "copy",
             "source": "scientificMetadata.run_number.value",
             "order": 1
-          },
-          {
-            "element": "text",
-            "source": "creationTime",
-            "order": 2
-          },
-          {
-            "element": "text",
-            "source": "type",
-            "order": 3
-          },
-          {
-            "element": "text",
-            "source": "datasetName",
-            "order": 4
-          },
-          {
-            "element": "tag",
-            "source": "keywords",
-            "order": 5
-          }
-        ]
-      },
-      {
-        "type": "attachments",
-        "label": "Gallery",
-        "order": 1,
-        "col": 2,
-        "row": 2,
-        "options": {
-          "limit": 5,
-          "size": "medium"
-        }
-      },
-      {
-        "type": "regular",
-        "label": "Contact Information",
-        "order": 2,
-        "col": 2,
-        "row": 1,
-        "fields": [
-          {
-            "element": "text",
-            "source": "principalInvestigator",
-            "order": 0
-          },
-          {
-            "element": "linky",
-            "source": "contactEmail",
-            "order": 1
-          }
-        ]
-      },
-      {
-        "type": "regular",
-        "label": "Files Information",
-        "order": 3,
-        "col": 2,
-        "row": 1,
-        "fields": [
-          {
-            "element": "text",
-            "source": "scientificMetadata.runnumber",
-            "order": 0
-          },
-          {
-            "element": "text",
-            "source": "sourceFolderHost",
-            "order": 1
-          },
-          {
-            "element": "text",
-            "source": "numberOfFiles",
-            "order": 2
-          },
-          {
-            "element": "text",
-            "source": "size",
-            "order": 3
-          },
-          {
-            "element": "text",
-            "source": "numberOfFilesArchived",
-            "order": 4
-          },
-          {
-            "element": "text",
-            "source": "packedSize",
-            "order": 5
-          }
-        ]
-      },
-      {
-        "type": "regular",
-        "label": "Related Documents",
-        "order": 4,
-        "col": 4,
-        "row": 1,
-        "fields": [
-          {
-            "element": "internalLink",
-            "source": "proposalIds",
-            "order": 0
-          },
-          {
-            "element": "internalLink",
-            "source": "instrumentIds",
-            "order": 1
-          },
-          {
-            "element": "tag",
-            "source": "sampleIds",
-            "order": 2
-          },
-          {
-            "element": "tag",
-            "source": "inputDatasets",
-            "order": 3
-          },
-          {
-            "element": "internalLink",
-            "source": "creationLocation",
-            "order": 4
           }
         ]
       },
@@ -496,7 +358,7 @@
         "row": 1,
         "options": {
           "limit": 2,
-          "size": "small"
+          "size": "large"
         }
       },
       {
@@ -506,25 +368,6 @@
         "order": 6,
         "col": 9,
         "row": 1
-      },
-      {
-        "type": "scientificMetadata",
-        "label": "Scientific Metadata JSON",
-        "viewMode": "json",
-        "order": 6
-      },
-      {
-        "type": "scientificMetadata",
-        "label": "Scientific Metadata Tree",
-        "viewMode": "tree",
-        "order": 6
-      },
-      {
-        "type": "datasetJsonView",
-        "label": "Dataset JsonView",
-        "order": 7,
-        "col": 10,
-        "row": 2
       }
     ]
   },

src/runtime-config/runtime-config.controller.ts

@@ -1,31 +1,58 @@
-import { Body, Controller, Get, Param, Put, Req } from "@nestjs/common";
-import { ApiTags } from "@nestjs/swagger";
+import {
+  Body,
+  Controller,
+  Get,
+  Param,
+  Put,
+  Req,
+  UseGuards,
+} from "@nestjs/common";
+import { ApiBearerAuth, ApiBody, ApiTags } from "@nestjs/swagger";
 import { Request } from "express";
 import { AllowAny } from "src/auth/decorators/allow-any.decorator";
 import { JWTUser } from "src/auth/interfaces/jwt-user.interface";
 import { OutputRuntimeConfigDto } from "./dto/runtime-config.dto";
 import { RuntimeConfigService } from "./runtime-config.service";
-
+import { PoliciesGuard } from "src/casl/guards/policies.guard";
+import { Action } from "src/casl/action.enum";
+import { AppAbility } from "src/casl/casl-ability.factory";
+import { CheckPolicies } from "src/casl/decorators/check-policies.decorator";
+import { RuntimeConfig } from "./schemas/runtime-config.schema";
+@ApiBearerAuth()
 @ApiTags("runtime-config")
 @Controller("runtime-config")
 export class RuntimeConfigController {
   constructor(private readonly runtimeConfigService: RuntimeConfigService) {}
 
   @AllowAny()
-  @Get("data")
+  @Get("data/:id")
   async getConfig(
     @Param("id") id: string,
   ): Promise<OutputRuntimeConfigDto | null> {
-    return this.runtimeConfigService.getConfig(id);
+    const config = await this.runtimeConfigService.getConfig(id);
+
+    return config;
   }
 
-  @Put("data")
+  @UseGuards(PoliciesGuard)
+  @CheckPolicies("runtimeconfig", (ability: AppAbility) =>
+    ability.can(Action.Update, RuntimeConfig),
+  )
+  @Put("data/:id")
+  @ApiBody({
+    type: Object,
+    description: "Runtime config object",
+  })
   async updateConfig(
     @Req() request: Request,
     @Param("id") id: string,
     @Body() config: Record<string, unknown>,
-  ): Promise<void> {
+  ): Promise<OutputRuntimeConfigDto | null> {
     const user: JWTUser = request.user as JWTUser;
-    await this.runtimeConfigService.updateConfig(id, config, user.username);
+    return await this.runtimeConfigService.updateConfig(
+      id,
+      config,
+      user.username,
+    );
   }
 }

src/runtime-config/runtime-config.module.ts

@@ -6,13 +6,35 @@ import {
   RuntimeConfig,
   RuntimeConfigSchema,
 } from "./schemas/runtime-config.schema";
+import {
+  GenericHistory,
+  GenericHistorySchema,
+} from "src/common/schemas/generic-history.schema";
+import { ConfigModule, ConfigService } from "@nestjs/config";
+import { CaslModule } from "src/casl/casl.module";
+import { applyHistoryPluginOnce } from "src/common/mongoose/plugins/history.plugin.util";
 
 @Module({
   imports: [
+    CaslModule,
+    ConfigModule,
     MongooseModule.forFeature([
+      {
+        name: GenericHistory.name,
+        schema: GenericHistorySchema,
+      },
+    ]),
+    MongooseModule.forFeatureAsync([
       {
         name: RuntimeConfig.name,
-        schema: RuntimeConfigSchema,
+        imports: [ConfigModule],
+        inject: [ConfigService],
+        useFactory: (configService: ConfigService) => {
+          const schema = RuntimeConfigSchema;
+          applyHistoryPluginOnce(schema, configService);
+
+          return schema;
+        },
       },
     ]),
   ],