feat(4.5.2):enhance isDeepObjectMatch function for recursive object comparison; add comprehensive tests for deep object matching

Author: JJ-Cro

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "4.5.1",
+  "version": "4.5.2",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package.json

@@ -10,7 +10,7 @@ import {
 } from './WsStore.types';
 
 /**
- * Simple comparison of two objects, only checks 1-level deep (nested objects won't match)
+ * Simple comparison of two objects, recursive for nested objects
  */
 export function isDeepObjectMatch(object1: unknown, object2: unknown): boolean {
   if (typeof object1 === 'string' && typeof object2 === 'string') {
@@ -21,11 +21,35 @@ export function isDeepObjectMatch(object1: unknown, object2: unknown): boolean {
     return false;
   }
 
+  if (object1 === null || object2 === null) {
+    return object1 === object2;
+  }
+
+  const keys1 = Object.keys(object1).sort();
+  const keys2 = Object.keys(object2).sort();
+
+  if (keys1.length !== keys2.length) {
+    return false;
+  }
+
+  if (!keys1.every((val, i) => val === keys2[i])) {
+    return false;
+  }
+
   for (const key in object1) {
     const value1 = (object1 as any)[key];
     const value2 = (object2 as any)[key];
 
-    if (value1 !== value2) {
+    if (
+      typeof value1 === 'object' &&
+      typeof value2 === 'object' &&
+      value1 !== null &&
+      value2 !== null
+    ) {
+      if (!isDeepObjectMatch(value1, value2)) {
+        return false;
+      }
+    } else if (value1 !== value2) {
       return false;
     }
   }

src/util/websockets/WsStore.ts

@@ -0,0 +1,150 @@
+import { isDeepObjectMatch } from '../../src/util/websockets/WsStore';
+
+describe('WsStore', () => {
+  describe('isDeepObjectMatch()', () => {
+    it('should match two equal strings', () => {
+      expect(
+        isDeepObjectMatch('orderbook.50.BTCUSDT', 'orderbook.50.BTCUSDT'),
+      ).toBeTruthy();
+      expect(
+        isDeepObjectMatch('orderbook.50.BTCUSDT', 'orderbook.50.ETHUSDT'),
+      ).toBeFalsy();
+    });
+
+    it('should match simple topic objects', () => {
+      const topic1 = {
+        topic: 'orderbook.50.BTCUSDT',
+      };
+      const topic2 = {
+        topic: 'orderbook.50.BTCUSDT',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeTruthy();
+    });
+
+    it('should match topic objects with payload, even if keys are differently ordered', () => {
+      const topic1 = {
+        topic: 'orderbook.50.BTCUSDT',
+        payload: { symbol: 'BTCUSDT' },
+        category: 'linear',
+      };
+      const topic2 = {
+        category: 'linear',
+        payload: { symbol: 'BTCUSDT' },
+        topic: 'orderbook.50.BTCUSDT',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeTruthy();
+    });
+
+    it('should match nested payload objects', () => {
+      const topic1 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: {
+          symbol: 'BTCUSDT',
+          interval: '5',
+        },
+        category: 'spot',
+      };
+      const topic2 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: {
+          symbol: 'BTCUSDT',
+          interval: '5',
+        },
+        category: 'spot',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeTruthy();
+    });
+
+    it('should NOT match topics with different category', () => {
+      const topic1 = {
+        topic: 'orderbook.50.BTCUSDT',
+        category: 'linear',
+      };
+      const topic2 = {
+        topic: 'orderbook.50.BTCUSDT',
+        category: 'spot',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeFalsy();
+    });
+
+    it('should NOT match topics with different payload values', () => {
+      const topic1 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: { symbol: 'BTCUSDT' },
+        category: 'spot',
+      };
+      const topic2 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: { symbol: 'ETHUSDT' },
+        category: 'spot',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeFalsy();
+    });
+
+    it('should NOT match topics with nested payload differences', () => {
+      const topic1 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: {
+          symbol: 'BTCUSDT',
+          interval: '5',
+        },
+        category: 'spot',
+      };
+      const topic2 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: {
+          symbol: 'BTCUSDT',
+          interval: '15',
+        },
+        category: 'spot',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeFalsy();
+    });
+
+    it('should NOT match asymmetric objects (missing category property)', () => {
+      const topic1 = {
+        topic: 'orderbook.50.BTCUSDT',
+        category: 'linear',
+      };
+      const topic2 = {
+        topic: 'orderbook.50.BTCUSDT',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeFalsy();
+    });
+
+    it('should NOT match asymmetric objects (missing nested property)', () => {
+      const topic1 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: {
+          symbol: 'BTCUSDT',
+          interval: '5',
+        },
+        category: 'spot',
+      };
+      const topic2 = {
+        topic: 'kline.5.BTCUSDT',
+        payload: {
+          symbol: 'BTCUSDT',
+        },
+        category: 'spot',
+      };
+
+      expect(isDeepObjectMatch(topic1, topic2)).toBeFalsy();
+    });
+
+    it('should NOT match string to object', () => {
+      expect(
+        isDeepObjectMatch('orderbook.50.BTCUSDT', {
+          topic: 'orderbook.50.BTCUSDT',
+        }),
+      ).toBeFalsy();
+    });
+  });
+});