Hey @christian-bromann, sure thing, I was looking for a good place to do it but struggled to find it. Are there any existing specs in this area that I could extend, or should I make something new?

I think packages/webdriverio/tests/commands/browser/getPuppeteer.test.ts is the best place to test the change. I wonder if this bug was the reason why I called browser.getPuppeteer.call(...) instead of just browser.getPuppeteer(...)

Looks like packages/webdriverio/tests/commands/browser/getPuppeteer.test.ts uses remote to instantiate a browser rather than the global browser object, so doesn't trigger the bug 🤔.

For example, this test works with and without the patch:

    it('should work', async () => {
        browser = await remote({
            baseUrl: 'http://foobar.com',
            capabilities: {
                browserName: 'chrome',
            },
        })
        const pptr = await browser.getPuppeteer()
        expect(typeof pptr).toBe('object')
    })

Are there any tests specifically around @wdio/globals that I could extend?

I recommend adding a smoke test then. It runs a "fake" session but allows you to import the browser via @wdio/globals. You can just add a test case to the mocha one: tests/mocha/test.ts

Hey @christian-bromann, it looks like adding tests in this area might be a bit challenging, so I'd be grateful if you could suggest a way to proceed.

Adding a test

I started by adding a simple test to tests/mocha/test.ts:

    it('should provide access to Puppeteer', async () => {
        const puppeteer = await global.browser.getPuppeteer()
        expect(puppeteer).toBeDefined()
    })

This failed with:

[0-0] TypeError in "Mocha smoke test.should provide access to Puppeteer"
TypeError: caps.browserVersion.split is not a function
    at Browser.getPuppeteer (file:///Users/jan/Projects/jan-molak/webdriverio/packages/webdriverio/build/commands/browser/getPuppeteer.js:95:59)
    at Browser.wrapCommandFn (file:///Users/jan/Projects/jan-molak/webdriverio/packages/wdio-utils/build/shim.js:72:38)
    at async Context.<anonymous> (file:///Users/jan/Projects/jan-molak/webdriverio/tests/mocha/test.ts:117:27)

🐛 #2 Mock config issue

I tracked it down to this line, which defines the browser version as number instead of
string

I changed that as follows:

- browserVersion: 64.0,
+ browserVersion: '79.0',

This is to avoid triggering this clause that prevents using Puppeteer with anything older than v79.0:

This allowed me to get further, but resulted in the following error message:

[0-0] Error in "Mocha smoke test.should provide access to Puppeteer"
Error: Could't find a websocket url within returned capabilities to connect to! Make sure you have "moz:debuggerAddress" set to `true` in your Firefox capabilities
    at Browser.getPuppeteer (file:///Users/jan/Projects/jan-molak/webdriverio/packages/webdriverio/build/commands/browser/getPuppeteer.js:113:23)
    at Browser.wrapCommandFn (file:///Users/jan/Projects/jan-molak/webdriverio/packages/wdio-utils/build/shim.js:72:38)
    at async Context.<anonymous> (file:///Users/jan/Projects/jan-molak/webdriverio/tests/mocha/test.ts:117:27)

🐛 #3 Error message issue

Setting moz:debuggerAddress to true, as per the error message causes URL parsing error, so the error message should be adjusted at

🐛 #4 Can't use Puppeteer with mock WebdriverIO

Setting moz:debuggerAddress to an actual debugger URL, like http://localhost:1234 allows me to pass the configuration stage, but fails since Puppeteer connection is not mocked out by wdio-service-mock and of course there's no actual browser involved:

[0-0] system in "Mocha smoke test.should provide access to Puppeteer"
FetchError: Failed to fetch browser webSocket URL from http://localhost:1234/json/version: request to http://localhost:1234/json/version failed, reason: connect ECONNREFUSED 127.0.0.1:1234

Next steps?

I suppose we could reuse Nock instance in

The mock might need to be quite involved to fool puppeteer.connect({...}) at

Dang .. I guess testing that this.puppeteer is accessible is the only way to test it. Then I suggest to add a full e2e test. I suggest the best place would be https://github.com/webdriverio/webdriverio/blob/main/e2e/wdio/headless/test.e2e.ts then.

@christian-bromann - I've added a new e2e test file as modifying test.e2e.ts makes Husky pre-commit checks complain about unrecognised Mocha global functions, window, and them like. I'm guessing that the pre-commit check was introduced after the test.e2e.ts, so they're a bit out of sync.

Anyway, hope the test is OK.