appium 3.0.0 → 3.0.2

package/lib/cli/extension-command.js

@@ -927,33 +927,33 @@ class ExtensionCliCommand {
         this.log.ok(`${scriptName} successfully ran`.green);
         return {output: output.getBuff()};
       } catch (err) {
-        this.log.error(`Encountered an error when running '${scriptName}': ${err.message}`.red);
-        return {error: err.message, output: output.getBuff()};
+        const message = `Encountered an error when running '${scriptName}': ${err.message}`;
+        throw this._createFatalError(message);
       }
     }
 
     try {
       await new B((resolve, reject) => {
         this._runUnbuffered(moduleRoot, scriptPath, extraArgs)
-          .on('error', (err) => {
+          .once('error', (err) => {
             // generally this is of the "I can't find the script" variety.
             // this is a developer bug: the extension is pointing to a script that is not where the
             // developer said it would be (in `appium.scripts` of the extension's `package.json`)
             reject(err);
           })
-          .on('close', (code) => {
+          .once('close', (code) => {
             if (code === 0) {
               resolve();
             } else {
-              reject(new Error(`Script "${scriptName}" exited with code ${code}`));
+              reject(new Error(`Script exited with code ${code}`));
             }
           });
       });
       this.log.ok(`${scriptName} successfully ran`.green);
       return {};
     } catch (err) {
-      this.log.error(`Encountered an error when running '${scriptName}': ${err.message}`.red);
-      return {error: err.message};
+      const message = `Encountered an error when running '${scriptName}': ${err.message}`;
+      throw this._createFatalError(message);
     }
   }
 }
@@ -1079,7 +1079,6 @@ export {ExtensionCliCommand as ExtensionCommand};
  * Return value of {@linkcode ExtensionCliCommand._run}
  *
  * @typedef RunOutput
- * @property {string} [error] - error message if script ran unsuccessfully, otherwise undefined
  * @property {string[]} [output] - script output if `bufferOutput` was `true` in {@linkcode RunOptions}
  */
 

package/lib/cli/plugin-command.js

@@ -52,9 +52,11 @@ export default class PluginCliCommand extends ExtensionCliCommand {
   }
 
   /**
+   * Run a script from a plugin
    *
    * @param {PluginRunOptions} opts
    * @returns {Promise<import('./extension-command').RunOutput>}
+   * @throws {Error} if the script fails to run
    */
   async run({plugin, scriptName, extraArgs}) {
     return await super._run({

package/lib/cli/utils.js

@@ -59,12 +59,29 @@ export class RingBuffer {
     this.size = size;
     this.buffer = [];
   }
+
+  /**
+   * Get the current buffer contents
+   *
+   * @returns {any[]}
+   */
   getBuff() {
     return this.buffer;
   }
+
+  /**
+   * Remove the oldest item from the buffer
+   *
+   * @returns {void}
+   */
   dequeue() {
     this.buffer.shift();
   }
+  /**
+   * Add an item to the buffer
+   *
+   * @param {any} item
+   */
   enqueue(item) {
     if (this.buffer.length >= this.size) {
       this.dequeue();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -60,13 +60,13 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^10.0.0",
-    "@appium/base-plugin": "^3.0.0",
-    "@appium/docutils": "^2.0.0",
-    "@appium/logger": "^2.0.0",
+    "@appium/base-driver": "^10.0.1",
+    "@appium/base-plugin": "^3.0.2",
+    "@appium/docutils": "^2.1.0",
+    "@appium/logger": "^2.0.1",
     "@appium/schema": "^1.0.0",
-    "@appium/support": "^7.0.0",
-    "@appium/types": "^1.0.0",
+    "@appium/support": "^7.0.1",
+    "@appium/types": "^1.0.1",
     "@sidvind/better-ajv-errors": "4.0.0",
     "ajv": "8.17.1",
     "ajv-formats": "3.0.1",
@@ -77,13 +77,13 @@
     "bluebird": "3.7.2",
     "lilconfig": "3.1.3",
     "lodash": "4.17.21",
-    "lru-cache": "11.1.0",
+    "lru-cache": "11.2.1",
     "ora": "5.4.1",
     "package-changed": "3.0.0",
     "resolve-from": "5.0.0",
     "semver": "7.7.2",
     "source-map-support": "0.5.21",
-    "teen_process": "3.0.0",
+    "teen_process": "3.0.1",
     "type-fest": "4.41.0",
     "winston": "3.17.0",
     "wrap-ansi": "7.0.0",
@@ -97,5 +97,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "284da50353921343fa5a7f82574e64ce0c146db7"
+  "gitHead": "606e4c1f58fa68d96c04be4313ccab86ccd48361"
 }