Error: Invalid or unsupported WebDriver capabilities found ("pollTimeout")

[mo]

I tried to upgrade from 8.0.1 to 8.1.0 today but after the upgrade my tests fail with the message:

[0-3] 2023-02-13T19:19:54.819Z ERROR @wdio/runner: Error: Invalid or unsupported WebDriver capabilities found ("pollTimeout"). Ensure to only use valid W3C WebDriver capabilities (see https://w3c.github.io/webdriver/#capabilities).If you run your tests on a remote vendor, like Sauce Labs or BrowserStack, make sure that you put them into vendor specific capabilities, e.g. "sauce:options" or "bstack:options". Please reach out to to your vendor support team if you have further questions.

Is this a regression from 2c738d3 ?

[mo]

@m4hdyar fyi

[m4hdyar]

@mo Are you passing somehow chromedriver options as capabilities? Can you send your config file ?

[m4hdyar]

I've tested it with https://github.com/amiya-pattnaik/webdriverIO-with-mochaBDD. Changed chromedriver service version to 8.1.0 and it seems working.

[mo]

const chalk = require('chalk')

const baseUrl =
  process.env['HTTP_ORIGIN'] ||
  require('fs')
    .readFileSync(require('path').join(__dirname, '.env'))
    .toString()
    .split('\n')
    .map((line) => line.split('='))
    .find((line) => line[0] === 'HTTP_ORIGIN')[1]

exports.config = {
  //
  // ==================
  // Specify Test Files
  // ==================
  // Define which test specs should run. The pattern is relative to the directory
  // from which `wdio` was called. Notice that, if you are calling `wdio` from an
  // NPM script (see https://docs.npmjs.com/cli/run-script) then the current working
  // directory is where your package.json resides, so `wdio` will be called from there.
  //
  specs: ['./src/tests/e2e/**/*.uitest.cjs'],

  suites: {
    main: ['./src/tests/e2e/suites/main/**/*.uitest.cjs'],
    stripe: ['./src/tests/e2e/suites/stripe/**/*.uitest.cjs'],
  },

  // Patterns to exclude.
  exclude: [
    // 'path/to/excluded/files'
  ],
  //
  // ============
  // Capabilities
  // ============
  // Define your capabilities here. WebdriverIO can run multiple capabilities at the same
  // time. Depending on the number of capabilities, WebdriverIO launches several test
  // sessions. Within your capabilities you can overwrite the spec and exclude options in
  // order to group specific specs to a specific capability.
  //
  // First, you can define how many instances should be started at the same time. Let's
  // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
  // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
  // files and you set maxInstances to 10, all spec files will get tested at the same time
  // and 30 processes will get spawned. The property handles how many capabilities
  // from the same test should run tests.
  //
  maxInstances: Number(process.env.EE_BROWSER_COUNT) || 4,
  //
  // If you have trouble getting all important capabilities together, check out the
  // Sauce Labs platform configurator - a great tool to configure your capabilities:
  // https://docs.saucelabs.com/reference/platforms-configurator
  //
  // NOTE: capabilities are set at the bottom of the file instead!
  //capabilities: [],

  // ===================
  // Test Configurations
  // ===================
  // Define all options that are relevant for the WebdriverIO instance here
  //
  // By default WebdriverIO commands are executed in a synchronous way using
  // the wdio-sync package. If you still want to run your tests in an async way
  // e.g. using promises you can set the sync option to false.
  sync: false,
  //
  // Level of logging verbosity: silent | verbose | command | data | result | error
  logLevel: process.env.EE_LOG_LEVEL || 'error',
  //
  // Enables colors for log output.
  coloredLogs: true,
  //
  // If you only want to run your tests until a specific amount of tests have failed use
  // bail (default is 0 - don't bail, run all tests).
  bail: process.env.EE_BAIL || 1,
  //
  // Saves a screenshot to a given path if a command fails.
  //screenshotPath: './tests/errorShots/',
  //
  // Set a base URL in order to shorten url command calls. If your url parameter starts
  // with "/", then the base url gets prepended.
  baseUrl,
  //
  // Default timeout for all waitFor* commands.
  waitforTimeout: Number(process.env.EE_TIMEOUT_MILLIS) || Number(process.env.EE_NORMAL_TIMEOUT_MILLIS) || 6000,
  //
  // Default timeout in milliseconds for request
  // if Selenium Grid doesn't send response
  connectionRetryTimeout: 90000,
  //
  // Default request retries count
  connectionRetryCount: 3,
  //
  // Initialize the browser instance with a WebdriverIO plugin. The object should have the
  // plugin name as key and the desired plugin options as properties. Make sure you have
  // the plugin installed before running any tests. The following plugins are currently
  // available:
  // WebdriverCSS: https://github.com/webdriverio/webdrivercss
  // WebdriverRTC: https://github.com/webdriverio/webdriverrtc
  // Browserevent: https://github.com/webdriverio/browserevent
  // plugins: {
  //     webdrivercss: {
  //         screenshotRoot: 'my-shots',
  //         failedComparisonsRoot: 'diffs',
  //         misMatchTolerance: 0.05,
  //         screenWidth: [320,480,640,1024]
  //     },
  //     webdriverrtc: {},
  //     browserevent: {}
  // },
  //
  // Test runner services
  // Services take over a specific job you don't want to take care of. They enhance
  // your test setup with almost no effort. Unlike plugins, they don't add new
  // commands. Instead, they hook themselves up into the test process.
  services: ['chromedriver', 'geckodriver'],

  //seleniumArgs: seleniumVersions,
  //seleniumInstallArgs: seleniumVersions,

  //
  // Framework you want to run your specs with.
  // The following are supported: Mocha, Jasmine, and Cucumber
  // see also: http://webdriver.io/guide/testrunner/frameworks.html
  //
  // Make sure you have the wdio adapter package for the specific framework installed
  // before running any tests.
  framework: 'jasmine',
  //
  // Test reporter for stdout.
  // The only one supported by default is 'dot'
  // see also: http://webdriver.io/guide/testrunner/reporters.html
  reporters: ['spec'],

  //
  // Options to be passed to Jasmine.
  jasmineOpts: {
    //
    // Jasmine default timeout
    defaultTimeoutInterval: Number(process.env.EE_TIMEOUT_MILLIS) || 120000,
    //
    // The Jasmine framework allows interception of each assertion in order to log the state of the application
    // or website depending on the result. For example, it is pretty handy to take a screenshot every time
    // an assertion fails.
    expectationResultHandler: function (passed, assertion) {
      // do something
    },
  },

  //
  // =====
  // Hooks
  // =====
  // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
  // it and to build services around it. You can either apply a single function or an array of
  // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
  // resolved to continue.
  /**
   * Gets executed once before all workers get launched.
   * @param {Object} config wdio configuration object
   * @param {Array.<Object>} capabilities list of capabilities details
   */
  // onPrepare: function (config, capabilities) {
  // },
  /**
   * Gets executed just before initialising the webdriver session and test framework. It allows you
   * to manipulate configurations depending on the capability or spec.
   * @param {Object} config wdio configuration object
   * @param {Array.<Object>} capabilities list of capabilities details
   * @param {Array.<String>} specs List of spec file paths that are to be run
   */
  // beforeSession: function (config, capabilities, specs) {
  // },
  /**
   * Gets executed before test execution begins. At this point you can access to all global
   * variables like `browser`. It is the perfect place to define custom commands.
   * @param {Array.<Object>} capabilities list of capabilities details
   * @param {Array.<String>} specs List of spec file paths that are to be run
   */
  before: function (capabilities, specs) {},
  //
  /**
   * Hook that gets executed before the suite starts
   * @param {Object} suite suite details
   */
  // beforeSuite: function (suite) {
  // },
  /**
   * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
   * beforeEach in Mocha)
   */
  // beforeHook: function () {
  // },
  /**
   * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
   * afterEach in Mocha)
   */
  // afterHook: function () {
  // },
  /**
   * Function to be executed before a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
   * @param {Object} test test details
   */
  // beforeTest: function (test) {
  // },
  /**
   * Runs before a WebdriverIO command gets executed.
   * @param {String} commandName hook command name
   * @param {Array} args arguments that command would receive
   */
  // beforeCommand: function (commandName, args) {
  // },
  /**
   * Runs after a WebdriverIO command gets executed
   * @param {String} commandName hook command name
   * @param {Array} args arguments that command would receive
   * @param {Number} result 0 - command success, 1 - command error
   * @param {Object} error error object if any
   */
  // afterCommand: function (commandName, args, result, error) {
  // },
  /**
   * Function to be executed after a test (in Mocha/Jasmine)
   */
  afterTest: async function (test, context, { error, result, duration, passed, retries }) {
    if (error || !passed) {
      const timestamp = new Date().toISOString().replace(/:/g, '').replace('T', '_').slice(0, 17)
      const tcSafeName = test.description.replace(/[^a-zA-Z0-9]/g, '')
      const browserSuffix = process.env.SELENIUM_BROWSER ? process.env.SELENIUM_BROWSER : ''
      const screenshotDirectory = process.env.EE_SCREENSHOT_DIR
        ? process.env.EE_SCREENSHOT_DIR
        : `${__dirname}/pipeline-results`
      const { mkdirp } = await import('./src/server/Utils.js')
      await mkdirp(screenshotDirectory)
      const screenshotFilename = `${screenshotDirectory}/testfail-${tcSafeName}-${timestamp}-${browserSuffix}.png`
      // eslint-disable-next-line no-undef
      browser.saveScreenshot(screenshotFilename)
      // eslint-disable-next-line no-console
      console.log(
        chalk.redBright(`ERROR: Test with title "${test.description}" failed with error `) +
          chalk.magenta(JSON.stringify(error, null, 2)) +
          chalk.redBright(' and the following screenshot was captured: ') +
          chalk.yellow(screenshotFilename)
      )
    }
  },
  /**
   * Hook that gets executed after the suite has ended
   * @param {Object} suite suite details
   */
  // afterSuite: function (suite) {
  // },
  /**
   * Gets executed after all tests are done. You still have access to all global variables from
   * the test.
   * @param {Number} result 0 - test pass, 1 - test fail
   * @param {Array.<Object>} capabilities list of capabilities details
   * @param {Array.<String>} specs List of spec file paths that ran
   */
  // after: function (result, capabilities, specs) {
  // },
  /**
   * Gets executed right after terminating the webdriver session.
   * @param {Object} config wdio configuration object
   * @param {Array.<Object>} capabilities list of capabilities details
   * @param {Array.<String>} specs List of spec file paths that ran
   */
  // afterSession: function (config, capabilities, specs) {
  // },
  /**
   * Gets executed after all workers got shut down and the process is about to exit. It is not
   * possible to defer the end of the process using a promise.
   * @param {Object} exitCode 0 - success, 1 - fail
   */
  // onComplete: function(exitCode) {
  // }
}

exports.config.capabilities = [
  {
    browserName: 'chrome',
    'goog:chromeOptions': {
      binary: process.env.EE_CHROME_BINARY,
      args: ['--no-sandbox'],
    },
  },
  {
    browserName: 'firefox',
    'moz:firefoxOptions': {
      binary: process.env.EE_FIREFOX_BINARY,
      prefs: {
        'app.update.auto': false,
        'app.update.enabled': false,
        // Set "browser.anchor_color" to verify the prefs are applied correctly or not.
        //'browser.anchor_color': '#FF0000',
      },
      args: [],
    },
  },
]

const chromeCapability = exports.config.capabilities.find((conf) => conf.browserName === 'chrome')
chromeCapability['goog:chromeOptions'].args.push('--disable-gpu', '--disable-dev-shm-usage')

if (process.env.EE_HEADLESS && process.env.EE_HEADLESS != '0') {
  const headlessScreenWidth = 3000
  const headlessScreenHeight = 1500
  const chromeCapability = exports.config.capabilities.find((conf) => conf.browserName === 'chrome')
  chromeCapability['goog:chromeOptions'].args.push(
    '--headless',
    `--window-size=${headlessScreenWidth},${headlessScreenHeight}`
  )

  const firefoxCapability = exports.config.capabilities.find((conf) => conf.browserName === 'firefox')
  firefoxCapability['moz:firefoxOptions'].args.push(
    '-headless',
    `--window-size=${headlessScreenWidth},${headlessScreenHeight}`
  )
}

if (process.env.SELENIUM_BROWSER) {
  exports.config.capabilities = exports.config.capabilities.filter(
    (conf) => conf.browserName === process.env.SELENIUM_BROWSER
  )
}

if (process.env.EE_WDIO_EXEC_ARGV) {
  exports.config.execArgv = [process.env.EE_WDIO_EXEC_ARGV]
}

[m4hdyar]

Using https://github.com/amiya-pattnaik/webdriverIO-with-mochaBDD still cant reproduce your problem. I tested all of your conditions with 8.1.0 versions and the problem seems not happening. Can you test it yourself with the boilerplate project or give us a reproducable example ?

PS: I used ESM as the boilerplate project is in ESM and not CommonJS Style

[mo]

I added a console.log into the js file inside my node_modules and I can see pollTimeout inside my capabilties... not sure why but I will try to debug it a bit further:

[mo]

Looks like the polluted caps are passed into Runner.run() at the top of the stacktrace ... maybe it has to do with how cjs vs ESM are loaded?

[wekuang]

I execute wdio Getting Start and see the same problem
https://webdriver.io/docs/gettingstarted

[m4hdyar]

Still trying to investigate.
Maybe relevant:
webdriverio/webdriverio#6445

[AZANIR]

Create a project from scratch and have the same problem
try with different node versions 16.18.0 and 18.14.0 , but the same(

P.S. solved use "wdio-chromedriver-service": "8.0.1" and all run correct

[christian-bromann]

this.options in the Chromedriver Launcher class will get merged into the caps object so that the capability connects to given host and port of started Chromedriver instance. I added a patch to make pollTimeout a class property so this won't happen anymore.

[vikasranjan009]

Using "wdio-chromedriver-service": "^8.1.1", issue is resolved.