fix: WebSocket Connection Closed crashing from BrowserCriClient (#30174)

* catch Fetch.enable errors on extra target in browser CRI * changelog * changelog * changelog * Update packages/server/test/unit/browsers/browser-cri-client_spec.ts Co-authored-by: Bill Glesias <[email protected]> * use try/catch instead of .catch for wider unit test support --------- Co-authored-by: Bill Glesias <[email protected]>
cypress-io · Sep 3, 2024 · bbe5328 · bbe5328 · cypress-bot · Sep 3, 2024
1 parent 57d7b63
commit bbe5328
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 13.14.2
+
+_Released 9/10/2024 (PENDING)_
+
+**Bugfixes:**
+
+- Fixed an issue where Cypress could crash with a `WebSocket Connection Closed` error. Fixes [#30100](https://github.com/cypress-io/cypress/issues/30100).
+
 ## 13.14.1
 
 _Released 8/29/2024_

diff --git a/packages/server/lib/browsers/browser-cri-client.ts b/packages/server/lib/browsers/browser-cri-client.ts
@@ -403,7 +403,12 @@ export class BrowserCriClient {
 
     browserCriClient.addExtraTargetClient(targetInfo, extraTargetCriClient)
 
-    await extraTargetCriClient.send('Fetch.enable')
+    try {
+      await extraTargetCriClient.send('Fetch.enable')
+    } catch (err) {
+      // swallow this error so it doesn't crash Cypress
+      debug('Fetch.enable failed on extra target#%s: %s', targetId, err)
+    }
 
     // we mark extra targets with this header, so that the proxy can recognize
     // where they came from and run only the minimal middleware necessary

diff --git a/packages/server/test/unit/browsers/browser-cri-client_spec.ts b/packages/server/test/unit/browsers/browser-cri-client_spec.ts
@@ -278,6 +278,20 @@ describe('lib/browsers/browser-cri-client', function () {
       expect(options.browserClient.send).to.be.calledWith('Runtime.runIfWaitingForDebugger', undefined, 'session-id')
     })
 
+    it('does not throw if Fetch.enable on extra target throws', () => {
+      const extraTargetCriClient = {
+        send: sinon.stub().withArgs('Fetch.enable').rejects('Fetch.enable failed'),
+        on: sinon.stub(),
+      }
+
+      options.CriConstructor.resolves(extraTargetCriClient)
+
+      options.browserClient.send.withArgs('Fetch.enable').resolves()
+      options.browserClient.send.withArgs('Runtime.runIfWaitingForDebugger').resolves()
+
+      expect(BrowserCriClient._onAttachToTarget(options as any)).to.be.fulfilled
+    })
+
     it('adds the service worker fetch event binding', async () => {
       options.event.targetInfo.type = 'service_worker'