[eslint] Prefer sinon.assert.calledWith() and friends.

This extends the `sinon.assert` ESLint rule to also check for the
following helpers:

- `sinon.assert.alwaysCalledWith(spy, x, y)`
- `sinon.assert.alwaysCalledWithExactly(spy, x, y)`
- `sinon.assert.alwaysCalledWithMatch(spy, match)`
- `sinon.assert.calledWith(spy, x, y)`
- `sinon.assert.calledWithExactly(spy, x, y)`
- `sinon.assert.calledOnceWithExactly(spy, x, y)`
- `sinon.assert.neverCalledWith(spy, x, y)`
- `sinon.assert.calledOn(spy, obj)'
- `sinon.assert.alwaysCalledOn(spy, obj)`
- `sinon.assert.neverCalledWith(spy, x, y)`
- `sinon.assert.calledWithMatch(spy, match)`
- `sinon.assert.calledOnceWithMatch(spy, match)`

Using the `sinon.assert` APIs provides us with much more actionable and
human readable error messages.

Bug: 397260638
Change-Id: I1115c36f2840550ca6cfca78d0d9f3f4306ed3e1
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6448978
Commit-Queue: Nikolay Vitkov <[email protected]>
Commit-Queue: Benedikt Meurer <[email protected]>
Auto-Submit: Benedikt Meurer <[email protected]>
Reviewed-by: Nikolay Vitkov <[email protected]>

Author: bmeurer

front_end/core/sdk/CPUThrottlingManager.test.ts

@@ -33,7 +33,7 @@ describeWithMockConnection('CPUThrottlingManager', () => {
     manager.setHardwareConcurrency(5);
 
     sinon.assert.calledOnce(cdpStub);
-    assert.isTrue(cdpStub.calledWithExactly({hardwareConcurrency: 5}));
+    sinon.assert.calledWithExactly(cdpStub, {hardwareConcurrency: 5});
   });
 
   it('does not set concurrency to 0 or negative numbers', async () => {

front_end/core/sdk/ConsoleModel.test.ts

@@ -161,7 +161,7 @@ describeWithMockConnection('ConsoleMessage', () => {
     runtimeModel.dispatchEventToListeners(
         SDK.RuntimeModel.Events.ConsoleAPICalled, {...consoleAPICall, timestamp: 123457.000});
     sinon.assert.calledTwice(addMessage);
-    assert.isTrue(addMessage.secondCall.calledWith(sinon.match({messageText: 'log me'})));
+    sinon.assert.calledWith(addMessage.secondCall, sinon.match({messageText: 'log me'}));
   });
 
   it('clears when main frame global object cleared', async () => {

front_end/core/sdk/CookieParser.test.ts

@@ -101,7 +101,7 @@ describe('CookieParser', () => {
               size: 83,
             },
           ]);
-      assert.isTrue(stub.calledOnceWithExactly('Failed getting cookie attribute: Discard'));
+      sinon.assert.calledOnceWithExactly(stub, 'Failed getting cookie attribute: Discard');
     });
 
     it('handles multiple cookies with an invalid attribute', () => {
@@ -121,7 +121,7 @@ describe('CookieParser', () => {
               size: 83,
             },
           ]);
-      assert.isTrue(stub.calledOnceWithExactly('Failed getting cookie attribute: Discard'));
+      sinon.assert.calledOnceWithExactly(stub, 'Failed getting cookie attribute: Discard');
     });
 
     describe('handles the SameSite attribute', () => {

front_end/core/sdk/EmulationModel.test.ts

@@ -22,7 +22,7 @@ describeWithMockConnection('EmulationModel', () => {
 
     sinon.assert.calledOnce(spySetTouchEmulationEnabled);
     sinon.assert.calledOnce(spySetEmitTouchEventsForMouse);
-    assert.isTrue(spySetTouchEmulationEnabled.calledWith({enabled: true, maxTouchPoints: 1}));
+    sinon.assert.calledWith(spySetTouchEmulationEnabled, {enabled: true, maxTouchPoints: 1});
   });
 
   it('should `emulateTouch` not enable touch emulation when `setTouchEmulationAllowed` is called with false',

front_end/core/sdk/NetworkManager.test.ts

@@ -819,7 +819,7 @@ describeWithMockConnection('InterceptedRequest', () => {
     sinon.assert.notCalled(fulfillRequestSpy);
     await multitargetNetworkManager.requestIntercepted(interceptedRequest);
     await fulfilledRequest;
-    assert.isTrue(fulfillRequestSpy.calledOnceWithExactly(expectedOverriddenResponse));
+    sinon.assert.calledOnceWithExactly(fulfillRequestSpy, expectedOverriddenResponse);
     assert.deepEqual(networkRequest.setCookieHeaders, expectedSetCookieHeaders);
     fulfillRequestSpy.resetHistory();
   }

front_end/core/sdk/OverlayPersistentHighlighter.test.ts

@@ -222,11 +222,11 @@ describeWithEnvironment('OverlayPersistentHighlighter', () => {
 
        await highlighter.restoreHighlightsForDocument();
 
-       assert(stubbedCallbacks.onGridOverlayStateChanged.calledWith(
-           {nodeId: PATH_TO_NODE_ID_FOR_TEST[paths[0]], enabled: true}));
+       sinon.assert.calledWith(
+           stubbedCallbacks.onGridOverlayStateChanged, {nodeId: PATH_TO_NODE_ID_FOR_TEST[paths[0]], enabled: true});
        assert(highlighter.isGridHighlighted(PATH_TO_NODE_ID_FOR_TEST[paths[0]]));
-       assert(stubbedCallbacks.onFlexOverlayStateChanged.calledWith(
-           {nodeId: PATH_TO_NODE_ID_FOR_TEST[paths[1]], enabled: true}));
+       sinon.assert.calledWith(
+           stubbedCallbacks.onFlexOverlayStateChanged, {nodeId: PATH_TO_NODE_ID_FOR_TEST[paths[1]], enabled: true});
        assert(highlighter.isFlexHighlighted(PATH_TO_NODE_ID_FOR_TEST[paths[1]]));
      });
 });

front_end/core/sdk/ServiceWorkerCacheModel.test.ts

@@ -74,7 +74,7 @@ describeWithMockConnection('ServiceWorkerCacheModel', () => {
       cacheStorageModel.enable();
       manager?.storageBucketCreatedOrUpdated({bucketInfo: testStorageBucketInfo});
 
-      assert.isTrue(trackCacheSpy.calledOnceWithExactly({storageKey: testKey}));
+      sinon.assert.calledOnceWithExactly(trackCacheSpy, {storageKey: testKey});
     });
   });
 
@@ -85,7 +85,7 @@ describeWithMockConnection('ServiceWorkerCacheModel', () => {
     manager?.storageBucketCreatedOrUpdated({bucketInfo: testStorageBucketInfo});
     manager?.storageBucketDeleted({bucketId: testStorageBucketInfo.id});
 
-    assert.isTrue(untrackCacheSpy.calledOnceWithExactly({storageKey: testKey}));
+    sinon.assert.calledOnceWithExactly(untrackCacheSpy, {storageKey: testKey});
   });
 
   it('detaches storage key event listeners on dispose', () => {
@@ -118,7 +118,7 @@ describeWithMockConnection('ServiceWorkerCacheModel', () => {
 
     void cacheStorageModel.refreshCacheNames();
 
-    assert.isTrue(requestCacheNamesSpy.calledWithExactly({storageBucket: testStorageBucket}));
+    sinon.assert.calledWithExactly(requestCacheNamesSpy, {storageBucket: testStorageBucket});
     await cacheAddedPromise;
   });
 
@@ -129,9 +129,10 @@ describeWithMockConnection('ServiceWorkerCacheModel', () => {
     cacheStorageModel.cacheStorageContentUpdated(
         {origin: '', storageKey: testKey, bucketId: testStorageBucketInfo.id, cacheName: 'test-cache'});
 
-    assert.isTrue(dispatcherSpy.calledOnceWithExactly(
+    sinon.assert.calledOnceWithExactly(
+        dispatcherSpy,
         SDK.ServiceWorkerCacheModel.Events.CACHE_STORAGE_CONTENT_UPDATED as unknown as sinon.SinonMatcher,
-        {storageBucket: testStorageBucket, cacheName: 'test-cache'}));
+        {storageBucket: testStorageBucket, cacheName: 'test-cache'});
   });
 
   it('requests cache names on cacheStorageListUpdated', async () => {
@@ -141,7 +142,7 @@ describeWithMockConnection('ServiceWorkerCacheModel', () => {
 
     cacheStorageModel.cacheStorageListUpdated({origin: '', storageKey: testKey, bucketId: testStorageBucketInfo.id});
 
-    assert.isTrue(requestCacheNamesSpy.calledWithExactly({storageBucket: testStorageBucket}));
+    sinon.assert.calledWithExactly(requestCacheNamesSpy, {storageBucket: testStorageBucket});
   });
 
   it('gets caches added for storage key', async () => {
@@ -194,6 +195,6 @@ describeWithMockConnection('ServiceWorkerCacheModel', () => {
     manager?.storageBucketCreatedOrUpdated({bucketInfo: testStorageBucketInfo});
     cacheStorageModel.enable();
 
-    assert.isTrue(trackCacheSpy.calledOnceWithExactly({storageKey: testKey}));
+    sinon.assert.calledOnceWithExactly(trackCacheSpy, {storageKey: testKey});
   });
 });

front_end/core/sdk/SourceMapManager.test.ts

@@ -134,11 +134,11 @@ describe('SourceMapManager', () => {
       sinon.stub(SDK.PageResourceLoader.PageResourceLoader.instance(), 'loadResource').resolves({content});
       sourceMapManager.attachSourceMap(client, sourceURL, sourceMappingURL);
       assert.strictEqual(sourceMapWillAttach.callCount, 1, 'SourceMapWillAttach events');
-      assert.isTrue(sourceMapWillAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapWillAttach, sinon.match.hasNested('data.client', client));
       const sourceMap = await sourceMapManager.sourceMapForClientPromise(client);
       assert.strictEqual(sourceMapAttached.callCount, 1, 'SourceMapAttached events');
-      assert.isTrue(sourceMapAttached.calledWith(sinon.match.hasNested('data.client', client)));
-      assert.isTrue(sourceMapAttached.calledWith(sinon.match.hasNested('data.sourceMap', sourceMap)));
+      sinon.assert.calledWith(sourceMapAttached, sinon.match.hasNested('data.client', client));
+      sinon.assert.calledWith(sourceMapAttached, sinon.match.hasNested('data.sourceMap', sourceMap));
       assert.isTrue(sourceMapAttached.calledAfter(sourceMapWillAttach));
     });
 
@@ -153,10 +153,10 @@ describe('SourceMapManager', () => {
       sinon.stub(SDK.PageResourceLoader.PageResourceLoader.instance(), 'loadResource').rejects('Error');
       sourceMapManager.attachSourceMap(client, sourceURL, sourceMappingURL);
       assert.strictEqual(sourceMapWillAttach.callCount, 1, 'SourceMapWillAttach events');
-      assert.isTrue(sourceMapWillAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapWillAttach, sinon.match.hasNested('data.client', client));
       await sourceMapManager.sourceMapForClientPromise(client);
       assert.strictEqual(sourceMapFailedToAttach.callCount, 1, 'SourceMapFailedToAttach events');
-      assert.isTrue(sourceMapFailedToAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapFailedToAttach, sinon.match.hasNested('data.client', client));
       assert.isTrue(sourceMapFailedToAttach.calledAfter(sourceMapWillAttach));
     });
 
@@ -171,11 +171,11 @@ describe('SourceMapManager', () => {
       sinon.stub(SDK.PageResourceLoader.PageResourceLoader.instance(), 'loadResource').resolves({content});
       sourceMapManager.attachSourceMap(client, sourceURL, sourceMappingURL);
       sourceMapManager.detachSourceMap(client);
-      assert.isTrue(sourceMapFailedToAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapFailedToAttach, sinon.match.hasNested('data.client', client));
       sourceMapManager.attachSourceMap(client, sourceURL, sourceMappingURL);
       await sourceMapManager.sourceMapForClientPromise(client);
       assert.strictEqual(sourceMapAttached.callCount, 1, 'SourceMapAttached events');
-      assert.isTrue(sourceMapAttached.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapAttached, sinon.match.hasNested('data.client', client));
       assert.isTrue(sourceMapAttached.calledAfter(sourceMapFailedToAttach));
     });
 
@@ -223,7 +223,7 @@ describe('SourceMapManager', () => {
       assert.strictEqual(loadResource.callCount, 0, 'loadResource calls');
       await sourceMapManager.sourceMapForClientPromise(client);
       assert.strictEqual(sourceMapFailedToAttach.callCount, 1, 'SourceMapFailedToAttach events');
-      assert.isTrue(sourceMapFailedToAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapFailedToAttach, sinon.match.hasNested('data.client', client));
     });
   });
 
@@ -246,8 +246,8 @@ describe('SourceMapManager', () => {
       const sourceMap = await sourceMapManager.sourceMapForClientPromise(client);
       sourceMapManager.detachSourceMap(client);
       assert.strictEqual(sourceMapDetached.callCount, 1, 'SourceMapDetached events');
-      assert.isTrue(sourceMapDetached.calledWith(sinon.match.hasNested('data.client', client)));
-      assert.isTrue(sourceMapDetached.calledWith(sinon.match.hasNested('data.sourceMap', sourceMap)));
+      sinon.assert.calledWith(sourceMapDetached, sinon.match.hasNested('data.client', client));
+      sinon.assert.calledWith(sourceMapDetached, sinon.match.hasNested('data.sourceMap', sourceMap));
     });
 
     it('triggers the correct lifecycle events when disabled', async () => {
@@ -281,7 +281,7 @@ describe('SourceMapManager', () => {
       sourceMapManager.setEnabled(false);
 
       assert.strictEqual(sourceMapFailedToAttach.callCount, 1, 'SourceMapFailedToAttach events');
-      assert.isTrue(sourceMapFailedToAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapFailedToAttach, sinon.match.hasNested('data.client', client));
     });
 
     it('triggers the correct lifecycle events when disabling once attached', async () => {
@@ -297,8 +297,8 @@ describe('SourceMapManager', () => {
       sourceMapManager.setEnabled(false);
 
       assert.strictEqual(sourceMapDetached.callCount, 1, 'SourceMapDetached events');
-      assert.isTrue(sourceMapDetached.calledWith(sinon.match.hasNested('data.client', client)));
-      assert.isTrue(sourceMapDetached.calledWith(sinon.match.hasNested('data.sourceMap', sourceMap)));
+      sinon.assert.calledWith(sourceMapDetached, sinon.match.hasNested('data.client', client));
+      sinon.assert.calledWith(sourceMapDetached, sinon.match.hasNested('data.sourceMap', sourceMap));
     });
 
     it('triggers the correct lifecycle events when re-enabling', async () => {
@@ -324,11 +324,11 @@ describe('SourceMapManager', () => {
       assert.strictEqual(sourceMapDetached.callCount, 0, 'SourceMapDetached events');
       assert.strictEqual(sourceMapFailedToAttach.callCount, 0, 'SourceMapFailedToAttach events');
       assert.strictEqual(sourceMapWillAttach.callCount, 1, 'SourceMapWillAttach events');
-      assert.isTrue(sourceMapWillAttach.calledWith(sinon.match.hasNested('data.client', client)));
+      sinon.assert.calledWith(sourceMapWillAttach, sinon.match.hasNested('data.client', client));
       assert.isTrue(sourceMapAttached.calledAfter(sourceMapWillAttach));
       assert.strictEqual(sourceMapAttached.callCount, 1, 'SourceMapAttached events');
-      assert.isTrue(sourceMapAttached.calledWith(sinon.match.hasNested('data.client', client)));
-      assert.isTrue(sourceMapAttached.calledWith(sinon.match.hasNested('data.sourceMap', sourceMap)));
+      sinon.assert.calledWith(sourceMapAttached, sinon.match.hasNested('data.client', client));
+      sinon.assert.calledWith(sourceMapAttached, sinon.match.hasNested('data.sourceMap', sourceMap));
     });
   });
 });

front_end/core/sdk/StorageBucketsModel.test.ts

@@ -146,7 +146,7 @@ describeWithMockConnection('StorageBucketsModel', () => {
 
       sinon.assert.notCalled(setStorageBucketTrackingSpy);
       storageKeyManager.updateStorageKeys(new Set([storageKey]));
-      assert.isTrue(setStorageBucketTrackingSpy.calledOnceWithExactly({storageKey, enable: true}));
+      sinon.assert.calledOnceWithExactly(setStorageBucketTrackingSpy, {storageKey, enable: true});
     });
 
     it('adds buckets for storage keys that already have been added', async () => {
@@ -179,7 +179,7 @@ describeWithMockConnection('StorageBucketsModel', () => {
       storageKeyManager.updateStorageKeys(new Set([storageKey]));
       storageKeyManager.updateStorageKeys(new Set([]));
       sinon.assert.callCount(setStorageBucketTrackingSpy, 2);
-      assert.isTrue(setStorageBucketTrackingSpy.secondCall.calledWithExactly({storageKey, enable: false}));
+      sinon.assert.calledWithExactly(setStorageBucketTrackingSpy.secondCall, {storageKey, enable: false});
     });
 
     it('removes all buckets for removed storage key', async () => {
@@ -378,6 +378,6 @@ describeWithMockConnection('StorageBucketsModel', () => {
         });
 
     storageBucketsModel.deleteBucket(bucket);
-    assert.isTrue(setStorageBucketTrackingSpy.calledOnceWithExactly({bucket}));
+    sinon.assert.calledOnceWithExactly(setStorageBucketTrackingSpy, {bucket});
   });
 });

front_end/core/sdk/TargetManager.test.ts

@@ -35,7 +35,7 @@ describeWithMockConnection('TargetManager', () => {
     assert.isTrue(observer.targetAdded.calledOnceWith(target1));
     const target2 = createTarget();
     sinon.assert.calledTwice(observer.targetAdded);
-    assert.isTrue(observer.targetAdded.calledWith(target2));
+    sinon.assert.calledWith(observer.targetAdded, target2);
     target2.dispose('YOLO!');
     assert.isTrue(observer.targetRemoved.calledOnceWith(target2));
 
@@ -51,7 +51,7 @@ describeWithMockConnection('TargetManager', () => {
     assert.isTrue(observer.modelAdded.calledOnceWith(resourceTreeModel(target1)));
     const target2 = createTarget();
     sinon.assert.calledTwice(observer.modelAdded);
-    assert.isTrue(observer.modelAdded.calledWith(resourceTreeModel(target2)));
+    sinon.assert.calledWith(observer.modelAdded, resourceTreeModel(target2));
     target2.dispose('YOLO!');
     assert.isTrue(observer.modelRemoved.calledOnceWith(resourceTreeModel(target2)));
 
@@ -70,12 +70,12 @@ describeWithMockConnection('TargetManager', () => {
 
     resourceTreeModel(target1).dispatchEventToListeners(WillReloadPage);
     sinon.assert.calledOnce(listener);
-    assert.isTrue(listener.calledOn(thisObject));
+    sinon.assert.calledOn(listener, thisObject);
 
     const target2 = createTarget();
     resourceTreeModel(target2).dispatchEventToListeners(WillReloadPage);
     sinon.assert.calledTwice(listener);
-    assert.isTrue(listener.calledOn(thisObject));
+    sinon.assert.calledOn(listener, thisObject);
 
     targetManager.removeModelListener(SDK.ResourceTreeModel.ResourceTreeModel, WillReloadPage, listener, thisObject);
     resourceTreeModel(target1).dispatchEventToListeners(WillReloadPage);
@@ -96,7 +96,7 @@ describeWithMockConnection('TargetManager', () => {
 
     const subtarget1 = createTarget({parentTarget: target1});
     sinon.assert.calledTwice(observer.targetAdded);
-    assert.isTrue(observer.targetAdded.calledWith(subtarget1));
+    sinon.assert.calledWith(observer.targetAdded, subtarget1);
   });
 
   it('allows observing models in scope', () => {
@@ -113,7 +113,7 @@ describeWithMockConnection('TargetManager', () => {
 
     const subtarget1 = createTarget({parentTarget: target1});
     sinon.assert.calledTwice(observer.modelAdded);
-    assert.isTrue(observer.modelAdded.calledWith(resourceTreeModel(subtarget1)));
+    sinon.assert.calledWith(observer.modelAdded, resourceTreeModel(subtarget1));
   });
 
   it('calls second observers even if the first is changing the scope', () => {
@@ -144,7 +144,7 @@ describeWithMockConnection('TargetManager', () => {
 
     resourceTreeModel(target1).dispatchEventToListeners(WillReloadPage);
     sinon.assert.calledOnce(listener);
-    assert.isTrue(listener.calledOn(thisObject));
+    sinon.assert.calledOn(listener, thisObject);
 
     const target2 = createTarget();
     resourceTreeModel(target2).dispatchEventToListeners(WillReloadPage);