fix: attempt reconnection if CDP websocket in closed/closing state (#…

…7981)
cypress-io · Jul 16, 2020 · aae5187 · aae5187 · cypress-bot · Jul 16, 2020
1 parent 582fb15
commit aae5187
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 6 deletions.
diff --git a/packages/server/lib/browsers/cri-client.ts b/packages/server/lib/browsers/cri-client.ts
@@ -11,7 +11,7 @@ const debugVerboseSend = debugModule('cypress-verbose:server:browsers:cri-client
 // debug using cypress-verbose:server:browsers:cri-client:recv:*
 const debugVerboseReceive = debugModule('cypress-verbose:server:browsers:cri-client:recv:[<--]')
 
-const WEBSOCKET_NOT_OPEN_RE = /^WebSocket is not open/
+const WEBSOCKET_NOT_OPEN_RE = /^WebSocket is (?:not open|already in CLOSING or CLOSED state)/
 
 /**
  * Url returned by the Chrome Remote Interface

diff --git a/packages/server/test/unit/browsers/cri-client_spec.ts b/packages/server/test/unit/browsers/cri-client_spec.ts
@@ -13,10 +13,7 @@ describe('lib/browsers/cri-client', function () {
   let send: sinon.SinonStub
   let criImport: sinon.SinonStub
   let onError: sinon.SinonStub
-
-  function getClient () {
-    return criClient.create(DEBUGGER_URL, onError)
-  }
+  let getClient: () => ReturnType<typeof create>
 
   beforeEach(function () {
     sinon.stub(Bluebird, 'promisify').returnsArg(0)
@@ -29,11 +26,17 @@ describe('lib/browsers/cri-client', function () {
       target: DEBUGGER_URL,
       local: true,
     })
-    .resolves({ send, _notifier: new EventEmitter() })
+    .resolves({
+      send,
+      close: sinon.stub(),
+      _notifier: new EventEmitter(),
+    })
 
     criClient = proxyquire('../lib/browsers/cri-client', {
       'chrome-remote-interface': criImport,
     })
+
+    getClient = () => criClient.create(DEBUGGER_URL, onError)
   })
 
   context('.create', function () {
@@ -51,6 +54,37 @@ describe('lib/browsers/cri-client', function () {
         client.send('Browser.getVersion', { baz: 'quux' })
         expect(send).to.be.calledWith('Browser.getVersion', { baz: 'quux' })
       })
+
+      it('rejects if cri.send rejects', async function () {
+        const err = new Error
+
+        send.rejects(err)
+        const client = await getClient()
+
+        await expect(client.send('Browser.getVersion', { baz: 'quux' }))
+        .to.be.rejectedWith(err)
+      })
+
+      context('retries', () => {
+        ([
+          'WebSocket is not open',
+          // @see https://github.com/cypress-io/cypress/issues/7180
+          'WebSocket is already in CLOSING or CLOSED state',
+        ]).forEach((msg) => {
+          it(`with '${msg}'`, async function () {
+            const err = new Error(msg)
+
+            send.onFirstCall().rejects(err)
+            send.onSecondCall().resolves()
+
+            const client = await getClient()
+
+            await client.send('Browser.getVersion', { baz: 'quux' })
+
+            expect(send).to.be.calledTwice
+          })
+        })
+      })
     })
 
     context('#ensureMinimumProtocolVersion', function () {