@appium/support 2.59.5 → 2.61.0

package/lib/fs.js

@@ -25,6 +25,7 @@ import sanitize from 'sanitize-filename';
 import which from 'which';
 import log from './logger';
 import Timer from './timing';
+import {isWindows} from './system';
 import {pluralize} from './util';
 
 const ncpAsync =
@@ -36,13 +37,38 @@ const findRootCached = _.memoize(pkgDir.sync);
 const fs = {
   /**
    * Resolves `true` if `path` is _readable_, which differs from Node.js' default behavior of "can we see it?"
-   * @param {import('fs').PathLike} path
+   *
+   * On Windows, ACLs are not supported, so this becomes a simple check for existence.
+   *
+   * This function will never reject.
+   * @param {PathLike} path
    * @returns {Promise<boolean>}
    */
   async hasAccess(path) {
     try {
       await fsPromises.access(path, constants.R_OK);
-    } catch (err) {
+    } catch {
+      return false;
+    }
+    return true;
+  },
+
+  /**
+   * Resolves `true` if `path` is executable; `false` otherwise.
+   *
+   * On Windows, this function delegates to {@linkcode fs.hasAccess}.
+   *
+   * This function will never reject.
+   * @param {PathLike} path
+   * @returns {Promise<boolean>}
+   */
+  async isExecutable(path) {
+    try {
+      if (isWindows()) {
+        return await fs.hasAccess(path);
+      }
+      await fsPromises.access(path, constants.R_OK | constants.X_OK);
+    } catch {
       return false;
     }
     return true;
@@ -50,7 +76,7 @@ const fs = {
 
   /**
    * Alias for {@linkcode fs.hasAccess}
-   * @param {import('fs').PathLike} path
+   * @param {PathLike} path
    */
   async exists(path) {
     return await fs.hasAccess(path);
@@ -104,7 +130,7 @@ const fs = {
 
   /**
    * Create an MD5 hash of a file.
-   * @param {import('fs').PathLike} filePath
+   * @param {PathLike} filePath
    * @returns {Promise<string>}
    */
   async md5(filePath) {
@@ -136,7 +162,7 @@ const fs = {
 
   /**
    * Create a hex digest of some file at `filePath`
-   * @param {import('fs').PathLike} filePath
+   * @param {PathLike} filePath
    * @param {string} [algorithm]
    * @returns {Promise<string>}
    */
@@ -170,7 +196,7 @@ const fs = {
 
   /**
    * Recursively create a directory.
-   * @param {import('fs').PathLike} dir
+   * @param {PathLike} dir
    * @returns {Promise<string|undefined>}
    */
   async mkdirp(dir) {
@@ -305,7 +331,7 @@ const fs = {
   /**
    * Warning: this is a promisified {@linkcode open fs.open}.
    * It resolves w/a file descriptor instead of a {@linkcode fsPromises.FileHandle FileHandle} object, as {@linkcode fsPromises.open} does. Use {@linkcode fs.openFile} if you want a `FileHandle`.
-   * @type {(path: import('fs').PathLike, flags: import('fs').OpenMode, mode?: import('fs').Mode) => Promise<number>}
+   * @type {(path: PathLike, flags: import('fs').OpenMode, mode?: import('fs').Mode) => Promise<number>}
    */
   open: B.promisify(open),
   openFile: fsPromises.open,
@@ -362,4 +388,5 @@ export default fs;
 /**
  * @typedef {import('glob')} glob
  * @typedef {import('mv')} mv
+ * @typedef {import('fs').PathLike} PathLike
  */

package/lib/node.js

@@ -3,6 +3,7 @@ import log from './logger';
 import _ from 'lodash';
 import {exec} from 'teen_process';
 import path from 'path';
+import _fs from 'fs';
 import {v4 as uuidV4} from 'uuid';
 
 const ECMA_SIZES = Object.freeze({
@@ -200,4 +201,30 @@ function deepFreeze(object) {
   return Object.freeze(object);
 }
 
-export {requirePackage, getObjectSize, getObjectId, deepFreeze};
+/**
+ * Tries to synchronously detect the absolute path to the folder
+ * where the given `moduleName` is located.
+ *
+ * @param {string} moduleName The name of the module as it is written in package.json
+ * @param {string} filePath Full path to any of files that `moduleName` contains. Use
+ * `__filename` to find the root of the module where this helper is called.
+ * @returns {string?} Full path to the module root
+ */
+function getModuleRootSync (moduleName, filePath) {
+  let currentDir = path.dirname(path.resolve(filePath));
+  let isAtFsRoot = false;
+  while (!isAtFsRoot) {
+    const manifestPath = path.join(currentDir, 'package.json');
+    try {
+      if (_fs.existsSync(manifestPath) &&
+          JSON.parse(_fs.readFileSync(manifestPath, 'utf8')).name === moduleName) {
+        return currentDir;
+      }
+    } catch (ign) {}
+    currentDir = path.dirname(currentDir);
+    isAtFsRoot = currentDir.length <= path.dirname(currentDir).length;
+  }
+  return null;
+}
+
+export {requirePackage, getObjectSize, getObjectId, deepFreeze, getModuleRootSync};

package/lib/npm.js

@@ -92,29 +92,47 @@ export class NPM {
   /**
    * @param {string} cwd
    * @param {string} pkg
+   * @returns {Promise<string?>}
    */
   async getLatestVersion(cwd, pkg) {
-    return (
-      await this.exec('view', [pkg, 'dist-tags'], {
-        json: true,
-        cwd,
-      })
-    ).json?.latest;
+    try {
+      return (
+        (
+          await this.exec('view', [pkg, 'dist-tags'], {
+            json: true,
+            cwd,
+          })
+        ).json?.latest ?? null
+      );
+    } catch (err) {
+      if (!err?.message.includes('E404')) {
+        throw err;
+      }
+      return null;
+    }
   }
 
   /**
    * @param {string} cwd
    * @param {string} pkg
    * @param {string} curVersion
+   * @returns {Promise<string?>}
    */
   async getLatestSafeUpgradeVersion(cwd, pkg, curVersion) {
-    const allVersions = (
-      await this.exec('view', [pkg, 'versions'], {
-        json: true,
-        cwd,
-      })
-    ).json;
-    return this.getLatestSafeUpgradeFromVersions(curVersion, allVersions);
+    try {
+      const allVersions = (
+        await this.exec('view', [pkg, 'versions'], {
+          json: true,
+          cwd,
+        })
+      ).json;
+      return this.getLatestSafeUpgradeFromVersions(curVersion, allVersions);
+    } catch (err) {
+      if (!err?.message.includes('E404')) {
+        throw err;
+      }
+      return null;
+    }
   }
 
   /**
@@ -193,20 +211,13 @@ export class NPM {
       }
     }
 
-    /**
-     * If we've found a `package.json` containined the `appiumCreated` property,
-     * then we can do whatever we please with it, since we created it.  This is
-     * likely when `APPIUM_HOME` is the default (in `~/.appium`).  In that case,
-     * we want `--global-style` to avoid deduping, and we also do not need a
-     * `package-lock.json`.
-     *
-     * If we _haven't_ found such a key, then this `package.json` isn't a
-     * "dummy" and is controlled by the user.  So we'll just add it as a dev
-     * dep; whatever else it does is up to the user's npm config.
-     */
-    const installOpts = (await hasAppiumDependency(cwd))
-      ? ['--save-dev']
-      : ['--save-dev', '--save-exact', '--global-style', '--no-package-lock'];
+    const installOpts = ['--save-dev'];
+    if (!(await hasAppiumDependency(cwd))) {
+      if (process.env.APPIUM_OMIT_PEER_DEPS) {
+        installOpts.push('--omit=peer');
+      }
+      installOpts.push('--save-exact', '--global-style', '--no-package-lock');
+    }
 
     const res = await this.exec(
       'install',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/support",
-  "version": "2.59.5",
+  "version": "2.61.0",
   "description": "Support libs used across appium packages",
   "keywords": [
     "automation",
@@ -44,13 +44,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/types": "^0.4.0",
-    "@babel/runtime": "7.18.9",
+    "@appium/types": "^0.5.0",
     "@colors/colors": "1.5.0",
     "@types/archiver": "5.3.1",
     "@types/base64-stream": "1.0.2",
     "@types/find-root": "1.1.2",
-    "@types/glob": "7.2.0",
+    "@types/glob": "8.0.0",
     "@types/jsftp": "2.1.2",
     "@types/klaw": "3.0.3",
     "@types/lockfile": "1.0.2",
@@ -60,7 +59,7 @@
     "@types/pluralize": "0.0.29",
     "@types/pngjs": "6.0.1",
     "@types/rimraf": "3.0.2",
-    "@types/semver": "7.3.10",
+    "@types/semver": "7.3.12",
     "@types/shell-quote": "1.7.1",
     "@types/supports-color": "8.1.1",
     "@types/teen_process": "1.16.1",
@@ -74,7 +73,7 @@
     "form-data": "4.0.0",
     "get-stream": "6.0.1",
     "glob": "8.0.3",
-    "jimp": "0.16.1",
+    "jimp": "0.16.2",
     "jsftp": "2.1.3",
     "klaw": "3.0.0",
     "lockfile": "1.0.4",
@@ -93,12 +92,12 @@
     "resolve-from": "5.0.0",
     "rimraf": "3.0.2",
     "sanitize-filename": "1.6.3",
-    "semver": "7.3.7",
+    "semver": "7.3.8",
     "shell-quote": "1.7.3",
     "source-map-support": "0.5.21",
     "supports-color": "8.1.1",
-    "teen_process": "1.16.0",
-    "type-fest": "2.18.0",
+    "teen_process": "2.0.2",
+    "type-fest": "3.1.0",
     "uuid": "8.3.2",
     "which": "2.0.2",
     "yauzl": "2.10.0"
@@ -110,5 +109,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c58f32441daba3aae9768a57d0a412fe92f4b587"
+  "gitHead": "f545a6cde58d83f3289072f8957468793947ba66"
 }