[patch] handle circular references in checkCustomDeepQuality

electrovir · Oct 10, 2024 · 37da0e3 · 37da0e3
1 parent 4356f08
commit 37da0e3
Show file tree

Hide file tree

Showing 12 changed files with 115 additions and 59 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/mono-repo-root",
-    "version": "30.2.0",
+    "version": "30.3.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/assert/package.json b/packages/assert/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/assert",
-    "version": "30.2.0",
+    "version": "30.3.0",
     "description": "A collection of assertions for test and production code alike.",
     "keywords": [
         "augment",
@@ -41,7 +41,7 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/core": "^30.2.0",
+        "@augment-vir/core": "^30.3.0",
         "@date-vir/duration": "^6.0.1",
         "deep-eql": "^5.0.2",
         "expect-type": "^0.20.0",

diff --git a/packages/assert/src/augments/custom-equality.test.ts b/packages/assert/src/augments/custom-equality.test.ts
@@ -301,6 +301,30 @@ describe(checkCustomDeepQuality.name, () => {
         },
     ]);
 
+    it('handles equal circular references', () => {
+        const circular1 = {hi: 'bye', nested: {}};
+        circular1.nested = circular1;
+        const circular2 = {hi: 'bye', nested: {}};
+        circular2.nested = circular2;
+
+        assert.isTrue(checkCustomDeepQuality(circular1, circular2, check.strictEquals));
+    });
+    it('handles circular arrays', () => {
+        const circular1: any[] = [];
+        circular1.push(circular1);
+
+        assert.isTrue(checkCustomDeepQuality(circular1, circular1, check.strictEquals));
+    });
+
+    it('handles unequal circular references', () => {
+        const circular1 = {hi: 'bye', nested: {}};
+        circular1.nested = circular1;
+        const circular2 = {hi: 'different', nested: {}};
+        circular2.nested = circular2;
+
+        assert.isFalse(checkCustomDeepQuality(circular1, circular2, check.strictEquals));
+    });
+
     it('handles return types', async () => {
         const asyncResult = checkCustomDeepQuality('a', 'a', (a, b) =>
             Promise.resolve(check.strictEquals(a, b)),

diff --git a/packages/assert/src/augments/custom-equality.ts b/packages/assert/src/augments/custom-equality.ts
@@ -7,8 +7,9 @@ import {
 import {check} from './guards/check.js';
 
 /**
- * Runs a custom provided checker that is applied deeply to any given variables. Automatically
- * handles async custom checkers.
+ * Deeply checks inputs for equality with a custom checker callback. All objects are recursed into
+ * and the custom checker is only run on primitives. This function automatically handles async
+ * custom checkers and circular references.
  *
  * @category Assert
  */
@@ -18,8 +19,9 @@ export function checkCustomDeepQuality(
     customChecker: (a: unknown, b: unknown) => boolean,
 ): boolean;
 /**
- * Runs a custom provided checker that is applied deeply to any given variables. Automatically
- * handles async custom checkers.
+ * Deeply checks inputs for equality with a custom checker callback. All objects are recursed into
+ * and the custom checker is only run on primitives. This function automatically handles async
+ * custom checkers and circular references.
  *
  * @category Assert
  */
@@ -29,8 +31,9 @@ export function checkCustomDeepQuality(
     customChecker: (a: unknown, b: unknown) => Promise<boolean>,
 ): Promise<boolean>;
 /**
- * Runs a custom provided checker that is applied deeply to any given variables. Automatically
- * handles async custom checkers.
+ * Deeply checks inputs for equality with a custom checker callback. All objects are recursed into
+ * and the custom checker is only run on primitives. This function automatically handles async
+ * custom checkers and circular references.
  *
  * @category Assert
  */
@@ -40,25 +43,41 @@ export function checkCustomDeepQuality(
     customChecker: (a: unknown, b: unknown) => MaybePromise<boolean>,
 ): MaybePromise<boolean>;
 /**
- * Runs a custom provided checker that is applied deeply to any given variables. Automatically
- * handles async custom checkers.
+ * Deeply checks inputs for equality with a custom checker callback. All objects are recursed into
+ * and the custom checker is only run on primitives. This function automatically handles async
+ * custom checkers and circular references.
  *
  * @category Assert
  */
 export function checkCustomDeepQuality(
     a: unknown,
     b: unknown,
     customChecker: (a: unknown, b: unknown) => MaybePromise<boolean>,
+): MaybePromise<boolean> {
+    return recursiveCheckCustomDeepQuality(a, b, customChecker, new Set());
+}
+
+function recursiveCheckCustomDeepQuality(
+    a: unknown,
+    b: unknown,
+    customChecker: (a: unknown, b: unknown) => MaybePromise<boolean>,
+    checkedObjects: Set<AnyObject>,
 ): MaybePromise<boolean> {
     a = flattenComplexObject(a);
     b = flattenComplexObject(b);
 
     if (check.isObject(a) && check.isObject(b)) {
+        if (checkedObjects.has(a) || checkedObjects.has(b)) {
+            return true;
+        }
+        checkedObjects.add(a);
+        checkedObjects.add(b);
         if (
-            !checkCustomDeepQuality(
+            !recursiveCheckCustomDeepQuality(
                 getObjectTypedKeys(a).sort(),
                 getObjectTypedKeys(b).sort(),
                 customChecker,
+                checkedObjects,
             )
         ) {
             return false;
@@ -67,10 +86,11 @@ export function checkCustomDeepQuality(
         let receivedPromise = false as boolean;
 
         const results = getObjectTypedKeys(a).map((key) => {
-            const result = checkCustomDeepQuality(
+            const result = recursiveCheckCustomDeepQuality(
                 (a as AnyObject)[key],
                 (b as AnyObject)[key],
                 customChecker,
+                checkedObjects,
             );
             if (check.isPromise(result)) {
                 receivedPromise = true;
@@ -80,13 +100,23 @@ export function checkCustomDeepQuality(
 
         return handleMaybePromise(receivedPromise, results);
     } else if (check.isArray(a) && check.isArray(b)) {
+        if (checkedObjects.has(a) || checkedObjects.has(b)) {
+            return true;
+        }
+        checkedObjects.add(a);
+        checkedObjects.add(b);
         if (a.length !== b.length) {
             return false;
         }
 
         let receivedPromise = false as boolean;
         const results = a.map((entry, index) => {
-            const result = checkCustomDeepQuality(entry, b[index], customChecker);
+            const result = recursiveCheckCustomDeepQuality(
+                entry,
+                b[index],
+                customChecker,
+                checkedObjects,
+            );
             if (check.isPromise(result)) {
                 receivedPromise = true;
             }

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "30.2.0",
+    "version": "30.3.0",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -39,8 +39,8 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.2.0",
-        "@augment-vir/core": "^30.2.0",
+        "@augment-vir/assert": "^30.3.0",
+        "@augment-vir/core": "^30.3.0",
         "@date-vir/duration": "^6.0.1",
         "ansi-styles": "^6.2.1",
         "json5": "^2.2.3",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/core",
-    "version": "30.2.0",
+    "version": "30.3.0",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/node",
-    "version": "30.2.0",
+    "version": "30.3.0",
     "description": "A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.",
     "keywords": [
         "augment",
@@ -37,16 +37,16 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.2.0",
-        "@augment-vir/common": "^30.2.0",
+        "@augment-vir/assert": "^30.3.0",
+        "@augment-vir/common": "^30.3.0",
         "@date-vir/duration": "^6.0.1",
         "ansi-styles": "^6.2.1",
         "terminate": "^2.8.0",
         "type-fest": "^4.26.1",
         "typed-event-target": "^3.4.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^30.2.0",
+        "@augment-vir/test": "^30.3.0",
         "@prisma/client": "^5.20.0",
         "@types/node": "^22.7.4",
         "@web/dev-server-esbuild": "^1.0.2",

diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/scripts",
-    "version": "30.2.0",
+    "version": "30.3.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {
@@ -24,14 +24,14 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.2.0",
-        "@augment-vir/core": "^30.2.0",
+        "@augment-vir/assert": "^30.3.0",
+        "@augment-vir/core": "^30.3.0",
         "@virmator/docs": "^13.4.1",
         "jsdom": "^25.0.1",
         "typedoc": "^0.26.7"
     },
     "devDependencies": {
-        "@augment-vir/test": "^30.2.0",
+        "@augment-vir/test": "^30.3.0",
         "@types/jsdom": "^21.1.7",
         "@types/node": "^22.7.4"
     },