@wdio/local-runner 9.18.3 → 9.19.0

package/build/index.d.ts

@@ -8,17 +8,23 @@ export interface RunArgs extends Workers.WorkerRunPayload {
 }
 export default class LocalRunner {
     private _options;
-    protected _config: WebdriverIO.Config;
+    protected config: WebdriverIO.Config;
     workerPool: Record<string, WorkerInstance>;
+    private xvfbInitialized;
+    private xvfbManager;
     stdout: WritableStreamBuffer;
     stderr: WritableStreamBuffer;
-    constructor(_options: never, _config: WebdriverIO.Config);
+    constructor(_options: never, config: WebdriverIO.Config);
     /**
-     * nothing to initialize when running locally
+     * initialize local runner environment
      */
-    initialize(): void;
+    initialize(): Promise<void>;
     getWorkerCount(): number;
     run({ command, args, ...workerOptions }: RunArgs): Promise<WorkerInstance>;
+    /**
+     * Initialize XVFB with capability-aware detection
+     */
+    private initializeXvfb;
     /**
      * shutdown all worker processes
      *

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,cAAc,MAAM,aAAa,CAAA;AAKxC,YAAY,EAAE,cAAc,EAAE,CAAA;AAE9B,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,gBAAgB;IACrD,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAA;CAClC;AAED,MAAM,CAAC,OAAO,OAAO,WAAW;IAOxB,OAAO,CAAC,QAAQ;IAChB,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM;IAPzC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAK;IAE/C,MAAM,uBAA2C;IACjD,MAAM,uBAA2C;gBAGrC,QAAQ,EAAE,KAAK,EACb,OAAO,EAAE,WAAW,CAAC,MAAM;IAGzC;;OAEG;IACH,UAAU;IAEV,cAAc;IAIR,GAAG,CAAE,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,EAAE,OAAO;IAgBvD;;;;;OAKG;IACH,QAAQ;CA2CX"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,cAAc,MAAM,aAAa,CAAA;AAKxC,YAAY,EAAE,cAAc,EAAE,CAAA;AAE9B,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,gBAAgB;IACrD,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAA;CAClC;AAED,MAAM,CAAC,OAAO,OAAO,WAAW;IASxB,OAAO,CAAC,QAAQ;IAChB,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM;IATxC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAK;IAC/C,OAAO,CAAC,eAAe,CAAQ;IAC/B,OAAO,CAAC,WAAW,CAAa;IAEhC,MAAM,uBAA2C;IACjD,MAAM,uBAA2C;gBAGrC,QAAQ,EAAE,KAAK,EACb,MAAM,EAAE,WAAW,CAAC,MAAM;IASxC;;OAEG;IACG,UAAU;IAIhB,cAAc;IAIR,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,EAAE,OAAO;IA4BtD;;OAEG;YACW,cAAc;IAsB5B;;;;;OAKG;IACG,QAAQ;CA0DjB"}

package/build/index.js

@@ -1,12 +1,13 @@
 // src/index.ts
 import logger2 from "@wdio/logger";
 import { WritableStreamBuffer } from "stream-buffers";
+import { XvfbManager } from "@wdio/xvfb";
 
 // src/worker.ts
 import url from "node:url";
 import path from "node:path";
-import child from "node:child_process";
 import { EventEmitter } from "node:events";
+import { ProcessFactory } from "@wdio/xvfb";
 import logger from "@wdio/logger";
 
 // src/transformStream.ts
@@ -202,6 +203,7 @@ var WorkerInstance = class extends EventEmitter {
   sessionId;
   server;
   logsAggregator = [];
+  #processFactory;
   instances;
   isMultiremote;
   isBusy = false;
@@ -221,8 +223,9 @@ var WorkerInstance = class extends EventEmitter {
    * @param  {string[]} specs       list of paths to test files to run in this worker
    * @param  {number}   retries     number of retries remaining
    * @param  {object}   execArgv    execution arguments for the test run
+   * @param  {XvfbManager} xvfbManager configured XvfbManager instance
    */
-  constructor(config, { cid, configFile, caps, specs, execArgv, retries }, stdout, stderr) {
+  constructor(config, { cid, configFile, caps, specs, execArgv, retries }, stdout, stderr, xvfbManager) {
     super();
     this.cid = cid;
     this.config = config;
@@ -234,6 +237,7 @@ var WorkerInstance = class extends EventEmitter {
     this.retries = retries;
     this.stdout = stdout;
     this.stderr = stderr;
+    this.#processFactory = new ProcessFactory(xvfbManager);
     this.isReady = new Promise((resolve) => {
       this.isReadyResolver = resolve;
     });
@@ -244,7 +248,7 @@ var WorkerInstance = class extends EventEmitter {
   /**
    * spawns process to kick of wdio-runner
    */
-  startProcess() {
+  async startProcess() {
     const { cid, execArgv } = this;
     const argv = process.argv.slice(2);
     const runnerEnv = Object.assign({
@@ -258,12 +262,16 @@ var WorkerInstance = class extends EventEmitter {
     }
     runnerEnv.NODE_OPTIONS = process.env.NODE_OPTIONS + " " + (runnerEnv.NODE_OPTIONS || "");
     log.info(`Start worker ${cid} with arg: ${argv.join(" ")}`);
-    const childProcess = this.childProcess = child.fork(path.join(__dirname, "run.js"), argv, {
-      cwd: process.cwd(),
-      env: runnerEnv,
-      execArgv,
-      stdio: ["inherit", "pipe", "pipe", "ipc"]
-    });
+    const childProcess = this.childProcess = await this.#processFactory.createWorkerProcess(
+      path.join(__dirname, "run.js"),
+      argv,
+      {
+        cwd: process.cwd(),
+        env: runnerEnv,
+        execArgv,
+        stdio: ["inherit", "pipe", "pipe", "ipc"]
+      }
+    );
     childProcess.on("message", this._handleMessage.bind(this));
     childProcess.on("error", this._handleError.bind(this));
     childProcess.on("exit", this._handleExit.bind(this));
@@ -333,13 +341,13 @@ var WorkerInstance = class extends EventEmitter {
    * @param  command  method to run in wdio-runner
    * @param  args     arguments for functions to call
    */
-  postMessage(command, args, requiresSetup = false) {
+  async postMessage(command, args, requiresSetup = false) {
     const { cid, configFile, capabilities, specs, retries, isBusy } = this;
     if (isBusy && !ACCEPTABLE_BUSY_COMMANDS.includes(command)) {
       return log.info(`worker with cid ${cid} already busy and can't take new commands`);
     }
     if (!this.childProcess) {
-      this.childProcess = this.startProcess();
+      this.childProcess = await this.startProcess();
     }
     const cmd = { cid, command, configFile, args, caps: capabilities, specs, retries };
     log.debug(`Send command ${command} to worker with cid "${cid}"`);
@@ -356,42 +364,86 @@ var WorkerInstance = class extends EventEmitter {
 // src/index.ts
 var log2 = logger2("@wdio/local-runner");
 var LocalRunner = class {
-  constructor(_options, _config) {
+  constructor(_options, config) {
     this._options = _options;
-    this._config = _config;
+    this.config = config;
+    this.xvfbManager = new XvfbManager({
+      xvfbMaxRetries: this.config.xvfbMaxRetries,
+      xvfbRetryDelay: this.config.xvfbRetryDelay
+    });
   }
   workerPool = {};
+  xvfbInitialized = false;
+  xvfbManager;
   stdout = new WritableStreamBuffer(BUFFER_OPTIONS);
   stderr = new WritableStreamBuffer(BUFFER_OPTIONS);
   /**
-   * nothing to initialize when running locally
+   * initialize local runner environment
    */
-  initialize() {
+  async initialize() {
   }
   getWorkerCount() {
     return Object.keys(this.workerPool).length;
   }
   async run({ command, args, ...workerOptions }) {
+    if (!this.xvfbInitialized) {
+      await this.initializeXvfb(workerOptions);
+      this.xvfbInitialized = true;
+    }
     const workerCnt = this.getWorkerCount();
     if (workerCnt >= process.stdout.getMaxListeners() - 2) {
       process.stdout.setMaxListeners(workerCnt + 2);
       process.stderr.setMaxListeners(workerCnt + 2);
     }
-    const worker = new WorkerInstance(this._config, workerOptions, this.stdout, this.stderr);
+    const worker = new WorkerInstance(
+      this.config,
+      workerOptions,
+      this.stdout,
+      this.stderr,
+      this.xvfbManager
+    );
     this.workerPool[workerOptions.cid] = worker;
-    worker.postMessage(command, args);
+    await worker.postMessage(command, args);
     return worker;
   }
+  /**
+   * Initialize XVFB with capability-aware detection
+   */
+  async initializeXvfb(workerOptions) {
+    if (this.config.autoXvfb === false) {
+      log2.info("Skipping automatic Xvfb initialization (disabled by config)");
+      return;
+    }
+    try {
+      const capabilities = workerOptions.caps;
+      const xvfbInitialized = await this.xvfbManager.init(capabilities);
+      if (xvfbInitialized) {
+        log2.info("Xvfb is ready for use");
+      }
+    } catch (error) {
+      log2.warn(
+        "Failed to initialize Xvfb, continuing without virtual display:",
+        error
+      );
+    }
+  }
   /**
    * shutdown all worker processes
    *
    * @return {Promise}  resolves when all worker have been shutdown or
    *                    a timeout was reached
    */
-  shutdown() {
+  async shutdown() {
     log2.info("Shutting down spawned worker");
     for (const [cid, worker] of Object.entries(this.workerPool)) {
-      const { capabilities, server, sessionId, config, isMultiremote, instances } = worker;
+      const {
+        capabilities,
+        server,
+        sessionId,
+        config,
+        isMultiremote,
+        instances
+      } = worker;
       let payload = {};
       if (config && config.watch && (sessionId || isMultiremote)) {
         payload = {
@@ -405,12 +457,14 @@ var LocalRunner = class {
         delete this.workerPool[cid];
         continue;
       }
-      worker.postMessage("endSession", payload);
+      await worker.postMessage("endSession", payload);
     }
-    return new Promise((resolve) => {
+    const shutdownResult = await new Promise((resolve) => {
       const timeout = setTimeout(resolve, SHUTDOWN_TIMEOUT);
       const interval = setInterval(() => {
-        const busyWorker = Object.entries(this.workerPool).filter(([, worker]) => worker.isBusy).length;
+        const busyWorker = Object.entries(this.workerPool).filter(
+          ([, worker]) => worker.isBusy
+        ).length;
         log2.info(`Waiting for ${busyWorker} to shut down gracefully`);
         if (busyWorker === 0) {
           clearTimeout(timeout);
@@ -420,6 +474,10 @@ var LocalRunner = class {
         }
       }, 250);
     });
+    if (this.xvfbManager.shouldRun()) {
+      log2.info("Xvfb cleanup handled automatically by xvfb-run");
+    }
+    return shutdownResult;
   }
 };
 export {

package/build/worker.d.ts

@@ -1,7 +1,7 @@
-import child from 'node:child_process';
 import { EventEmitter } from 'node:events';
 import type { ChildProcess } from 'node:child_process';
 import type { WritableStreamBuffer } from 'stream-buffers';
+import { type XvfbManager } from '@wdio/xvfb';
 import type { Workers } from '@wdio/types';
 /**
  * WorkerInstance
@@ -9,6 +9,7 @@ import type { Workers } from '@wdio/types';
  * session lifetime.
  */
 export default class WorkerInstance extends EventEmitter implements Workers.Worker {
+    #private;
     cid: string;
     config: WebdriverIO.Config;
     configFile: string;
@@ -42,12 +43,13 @@ export default class WorkerInstance extends EventEmitter implements Workers.Work
      * @param  {string[]} specs       list of paths to test files to run in this worker
      * @param  {number}   retries     number of retries remaining
      * @param  {object}   execArgv    execution arguments for the test run
+     * @param  {XvfbManager} xvfbManager configured XvfbManager instance
      */
-    constructor(config: WebdriverIO.Config, { cid, configFile, caps, specs, execArgv, retries }: Workers.WorkerRunPayload, stdout: WritableStreamBuffer, stderr: WritableStreamBuffer);
+    constructor(config: WebdriverIO.Config, { cid, configFile, caps, specs, execArgv, retries }: Workers.WorkerRunPayload, stdout: WritableStreamBuffer, stderr: WritableStreamBuffer, xvfbManager: XvfbManager);
     /**
      * spawns process to kick of wdio-runner
      */
-    startProcess(): child.ChildProcess;
+    startProcess(): Promise<ChildProcess>;
     private _handleMessage;
     private _handleError;
     private _handleExit;
@@ -56,6 +58,6 @@ export default class WorkerInstance extends EventEmitter implements Workers.Work
      * @param  command  method to run in wdio-runner
      * @param  args     arguments for functions to call
      */
-    postMessage(command: string, args: Workers.WorkerMessageArgs, requiresSetup?: boolean): void;
+    postMessage(command: string, args: Workers.WorkerMessageArgs, requiresSetup?: boolean): Promise<void>;
 }
 //# sourceMappingURL=worker.d.ts.map

package/build/worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,oBAAoB,CAAA;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAmB1C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,YAAa,YAAW,OAAO,CAAC,MAAM;IAC9E,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,WAAW,CAAC,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAElB,IAAI,EAAE,WAAW,CAAC,YAAY,CAAA;IAE9B,YAAY,EAAE,WAAW,CAAC,YAAY,CAAA;IACtC,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,oBAAoB,CAAA;IAC5B,MAAM,EAAE,oBAAoB,CAAA;IAC5B,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,cAAc,EAAE,MAAM,EAAE,CAAK;IAE7B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACjD,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB,MAAM,UAAQ;IACd,QAAQ,UAAQ;IAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,eAAe,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI,CAAW;IAC3E,eAAe,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI,CAAW;IAE3E;;;;;;;;;OASG;gBAEC,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,gBAAgB,EAC7E,MAAM,EAAE,oBAAoB,EAC5B,MAAM,EAAE,oBAAoB;IAkBhC;;OAEG;IACH,YAAY;IAqDZ,OAAO,CAAC,cAAc;IAsDtB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,WAAW;IAkBnB;;;;OAIG;IACH,WAAW,CAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,iBAAiB,EAAE,aAAa,UAAQ,GAAG,IAAI;CA0B9F"}
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAAkB,KAAK,WAAW,EAAE,MAAM,YAAY,CAAA;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAmB1C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,YAAa,YAAW,OAAO,CAAC,MAAM;;IAC9E,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,WAAW,CAAC,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAElB,IAAI,EAAE,WAAW,CAAC,YAAY,CAAA;IAE9B,YAAY,EAAE,WAAW,CAAC,YAAY,CAAA;IACtC,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,oBAAoB,CAAA;IAC5B,MAAM,EAAE,oBAAoB,CAAA;IAC5B,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,cAAc,EAAE,MAAM,EAAE,CAAK;IAG7B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACjD,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB,MAAM,UAAQ;IACd,QAAQ,UAAQ;IAChB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,eAAe,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI,CAAW;IAC3E,eAAe,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI,CAAW;IAE3E;;;;;;;;;;OAUG;gBAEC,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,gBAAgB,EAC7E,MAAM,EAAE,oBAAoB,EAC5B,MAAM,EAAE,oBAAoB,EAC5B,WAAW,EAAE,WAAW;IAmB5B;;OAEG;IACG,YAAY;IA2DlB,OAAO,CAAC,cAAc;IAsDtB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,WAAW;IAkBnB;;;;OAIG;IACG,WAAW,CAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,iBAAiB,EAAE,aAAa,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CA0B7G"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/local-runner",
-  "version": "9.18.3",
+  "version": "9.19.0",
   "description": "A WebdriverIO runner to run tests locally",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-local-runner",
@@ -39,8 +39,9 @@
     "@types/node": "^20.1.0",
     "@wdio/logger": "9.18.0",
     "@wdio/repl": "9.16.2",
-    "@wdio/runner": "9.18.3",
-    "@wdio/types": "9.16.2",
+    "@wdio/runner": "9.19.0",
+    "@wdio/types": "9.19.0",
+    "@wdio/xvfb": "9.19.0",
     "exit-hook": "^4.0.0",
     "expect-webdriverio": "^5.3.4",
     "split2": "^4.1.0",
@@ -52,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fc1d8576f1ccd4f4b7b99f8d01cda3fe29642c5c"
+  "gitHead": "be9a42358a6646d48c3ce5a341761f55aa605b24"
 }