Consistently use assert.deepEqual instead of assert.deepStrictEqual.

Previously we have been a bit sloppy with sometimes using one or the
other. In Chai both methods perform exactly the same comparison, but
the name `deepStrictEqual` can be a bit confusing to developers not
familiar with the Chai implementation, and particularly might leave
you wondering what exactly is *strict* about this method.

Fixed: 386330115
Change-Id: Idda55ee784b01cce650996ab3d56f76e220e6b2c
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6110227
Commit-Queue: Samiya Caur <[email protected]>
Commit-Queue: Benedikt Meurer <[email protected]>
Auto-Submit: Benedikt Meurer <[email protected]>
Reviewed-by: Samiya Caur <[email protected]>

Author: bmeurer

.eslintrc.js

@@ -293,6 +293,7 @@ module.exports = {
 
       'rulesdir/check-test-definitions' : 'error',
       'rulesdir/no-assert-equal' : 'error',
+      'rulesdir/no-assert-deep-strict-equal' : 'error',
       'rulesdir/no-repeated-tests' : 'error',
       'rulesdir/compare-arrays-with-assert-deepequal' : 'error',
       'rulesdir/no-screenshot-test-outside-perf-panel' : 'error',

front_end/core/host/AidaClient.test.ts

@@ -12,7 +12,7 @@ describeWithEnvironment('AidaClient', () => {
   it('adds no model temperature if console insights is not enabled', () => {
     const stub = getGetHostConfigStub({});
     const request = Host.AidaClient.AidaClient.buildConsoleInsightsRequest('foo');
-    assert.deepStrictEqual(request, {
+    assert.deepEqual(request, {
       current_message: {parts: [{text: 'foo'}], role: Host.AidaClient.Role.USER},
       client: 'CHROME_DEVTOOLS',
       client_feature: 1,
@@ -29,7 +29,7 @@ describeWithEnvironment('AidaClient', () => {
       },
     });
     const request = Host.AidaClient.AidaClient.buildConsoleInsightsRequest('foo');
-    assert.deepStrictEqual(request, {
+    assert.deepEqual(request, {
       current_message: {parts: [{text: 'foo'}], role: Host.AidaClient.Role.USER},
       client: 'CHROME_DEVTOOLS',
       options: {
@@ -49,7 +49,7 @@ describeWithEnvironment('AidaClient', () => {
       },
     });
     const request = Host.AidaClient.AidaClient.buildConsoleInsightsRequest('foo');
-    assert.deepStrictEqual(request, {
+    assert.deepEqual(request, {
       current_message: {parts: [{text: 'foo'}], role: Host.AidaClient.Role.USER},
       client: 'CHROME_DEVTOOLS',
       options: {
@@ -69,7 +69,7 @@ describeWithEnvironment('AidaClient', () => {
       },
     });
     const request = Host.AidaClient.AidaClient.buildConsoleInsightsRequest('foo');
-    assert.deepStrictEqual(request, {
+    assert.deepEqual(request, {
       current_message: {parts: [{text: 'foo'}], role: Host.AidaClient.Role.USER},
       client: 'CHROME_DEVTOOLS',
       client_feature: 1,
@@ -87,7 +87,7 @@ describeWithEnvironment('AidaClient', () => {
       },
     });
     const request = Host.AidaClient.AidaClient.buildConsoleInsightsRequest('foo');
-    assert.deepStrictEqual(request, {
+    assert.deepEqual(request, {
       current_message: {parts: [{text: 'foo'}], role: Host.AidaClient.Role.USER},
       client: 'CHROME_DEVTOOLS',
       options: {
@@ -111,7 +111,7 @@ describeWithEnvironment('AidaClient', () => {
       },
     });
     const request = Host.AidaClient.AidaClient.buildConsoleInsightsRequest('foo');
-    assert.deepStrictEqual(request, {
+    assert.deepEqual(request, {
       current_message: {parts: [{text: 'foo'}], role: Host.AidaClient.Role.USER},
       client: 'CHROME_DEVTOOLS',
       metadata: {
@@ -153,7 +153,7 @@ describeWithEnvironment('AidaClient', () => {
 
     const provider = new Host.AidaClient.AidaClient();
     const results = await getAllResults(provider);
-    assert.deepStrictEqual(results, [
+    assert.deepEqual(results, [
       {
         explanation: 'hello ',
         metadata: {rpcGlobalId: 123},
@@ -191,7 +191,7 @@ describeWithEnvironment('AidaClient', () => {
 
     const provider = new Host.AidaClient.AidaClient();
     const results = await getAllResults(provider);
-    assert.deepStrictEqual(results, [
+    assert.deepEqual(results, [
       {
         explanation: 'hello world',
         metadata: {rpcGlobalId: 123},
@@ -233,7 +233,7 @@ describeWithEnvironment('AidaClient', () => {
 
     const provider = new Host.AidaClient.AidaClient();
     const results = await getAllResults(provider);
-    assert.deepStrictEqual(results, [
+    assert.deepEqual(results, [
       {
         explanation: 'Friends, Romans, countrymen, lend me your ears;\n' +
             'I come to bury Caesar, not to praise him.\n',
@@ -313,7 +313,7 @@ describeWithEnvironment('AidaClient', () => {
 
     const provider = new Host.AidaClient.AidaClient();
     const results = await getAllResults(provider);
-    assert.deepStrictEqual(results, [
+    assert.deepEqual(results, [
       {
         explanation: 'Chunk1\n' +
             'Chunk2\n',
@@ -391,7 +391,7 @@ describeWithEnvironment('AidaClient', () => {
 
     const provider = new Host.AidaClient.AidaClient();
     const results = (await getAllResults(provider)).map(r => r.explanation);
-    assert.deepStrictEqual(results, [
+    assert.deepEqual(results, [
       'hello ',
       'hello \n`````\nbrave \n`````\n',
       'hello \n`````\nbrave new World()\n`````\n',

front_end/core/platform/ArrayUtilities.test.ts

@@ -27,12 +27,11 @@ describe('ArrayUtilities', () => {
         const actualFirstOnlyTrue = [...testCase.input];
 
         Platform.ArrayUtilities.removeElement(actualFirstOnlyTrue, 2, true);
-        assert.deepStrictEqual(actualFirstOnlyTrue, testCase.expectedFirstOnlyTrue, 'Removing firstOnly (true) failed');
+        assert.deepEqual(actualFirstOnlyTrue, testCase.expectedFirstOnlyTrue, 'Removing firstOnly (true) failed');
 
         const actualFirstOnlyFalse = [...testCase.input];
         Platform.ArrayUtilities.removeElement(actualFirstOnlyFalse, 2, false);
-        assert.deepStrictEqual(
-            actualFirstOnlyFalse, testCase.expectedFirstOnlyFalse, 'Removing firstOnly (false) failed');
+        assert.deepEqual(actualFirstOnlyFalse, testCase.expectedFirstOnlyFalse, 'Removing firstOnly (false) failed');
       }
     });
   });
@@ -54,20 +53,20 @@ describe('ArrayUtilities', () => {
             for (let count = 1, k = right - first + 1; count <= k; ++count) {
               const actual = fixture.slice(0);
               Platform.ArrayUtilities.sortRange(actual, comparator, left, right, first, first + count - 1);
-              assert.deepStrictEqual(
+              assert.deepEqual(
                   fixture.slice(0, left), actual.slice(0, left), 'left ' + left + ' ' + right + ' ' + count);
-              assert.deepStrictEqual(
+              assert.deepEqual(
                   fixture.slice(right + 1), actual.slice(right + 1), 'right ' + left + ' ' + right + ' ' + count);
 
               const middle = fixture.slice(left, right + 1);
               middle.sort(comparator);
-              assert.deepStrictEqual(
+              assert.deepEqual(
                   middle.slice(first - left, first - left + count), actual.slice(first, first + count),
                   'sorted ' + left + ' ' + right + ' ' + first + ' ' + count);
 
               const actualRest = actual.slice(first + count, right + 1);
               actualRest.sort(comparator);
-              assert.deepStrictEqual(
+              assert.deepEqual(
                   middle.slice(first - left + count), actualRest,
                   'unsorted ' + left + ' ' + right + ' ' + first + ' ' + count);
             }
@@ -137,7 +136,7 @@ describe('ArrayUtilities', () => {
         }
 
         const shallowCopy = [...actual];
-        assert.deepStrictEqual(actual.sort(), shallowCopy, 'Result array is ordered');
+        assert.deepEqual(actual.sort(), shallowCopy, 'Result array is ordered');
       }
 
       const fixtures = new Map([

front_end/core/root/Runtime.test.ts

@@ -42,6 +42,6 @@ describe('Runtime', () => {
 
     const experiments = Root.Runtime.experiments.allConfigurableExperiments();
 
-    assert.deepStrictEqual(experiments.map(experiment => experiment.name), ['example', 'configurable']);
+    assert.deepEqual(experiments.map(experiment => experiment.name), ['example', 'configurable']);
   });
 });

front_end/core/sdk/AutofillModel.test.ts

@@ -79,6 +79,6 @@ describeWithMockConnection('AutofillModel', () => {
     };
     autofillModel!.addressFormFilled(addressFormFilledEvent);
     assert.lengthOf(dispatchedEvents, 1);
-    assert.deepStrictEqual(dispatchedEvents[0].event, addressFormFilledEvent);
+    assert.deepEqual(dispatchedEvents[0].event, addressFormFilledEvent);
   });
 });

front_end/core/sdk/CSSMatchedStyles.test.ts

@@ -398,13 +398,12 @@ describe('CSSMatchedStyles', () => {
          inheritedPayload,
        });
 
-       assert.deepStrictEqual(
-           matchedStyles.nodeStyles().map(style => style.allProperties().map(prop => prop.propertyText)), [
-             ['--var: red;'],
-             ['color: var(--var);'],
-             ['--var: blue;'],
-             ['--var: red;'],
-           ]);
+       assert.deepEqual(matchedStyles.nodeStyles().map(style => style.allProperties().map(prop => prop.propertyText)), [
+         ['--var: red;'],
+         ['color: var(--var);'],
+         ['--var: blue;'],
+         ['--var: red;'],
+       ]);
      });
 
   describe('resolveGlobalKeyword', () => {

front_end/core/sdk/CookieModel.test.ts

@@ -197,7 +197,7 @@ describeWithMockConnection('CookieModel', () => {
     cookieModel.addBlockedCookie(cookie, [blockedReason]);
     const cookieToBlockedReasons = cookieModel.getCookieToBlockedReasonsMap();
     assert.strictEqual(cookieToBlockedReasons.size, 1);
-    assert.deepStrictEqual(cookieToBlockedReasons.get(cookie), [blockedReason]);
+    assert.deepEqual(cookieToBlockedReasons.get(cookie), [blockedReason]);
 
     navigate(getMainFrame(target));
     assert.strictEqual(cookieModel.getCookieToBlockedReasonsMap().size, 0);

front_end/core/sdk/DebuggerModel.test.ts

@@ -327,7 +327,7 @@ describe('DebuggerModel', () => {
       }
 
       assert.lengthOf(consoleMessages, 1);
-      assert.deepStrictEqual(consoleMessages[0].text, expectedWarning);
+      assert.deepEqual(consoleMessages[0].text, expectedWarning);
     }
 
     it('prioritizes external DWARF over all types', () => {

front_end/core/sdk/FrameManager.test.ts

@@ -102,7 +102,7 @@ describe('FrameManager', () => {
     addMockFrame(mockModel, frameId);
 
     const frameIds = dispatchedEvents.map(event => event.data.frame.id);
-    assert.deepStrictEqual(frameIds, [frameId]);
+    assert.deepEqual(frameIds, [frameId]);
     const frameFromId = frameManager.getFrame(frameId);
     assert.strictEqual(frameFromId?.id, frameId);
   });

front_end/core/sdk/NetworkManager.test.ts

@@ -1103,6 +1103,6 @@ describeWithMockConnection('InterceptedRequest', () => {
       {name: 'set-cookie', value: 'override_duplicate'},
       {name: 'set-cookie', value: 'malformed_override'},
     ];
-    assert.deepStrictEqual(SDK.NetworkManager.InterceptedRequest.mergeSetCookieHeaders(original, overrides), expected);
+    assert.deepEqual(SDK.NetworkManager.InterceptedRequest.mergeSetCookieHeaders(original, overrides), expected);
   });
 });

front_end/core/sdk/NetworkRequest.test.ts

@@ -293,7 +293,7 @@ describeWithMockConnection('NetworkRequest', () => {
             'Setting this cookie was blocked either because of Chrome flags or browser configuration. Learn more in the Issues panel.',
       },
     ]));
-    assert.deepStrictEqual(await cookieModel.getCookiesForDomain(''), [cookie]);
+    assert.deepEqual(await cookieModel.getCookiesForDomain(''), [cookie]);
 
     request.addExtraResponseInfo({
       responseHeaders: [{name: 'Set-Cookie', value: 'name=value; Path=/'}],
@@ -358,8 +358,8 @@ describeWithMockConnection('ServerSentEvents', () => {
     });
 
     assert.lengthOf(networkEvents, 2);
-    assert.deepStrictEqual(networkEvents[0], {data: 'foo', eventId: 'fooId', eventName: 'fooName', time: 21});
-    assert.deepStrictEqual(networkEvents[1], {data: 'bar', eventId: 'barId', eventName: 'barName', time: 42});
+    assert.deepEqual(networkEvents[0], {data: 'foo', eventId: 'fooId', eventName: 'fooName', time: 21});
+    assert.deepEqual(networkEvents[1], {data: 'bar', eventId: 'barId', eventName: 'barName', time: 42});
   });
 
   it('sends EventSourceMessageAdded events for raw text/event-stream', async () => {

front_end/core/sdk/ResourceTreeModel.test.ts

@@ -116,7 +116,7 @@ describeWithMockConnection('ResourceTreeModel', () => {
     assert.isNotNull(resourceTreeModel.mainFrame);
     resourceTreeModel.reloadPage();
     assert.isTrue(reload.calledOnce);
-    assert.deepStrictEqual(
+    assert.deepEqual(
         reload.args[0], [{ignoreCache: undefined, loaderId: LOADER_ID, scriptToEvaluateOnLoad: undefined}]);
   });
 

front_end/core/sdk/ServiceWorkerManager.test.ts

@@ -42,9 +42,9 @@ describe('ServiceWorkerVersion', () => {
     assert.strictEqual(version.status, VERSION_PAYLOAD.status);
     assert.strictEqual(version.scriptLastModified, VERSION_PAYLOAD.scriptLastModified);
     assert.strictEqual(version.scriptResponseTime, VERSION_PAYLOAD.scriptResponseTime);
-    assert.deepStrictEqual(version.controlledClients, VERSION_PAYLOAD.controlledClients);
+    assert.deepEqual(version.controlledClients, VERSION_PAYLOAD.controlledClients);
     assert.strictEqual(version.targetId, VERSION_PAYLOAD.targetId);
-    assert.deepStrictEqual(version.routerRules, expectedRouterRules);
+    assert.deepEqual(version.routerRules, expectedRouterRules);
   });
 
   it('should update the version with the given payload', () => {
@@ -67,7 +67,7 @@ describe('ServiceWorkerVersion', () => {
     assert.strictEqual(version.status, 'installing');
     assert.strictEqual(version.scriptLastModified, 1234567891);
     assert.strictEqual(version.scriptResponseTime, 12346);
-    assert.deepStrictEqual(version.controlledClients, ['client3', 'client4']);
+    assert.deepEqual(version.controlledClients, ['client3', 'client4']);
     assert.strictEqual(version.targetId, 'target2');
   });
 

front_end/models/autofill_manager/AutofillManager.test.ts

@@ -41,7 +41,7 @@ describeWithMockConnection('AutofillManager', () => {
           SDK.AutofillModel.Events.ADDRESS_FORM_FILLED, {autofillModel: model, event: inEvent});
       await new Promise(resolve => setTimeout(resolve, 0));
       assert.isTrue(showViewStub.calledOnceWithExactly('autofill-view'));
-      assert.deepStrictEqual(dispatchedAutofillEvents, [outEvent]);
+      assert.deepEqual(dispatchedAutofillEvents, [outEvent]);
     };
 
     it('with a single match', async () => {

front_end/models/bindings/DebuggerLanguagePlugins.test.ts

@@ -103,7 +103,7 @@ describe('DebuggerLanguagePlugins', () => {
         const location = sinon.createStubInstance(SDK.DebuggerModel.Location);
         const result = await pluginManager.getFunctionInfo(script, location);
         Platform.assertNotNullOrUndefined(result);
-        assert.deepStrictEqual(result, {missingSymbolFiles: [MISSING_DEBUG_FILES]});
+        assert.deepEqual(result, {missingSymbolFiles: [MISSING_DEBUG_FILES]});
       });
 
       it('correctly returns frames if available', async () => {
@@ -116,7 +116,7 @@ describe('DebuggerLanguagePlugins', () => {
 
         const result = await pluginManager.getFunctionInfo(script, location);
         Platform.assertNotNullOrUndefined(result);
-        assert.deepStrictEqual(result, {frames: [{name: FUNCTION_NAME}]});
+        assert.deepEqual(result, {frames: [{name: FUNCTION_NAME}]});
       });
 
       it('correctly returns frames and missing debug info if both are available', async () => {
@@ -130,7 +130,7 @@ describe('DebuggerLanguagePlugins', () => {
 
         const result = await pluginManager.getFunctionInfo(script, location);
         Platform.assertNotNullOrUndefined(result);
-        assert.deepStrictEqual(result, {frames: [{name: FUNCTION_NAME}], missingSymbolFiles: [MISSING_DEBUG_FILES]});
+        assert.deepEqual(result, {frames: [{name: FUNCTION_NAME}], missingSymbolFiles: [MISSING_DEBUG_FILES]});
       });
     });
   });

front_end/models/breakpoints/BreakpointManager.test.ts

@@ -1636,7 +1636,7 @@ describeWithMockConnection('BreakpointManager', () => {
 
     // Expect that the breakpoint is only added to the network UI source code.
     assert.strictEqual(breakpoint, addedBreakpoint);
-    assert.deepStrictEqual(Array.from(breakpoint.getUiSourceCodes()), [uiSourceCode]);
+    assert.deepEqual(Array.from(breakpoint.getUiSourceCodes()), [uiSourceCode]);
   });
 
   it('updates a breakpoint after live editing the underlying script', async () => {