@wdio/appium-service 8.29.1 → 8.29.3

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;AAW5E,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;IAgDlB,SAAS;IAgCf,UAAU;IAOV,OAAO,CAAC,YAAY;YAiCN,kBAAkB;mBAeX,iBAAiB;CAezC"}
+{"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;IAgDlB,SAAS;IAgCf,UAAU;IAMV,OAAO,CAAC,YAAY;YAmEN,kBAAkB;mBAeX,iBAAiB;CAezC"}

package/build/launcher.js

@@ -18,6 +18,7 @@ const DEFAULT_CONNECTION = {
     hostname: '127.0.0.1',
     path: '/'
 };
+const APPIUM_START_TIMEOUT = 30 * 1000;
 export default class AppiumLauncher {
     _options;
     _capabilities;
@@ -122,33 +123,65 @@ export default class AppiumLauncher {
             this._process.kill();
         }
     }
-    _startAppium(command, args) {
+    _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) => {
-                if (data.includes('Appium REST http interface listener started')) {
+                outputBuffer += data.toString();
+                if (outputBuffer.includes('Appium REST http interface listener started')) {
                     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', (err) => { error = err; });
-            process.once('exit', exitCode => {
+            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 (error) {
-                    errorMessage += `\n${error.toString()}`;
+                else if (errorCaptured) {
+                    errorMessage += `\n${error?.toString()}`;
                 }
                 if (exitCode !== 0) {
                     log.error(errorMessage);
                 }
-                reject(new Error(errorMessage));
+                rejectOnce(new Error(errorMessage));
             });
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/appium-service",
-  "version": "8.29.1",
+  "version": "8.29.3",
   "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",
@@ -33,17 +33,17 @@
   },
   "typeScriptVersion": "3.8.3",
   "dependencies": {
-    "@wdio/config": "8.29.1",
+    "@wdio/config": "8.29.3",
     "@wdio/logger": "8.28.0",
     "@wdio/types": "8.29.1",
-    "@wdio/utils": "8.29.1",
+    "@wdio/utils": "8.29.3",
     "get-port": "^7.0.0",
     "import-meta-resolve": "^4.0.0",
     "param-case": "^3.0.4",
-    "webdriverio": "8.29.1"
+    "webdriverio": "8.29.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d434fcf0aaaa9d835789c4c335d319f94a899687"
+  "gitHead": "4c6433be548950dc6ccf0efff77507dfa2f0b321"
 }