Issue 53137: Resolve storage details race condition (#1795)

Author: labkey-nicka

packages/components/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/components",
-  "version": "6.43.2",
+  "version": "6.43.3",
   "description": "Components, models, actions, and utility functions for LabKey applications and pages",
   "sideEffects": false,
   "files": [

packages/components/package.json

@@ -1,6 +1,10 @@
 # @labkey/components
 Components, models, actions, and utility functions for LabKey applications and pages
 
+### version 6.43.3
+*Released*: 26 May 2025
+- Migrate `isSetEqual` to `@labkey/components`. Extend with additional support for deep comparison.
+
 ### version 6.43.2
 *Released*: 23 May 2025
 - Add detailed auditing of domain changes & comment ability

packages/components/releaseNotes/components.md

@@ -65,6 +65,7 @@ import {
     isIntegerInRange,
     isNonNegativeFloat,
     isNonNegativeInteger,
+    isSetEqual,
     parseCsvString,
     parseScientificInt,
     quoteValueWithDelimiters,
@@ -1666,6 +1667,7 @@ export {
     isNonNegativeFloat,
     isNonNegativeInteger,
     isLoading,
+    isSetEqual,
     naturalSort,
     naturalSortByProperty,
     generateId,

packages/components/src/index.ts

@@ -19,6 +19,8 @@ import { QueryInfo } from '../../public/QueryInfo';
 import { ExtendedMap } from '../../public/ExtendedMap';
 import { QueryColumn } from '../../public/QueryColumn';
 
+import getDomainDetailsJSON from '../../test/data/dataclass-getDomainDetails.json';
+
 import {
     arrayEquals,
     camelCaseToTitleCase,
@@ -39,6 +41,7 @@ import {
     isNonNegativeFloat,
     isNonNegativeInteger,
     isQuotedWithDelimiters,
+    isSetEqual,
     makeCommaSeparatedString,
     parseCsvString,
     parseScientificInt,
@@ -1490,3 +1493,22 @@ describe('styleStringToObj', () => {
         });
     });
 });
+
+describe('isSetEqual', () => {
+    test('equivalency', () => {
+        expect(isSetEqual([], new Set())).toBe(true);
+        expect(isSetEqual([1], new Set([1, 1]))).toBe(true);
+        expect(isSetEqual([1], [1, 1])).toBe(true);
+        expect(isSetEqual([1, 3, 2], [2, 1, 1, 3, 2])).toBe(true);
+        expect(isSetEqual([{ x: 'a', y: 'b' }], [{ x: 'a', y: 'b' }])).toBe(true);
+        expect(isSetEqual([{ x: 'a', y: 'b' }], [{ y: 'b', x: 'a' }])).toBe(true);
+        expect(isSetEqual([undefined, null], [null, undefined])).toBe(true);
+
+        // Compare more complex objects to check for deep equivalency
+        expect(isSetEqual([{ x: 'a', y: 'b', z: { a: 'x', 1: -1 } }], [{ z: { 1: -1, a: 'x' }, y: 'b', x: 'a' }])).toBe(
+            true
+        );
+        expect(isSetEqual([getDomainDetailsJSON, 1], [getDomainDetailsJSON, 1, 1])).toBe(true);
+        expect(isSetEqual([getDomainDetailsJSON, 1], [getDomainDetailsJSON, 1, 2])).toBe(false);
+    });
+});

packages/components/src/internal/util/utils.test.ts

@@ -753,6 +753,43 @@ export function styleStringToObj(styleString: string): CSSProperties {
     }, {});
 }
 
+type Collection<C> = C[] | Set<C>;
+
+/**
+ * Replacer function for JSON.stringify() to support having object keys sorted in output. Supports deeply nested objects.
+ *
+ * https://stackoverflow.com/a/43636793
+ */
+const stringifyReplacer = (_, value): any => {
+    if (value instanceof Object && !(value instanceof Array) && Object.keys(value).length > 0) {
+        return Object.keys(value)
+            .sort()
+            .reduce((sorted, key) => {
+                sorted[key] = value[key];
+                return sorted;
+            }, {});
+    }
+
+    return value;
+};
+
+/**
+ * Serializes a Set/Array into a JSON string with sorted unique members.
+ * Useful for determining deep equivalency.
+ *
+ * https://stackoverflow.com/a/43858768
+ */
+const toJsonSet = (s): string => JSON.stringify([...new Set(s)].sort(), stringifyReplacer);
+
+/**
+ * Compare any combination of two Set(s)/Array(s) to determine if they're equivalent.
+ * NOTE: This does not do deeply nested equivalency in all cases. Specifically, when objects are
+ * compared the order of their properties is determined by the symbol/type of the property.
+ */
+export function isSetEqual<T = any>(a: Collection<T>, b: Collection<T>): boolean {
+    return toJsonSet(a) === toJsonSet(b);
+}
+
 /**
  * When this package is exported this environment variable reference is inline rewritten as
  * `const IS_NODE_TEST_ENV = "production" === 'test';`