feat: mergepatch to support partial update of nested objects

src/common/utils.ts

@@ -231,6 +231,14 @@ export const IsRecord = (x: unknown): x is Record<string, unknown> => {
   // checks if value is (nested) object
   return x !== null && typeof x === "object" && !Array.isArray(x);
 };
+
+export const IsValueUnitObject = (
+  x: unknown,
+): x is { value?: unknown; unit?: unknown } => {
+  // checks if the argument is object and contains either property 'value' or 'unit'
+  return IsRecord(x) && ("value" in x || "unit" in x);
+};
+
 export const extractMetadataKeys = <T>(
   instances: T[],
   prop: keyof T,

src/datasets/datasets.v4.controller.ts

@@ -33,7 +33,7 @@
 import { Request } from "express";
 import { MongoError } from "mongodb";
 import * as jmp from "json-merge-patch";
-import { IsRecord } from "../common/utils";
+import { IsRecord, IsValueUnitObject } from "../common/utils";
 import { DatasetsService } from "./datasets.service";
 import { DatasetClass, DatasetDocument } from "./schemas/dataset.schema";
 import { PoliciesGuard } from "src/casl/guards/policies.guard";
@@ -237,14 +237,10 @@
     return filter;
   }
 
-  isValueUnitObject(obj: unknown): obj is { value?: unknown; unit?: unknown } {
-    // checks if the argument is object and contains either property 'value' or 'unit'
-    return IsRecord(obj) && ("value" in obj || "unit" in obj);
-  }
 
   findInvalidValueUnitUpdates(
     updateDto: Record<string, unknown>,
     dataset: Record<string, unknown>,
     path: string[] = [],
   ): string[] {
     // collect properties that have both 'value' and 'unit' in original dataset but one of either is missing in the updateDto body
@@ -253,12 +249,12 @@
     for (const key in updateDto) {
       const value = updateDto[key];
       const currentPath = [...path, key];
-      if (this.isValueUnitObject(value)) {
+      if (IsValueUnitObject(value)) {
         const datasetAtKey = currentPath.reduce<unknown>(
           (obj, k) => (IsRecord(obj) ? obj[k] : undefined),
           dataset,
         );
-        if (this.isValueUnitObject(datasetAtKey)) {
+        if (IsValueUnitObject(datasetAtKey)) {
           // check if current object's 'value' or 'unit' are not undefined in original dataset and passed updateDto
           const originalHasValue = datasetAtKey.value !== undefined;
           const originalHasUnit = datasetAtKey.unit !== undefined;

test/config/.env.override

@@ -0,0 +1,2 @@
+MONGODB_URI=mongodb://mongodb:27017/scicat-test-db
+ES_HOST=http://elastic:9200