[🐛 Bug]: ESM module exports in Puppeteer 13.3.0 break devtools integration (ERR_PACKAGE_PATH_NOT_EXPORTED)

[jan-molak]

Have you read the Contributing Guidelines on issues?

• I have read the Contributing Guidelines on issues.

WebdriverIO Version

7.16.14

Node.js Version

16.13.1

Mode

WDIO Testrunner

Which capabilities are you using?

headless: true,
    automationProtocol: 'devtools',

    runner: 'local',

    capabilities: [{

        browserName: 'chrome',
        'goog:chromeOptions': {
            args: [
                '--headless',
                '--disable-infobars',
                '--no-sandbox',
                '--disable-gpu',
                '--window-size=1024x768',
            ],
        },
    }],

What happened?

• WebdriverIO defines its dependency on puppeteer-core as a range of ^13.1.3
• In version 13.3.0, Puppeteer introduced support for ESM modules, which seems to be backwards-incompatible
• This means that imports used in the devtools, such as these ones now break with ERR_PACKAGE_PATH_NOT_EXPORTED since the files that WebdriverIO expects to be available are no longer exported by puppeteer-core
• see [Bug]: Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: puppeteer/puppeteer#7986

@serenity-js/webdriverio: [0-8] 2022-02-09T19:46:25.742Z ERROR @wdio/runner: Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './lib/cjs/puppeteer/common/USKeyboardLayout' is not defined by "exports" in /home/runner/work/serenity-js/serenity-js/packages/webdriverio/node_modules/webdriverio/node_modules/puppeteer-core/package.json
@serenity-js/webdriverio: [0-8]     at new NodeError (internal/errors.js:322:7)
@serenity-js/webdriverio: [0-8]     at throwExportsNotFound (internal/modules/esm/resolve.js:332:9)
@serenity-js/webdriverio: [0-8]     at packageExportsResolve (internal/modules/esm/resolve.js:565:3)
@serenity-js/webdriverio: [0-8]     at resolveExports (internal/modules/cjs/loader.js:450:36)
@serenity-js/webdriverio: [0-8]     at Function.Module._findPath (internal/modules/cjs/loader.js:490:31)
@serenity-js/webdriverio: [0-8]     at Function.Module._resolveFilename (internal/modules/cjs/loader.js:888:27)
@serenity-js/webdriverio: [0-8]     at Function.Module._resolveFilename.sharedData.moduleResolveFilenameHook.installedValue [as _resolveFilename] (/home/runner/work/serenity-js/serenity-js/node_modules/@cspotcode/source-map-support/source-map-support.js:679:30)
@serenity-js/webdriverio: [0-8]     at Function.Module._load (internal/modules/cjs/loader.js:746:27)
@serenity-js/webdriverio: [0-8]     at Module.require (internal/modules/cjs/loader.js:974:19)
@serenity-js/webdriverio: [0-8]     at require (internal/modules/cjs/helpers.js:101:18)

@christian-bromann?

What is your expected behavior?

I'd expect WebdriverIO to work with Puppeteer and not throw errors

How to reproduce the bug.

• Run any test in WebdriverIO using the devtools protocol, local Chrome (I'm using v98) and puppeteer-core 13.3.0
• see ERR_PACKAGE_PATH_NOT_EXPORTED

Relevant log output

See above.

Code of Conduct

• I agree to follow this project's Code of Conduct

Is there an existing issue for this?

• I have searched the existing issues

[christian-bromann]

This problem is caused based on one of the imports you find in performActions.ts. I had to import it this way because there was no other way to do so and of course at some points it would break. The solution to this would be to find a better way to import this file. Maybe they properly export it now.

@jan-molak you want to take a stab at it?

[jan-molak]

I might give it a shot tonight ;-)

[abianche]

Is there any way to workaround the issue until this gets fixed?
Thanks.

EDIT: downgrading wdio deps. obviously worked.

[christian-bromann]

@abianche you can also help provide a fix 😉

[jan-molak]

@abianche looks like it might get fixed at the source - puppeteer/puppeteer#7986

[jan-molak]

OK, Puppeteer has reverted the change in 13.3.1 (puppeteer/puppeteer@179eded).
Closing.

Thanks for replying, @christian-bromann - good to know you're still around ;-)

[christian-bromann]

Awesome!

[pdrmailbox]

Is there any way to workaround the issue until this gets fixed? Thanks.

EDIT: downgrading wdio deps. obviously worked.

Workaround

If you have backup of "node_modules/puppeteer-core" then overwrite it. It worked for us.

Also you may try using previous version of "puppeteer-core" package from https://www.npmjs.com/package/puppeteer-core.