@wdio/browser-runner 8.0.4 → 8.0.6

package/build/browser/frameworks/mocha.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mocha.d.ts","sourceRoot":"","sources":["../../../src/browser/frameworks/mocha.ts"],"names":[],"mappings":"AAUA,qBAAa,cAAc;;gBAKV,MAAM,EAAE,SAAS;IAqB9B,GAAG;CA0EN"}
+{"version":3,"file":"mocha.d.ts","sourceRoot":"","sources":["../../../src/browser/frameworks/mocha.ts"],"names":[],"mappings":"AAUA,qBAAa,cAAc;;gBAKV,MAAM,EAAE,SAAS;IA+B9B,GAAG;CA+DN"}

package/build/browser/frameworks/mocha.js

@@ -10,6 +10,15 @@ export class MochaFramework {
     constructor(socket) {
         this.#socket = socket;
         socket.addEventListener('message', this.#handleSocketMessage.bind(this));
+        const [cid] = window.location.pathname.slice(1).split('/');
+        if (!cid) {
+            throw new Error('"cid" query parameter is missing');
+        }
+        const beforeHook = this.#getHook('beforeHook');
+        const beforeTest = this.#getHook('beforeTest');
+        const afterHook = this.#getHook('afterHook');
+        const afterTest = this.#getHook('afterTest');
+        setupEnv(cid, window.__wdioEnv__.args, beforeTest, beforeHook, afterTest, afterHook);
         const self = this;
         before(function () {
             self.#getHook('beforeSuite')({
@@ -27,15 +36,6 @@ export class MochaFramework {
     }
     run() {
         const runner = mocha.run(this.#onFinish.bind(this));
-        const [cid] = window.location.pathname.slice(1).split('/');
-        if (!cid) {
-            throw new Error('"cid" query parameter is missing');
-        }
-        const beforeHook = this.#getHook('beforeHook');
-        const beforeTest = this.#getHook('beforeTest');
-        const afterHook = this.#getHook('afterHook');
-        const afterTest = this.#getHook('afterTest');
-        setupEnv(cid, window.__wdioEnv__.args, beforeTest, beforeHook, afterTest, afterHook);
         Object.entries(EVENTS).map(([mochaEvent, wdioEvent]) => runner.on(mochaEvent, (payload) => {
             this.#runnerEvents.push(formatMessage({ type: wdioEvent, payload, err: payload.err }));
         }));

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,EAAE,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAIzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAK1C,OAAO,KAAK,EAAE,oBAAoB,IAAI,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAIjF,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,WAAW;;IAK9C,OAAO,CAAC,OAAO;IACf,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU;gBAD7B,OAAO,EAAE,0BAA0B,EACjC,OAAO,EAAE,OAAO,CAAC,UAAU;IAYzC;;OAEG;IACG,UAAU;IAYhB,GAAG,CAAE,OAAO,EAAE,OAAO;IAyCrB;;;;OAIG;IACG,QAAQ;CAIjB;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,oBAAqB,SAAQ,0BAA0B;SAAG;KACvE;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,EAAE,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAIzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAM1C,OAAO,KAAK,EAAE,oBAAoB,IAAI,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAIjF,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,WAAW;;IAK9C,OAAO,CAAC,OAAO;IACf,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU;gBAD7B,OAAO,EAAE,0BAA0B,EACjC,OAAO,EAAE,OAAO,CAAC,UAAU;IAYzC;;OAEG;IACG,UAAU;IAYhB,GAAG,CAAE,OAAO,EAAE,OAAO;IAmDrB;;;;OAIG;IACG,QAAQ;CAIjB;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,oBAAqB,SAAQ,0BAA0B;SAAG;KACvE;CACJ"}

package/build/index.js

@@ -40,6 +40,13 @@ export default class BrowserRunner extends LocalRunner {
             runArgs.args.baseUrl = this._config.baseUrl;
         }
         const worker = super.run(runArgs);
+        this.#server.on('debugState', (state) => worker.postMessage('switchDebugState', state));
+        this.#server.on('workerHookExecution', (payload) => {
+            if (worker.cid !== payload.cid) {
+                return;
+            }
+            return worker.postMessage('workerHookExecution', payload);
+        });
         worker.on('message', async (payload) => {
             if (payload.name === 'sessionStarted' && !SESSIONS.has(payload.cid)) {
                 SESSIONS.set(payload.cid, {
@@ -60,13 +67,15 @@ export default class BrowserRunner extends LocalRunner {
                 /**
                  * propagate debug state to the worker
                  */
-                browser.on('debugState', (state) => worker.postMessage('switchDebugState', state));
                 BROWSER_POOL.set(payload.cid, browser);
             }
             if (payload.name === 'sessionEnded') {
                 SESSIONS.delete(payload.cid);
                 BROWSER_POOL.delete(payload.cid);
             }
+            if (payload.name === 'workerHookResult') {
+                this.#server.resolveHook(payload.args);
+            }
         });
         return worker;
     }

package/build/vite/server.d.ts

@@ -1,11 +1,16 @@
+/// <reference types="node" />
+import { EventEmitter } from 'node:events';
 import { WebSocketServer } from 'ws';
 import { InlineConfig } from 'vite';
-export declare class ViteServer {
+import type { HookTriggerEvent } from './types';
+export declare class ViteServer extends EventEmitter {
     #private;
     get socketServer(): WebSocketServer | undefined;
     get config(): Partial<InlineConfig>;
     constructor(options: WebdriverIO.BrowserRunnerOptions);
     start(): Promise<void>;
     close(): Promise<void>;
+    private runWorkerHooks;
+    resolveHook(result: HookTriggerEvent): void;
 }
 //# sourceMappingURL=server.d.ts.map

package/build/vite/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/vite/server.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAa,MAAM,IAAI,CAAA;AAG/C,OAAO,EAA+B,YAAY,EAAE,MAAM,MAAM,CAAA;AAchE,qBAAa,UAAU;;IAOnB,IAAI,YAAY,gCAEf;IAED,IAAI,MAAM,0BAET;gBAEY,OAAO,EAAE,WAAW,CAAC,oBAAoB;IAiBhD,KAAK;IAuCL,KAAK;CA8Gd"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/vite/server.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAK1C,OAAO,EAAE,eAAe,EAAa,MAAM,IAAI,CAAA;AAG/C,OAAO,EAA+B,YAAY,EAAE,MAAM,MAAM,CAAA;AAQhE,OAAO,KAAK,EAAgB,gBAAgB,EAA6E,MAAM,SAAS,CAAA;AAYxI,qBAAa,UAAW,SAAQ,YAAY;;IAQxC,IAAI,YAAY,gCAEf;IAED,IAAI,MAAM,0BAET;gBAEY,OAAO,EAAE,WAAW,CAAC,oBAAoB;IAkBhD,KAAK;IAwCL,KAAK;IAmIX,OAAO,CAAC,cAAc;IAetB,WAAW,CAAE,MAAM,EAAE,gBAAgB;CAUxC"}

package/build/vite/server.js

@@ -1,3 +1,4 @@
+import { EventEmitter } from 'node:events';
 import getPort from 'get-port';
 import logger from '@wdio/logger';
 import { deepmerge } from 'deepmerge-ts';
@@ -11,7 +12,9 @@ import { PRESET_DEPENDENCIES, DEFAULT_VITE_CONFIG } from './constants.js';
 import { MESSAGE_TYPES } from '../constants.js';
 import { BROWSER_POOL, SESSIONS } from '../constants.js';
 const log = logger('@wdio/browser-runner:ViteServer');
-export class ViteServer {
+const HOOK_TIMEOUT = 15 * 1000;
+export class ViteServer extends EventEmitter {
+    #pendingHooks = new Map();
     #connections = new Set();
     #options;
     #viteConfig;
@@ -24,6 +27,7 @@ export class ViteServer {
         return this.#viteConfig;
     }
     constructor(options) {
+        super();
         this.#options = options;
         if (options.preset && options.viteConfig) {
             throw new Error('Invalid runner configuration: "preset" and "viteConfig" options are defined but only one of each can be used at the same time');
@@ -55,6 +59,7 @@ export class ViteServer {
         this.#wss.on('connection', this.#onConnect.bind(this));
         this.#viteConfig = deepmerge(this.#viteConfig, {
             server: {
+                host: '0.0.0.0',
                 port: vitePort,
                 proxy: {
                     '/ws': {
@@ -116,7 +121,21 @@ export class ViteServer {
             const error = serializeError(new Error(`No session for cid ${payload.cid} found!`));
             return ws.send(JSON.stringify(this.#hookResponse({ ...payload, error })));
         }
-        const result = await executeHooksWithArgs(payload.name, session.config[payload.name], payload.args).then(() => payload, (error) => ({ ...payload, error: serializeError(error) }));
+        const result = await Promise.all([
+            /**
+             * run config file hooks
+             */
+            executeHooksWithArgs(payload.name, session.config[payload.name], payload.args).then(() => payload, (error) => ({ ...payload, error: serializeError(error) })),
+            /**
+             * run service hooks in worker process
+             */
+            this.runWorkerHooks(payload).catch((error) => ({ ...payload, error: serializeError(error) }))
+        ]).then(
+        /**
+         * we don't propagate hook results from worker executions back
+         * as it doesn't seem to be necessary or relevant
+         */
+        ([result]) => result);
         return ws.send(JSON.stringify(this.#hookResponse(result)));
     }
     async #handleCommand(ws, payload) {
@@ -136,7 +155,7 @@ export class ViteServer {
              * emit debug state to be enabled to runner so it can be propagated to the worker
              */
             if (payload.commandName === 'debug') {
-                browser.emit('debugState', true);
+                this.emit('debugState', true);
             }
             const result = await browser[payload.commandName](...payload.args);
             const resultMsg = JSON.stringify(this.#commandResponse({ id: payload.id, result }));
@@ -144,7 +163,7 @@ export class ViteServer {
              * emit debug state to be disabled to runner so it can be propagated to the worker
              */
             if (payload.commandName === 'debug') {
-                browser.emit('debugState', false);
+                this.emit('debugState', false);
             }
             log.info(`Return command result: ${resultMsg}`);
             return ws.send(resultMsg);
@@ -168,4 +187,27 @@ export class ViteServer {
             value
         };
     }
+    #getPendingHookId(payload) {
+        return `${payload.cid}-${payload.id}`;
+    }
+    runWorkerHooks(payload) {
+        const hookId = this.#getPendingHookId(payload);
+        if (this.#pendingHooks.has(hookId)) {
+            throw new Error(`There is still a hook running for runner with id ${hookId}`);
+        }
+        this.emit('workerHookExecution', payload);
+        return new Promise((resolve, reject) => {
+            const hookExecutionTimeout = setTimeout(() => reject(new Error(`hook execution for runner with id ${hookId} timed out`)), HOOK_TIMEOUT);
+            this.#pendingHooks.set(hookId, { hookExecutionTimeout, resolveFn: resolve });
+        });
+    }
+    resolveHook(result) {
+        const hookId = this.#getPendingHookId(result);
+        const pendingHook = this.#pendingHooks.get(hookId);
+        if (!pendingHook) {
+            return log.warn(`Tried to resolve hook for cid ${result.cid} with id ${result.id} that didn't exist`);
+        }
+        pendingHook.resolveFn();
+        this.#pendingHooks.delete(hookId);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browser-runner",
-  "version": "8.0.4",
+  "version": "8.0.6",
   "description": "A WebdriverIO runner to run unit tests tests in the browser.",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browser-runner",
@@ -31,14 +31,14 @@
     "@esbuild-plugins/node-globals-polyfill": "^0.1.1",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "@types/mocha": "^10.0.0",
-    "@wdio/globals": "8.0.4",
-    "@wdio/local-runner": "8.0.4",
+    "@wdio/globals": "8.0.6",
+    "@wdio/local-runner": "8.0.6",
     "@wdio/logger": "8.0.0",
-    "@wdio/mocha-framework": "8.0.2",
+    "@wdio/mocha-framework": "8.0.6",
     "@wdio/protocols": "8.0.0",
-    "@wdio/runner": "8.0.4",
-    "@wdio/types": "8.0.0",
-    "@wdio/utils": "8.0.2",
+    "@wdio/runner": "8.0.6",
+    "@wdio/types": "8.0.6",
+    "@wdio/utils": "8.0.6",
     "deepmerge-ts": "^4.2.2",
     "expect-webdriverio": "^4.0.1",
     "fast-safe-stringify": "^2.1.1",
@@ -47,8 +47,8 @@
     "serialize-error": "^11.0.0",
     "vite": "^3.1.7",
     "vite-plugin-top-level-await": "^1.2.1",
-    "webdriver": "8.0.2",
-    "webdriverio": "8.0.4",
+    "webdriver": "8.0.6",
+    "webdriverio": "8.0.6",
     "ws": "^8.10.0"
   },
   "scripts": {
@@ -60,5 +60,5 @@
   "devDependencies": {
     "@types/ws": "^8.5.3"
   },
-  "gitHead": "3e59b46e07fe878dd9ff57d746f698edcb13d94f"
+  "gitHead": "4f63a94a3af029401d652ff1d0fa36e9057f553c"
 }