Bug: require('wdio-electron-service/main') crashes app

[qwalley]

Seems that vitest/spy does not enjoy being "require"d. Here's a minimal reproduction using the electron boilerplate project.

Environment: Ubuntu 22

Steps:

1. git clone https://github.com/webdriverio/electron-boilerplate.git
2. cd electron-boilerplate && npm install && npm run package
3. NODE_ENV=test ./out/WebdriverIO\ +\ Electron\ Boilerplate-linux-x64/WebdriverIO\ +\ Electron\ Boilerplate

Output:

A JavaScript error occurred in the main process
Uncaught Exception:
Error [ERR_REQUIRE_ESM]: require() of ES Module /home/walley/repos/electron-boilerplate/out/WebdriverIO + Electron Boilerplate-linux-x64/resources/app.asar/node_modules/@vitest/spy/dist/index.js from /home/walley/repos/electron-boilerplate/out/WebdriverIO + Electron Boilerplate-linux-x64/resources/app.asar/node_modules/wdio-electron-service/dist/cjs/main.js not supported.
Instead change the require of index.js in /home/walley/repos/electron-boilerplate/out/WebdriverIO + Electron Boilerplate-linux-x64/resources/app.asar/node_modules/wdio-electron-service/dist/cjs/main.js to a dynamic import() which is available in all CommonJS modules.
    at l._load (node:electron/js2c/asar_bundle:2:13642)
    at Object.<anonymous> (/home/walley/repos/electron-boilerplate/out/WebdriverIO + Electron Boilerplate-linux-x64/resources/app.asar/node_modules/wdio-electron-service/dist/cjs/main.js:30:15)
    at l._load (node:electron/js2c/asar_bundle:2:13642)
    at Object.<anonymous> (/home/walley/repos/electron-boilerplate/out/WebdriverIO + Electron Boilerplate-linux-x64/resources/app.asar/dist/app.js:17:5)
    at l._load (node:electron/js2c/asar_bundle:2:13642)
    at node:electron/js2c/browser_init:2:120247
    at node:electron/js2c/browser_init:2:120456
    at node:electron/js2c/browser_init:2:120460
    at l._load (node:electron/js2c/asar_bundle:2:13642)

[christian-bromann]

@qwalley I recommend to mock the wdio-electron-service dependency, there is no reason to actually import it into your application.

[christian-bromann]

It makes sense to me now. The /main import does this const spy_1 = require("@vitest/spy") which doesn't work since @vitest/spy is an ESM package. I added a comment to the PR which asks if it is possible to dynamically import it or if there is a need to set fn as global.

[goosewobbler]

@qwalley Do you have reproduction steps for this which work? electron-boilerplate is producing TS errors on the package step.

To test my hypothesis above, I'm currently looking to add yet another example app in the service, one which doesn't use a bundler - not managed to get it working yet. Depending on how much work this ends up being, it may be worthwhile just telling people to use a bundler until we can get #308 built out.

[goosewobbler]

Never mind, I got example-no-bundling working and can now reproduce the error there.

[goosewobbler]

This should be fixed now in 6.3.1.

[christian-bromann]

Thanks for your work @goosewobbler 🎉