fix(server): increase timeout when making Marionette connection (#7372)

flotwig · web-flow · commit 5a4e339789e0 · 2020-05-15T17:30:29.000-04:00
diff --git a/packages/server/__snapshots__/5_cdp_spec.ts.js b/packages/server/__snapshots__/5_cdp_spec.ts.js
@@ -1,49 +1,3 @@
-exports['e2e cdp / fails when remote debugging port cannot be connected to'] = `
-
-====================================================================================================
-
-  (Run Starting)
-
-  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
-  │ Cypress:    1.2.3                                                                              │
-  │ Browser:    FooBrowser 88                                                                      │
-  │ Specs:      1 found (spec.ts)                                                                  │
-  │ Searched:   cypress/integration/spec.ts                                                        │
-  └────────────────────────────────────────────────────────────────────────────────────────────────┘
-
-
-────────────────────────────────────────────────────────────────────────────────────────────────────
-                                                                                                    
-  Running:  spec.ts                                                                         (1 of 1)
-Failed to connect to Chrome, retrying in 1 second (attempt 18/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 19/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 20/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 21/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 22/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 23/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 24/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 25/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 26/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 27/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 28/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 29/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 30/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 31/32)
-Failed to connect to Chrome, retrying in 1 second (attempt 32/32)
-Cypress failed to make a connection to the Chrome DevTools Protocol after retrying for 20 seconds.
-
-This usually indicates there was a problem opening the Chrome browser.
-
-The CDP port requested was 7777.
-
-Error details:
-
-Error: connect ECONNREFUSED 127.0.0.1:7777
-      [stack trace lines]
-
-
-`
-
 exports['e2e cdp / handles disconnections as expected'] = `
 
 ====================================================================================================
diff --git a/packages/server/__snapshots__/protocol_spec.ts.js b/packages/server/__snapshots__/protocol_spec.ts.js
@@ -1,4 +1,4 @@
-exports['lib/browsers/protocol ._getDelayMsForRetry retries as expected for up to 20 seconds 1'] = [
+exports['lib/browsers/protocol ._getDelayMsForRetry retries as expected for up to 50 seconds 1'] = [
   100,
   100,
   100,
@@ -31,5 +31,35 @@ exports['lib/browsers/protocol ._getDelayMsForRetry retries as expected for up t
   1000,
   1000,
   1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
+  1000,
   1000
 ]
diff --git a/packages/server/lib/browsers/chrome.ts b/packages/server/lib/browsers/chrome.ts
@@ -10,7 +10,7 @@ import appData from '../util/app_data'
 import fs from '../util/fs'
 import { CdpAutomation } from './cdp_automation'
 import * as CriClient from './cri-client'
-import protocol from './protocol'
+import * as protocol from './protocol'
 import utils from './utils'
 import { Browser } from './types'
 
diff --git a/packages/server/lib/browsers/firefox-util.ts b/packages/server/lib/browsers/firefox-util.ts
@@ -5,7 +5,7 @@ import Marionette from 'marionette-client'
 import { Command } from 'marionette-client/lib/marionette/message.js'
 import util from 'util'
 import Foxdriver from '@benmalka/foxdriver'
-import protocol from './protocol'
+import * as protocol from './protocol'
 
 const errors = require('../errors')
 
@@ -23,6 +23,22 @@ const getTabId = (tab) => {
   return _.get(tab, 'browsingContextID')
 }
 
+const getDelayMsForRetry = (i) => {
+  if (i < 10) {
+    return 100
+  }
+
+  if (i < 18) {
+    return 500
+  }
+
+  if (i < 63) {
+    return 1000
+  }
+
+  return
+}
+
 const getPrimaryTab = Bluebird.method((browser) => {
   const setPrimaryTab = () => {
     return browser.listTabs()
@@ -154,21 +170,7 @@ export default {
     await protocol._connectAsync({
       host: '127.0.0.1',
       port,
-      getDelayMsForRetry: (i) => {
-        if (i < 10) {
-          return 100
-        }
-
-        if (i < 18) {
-          return 500
-        }
-
-        if (i < 33) {
-          return 1000
-        }
-
-        return
-      },
+      getDelayMsForRetry,
     })
 
     const foxdriver = await Foxdriver.attach('127.0.0.1', port)
@@ -220,7 +222,16 @@ export default {
   },
 
   async setupMarionette (extensions, url, port) {
-    const driver = new Marionette.Drivers.Promises({ port })
+    await protocol._connectAsync({
+      host: '127.0.0.1',
+      port,
+      getDelayMsForRetry,
+    })
+
+    const driver = new Marionette.Drivers.Promises({
+      port,
+      tries: 1, // marionette-client has its own retry logic which we want to avoid
+    })
 
     const sendMarionette = (data) => {
       return driver.send(new Command(data))
diff --git a/packages/server/lib/browsers/firefox.ts b/packages/server/lib/browsers/firefox.ts
@@ -8,7 +8,9 @@ import urlUtil from 'url'
 import FirefoxProfile from 'firefox-profile'
 import firefoxUtil from './firefox-util'
 import utils from './utils'
+import * as launcherDebug from '@packages/launcher/lib/log'
 import { Browser } from './types'
+const errors = require('../errors')
 
 const debug = Debug('cypress:server:browsers:firefox')
 
@@ -281,6 +283,8 @@ const defaultPreferences = {
   // allow getUserMedia APIs on insecure domains
   'media.devices.insecure.enabled':	true,
   'media.getusermedia.insecure.enabled': true,
+
+  'marionette.log.level': launcherDebug.log.enabled ? 'Debug' : undefined,
 }
 
 export async function open (browser: Browser, url, options: any = {}) {
@@ -411,6 +415,9 @@ export async function open (browser: Browser, url, options: any = {}) {
   const browserInstance = await utils.launch(browser, 'about:blank', launchOptions.args)
 
   await firefoxUtil.setup({ extensions: launchOptions.extensions, url, foxdriverPort, marionettePort })
+  .catch((err) => {
+    errors.throw('FIREFOX_COULD_NOT_CONNECT', err)
+  })
 
   return browserInstance
 }
diff --git a/packages/server/lib/browsers/protocol.ts b/packages/server/lib/browsers/protocol.ts
@@ -1,13 +1,16 @@
-const _ = require('lodash')
-const CRI = require('chrome-remote-interface')
-const { connect } = require('@packages/network')
+import _ from 'lodash'
+import CRI from 'chrome-remote-interface'
+import { connect } from '@packages/network'
+import Bluebird from 'bluebird'
+import la from 'lazy-ass'
+import Debug from 'debug'
+import { Socket } from 'net'
 const errors = require('../errors')
-const Promise = require('bluebird')
-const la = require('lazy-ass')
 const is = require('check-more-types')
-const debug = require('debug')('cypress:server:protocol')
 
-function _getDelayMsForRetry (i) {
+const debug = Debug('cypress:server:browsers:protocol')
+
+export function _getDelayMsForRetry (i) {
   if (i < 10) {
     return 100
   }
@@ -16,20 +19,22 @@ function _getDelayMsForRetry (i) {
     return 500
   }
 
-  if (i < 33) { // after 5 seconds, begin logging and retrying
+  if (i < 63) { // after 5 seconds, begin logging and retrying
     errors.warning('CDP_RETRYING_CONNECTION', i)
 
     return 1000
   }
+
+  return
 }
 
-function _connectAsync (opts) {
-  return Promise.fromCallback((cb) => {
+export function _connectAsync (opts) {
+  return Bluebird.fromCallback((cb) => {
     connect.createRetryingSocket(opts, cb)
   })
   .then((sock) => {
     // can be closed, just needed to test the connection
-    sock.end()
+    (sock as Socket).end()
   })
 }
 
@@ -72,7 +77,7 @@ const findStartPageTarget = (connectOpts) => {
  * Waits for the port to respond with connection to Chrome Remote Interface
  * @param {number} port Port number to connect to
  */
-const getWsTargetFor = (port) => {
+export const getWsTargetFor = (port) => {
   debug('Getting WS connection to CRI on port %d', port)
   la(is.port(port), 'expected port number', port)
 
@@ -106,7 +111,7 @@ const getWsTargetFor = (port) => {
           throw err
         }
 
-        return Promise.delay(delay)
+        return Bluebird.delay(delay)
         .then(retry)
       })
     }
@@ -118,9 +123,3 @@ const getWsTargetFor = (port) => {
     errors.throw('CDP_COULD_NOT_CONNECT', port, err)
   })
 }
-
-module.exports = {
-  _connectAsync,
-  _getDelayMsForRetry,
-  getWsTargetFor,
-}
diff --git a/packages/server/lib/errors.coffee b/packages/server/lib/errors.coffee
@@ -884,7 +884,7 @@ getMsgByType = (type, arg1 = {}, arg2, arg3) ->
       """
     when "CDP_COULD_NOT_CONNECT"
       """
-      Cypress failed to make a connection to the Chrome DevTools Protocol after retrying for 20 seconds.
+      Cypress failed to make a connection to the Chrome DevTools Protocol after retrying for 50 seconds.
 
       This usually indicates there was a problem opening the Chrome browser.
 
@@ -894,6 +894,16 @@ getMsgByType = (type, arg1 = {}, arg2, arg3) ->
 
       #{arg2.stack}
       """
+    when "FIREFOX_COULD_NOT_CONNECT"
+      """
+      Cypress failed to make a connection to Firefox.
+
+      This usually indicates there was a problem opening the Firefox browser.
+
+      Error details:
+
+      #{arg1.stack}
+      """
     when "CDP_COULD_NOT_RECONNECT"
       """
       There was an error reconnecting to the Chrome DevTools protocol. Please restart the browser.
@@ -902,7 +912,7 @@ getMsgByType = (type, arg1 = {}, arg2, arg3) ->
       """
     when "CDP_RETRYING_CONNECTION"
       """
-      Failed to connect to Chrome, retrying in 1 second (attempt #{chalk.yellow(arg1)}/32)
+      Failed to connect to Chrome, retrying in 1 second (attempt #{chalk.yellow(arg1)}/62)
       """
     when "DEPRECATED_BEFORE_BROWSER_LAUNCH_ARGS"
       """
diff --git a/packages/server/test/e2e/5_cdp_spec.ts b/packages/server/test/e2e/5_cdp_spec.ts
@@ -17,12 +17,12 @@ describe('e2e cdp', function () {
     restoreEnv()
   })
 
-  e2e.it('fails when remote debugging port cannot be connected to', {
+  // NOTE: this test takes almost a minute and is largely redundant with protocol_spec
+  e2e.it.skip('fails when remote debugging port cannot be connected to', {
     project: Fixtures.projectPath('remote-debugging-port-removed'),
     spec: 'spec.ts',
     browser: 'chrome',
     expectedExitCode: 1,
-    snapshot: true,
   })
 
   // https://github.com/cypress-io/cypress/issues/5685
diff --git a/packages/server/test/unit/browsers/firefox_spec.ts b/packages/server/test/unit/browsers/firefox_spec.ts
diff --git a/packages/server/test/unit/browsers/protocol_spec.ts b/packages/server/test/unit/browsers/protocol_spec.ts

-Original file line number
+Diff line change
@@ @@ -1,4 +1,4 @@ @@
 -exports['lib/browsers/protocol ._getDelayMsForRetry retries as expected for up to 20 seconds 1'] = [
 +exports['lib/browsers/protocol ._getDelayMsForRetry retries as expected for up to 50 seconds 1'] = [
 ,
 ,
 ,
 ,
 ,
 ,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
 +  1000,
+]