Feature/read timeout (webdriverio#4906)

* Revert "Remove `connectionRetryTimeout` option (webdriverio#4822)" This reverts commit 2df99a9. * Forward connectionRetryTimeout to 'request' lib * Validate timeout is set for retry * Apply suggestions from code review Co-Authored-By: Christian Bromann <github@christian-bromann.com> Co-authored-by: Ross Squires <ross.squires@gmail.com> Co-authored-by: Christian Bromann <github@christian-bromann.com>

Author: 3 people

docs/BrowserObject.md

@@ -72,6 +72,7 @@ console.log(browser.config)
  waitforInterval: 250,
  logLevel: 'debug',
  baseUrl: 'http://localhost',
+ connectionRetryTimeout: 90000,
  connectionRetryCount: 3,
  specs: [ 'err.js' ],
  fakeUser: 'maxmustermann', // <-- custom option

docs/Options.md

@@ -78,6 +78,12 @@ When running in standalone mode, the only log generated by WebdriverIO will be t
 Type: `String`<br>
 Default: `null`
 
+### `connectionRetryTimeout`
+Timeout for any WebDriver request to a driver or grid.
+
+Type: `Number`<br>
+Default: `90000`
+
 ### `connectionRetryCount`
 Maximum count of request retries to the Selenium server.
 

examples/pageobject/wdio.conf.js

@@ -44,6 +44,10 @@ exports.config = {
  // Default timeout for all waitForXXX commands.
  waitforTimeout: 150000,
  //
+ // Default timeout in milliseconds for request
+ // if browser driver or grid doesn't send response
+ connectionRetryTimeout: 90000,
+ //
  // Default request retries count
  connectionRetryCount: 3,
  //

packages/wdio-cli/src/templates/wdio.conf.tpl.ejs

@@ -141,6 +141,10 @@ exports.config = {
  // Default timeout for all waitFor* commands.
  waitforTimeout: 10000,
  //
+ // Default timeout in milliseconds for request
+ // if browser driver or grid doesn't send response
+ connectionRetryTimeout: 90000,
+ //
  // Default request retries count
  connectionRetryCount: 3,
  //

packages/wdio-config/src/constants.js

@@ -19,6 +19,7 @@ export const DEFAULT_CONFIGS = {
  maxInstances: 100,
  maxInstancesPerCapability: 100,
  filesToWatch: [],
+ connectionRetryTimeout: 90000,
  connectionRetryCount: 3,
  execArgv: [],
  runnerEnv: {},

packages/wdio-junit-reporter/tests/__fixtures__/runner.json

@@ -54,6 +54,7 @@
  ],
  "maxInstances": 1,
  "maxInstancesPerCapability": 100,
+ "connectionRetryTimeout": 90000,
  "connectionRetryCount": 3,
  "execArgv": [],
  "runnerEnv": {},

packages/webdriver/README.md

@@ -95,6 +95,12 @@ Shorten `url` command calls by setting a base url.
 Type: `String`<br>
 Default: *null*
 
+### connectionRetryTimeout
+Timeout for any WebDriver request to a driver or grid.
+
+Type: `Number`<br>
+Default: *90000*
+
 ### connectionRetryCount
 Count of request retries to the Selenium server.
 

packages/webdriver/src/constants.js

@@ -49,6 +49,13 @@ export const DEFAULTS = {
  default: 'info',
  match: /(trace|debug|info|warn|error|silent)/
  },
+ /**
+ * Timeout for any WebDriver request to a driver or grid
+ */
+ connectionRetryTimeout: {
+ type: 'number',
+ default: 90000
+ },
  /**
  * Count of request retries to the Selenium server
  */

packages/webdriver/src/request.js

@@ -50,7 +50,8 @@ export default class WebDriverRequest extends EventEmitter {
  ...DEFAULT_HEADERS,
  ...(typeof options.headers === 'object' ? options.headers : {})
  },
- qs: typeof options.queryParams === 'object' ? options.queryParams : {}
+ qs: typeof options.queryParams === 'object' ? options.queryParams : {},
+ timeout: options.connectionRetryTimeout
  }
 
  /**

packages/webdriver/tests/request.test.js

@@ -41,14 +41,16 @@ describe('webdriver request', () => {
  hostname: 'localhost',
  port: 4445,
  path: '/wd/hub/',
- headers: { foo: 'bar' }
+ headers: { foo: 'bar' },
+ connectionRetryTimeout: 10 * 1000
  }, 'foobar12345')
 
  expect(options.agent.protocol).toBe('https:')
  expect(options.uri.href)
  .toBe('https://localhost:4445/wd/hub/session/foobar12345/element')
  expect(Object.keys(options.headers))
  .toEqual(['Connection', 'Accept', 'User-Agent', 'foo'])
+ expect(options.timeout).toBe(10 * 1000)
  })
 
  it('passes a custom agent', () => {