chore(deps): replace deprecated lodash.isequal (#1911)

* chore(deps): replace deprecated lodash.isequal

* chore: replace isDeepStrictEqual with deep-eql

* test: add basic tests for compareObject

Author: eglitise

package-lock.json

@@ -61,14 +61,13 @@
   },
   "dependencies": {
     "@vitest/snapshot": "^3.2.4",
+    "deep-eql": "^5.0.2",
     "expect": "^30.0.0",
-    "jest-matcher-utils": "^30.0.0",
-    "lodash.isequal": "^4.5.0"
+    "jest-matcher-utils": "^30.0.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
     "@types/jest": "^30.0.0",
-    "@types/lodash.isequal": "^4.5.8",
     "@types/node": "^24.0.3",
     "@vitest/coverage-v8": "^3.2.4",
     "@wdio/eslint": "^0.1.1",

package.json

@@ -1,4 +1,4 @@
-import isEqual from 'lodash.isequal'
+import deepEql from 'deep-eql'
 import type { ParsedCSSValue } from 'webdriverio'
 
 import { expect } from 'expect'
@@ -305,7 +305,7 @@ export const compareObject = (actual: object | number, expected: string | number
 
     return {
         value: actual,
-        result: isEqual(actual, expected),
+        result: deepEql(actual, expected),
     }
 }
 

src/utils.ts

@@ -1,5 +1,5 @@
 import { describe, test, expect } from 'vitest'
-import { compareNumbers, compareText, compareTextWithArray } from '../src/utils.js'
+import { compareNumbers, compareObject, compareText, compareTextWithArray } from '../src/utils.js'
 
 describe('utils', () => {
     describe('compareText', () => {
@@ -135,4 +135,27 @@ describe('utils', () => {
             expect(compareNumbers(actual, { lte, gte })).toBe(false)
         })
     })
+
+    describe('compareObject', () => {
+        test('should pass if the objects are equal', () => {
+            expect(compareObject({ 'foo': 'bar' }, { 'foo': 'bar' }).result).toBe(true)
+        })
+
+        test('should pass if the objects are deep equal', () => {
+            expect(compareObject({ 'foo': { 'bar': 'baz' } }, { 'foo': { 'bar': 'baz' } }).result).toBe(true)
+        })
+
+        test('should fail if the objects are not equal', () => {
+            expect(compareObject({ 'foo': 'bar' }, { 'baz': 'quux' }).result).toBe(false)
+        })
+
+        test('should fail if the objects are only shallow equal', () => {
+            expect(compareObject({ 'foo': { 'bar': 'baz' } }, { 'foo': { 'baz': 'quux' } }).result).toBe(false)
+        })
+
+        test('should fail if the actual value is a number or array', () => {
+            expect(compareObject(10, { 'foo': 'bar' }).result).toBe(false)
+            expect(compareObject([{ 'foo': 'bar' }], { 'foo': 'bar' }).result).toBe(false)
+        })
+    })
 })