ignore defaultChromeFlags / PptrDefaultArgs tags

[anemer]

Proposed changes

Added 2 optional parameters (in wdio.conf.js / capabilities) that allow:

• to launch Google Chrome without the default flags (given in devtools)
• and/or to launch browser without the default Puppeteer arguments

#5339

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update

Checklist

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)
• I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

[jsf-clabot]

All committers have signed the CLA.

[anemer]

Haha!

• Jest: "global" coverage threshold for branches (96%) not met: 95.99%
• Test Suites: 201 passed, 201 total
• Tests: 1904 passed, 1904 total
• Snapshots: 89 passed, 89 total
• Time: 133.787s
• Ran all test suites.

[christian-bromann]

Can we use 1 parameter for both as they are essentially doing the same thing?

[anemer]

It's possible.
But what if someone wants to change some of default Chrome flags, but wants the default Puppeteer's arguments to be preserved (for Chrome or other browsers)?

[christian-bromann]

The user would just need to set:

ignorePuppeteerDefaultArgs: {
   // default args to be ignored
   args: [...]
}

[anemer]

Ok. I will set a single parameter that affects the 2 lists of default args/flags.
It will be exactly like the Puppeteer's ignoreDefaultArgs parameter (same name, same type = <[boolean]|[Array]<[string]>>) , and its value will be passed to Puppeteer.

[christian-bromann]

Could you move ignoreDefaultArgs into goog:chromeOptions as it i a custom capability?

[christian-bromann]

No need to use Object.assign:

    const chrome = await launchChromeBrowser({
        chromePath: chromeOptions.binary,
        chromeFlags,
        ignoreDefaultArgs: Boolean(ignoreDefaultArgs)
    })

[christian-bromann]

same as above:

    const puppeteerOptions = Object.assign({
        product,
        executablePath,
        defaultViewport: {
            width: DEFAULT_WIDTH,
            height: DEFAULT_HEIGHT
        },
		ignoreDefaultArgs: Boolean(ignoreDefaultArgs)
    }, capabilities[vendorCapKey] || {})

[anemer]

Could you move ignoreDefaultArgs into goog:chromeOptions as it i a custom capability?

It's true my first need was for Chrome. But:

• As I can see in devtools/launcher.js devtools can also be used for other browsers than Chrome. Maybe not yet at the same level as with Chrome, but it's possible.

• And it seems Puppeteer accepts this ignoreDefaultArgs parameter in its experimental support of Firefox (see experimental/puppeteer-firefox/Launcher.js).

so why limit this parameter only for Chrome?

[anemer]

same as above:

    const puppeteerOptions = Object.assign({
        product,
        executablePath,
        defaultViewport: {
            width: DEFAULT_WIDTH,
            height: DEFAULT_HEIGHT
        },
		ignoreDefaultArgs: Boolean(ignoreDefaultArgs)
    }, capabilities[vendorCapKey] || {})

line 124 is actually wrong. It should be like line 75:

    ignoreDefaultArgs ? { ignoreDefaultArgs: ignoreDefaultArgs } : {}

as ignoreDefaultArgs is either a boolean or a array of string (as in Puppeteer)

[christian-bromann]

We still don't need Object.assign here if ignoreDefaultArgs can contain the same values as in Puppeteer we can just do:

const chrome = await launchChromeBrowser({
    chromePath: chromeOptions.binary,
    ignoreDefaultArgs,
    chromeFlags
})

[christian-bromann]

we can do the same here:

    const puppeteerOptions = Object.assign({
        product,
        executablePath,
        ignoreDefaultArgs,
        defaultViewport: {
            width: DEFAULT_WIDTH,
            height: DEFAULT_HEIGHT
        }
    }, capabilities[vendorCapKey] || {})

[christian-bromann]

I think these specific DevTools capabilities should be documented differently but since we don't have such a section yet I will approve this PR.

Thanks @anemer