@wdio/runner 8.28.4 → 8.28.7

package/build/browser.d.ts

@@ -23,7 +23,7 @@ export default class BrowserFramework implements Omit<TestFramework, 'init'> {
         sessionId?: string;
     }, _specs: string[], _capabilities: Capabilities.RemoteCapability, _reporter: BaseReporter);
     /**
-     * always return true as it is unrelevant for component testing
+     * always return true as it is irrelevant for component testing
      */
     hasTests(): boolean;
     init(): TestFramework;

package/build/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,YAAY,EAAgB,KAAK,OAAO,EAAgC,MAAM,aAAa,CAAA;AAGzG,OAAO,KAAK,YAAY,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAyB,MAAM,YAAY,CAAA;AAMtE,KAAK,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAO9G,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,cAAc,EAAE,cAAc,EAAE,CAAA;QAChC,cAAc,EAAE,GAAG,EAAE,CAAA;QACrB,gBAAgB,EAAE,MAAM,CAAA;QACxB,YAAY,CAAC,EAAE,OAAO,CAAA;KACzB;CACJ;AAID,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;;IAKpE,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;gBAJT,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,CAAC,UAAU,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,EACpD,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,SAAS,EAAE,YAAY;IASnC;;OAEG;IACH,QAAQ;IAIR,IAAI;IAIE,GAAG;IAuVT,MAAM,CAAC,IAAI,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,QAAQ,EAAE,YAAY;CAItH"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,YAAY,EAAgB,KAAK,OAAO,EAAgC,MAAM,aAAa,CAAA;AAGzG,OAAO,KAAK,YAAY,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAyB,MAAM,YAAY,CAAA;AAOtE,KAAK,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAQ9G,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,cAAc,EAAE,cAAc,EAAE,CAAA;QAChC,cAAc,EAAE,GAAG,EAAE,CAAA;QACrB,gBAAgB,EAAE,MAAM,CAAA;QACxB,YAAY,CAAC,EAAE,OAAO,CAAA;KACzB;CACJ;AAED,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;;IAMpE,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;gBAJT,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,CAAC,UAAU,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,EACpD,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,SAAS,EAAE,YAAY;IAiBnC;;OAEG;IACH,QAAQ;IAIR,IAAI;IAIE,GAAG;IAgVT,MAAM,CAAC,IAAI,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,QAAQ,EAAE,YAAY;CAItH"}

package/build/browser.js

@@ -8,16 +8,17 @@ import { MESSAGE_TYPES } from '@wdio/types';
 import { transformExpectArgs } from './utils.js';
 const log = logger('@wdio/runner');
 const sep = '\n  - ';
+const ERROR_CHECK_INTERVAL = 500;
 const DEFAULT_TIMEOUT = 60 * 1000;
-const sleep = (ms = 100) => new Promise((resolve) => setTimeout(resolve, ms));
 export default class BrowserFramework {
     _cid;
     _config;
     _specs;
     _capabilities;
     _reporter;
-    #inDebugMode = false;
     #runnerOptions; // `any` here because we don't want to create a dependency to @wdio/browser-runner
+    #testStatePromise;
+    #resolveTestStatePromise;
     constructor(_cid, _config, _specs, _capabilities, _reporter) {
         this._cid = _cid;
         this._config = _config;
@@ -28,9 +29,16 @@ export default class BrowserFramework {
         process.on('message', this.#processMessage.bind(this));
         const [, runnerOptions] = Array.isArray(_config.runner) ? _config.runner : [];
         this.#runnerOptions = runnerOptions || {};
+        /**
+         * create promise to resolve test state which is being sent through the socket
+         * connection from the browser through the main process to the worker
+         */
+        this.#testStatePromise = new Promise((resolve) => {
+            this.#resolveTestStatePromise = resolve;
+        });
     }
     /**
-     * always return true as it is unrelevant for component testing
+     * always return true as it is irrelevant for component testing
      */
     hasTests() {
         return true;
@@ -89,46 +97,14 @@ export default class BrowserFramework {
         /**
          * wait for test results or page errors
          */
-        let state = {};
-        const now = Date.now();
-        await browser.waitUntil(async () => {
-            while (typeof state.failures !== 'number' && (!state.errors || state.errors.length === 0)) {
-                if ((Date.now() - now) > timeout) {
-                    return false;
-                }
-                await sleep();
-                /**
-                 * don't fetch events if user has called debug command
-                 */
-                if (this.#inDebugMode) {
-                    continue;
-                }
-                state = await browser?.execute(function fetchExecutionState() {
-                    const failures = window.__wdioEvents__ && window.__wdioEvents__.length > 0
-                        ? window.__wdioFailures__
-                        : null;
-                    let viteError;
-                    const viteErrorElem = document.querySelector('vite-error-overlay');
-                    if (viteErrorElem && viteErrorElem.shadowRoot) {
-                        const errorElements = Array.from(viteErrorElem.shadowRoot.querySelectorAll('pre'));
-                        if (errorElements.length) {
-                            viteError = [{ message: errorElements.map((elem) => elem.innerText).join('\n') }];
-                        }
-                    }
-                    const loadError = (typeof window.__wdioErrors__ === 'undefined' &&
-                        document.title !== 'WebdriverIO Browser Test' &&
-                        !document.querySelector('mocha-framework'))
-                        ? [{ message: `Failed to load test page (title = "${document.title}", source: ${document.documentElement.innerHTML})` }]
-                        : null;
-                    const errors = viteError || window.__wdioErrors__ || loadError;
-                    return { failures, errors, hasViteError: Boolean(viteError) };
-                }).catch((err) => ({ errors: [{ message: err.message }] }));
-            }
-            return true;
-        }, {
-            timeoutMsg: 'browser test timed out',
-            timeout
-        });
+        const testTimeout = setTimeout(() => this.#onTestTimeout(`Timed out after ${timeout / 1000}s waiting for test results`), timeout);
+        /**
+         * run checks for errors here to avoid breakage in communication with the browser
+         */
+        const errorInterval = setInterval(this.#checkForTestError.bind(this), ERROR_CHECK_INTERVAL);
+        const state = await this.#testStatePromise;
+        clearTimeout(testTimeout);
+        clearInterval(errorInterval);
         /**
          * capture coverage if enabled
          */
@@ -144,6 +120,9 @@ export default class BrowserFramework {
             };
             process.send(workerEvent);
         }
+        /**
+         * let runner fail if we detect an error
+         */
         if (state.errors?.length) {
             const errors = state.errors.map((ev) => state.hasViteError
                 ? `${ev.message}\n${(ev.error ? ev.error.split('\n').slice(1).join('\n') : '')}`
@@ -165,15 +144,10 @@ export default class BrowserFramework {
             });
             return 1;
         }
-        await this.#fetchEvents(browser, spec);
-        return state.failures || 0;
-    }
-    async #fetchEvents(browser, spec) {
         /**
-         * populate events to the reporter
+         * report browser events to WebdriverIO reporter
          */
-        const events = await browser.execute(() => window.__wdioEvents__);
-        for (const ev of events) {
+        for (const ev of (state.events || [])) {
             if ((ev.type === 'suite:start' || ev.type === 'suite:end') && ev.title === '') {
                 continue;
             }
@@ -184,16 +158,13 @@ export default class BrowserFramework {
                 cid: this._cid
             });
         }
+        return state.failures || 0;
     }
     async #processMessage(cmd) {
         if (cmd.command !== 'workerRequest' || !process.send) {
             return;
         }
         const { message, id } = cmd.args;
-        if (message.type === MESSAGE_TYPES.switchDebugState) {
-            this.#inDebugMode = message.value;
-            return;
-        }
         if (message.type === MESSAGE_TYPES.hookTriggerMessage) {
             return this.#handleHook(id, message.value);
         }
@@ -206,6 +177,9 @@ export default class BrowserFramework {
         if (message.type === MESSAGE_TYPES.expectRequestMessage) {
             return this.#handleExpectation(id, message.value);
         }
+        if (message.type === MESSAGE_TYPES.browserTestResult) {
+            return this.#handleTestFinish(message.value);
+        }
     }
     async #handleHook(id, payload) {
         const error = await executeHooksWithArgs(payload.name, this._config[payload.name], payload.args).then(() => undefined, (err) => err);
@@ -251,12 +225,6 @@ export default class BrowserFramework {
             const error = { message, stack, name: 'Error' };
             return this.#sendWorkerResponse(id, this.#commandResponse({ id: payload.id, error }));
         }
-        /**
-         * emit debug state to be enabled to runner so it can be propagated to the worker
-         */
-        if (payload.commandName === 'debug') {
-            this.#inDebugMode = true;
-        }
         try {
             /**
              * double check if function is registered
@@ -266,12 +234,6 @@ export default class BrowserFramework {
             }
             const result = await browser[payload.commandName](...payload.args);
             const resultMsg = this.#commandResponse({ id: payload.id, result });
-            /**
-             * emit debug state to be disabled to runner so it can be propagated to the worker
-             */
-            if (payload.commandName === 'debug') {
-                this.#inDebugMode = false;
-            }
             log.debug(`Return command result: ${resultMsg}`);
             return this.#sendWorkerResponse(id, resultMsg);
         }
@@ -335,6 +297,42 @@ export default class BrowserFramework {
             value
         };
     }
+    #handleTestFinish(payload) {
+        this.#resolveTestStatePromise({ failures: payload.failures, events: payload.events });
+    }
+    #onTestTimeout(message) {
+        return this.#resolveTestStatePromise?.({
+            events: [],
+            failures: 1,
+            errors: [{ message }]
+        });
+    }
+    async #checkForTestError() {
+        const testError = await browser.execute(function fetchExecutionState() {
+            let viteError;
+            const viteErrorElem = document.querySelector('vite-error-overlay');
+            if (viteErrorElem && viteErrorElem.shadowRoot) {
+                const errorElements = Array.from(viteErrorElem.shadowRoot.querySelectorAll('pre'));
+                if (errorElements.length) {
+                    viteError = [{ message: errorElements.map((elem) => elem.innerText).join('\n') }];
+                }
+            }
+            const loadError = (typeof window.__wdioErrors__ === 'undefined' &&
+                document.title !== 'WebdriverIO Browser Test' &&
+                !document.querySelector('mocha-framework'))
+                ? [{ message: `Failed to load test page (title = "${document.title}", source: ${document.documentElement.innerHTML})` }]
+                : null;
+            const errors = viteError || window.__wdioErrors__ || loadError;
+            return { errors, hasViteError: Boolean(viteError) };
+        });
+        if ((testError.errors && testError.errors.length > 0) || testError.hasViteError) {
+            this.#resolveTestStatePromise?.({
+                events: [],
+                failures: 1,
+                ...testError
+            });
+        }
+    }
     static init(cid, config, specs, caps, reporter) {
         const framework = new BrowserFramework(cid, config, specs, caps, reporter);
         return framework;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/runner",
-  "version": "8.28.4",
+  "version": "8.28.7",
   "description": "A WebdriverIO service that runs tests in arbitrary environments",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-runner",
@@ -30,19 +30,19 @@
   "typeScriptVersion": "3.8.3",
   "dependencies": {
     "@types/node": "^20.1.0",
-    "@wdio/config": "8.28.0",
-    "@wdio/globals": "8.28.4",
+    "@wdio/config": "8.28.6",
+    "@wdio/globals": "8.28.6",
     "@wdio/logger": "8.28.0",
-    "@wdio/types": "8.28.0",
-    "@wdio/utils": "8.28.0",
+    "@wdio/types": "8.28.6",
+    "@wdio/utils": "8.28.6",
     "deepmerge-ts": "^5.0.0",
     "expect-webdriverio": "^4.8.0",
     "gaze": "^1.1.2",
-    "webdriver": "8.28.0",
-    "webdriverio": "8.28.4"
+    "webdriver": "8.28.6",
+    "webdriverio": "8.28.6"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fbb60e474d2565447f43016ebc7444b679f85ff1"
+  "gitHead": "17828852f2b687ee32eaa1a16dbd14d0fd9ec58b"
 }