@wdio/appium-service 9.0.0-alpha.9 → 9.0.1

package/build/index.js

@@ -1,6 +1,236 @@
-/* istanbul ignore file */
-import AppiumLauncher from './launcher.js';
-export default class AppiumService {
+// src/launcher.ts
+import fs from "node:fs";
+import fsp from "node:fs/promises";
+import url from "node:url";
+import path from "node:path";
+import treeKill from "tree-kill";
+import { spawn } from "node:child_process";
+import logger from "@wdio/logger";
+import getPort from "get-port";
+import { resolve as resolve2 } from "import-meta-resolve";
+import { isCloudCapability } from "@wdio/config";
+import { SevereServiceError } from "webdriverio";
+import { isAppiumCapability } from "@wdio/utils";
+
+// src/utils.ts
+import { basename, join, resolve } from "node:path";
+import { kebabCase } from "change-case";
+var FILE_EXTENSION_REGEX = /\.[0-9a-z]+$/i;
+function getFilePath(filePath, defaultFilename) {
+  let absolutePath = resolve(filePath);
+  if (!FILE_EXTENSION_REGEX.test(basename(absolutePath))) {
+    absolutePath = join(absolutePath, defaultFilename);
+  }
+  return absolutePath;
 }
-export const launcher = AppiumLauncher;
-export * from './types.js';
+function formatCliArgs(args) {
+  const cliArgs = [];
+  for (const key in args) {
+    const value = args[key];
+    if (typeof value === "boolean" && !value || value === null) {
+      continue;
+    }
+    cliArgs.push(`--${kebabCase(key)}`);
+    if (typeof value !== "boolean") {
+      cliArgs.push(sanitizeCliOptionValue(value));
+    }
+  }
+  return cliArgs;
+}
+function sanitizeCliOptionValue(value) {
+  const valueString = typeof value === "object" ? JSON.stringify(value) : String(value);
+  return /\s/.test(valueString) ? `'${valueString}'` : valueString;
+}
+
+// src/launcher.ts
+var log = logger("@wdio/appium-service");
+var DEFAULT_APPIUM_PORT = 4723;
+var DEFAULT_LOG_FILENAME = "wdio-appium.log";
+var DEFAULT_CONNECTION = {
+  protocol: "http",
+  hostname: "127.0.0.1",
+  path: "/"
+};
+var APPIUM_START_TIMEOUT = 30 * 1e3;
+var AppiumLauncher = class _AppiumLauncher {
+  constructor(_options, _capabilities, _config) {
+    this._options = _options;
+    this._capabilities = _capabilities;
+    this._config = _config;
+    this._args = {
+      basePath: DEFAULT_CONNECTION.path,
+      ...this._options.args || {}
+    };
+    this._logPath = _options.logPath || this._config?.outputDir;
+  }
+  _logPath;
+  _appiumCliArgs = [];
+  _args;
+  _process;
+  _isShuttingDown = false;
+  async _getCommand(command) {
+    if (!command) {
+      command = "node";
+      this._appiumCliArgs.unshift(await _AppiumLauncher._getAppiumCommand());
+    }
+    if (process.platform === "win32") {
+      this._appiumCliArgs.unshift("/c", command);
+      command = "cmd";
+    }
+    return command;
+  }
+  /**
+   * update capability connection options to connect
+   * to Appium server
+   */
+  _setCapabilities(port) {
+    if (!Array.isArray(this._capabilities)) {
+      for (const [, capability] of Object.entries(this._capabilities)) {
+        const cap = capability.capabilities || capability;
+        const c = cap.alwaysMatch || cap;
+        if (!isCloudCapability(c) && isAppiumCapability(c)) {
+          Object.assign(
+            capability,
+            DEFAULT_CONNECTION,
+            { path: this._args.basePath, port },
+            { ...capability }
+          );
+        }
+      }
+      return;
+    }
+    this._capabilities.forEach((cap) => {
+      const w3cCap = cap;
+      if (Object.values(cap).length > 0 && Object.values(cap).every((c) => typeof c === "object" && c.capabilities)) {
+        Object.values(cap).forEach(
+          (c) => {
+            const capability = c.capabilities.alwaysMatch || c.capabilities || c;
+            if (!isCloudCapability(capability) && isAppiumCapability(capability)) {
+              Object.assign(
+                c,
+                DEFAULT_CONNECTION,
+                { path: this._args.basePath, port },
+                { ...c }
+              );
+            }
+          }
+        );
+      } else if (!isCloudCapability(w3cCap.alwaysMatch || cap) && isAppiumCapability(w3cCap.alwaysMatch || cap)) {
+        Object.assign(
+          cap,
+          DEFAULT_CONNECTION,
+          { path: this._args.basePath, port },
+          { ...cap }
+        );
+      }
+    });
+  }
+  async onPrepare() {
+    if (Array.isArray(this._options.args)) {
+      throw new Error("Args should be an object");
+    }
+    this._args.port = typeof this._args.port === "number" ? this._args.port : await getPort({ port: DEFAULT_APPIUM_PORT });
+    this._setCapabilities(this._args.port);
+    this._appiumCliArgs.push(...formatCliArgs({ ...this._args }));
+    const command = await this._getCommand(this._options.command);
+    this._process = await this._startAppium(command, this._appiumCliArgs);
+    if (this._logPath) {
+      this._redirectLogStream(this._logPath);
+    }
+  }
+  onComplete() {
+    this._isShuttingDown = true;
+    if (this._process && this._process.pid) {
+      log.info("Killing entire Appium tree");
+      treeKill(this._process.pid, "SIGTERM", (err) => {
+        if (err) {
+          log.warn("Failed to kill process:", err);
+        } else {
+          log.info(
+            "Process and its children successfully terminated"
+          );
+        }
+      });
+    }
+  }
+  _startAppium(command, args, timeout = APPIUM_START_TIMEOUT) {
+    log.info(`Will spawn Appium process: ${command} ${args.join(" ")}`);
+    const process2 = spawn(command, args, { stdio: ["ignore", "pipe", "pipe"] });
+    let errorCaptured = false;
+    let timeoutId;
+    let error;
+    return new Promise((resolve3, reject) => {
+      let outputBuffer = "";
+      timeoutId = setTimeout(() => {
+        rejectOnce(new Error("Timeout: Appium did not start within expected time"));
+      }, timeout);
+      const rejectOnce = (err) => {
+        if (!errorCaptured) {
+          errorCaptured = true;
+          clearTimeout(timeoutId);
+          reject(err);
+        }
+      };
+      process2.stdout.on("data", (data) => {
+        outputBuffer += data.toString();
+        if (outputBuffer.includes("Appium REST http interface listener started")) {
+          outputBuffer = "";
+          log.info(`Appium started with ID: ${process2.pid}`);
+          clearTimeout(timeoutId);
+          resolve3(process2);
+        }
+      });
+      process2.stderr.once("data", (data) => {
+        error = data.toString() || "Appium exited without unknown error message";
+        log.error(error);
+        rejectOnce(new Error(error));
+      });
+      process2.once("exit", (exitCode) => {
+        if (this._isShuttingDown) {
+          return;
+        }
+        let errorMessage = `Appium exited before timeout (exit code: ${exitCode})`;
+        if (exitCode === 2) {
+          errorMessage += "\n" + (error?.toString() || "Check that you don't already have a running Appium service.");
+        } else if (errorCaptured) {
+          errorMessage += `
+${error?.toString()}`;
+        }
+        if (exitCode !== 0) {
+          log.error(errorMessage);
+        }
+        rejectOnce(new Error(errorMessage));
+      });
+    });
+  }
+  async _redirectLogStream(logPath) {
+    if (!this._process) {
+      throw Error("No Appium process to redirect log stream");
+    }
+    const logFile = getFilePath(logPath, DEFAULT_LOG_FILENAME);
+    await fsp.mkdir(path.dirname(logFile), { recursive: true });
+    log.debug(`Appium logs written to: ${logFile}`);
+    const logStream = fs.createWriteStream(logFile, { flags: "w" });
+    this._process.stdout.pipe(logStream);
+    this._process.stderr.pipe(logStream);
+  }
+  static async _getAppiumCommand(command = "appium") {
+    try {
+      const entryPath = await resolve2(command, import.meta.url);
+      return url.fileURLToPath(entryPath);
+    } catch (err) {
+      const errorMessage = "Appium is not installed locally. Please install via e.g. `npm i --save-dev appium`.\nIf you use globally installed appium please add: `appium: { command: 'appium' }`\nto your wdio.conf.js!\n\n" + err.stack;
+      log.error(errorMessage);
+      throw new SevereServiceError(errorMessage);
+    }
+  }
+};
+
+// src/index.ts
+var AppiumService = class {
+};
+var launcher = AppiumLauncher;
+export {
+  AppiumService as default,
+  launcher
+};

package/build/launcher.d.ts

@@ -8,7 +8,8 @@ export default class AppiumLauncher implements Services.ServiceInstance {
     private readonly _appiumCliArgs;
     private readonly _args;
     private _process?;
-    constructor(_options: AppiumServiceConfig, _capabilities: Capabilities.RemoteCapabilities, _config?: Options.Testrunner | undefined);
+    private _isShuttingDown;
+    constructor(_options: AppiumServiceConfig, _capabilities: Capabilities.TestrunnerCapabilities, _config?: Options.Testrunner | undefined);
     private _getCommand;
     /**
      * update capability connection options to connect

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAIlE,OAAO,KAAK,EAAyB,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAY5E,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,QAAQ,CAAC,eAAe;IAO/D,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO,CAAC;IARpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAe;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAA+C;gBAGpD,QAAQ,EAAE,mBAAmB,EAC7B,aAAa,EAAE,YAAY,CAAC,kBAAkB,EAC9C,OAAO,CAAC,gCAAoB;YAS1B,WAAW;IAqBzB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAkDlB,SAAS;IAgCf,UAAU;IAMV,OAAO,CAAC,YAAY;YAoEN,kBAAkB;mBAeX,iBAAiB;CAezC"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAIlE,OAAO,KAAK,EAAyB,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAY5E,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,QAAQ,CAAC,eAAe;IAQ/D,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO,CAAC;IATpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAe;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAA+C;IAChE,OAAO,CAAC,eAAe,CAAiB;gBAG5B,QAAQ,EAAE,mBAAmB,EAC7B,aAAa,EAAE,YAAY,CAAC,sBAAsB,EAClD,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,YAAA;YAS1B,WAAW;IAqBzB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAkDlB,SAAS;IAiCf,UAAU;IAiBV,OAAO,CAAC,YAAY;YAuEN,kBAAkB;mBAeX,iBAAiB;CAezC"}

package/build/types.d.ts

@@ -47,6 +47,11 @@ export type AppiumServerArguments = {
      * Send log output to the file
      */
     log?: string;
+    /**
+     * Log Filters
+     * A path to a valid JSON file containing an array of filtering rules
+     */
+    logFilters?: string;
     /**
      * Log level
      */

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAA;CAC/B;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAA;AAChE,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAA;CAC/B;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAA;AAChE,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/appium-service",
-  "version": "9.0.0-alpha.9+9220932b7",
+  "version": "9.0.1",
   "description": "A WebdriverIO service to start & stop Appium Server",
   "author": "Morten Bjerg Gregersen <morten@mogee.dk>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-appium-service",
@@ -28,22 +28,25 @@
   "type": "module",
   "types": "./build/index.d.ts",
   "exports": {
-    ".": "./build/index.js",
-    "./package.json": "./package.json"
+    ".": {
+      "import": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
   },
   "typeScriptVersion": "3.8.3",
   "dependencies": {
-    "@wdio/config": "9.0.0-alpha.9+9220932b7",
-    "@wdio/logger": "9.0.0-alpha.9+9220932b7",
-    "@wdio/types": "9.0.0-alpha.9+9220932b7",
-    "@wdio/utils": "9.0.0-alpha.9+9220932b7",
+    "@wdio/config": "9.0.0",
+    "@wdio/logger": "9.0.0",
+    "@wdio/types": "9.0.0",
+    "@wdio/utils": "9.0.0",
     "change-case": "^5.4.3",
     "get-port": "^7.0.0",
     "import-meta-resolve": "^4.0.0",
-    "webdriverio": "9.0.0-alpha.9+9220932b7"
+    "tree-kill": "^1.2.2",
+    "webdriverio": "9.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9220932b7048d9b5b6c8397dda54842625be7ef2"
+  "gitHead": "2a869e5661b2f867d00997c8a17ed0efee0fd15b"
 }

package/build/launcher.js

@@ -1,217 +0,0 @@
-import fs from 'node:fs';
-import fsp from 'node:fs/promises';
-import url from 'node:url';
-import path from 'node:path';
-import { spawn } from 'node:child_process';
-import logger from '@wdio/logger';
-import getPort from 'get-port';
-import { resolve } from 'import-meta-resolve';
-import { isCloudCapability } from '@wdio/config';
-import { SevereServiceError } from 'webdriverio';
-import { isAppiumCapability } from '@wdio/utils';
-import { getFilePath, formatCliArgs } from './utils.js';
-const log = logger('@wdio/appium-service');
-const DEFAULT_APPIUM_PORT = 4723;
-const DEFAULT_LOG_FILENAME = 'wdio-appium.log';
-const DEFAULT_CONNECTION = {
-    protocol: 'http',
-    hostname: '127.0.0.1',
-    path: '/'
-};
-const APPIUM_START_TIMEOUT = 30 * 1000;
-export default class AppiumLauncher {
-    _options;
-    _capabilities;
-    _config;
-    _logPath;
-    _appiumCliArgs = [];
-    _args;
-    _process;
-    constructor(_options, _capabilities, _config) {
-        this._options = _options;
-        this._capabilities = _capabilities;
-        this._config = _config;
-        this._args = {
-            basePath: DEFAULT_CONNECTION.path,
-            ...(this._options.args || {})
-        };
-        this._logPath = _options.logPath || this._config?.outputDir;
-    }
-    async _getCommand(command) {
-        /**
-         * Explicitly set node as command and appium
-         * module path as it's first argument if it's not defined
-         */
-        if (!command) {
-            command = 'node';
-            this._appiumCliArgs.unshift(await AppiumLauncher._getAppiumCommand());
-        }
-        /**
-         * Windows needs to be started through `cmd` and the command needs to be an arg
-         */
-        if (process.platform === 'win32') {
-            this._appiumCliArgs.unshift('/c', command);
-            command = 'cmd';
-        }
-        return command;
-    }
-    /**
-     * update capability connection options to connect
-     * to Appium server
-     */
-    _setCapabilities(port) {
-        /**
-         * Multiremote sessions
-         */
-        if (!Array.isArray(this._capabilities)) {
-            for (const [, capability] of Object.entries(this._capabilities)) {
-                const cap = capability.capabilities || capability;
-                const c = cap.alwaysMatch || cap;
-                if (!isCloudCapability(c) && isAppiumCapability(c)) {
-                    Object.assign(capability, DEFAULT_CONNECTION, { path: this._args.basePath, port }, { ...capability });
-                }
-            }
-            return;
-        }
-        this._capabilities.forEach((cap) => {
-            const w3cCap = cap;
-            /**
-             * Parallel Multiremote
-             */
-            if (Object.values(cap).length > 0 && Object.values(cap).every(c => typeof c === 'object' && c.capabilities)) {
-                Object.values(cap).forEach(c => {
-                    const capability = c.capabilities.alwaysMatch || c.capabilities || c;
-                    if (!isCloudCapability(capability) && isAppiumCapability(capability)) {
-                        Object.assign(c, DEFAULT_CONNECTION, { path: this._args.basePath, port }, { ...c });
-                    }
-                });
-            }
-            else if (!isCloudCapability(w3cCap.alwaysMatch || cap) && isAppiumCapability(w3cCap.alwaysMatch || cap)) {
-                Object.assign(cap, DEFAULT_CONNECTION, { path: this._args.basePath, port }, { ...cap });
-            }
-        });
-    }
-    async onPrepare() {
-        /**
-         * Throws an error if `this._options.args` is defined and is an array.
-         * @throws {Error} If `this._options.args` is an array.
-         */
-        if (Array.isArray(this._options.args)) {
-            throw new Error('Args should be an object');
-        }
-        /**
-         * Append remaining arguments
-         */
-        this._appiumCliArgs.push(...formatCliArgs(this._args));
-        /**
-         * Get port from service option or use a random port
-         */
-        const port = typeof this._args.port === 'number'
-            ? this._args.port
-            : await getPort({ port: DEFAULT_APPIUM_PORT });
-        this._setCapabilities(port);
-        /**
-         * start Appium
-         */
-        const command = await this._getCommand(this._options.command);
-        this._process = await this._startAppium(command, this._appiumCliArgs);
-        if (this._logPath) {
-            this._redirectLogStream(this._logPath);
-        }
-    }
-    onComplete() {
-        if (this._process) {
-            log.info(`Appium (pid: ${this._process.pid}) killed`);
-            this._process.kill();
-        }
-    }
-    _startAppium(command, args, timeout = APPIUM_START_TIMEOUT) {
-        log.info(`Will spawn Appium process: ${command} ${args.join(' ')}`);
-        const process = spawn(command, args, { stdio: ['ignore', 'pipe', 'pipe'] });
-        // just for validate the first error
-        let errorCaptured = false;
-        // to set a timeout for the promise
-        let timeoutId;
-        // to store the first error message
-        let error;
-        return new Promise((resolve, reject) => {
-            let outputBuffer = '';
-            /**
-             * set timeout for promise. If Appium does not start within given timeout,
-             * e.g. if the port is already in use, reject the promise.
-             */
-            timeoutId = setTimeout(() => {
-                rejectOnce(new Error('Timeout: Appium did not start within expected time'));
-            }, timeout);
-            /**
-             * reject promise if Appium does not start within given timeout,
-             * e.g. if the port is already in use
-             *
-             * @param err - error to reject with
-             */
-            const rejectOnce = (err) => {
-                if (!errorCaptured) {
-                    errorCaptured = true;
-                    clearTimeout(timeoutId);
-                    reject(err);
-                }
-            };
-            process.stdout.on('data', (data) => {
-                outputBuffer += data.toString();
-                if (outputBuffer.includes('Appium REST http interface listener started')) {
-                    outputBuffer = '';
-                    log.info(`Appium started with ID: ${process.pid}`);
-                    clearTimeout(timeoutId);
-                    resolve(process);
-                }
-            });
-            /**
-             * only capture first error to print it in case Appium failed to start.
-             */
-            process.stderr.once('data', (data) => {
-                error = data.toString() || 'Appium exited without unknown error message';
-                log.error(error);
-                rejectOnce(new Error(error));
-            });
-            process.once('exit', (exitCode) => {
-                let errorMessage = `Appium exited before timeout (exit code: ${exitCode})`;
-                if (exitCode === 2) {
-                    errorMessage += '\n' + (error?.toString() || 'Check that you don\'t already have a running Appium service.');
-                }
-                else if (errorCaptured) {
-                    errorMessage += `\n${error?.toString()}`;
-                }
-                if (exitCode !== 0) {
-                    log.error(errorMessage);
-                }
-                rejectOnce(new Error(errorMessage));
-            });
-        });
-    }
-    async _redirectLogStream(logPath) {
-        if (!this._process) {
-            throw Error('No Appium process to redirect log stream');
-        }
-        const logFile = getFilePath(logPath, DEFAULT_LOG_FILENAME);
-        // ensure file & directory exists
-        await fsp.mkdir(path.dirname(logFile), { recursive: true });
-        log.debug(`Appium logs written to: ${logFile}`);
-        const logStream = fs.createWriteStream(logFile, { flags: 'w' });
-        this._process.stdout.pipe(logStream);
-        this._process.stderr.pipe(logStream);
-    }
-    static async _getAppiumCommand(command = 'appium') {
-        try {
-            const entryPath = await resolve(command, import.meta.url);
-            return url.fileURLToPath(entryPath);
-        }
-        catch (err) {
-            const errorMessage = ('Appium is not installed locally. Please install via e.g. `npm i --save-dev appium`.\n' +
-                'If you use globally installed appium please add: `appium: { command: \'appium\' }`\n' +
-                'to your wdio.conf.js!\n\n' +
-                err.stack);
-            log.error(errorMessage);
-            throw new SevereServiceError(errorMessage);
-        }
-    }
-}

package/build/types.js

@@ -1 +0,0 @@
-export {};

package/build/utils.js

@@ -1,42 +0,0 @@
-import { basename, join, resolve } from 'node:path';
-import { kebabCase } from 'change-case';
-const FILE_EXTENSION_REGEX = /\.[0-9a-z]+$/i;
-/**
- * Resolves the given path into a absolute path and appends the default filename as fallback when the provided path is a directory.
- * @param  {string} filePath         relative file or directory path
- * @param  {string} defaultFilename default file name when filePath is a directory
- * @return {String}                 absolute file path
- */
-export function getFilePath(filePath, defaultFilename) {
-    let absolutePath = resolve(filePath);
-    // test if we already have a file (e.g. selenium.txt, .log, log.txt, etc.)
-    // NOTE: path.extname doesn't work to detect a file, cause dotfiles are reported by node to have no extension
-    if (!FILE_EXTENSION_REGEX.test(basename(absolutePath))) {
-        absolutePath = join(absolutePath, defaultFilename);
-    }
-    return absolutePath;
-}
-export function formatCliArgs(args) {
-    const cliArgs = [];
-    for (const key in args) {
-        const value = args[key];
-        // If the value is false or null the argument is discarded
-        if ((typeof value === 'boolean' && !value) || value === null) {
-            continue;
-        }
-        cliArgs.push(`--${kebabCase(key)}`);
-        // Only non-boolean and non-null values are added as option values
-        if (typeof value !== 'boolean') {
-            cliArgs.push(sanitizeCliOptionValue(value));
-        }
-    }
-    return cliArgs;
-}
-export function sanitizeCliOptionValue(value) {
-    const valueString = typeof value === 'object' ? JSON.stringify(value) : String(value);
-    // Encapsulate the value string in single quotes if it contains a white space
-    return /\s/.test(valueString) ? `'${valueString}'` : valueString;
-}
-export function isWindows() {
-    return process.platform === 'win32';
-}