@wdio/browser-runner 8.29.7 → 8.30.0

package/build/browser/expect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../../src/browser/expect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2E,MAAM,QAAQ,CAAA;AA2JxG,OAAO,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../../src/browser/expect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA2E,MAAM,QAAQ,CAAA;AA2LxG,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/build/browser/expect.js

@@ -1,6 +1,5 @@
 import { expect } from 'expect';
 import { MESSAGE_TYPES } from '@wdio/types';
-import { matchers } from 'virtual:wdio';
 import { $ } from '@wdio/globals';
 import { getCID } from './utils.js';
 import { WDIO_EVENT_NAME } from '../constants.js';
@@ -11,14 +10,13 @@ let matcherRequestCount = 0;
 const matcherRequests = new Map();
 const COMMAND_TIMEOUT = 30 * 1000; // 30s
 /**
- * Set up expect-webdriverio matchers for the browser environment.
- * Every assertion is send to the testrunner via a websocket connection
- * and is executed in the Node.js environment. This allows us to enable
- * matchers that require Node.js specific modules like `fs` or `child_process`,
- * for visual regression or snapshot testing for example.
+ * Matcher factory enables to run all matchers within the browser by sending all necessary information
+ * to the worker process and execute the actual assertion in the Node.js environment.
+ * @param matcherName name of the matcher
+ * @returns a matcher result computed in the Node.js environment
  */
-expect.extend(matchers.reduce((acc, matcherName) => {
-    acc[matcherName] = async function (context, ...args) {
+function createMatcher(matcherName) {
+    return async function (context, ...args) {
         const cid = getCID();
         if (!import.meta.hot || !cid) {
             return {
@@ -40,25 +38,26 @@ expect.extend(matchers.reduce((acc, matcherName) => {
             matcherName,
             args: args
         };
+        const isContextObject = typeof context === 'object';
         /**
          * Check if context is an WebdriverIO.Element
          */
-        if ('elementId' in context && typeof context.elementId === 'string') {
+        if (isContextObject && 'elementId' in context && typeof context.elementId === 'string') {
             expectRequest.element = context;
         }
         /**
          * Check if context is ChainablePromiseElement
          */
-        if ('then' in context && typeof context.selector === 'object') {
+        if (isContextObject && 'then' in context && typeof context.selector === 'object') {
             expectRequest.element = await context;
         }
         /**
-         * Check if context is a `Element` and transtform it into a WebdriverIO.Element
+         * Check if context is a `Element` and transform it into a WebdriverIO.Element
          */
         if (context instanceof Element) {
             expectRequest.element = await $(context);
         }
-        else if (typeof context === 'object' && !('sessionId' in context)) {
+        else if (isContextObject && !('sessionId' in context)) {
             /**
              * check if context is an object or promise and resolve it
              * but not pass through the browser object
@@ -68,6 +67,12 @@ expect.extend(matchers.reduce((acc, matcherName) => {
                 expectRequest.context = await context;
             }
         }
+        else if (!isContextObject) {
+            /**
+             * if context is not an object or promise, pass it through
+             */
+            expectRequest.context = context;
+        }
         /**
          * Avoid serialization issues when sending over the element. If we create
          * an element from an existing HTMLElement, it might have custom properties
@@ -97,18 +102,42 @@ expect.extend(matchers.reduce((acc, matcherName) => {
                 .replace('/@fs/', '/');
         }
         import.meta.hot.send(WDIO_EVENT_NAME, { type: MESSAGE_TYPES.expectRequestMessage, value: expectRequest });
-        const contextString = 'elementId' in context ? 'WebdriverIO.Element' : 'WebdriverIO.Browser';
+        const contextString = isContextObject
+            ? 'elementId' in context
+                ? 'WebdriverIO.Element'
+                : 'WebdriverIO.Browser'
+            : context;
         return new Promise((resolve, reject) => {
             const commandTimeout = setTimeout(() => reject(new Error(`Assertion expect(${contextString}).${matcherName}(...) timed out`)), COMMAND_TIMEOUT);
             matcherRequests.set(expectRequest.id, { resolve, commandTimeout });
         });
     };
-    return acc;
-}, {}));
+}
+/**
+ * request all available matchers from the testrunner
+ */
+import.meta.hot?.send(WDIO_EVENT_NAME, { type: MESSAGE_TYPES.expectMatchersRequest });
 /**
  * listen on assertion results from testrunner
  */
 import.meta.hot?.on(WDIO_EVENT_NAME, (message) => {
+    /**
+     * Set up `expect-webdriverio` matchers for the browser environment.
+     * Every assertion is send to the testrunner via a websocket connection
+     * and is executed in the Node.js environment. This allows us to enable
+     * matchers that require Node.js specific modules like `fs` or `child_process`,
+     * for visual regression or snapshot testing for example.
+     *
+     * The testrunner will send a list of available matchers to the browser
+     * since there might services or other hooks that add custom matchers.
+     */
+    if (message.type === MESSAGE_TYPES.expectMatchersResponse) {
+        const matchers = message.value.matchers.reduce((acc, matcherName) => {
+            acc[matcherName] = createMatcher(matcherName);
+            return acc;
+        }, {});
+        expect.extend(matchers);
+    }
     if (message.type !== MESSAGE_TYPES.expectResponseMessage) {
         return;
     }

package/build/vite/plugins/testrunner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testrunner.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/testrunner.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AA2ClC,wBAAgB,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,oBAAoB,GAAG,MAAM,EAAE,CA2I9E"}
+{"version":3,"file":"testrunner.d.ts","sourceRoot":"","sources":["../../../src/vite/plugins/testrunner.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AA2ClC,wBAAgB,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,oBAAoB,GAAG,MAAM,EAAE,CA0I9E"}

package/build/vite/plugins/testrunner.js

@@ -2,7 +2,6 @@ import url from 'node:url';
 import path from 'node:path';
 import { builtinModules } from 'node:module';
 import logger from '@wdio/logger';
-import { matchers } from 'expect-webdriverio';
 import { polyfillPath } from 'modern-node-polyfills';
 import { deepmerge } from 'deepmerge-ts';
 import { resolve } from 'import-meta-resolve';
@@ -90,7 +89,6 @@ export function testrunner(options) {
                     import { fn } from '@wdio/browser-runner'
                     export const commands = ${JSON.stringify(protocolCommandList)}
                     export const automationProtocolPath = ${JSON.stringify(automationProtocolPath)}
-                    export const matchers = ${JSON.stringify(Object.keys(matchers))}
                     export const wrappedFn = (...args) => fn()(...args)
                 `;
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browser-runner",
-  "version": "8.29.7",
+  "version": "8.30.0",
   "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",
@@ -37,17 +37,17 @@
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "@types/istanbul-lib-source-maps": "^4.0.1",
     "@vitest/spy": "^1.0.1",
-    "@wdio/globals": "8.29.7",
-    "@wdio/local-runner": "8.29.7",
+    "@wdio/globals": "8.30.0",
+    "@wdio/local-runner": "8.30.0",
     "@wdio/logger": "8.28.0",
-    "@wdio/mocha-framework": "8.29.3",
+    "@wdio/mocha-framework": "8.30.0",
     "@wdio/protocols": "8.29.7",
-    "@wdio/runner": "8.29.7",
-    "@wdio/types": "8.29.1",
-    "@wdio/utils": "8.29.3",
+    "@wdio/runner": "8.30.0",
+    "@wdio/types": "8.30.0",
+    "@wdio/utils": "8.30.0",
     "deepmerge-ts": "^5.0.0",
     "expect": "^29.7.0",
-    "expect-webdriverio": "^4.9.3",
+    "expect-webdriverio": "^4.10.1",
     "get-port": "^7.0.0",
     "import-meta-resolve": "^4.0.0",
     "istanbul-lib-coverage": "^3.2.0",
@@ -62,8 +62,8 @@
     "vite": "~4.5.0",
     "vite-plugin-istanbul": "^5.0.0",
     "vite-plugin-top-level-await": "^1.3.0",
-    "webdriver": "8.29.7",
-    "webdriverio": "8.29.7"
+    "webdriver": "8.30.0",
+    "webdriverio": "8.30.0"
   },
   "scripts": {
     "prepare": "rimraf node_modules/@wdio/config node_modules/@wdio/repl node_modules/@wdio/utils"
@@ -71,5 +71,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1c7195268663df56856494c69d7bd655c834a368"
+  "gitHead": "033e2a91e97c9bd060eb70f2e4e412d382bec3af"
 }