Reference:

and

Applies for all other documentation updates in this file.

Ref:

Ref:

and

Applies for all other :::caution entries on this file.

This mentioned before already when we document binary for within the common driver options:

binary
Path to a custom driver binary. If set WebdriverIO won't attempt to download a driver but will use the one provided by this path. Make sure the driver is compatible with the browser you are using.

I think repeating this for all browser again isn't ideal.

Oh, I missed that! OK, I'm going to remove this in favor of promoting that to a :::caution so it gets more prominency.

Ref:

Ref:

and

and

webdriverio-community/node-edgedriver@7f2fc5d5b/src/install.ts:25-30

Ref:

You can't use 116. Ref:

and running:

await (async () => {
  const { canDownload, detectBrowserPlatform, resolveBuildId } = await import('@puppeteer/browsers')
  const browser = 'chrome'
  const platform = detectBrowserPlatform()

  const results = []
  for (const tag of ['116', '116.0.5845.96', 'stable', 'latest', 'dev', 'canary', 'beta']) {
    const buildId = await resolveBuildId(browser, platform, tag)
    const result = await canDownload({
      browser,
      platform,
      buildId,
    })

    results.push(`${tag}: ${result}`)
  }

  return results
})()

returns

[
  '116: false',
  '116.0.5845.96: true',
  'stable: true',
  'latest: true',
  'dev: true',
  'canary: true',
  'beta: true'
]

This actually works for me:

[
  '116: true',
  '116.0.5845.96: true',
  'stable: true',
  'latest: true',
  'dev: true',
  'canary: true',
  'beta: true'
]

I ran the code using @puppeteer/browsers version 1.4.6 (used here) that's why I got a different result from you.

Running it with @puppeteer/browsers version 1.7.0 (used here) I get the same result as you. Will revert.

That being said, using just the major version with firefox does not work, even with @puppeteer/browsers version 1.7.0:

await (async () => {
  const { canDownload, detectBrowserPlatform, resolveBuildId } = await import('@puppeteer/browsers')
  const browser = 'firefox'
  const platform = detectBrowserPlatform()

  const results = []
  for (const tag of ['119', '119.0a1', 'latest']) {
    const buildId = await resolveBuildId(browser, platform, tag)
    const result = await canDownload({
      browser,
      platform,
      buildId,
    })

    results.push(`${tag}: ${result}`)
  }

  return results
})()

I get:

[
  '119: false',
  '119.0a1: true',
  'latest: true'
]

I think we should mention this in a separate section here: https://webdriver.io/docs/driverbinaries rather than as part of the comment.

Sounds good, I'll add a bit more information there then.

same

The default value is not null , it is not defined

Yes, I was aware. I was just following the standard set by the other parameters:

I will update the documentation to indicate undefined instead.

This actually works for me:

[
  '116: true',
  '116.0.5845.96: true',
  'stable: true',
  'latest: true',
  'dev: true',
  'canary: true',
  'beta: true'
]

This mentioned before already when we document binary for within the common driver options:

binary
Path to a custom driver binary. If set WebdriverIO won't attempt to download a driver but will use the one provided by this path. Make sure the driver is compatible with the browser you are using.

I think repeating this for all browser again isn't ideal.

same as mentioned above

cp is not defined

Oops, copy/paste from a toy I had and forgot to rename that. That being said, I will be removing this.

I am not sure if it is valuable to document this. You example works for a single session but it becomes a lot more complex when multiple sessions are involved. Furthermore you example does the same as when using WebdriverIOs built-in setup because Geckodriver is downloaded when you call start so it will fail without network connections too.

I am not sure if it is valuable to document this.

Agreed, it's very use-case specific, and the ## Manual setup provides enough information on how to get/start the drivers.

Furthermore you example does the same as when using WebdriverIOs built-in setup because Geckodriver is downloaded when you call start so it will fail without network connections too.

Yeah, I missed to specify the customGeckoDriverPath parameter, which unfortunately is broken. In other words, this won't work:

{
  browserName: 'firefox',
  'wdio:geckodriverOptions': {
    binary: '/path/to/geckodriver'
  }
}

That being said, I have created webdriverio-community/node-geckodriver#222 to fix it.

In some environments, the auto-detected browser version may differ from the specified binary.

Can you elaborate?

Example 1

Say you have a linux machine with the following:

• firefox version A installed in /path/to/firefox

Then you use the following wdio configuration:

{
  browserName: 'firefox',
  'moz:firefoxOptions': {
    binary: '/path/to/firefox'
  }
}

This will invoke setupGeckodriver("...", undefined) in wdio:

Then in geckodriver:

// get latest version of Geckodriver
if (!geckodriverVersion) {
  // ...
}

The version you'll end up getting will be the latest which may not be compatible with firefox version A.

Example 2

Say you have a linux machine with the following:

• edge version A installed in /usr/bin/microsoft-edge
• edge version B installed in /path/to/microsoft-edge
• PATH environment variable set to /usr/bin

Then you use the following wdio configuration:

{
  browserName: 'msedge',
  'ms:edgeOptions': {
    binary: '/path/to/microsoft-edge'
  }
}

This will invoke setupEdgedriver("...", undefined) in wdio:

Then in edgedriver (ref1, ref2):

// install.ts
import findEdgePath from './finder.js'
// ...

export async function download (
  edgeVersion: string = process.env.EDGEDRIVER_VERSION,
  cacheDir: string = process.env.EDGEDRIVER_CACHE_DIR || os.tmpdir()
) {
  // ...
  if (!edgeVersion) {
    const edgePath = findEdgePath()
    log.info(`Trying to detect Microsoft Edge version from binary found at ${edgePath}`)
    edgeVersion = os.platform() === 'win32' ? await getEdgeVersionWin(edgePath) : await getEdgeVersionUnix(edgePath)
    log.info(`Detected Microsoft Edge v${edgeVersion}`)
  }
}

// finder.ts
// Look for edge by using the which command
function linux() {
  // ...
  return findByWhich(
    EDGE_BINARY_NAMES,
    [{ regex: EDGE_REGEX, weight: 51 }]
  )
}

The version you'll up getting will be A, yet you wanted the driver for B.

I see, to summarise this: if you define either a browser or a driver binary but not both, you will likely end up having no matching binaries and your test will fail. Do you think we can formulate it like this somehow? I had to read the sentence a couple of times without really understanding what it means 🙈

OK, I've reworded the paragraph. Hopefully this does the trick.