@contrail/util 1.1.13 → 1.1.14-alpha-1

package/lib/object-util/cloneDeep/cloneDeep.d.ts

@@ -1 +1,23 @@
-export declare function cloneDeep<T>(obj: T): T | null;
+type PerformanceComparisonEvent = {
+    durationMsJson: number;
+    durationMsRFDC: number;
+    input: any;
+};
+type PerformanceSummary = {
+    eventForWhichJsonWasMostFaster: PerformanceComparisonEvent | null;
+    eventForWhichRFDCWasMostFaster: PerformanceComparisonEvent | null;
+    totalDurationMsJson: number;
+    totalDurationMsRFDC: number;
+    invocationsInWhichJsonWasFaster: PerformanceComparisonEvent[];
+    invocationsInWhichRFDCWasFaster: PerformanceComparisonEvent[];
+};
+declare global {
+    interface Window {
+        performanceSummary: PerformanceSummary;
+        performanceEvents: PerformanceComparisonEvent[];
+    }
+}
+export declare function cloneDeep<T>(obj: T, options?: {
+    shouldPreserveCircularReferences?: boolean;
+}): T;
+export {};

package/lib/object-util/cloneDeep/cloneDeep.js

@@ -1,15 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cloneDeep = cloneDeep;
-function cloneDeep(obj) {
-    if (obj === null || obj === undefined)
-        return null;
-    return JSON.parse(JSON.stringify(obj), (_key, value) => {
-        if (typeof value === 'string' && /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/.test(value)) {
-            const date = new Date(value);
-            if (!isNaN(date.getTime()))
-                return date;
+const cloneDefault = require('rfdc')();
+const cloneWithCircles = require('rfdc')({ circles: true });
+function cloneDeep(obj, options) {
+    var _a;
+    console.log('running cloneDeep');
+    const shouldPreserveCircles = (_a = options === null || options === void 0 ? void 0 : options.shouldPreserveCircularReferences) !== null && _a !== void 0 ? _a : false;
+    const clone = shouldPreserveCircles ? cloneWithCircles : cloneDefault;
+    const startJson = performance.now();
+    JSON.parse(JSON.stringify(obj));
+    const durationMsJson = performance.now() - startJson;
+    const startRFDC = performance.now();
+    const rfdcClone = clone(obj);
+    const durationMsRFDC = performance.now() - startRFDC;
+    if (!window.performanceEvents) {
+        window.performanceEvents = [];
+    }
+    const performanceEvent = {
+        durationMsJson,
+        durationMsRFDC,
+        input: obj,
+    };
+    window.performanceEvents.push(performanceEvent);
+    window.performanceSummary = window.performanceSummary || {
+        eventForWhichJsonWasMostFaster: null,
+        eventForWhichRFDCWasMostFaster: null,
+        totalDurationMsJson: 0,
+        totalDurationMsRFDC: 0,
+        invocationsInWhichJsonWasFaster: [],
+        invocationsInWhichRFDCWasFaster: [],
+    };
+    window.performanceSummary.totalDurationMsJson += durationMsJson;
+    window.performanceSummary.totalDurationMsRFDC += durationMsRFDC;
+    const isJsonFaster = durationMsJson < durationMsRFDC;
+    if (isJsonFaster) {
+        window.performanceSummary.invocationsInWhichJsonWasFaster.push(performanceEvent);
+        if (!window.performanceSummary.eventForWhichJsonWasMostFaster ||
+            durationMsJson < window.performanceSummary.eventForWhichJsonWasMostFaster.durationMsJson) {
+            window.performanceSummary.eventForWhichJsonWasMostFaster = performanceEvent;
         }
-        return value;
-    });
+    }
+    else {
+        window.performanceSummary.invocationsInWhichRFDCWasFaster.push(performanceEvent);
+        if (!window.performanceSummary.eventForWhichRFDCWasMostFaster ||
+            durationMsRFDC < window.performanceSummary.eventForWhichRFDCWasMostFaster.durationMsRFDC) {
+            window.performanceSummary.eventForWhichRFDCWasMostFaster = performanceEvent;
+        }
+    }
+    console.log('cloneDeep performance summary:', window.performanceSummary);
+    return rfdcClone;
 }

package/lib/object-util/cloneDeep/performanceTest.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/object-util/cloneDeep/performanceTest.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const cloneDeep_1 = require("./cloneDeep");
+function jsonClone(obj) {
+    return JSON.parse(JSON.stringify(obj));
+}
+console.log('Performance test for very large objects:');
+let veryLargeObject = {};
+for (let i = 0; i < 100000; i++) {
+    veryLargeObject[`key${i}`] = {
+        sub1: {
+            val: i,
+        },
+        sub2: new Date('2023-10-01T12:00:00.000Z'),
+        sub3: {
+            val: i + 1,
+            valX: i + 2,
+        },
+    };
+}
+console.time('cloneDeep');
+(0, cloneDeep_1.cloneDeep)(veryLargeObject);
+console.timeEnd('cloneDeep');
+console.time('cloneDeepLodash');
+(0, lodash_1.cloneDeep)(veryLargeObject);
+console.timeEnd('cloneDeepLodash');
+console.time('cloneDeepJson');
+jsonClone(veryLargeObject);
+console.timeEnd('cloneDeepJson');
+console.time('structuredClone');
+structuredClone(veryLargeObject);
+console.timeEnd('structuredClone');
+console.log('\n\nPerformance test for very large arrays:');
+let veryLargeArray = [];
+for (let i = 0; i < 100000; i++) {
+    veryLargeArray.push({
+        sub1: {
+            val: i,
+        },
+        sub2: new Date('2023-10-01T12:00:00.000Z'),
+        sub3: {
+            val: i + 1,
+            valX: i + 2,
+        },
+    });
+}
+console.time('cloneDeepArray');
+(0, cloneDeep_1.cloneDeep)(veryLargeArray);
+console.timeEnd('cloneDeepArray');
+console.time('cloneDeepArrayLodash');
+(0, lodash_1.cloneDeep)(veryLargeArray);
+console.timeEnd('cloneDeepArrayLodash');
+console.time('cloneDeepArrayJson');
+jsonClone(veryLargeArray);
+console.timeEnd('cloneDeepArrayJson');
+console.time('structuredCloneArray');
+structuredClone(veryLargeArray);
+console.timeEnd('structuredCloneArray');
+console.log('\n\nPerformance test for assortment.json:');
+const fs = require("fs");
+const path = require("path");
+const assortmentFilePath = path.join(__dirname, 'assortment.json');
+const assortmentData = JSON.parse(fs.readFileSync(assortmentFilePath, 'utf8'));
+console.time('cloneDeepAssortment25k');
+(0, cloneDeep_1.cloneDeep)(assortmentData);
+console.timeEnd('cloneDeepAssortment25k');
+console.time('cloneDeepAssortment25kLodash');
+(0, lodash_1.cloneDeep)(assortmentData);
+console.timeEnd('cloneDeepAssortment25kLodash');
+console.time('cloneDeepAssortment25kJson');
+jsonClone(assortmentData);
+console.timeEnd('cloneDeepAssortment25kJson');
+console.time('structuredCloneAssortment25k');
+structuredClone(assortmentData);
+console.timeEnd('structuredCloneAssortment25k');

package/lib/object-util/retainOnlyProperties/retainOnlyProperties.d.ts

@@ -1,6 +1,8 @@
 export declare function retainOnlyProperties<T extends Record<string, any>, K extends readonly string[]>(obj: T[], keysToKeep: K, options?: {
-    shouldDeleteInPlace: boolean;
+    shouldDeleteInPlace?: boolean;
+    skipKeys?: readonly string[];
 }): Array<Pick<T, K[number]>>;
 export declare function retainOnlyProperties<T extends Record<string, any>, K extends readonly string[]>(obj: T, keysToKeep: K, options?: {
-    shouldDeleteInPlace: boolean;
+    shouldDeleteInPlace?: boolean;
+    skipKeys?: readonly string[];
 }): Pick<T, K[number]>;

package/lib/object-util/retainOnlyProperties/retainOnlyProperties.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.retainOnlyProperties = retainOnlyProperties;
 const object_util_1 = require("../object-util");
-function retainOnlyProperties(obj, keysToKeep, options = { shouldDeleteInPlace: false }) {
+function retainOnlyProperties(obj, keysToKeep, options = {}) {
     const keepSet = new Set(keysToKeep);
+    const skipSet = new Set(options.skipKeys || []);
     const shouldReturnAsIs = (value) => value === null || value === undefined || typeof value !== 'object' || value instanceof Date;
     const retain = (target) => {
         if (shouldReturnAsIs(target))
@@ -12,6 +13,9 @@ function retainOnlyProperties(obj, keysToKeep, options = { shouldDeleteInPlace:
             return target.map(retain);
         }
         for (const key in target) {
+            if (skipSet.has(key)) {
+                continue;
+            }
             if (!keepSet.has(key)) {
                 delete target[key];
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/util",
-  "version": "1.1.13",
+  "version": "1.1.14-alpha-1",
   "description": "General javascript utilities",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -41,6 +41,7 @@
   "dependencies": {
     "@contrail/types": "^3.0.95",
     "fflate": "^0.8.2",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "rfdc": "^1.4.1"
   }
 }