@appium/support 2.61.1 → 3.0.1

package/lib/log-internal.js

@@ -3,6 +3,15 @@ import _ from 'lodash';
 
 const DEFAULT_REPLACER = '**SECURE**';
 
+/**
+ * Type guard for log filter type
+ * @param {object} value
+ * @returns {value is import('@appium/types').LogFilterRegex}
+ */
+function isLogFilterRegex(value) {
+  return 'pattern' in value;
+}
+
 class SecureValuesPreprocessor {
   constructor() {
     this._rules = [];
@@ -19,7 +28,7 @@ class SecureValuesPreprocessor {
   /**
    * Parses single rule from the given JSON file
    *
-   * @param {string|Rule} rule The rule might either be represented as a single string
+   * @param {string|import('@appium/types').LogFilter} rule The rule might either be represented as a single string
    * or a configuration object
    * @throws {Error} If there was an error while parsing the rule
    * @returns {SecureValuePreprocessingRule} The parsed rule
@@ -34,7 +43,7 @@ class SecureValuesPreprocessor {
       }
       pattern = `\\b${_.escapeRegExp(rule)}\\b`;
     } else if (_.isPlainObject(rule)) {
-      if (_.has(rule, 'pattern')) {
+      if (isLogFilterRegex(rule)) {
         if (!_.isString(rule.pattern) || rule.pattern.length === 0) {
           throw new Error(
             `${JSON.stringify(rule)} -> The value of 'pattern' must be a valid non-empty string`
@@ -81,7 +90,7 @@ class SecureValuesPreprocessor {
   /**
    * Loads rules from the given JSON file
    *
-   * @param {string|string[]|Rule[]} source The full path to the JSON file containing secure
+   * @param {string|string[]|import('@appium/types').LogFiltersConfig} source The full path to the JSON file containing secure
    * values replacement rules or the rules themselves represented as an array
    * @throws {Error} If the format of the source file is invalid or
    * it does not exist
@@ -144,19 +153,6 @@ const SECURE_VALUES_PREPROCESSOR = new SecureValuesPreprocessor();
 export {SECURE_VALUES_PREPROCESSOR, SecureValuesPreprocessor};
 export default SECURE_VALUES_PREPROCESSOR;
 
-/**
- * @typedef Rule
- * @property {string} pattern A valid RegExp pattern to be replaced
- * @property {string} text A text match to replace. Either this property or the
- * above one must be provided. `pattern` has priority over `text` if both are provided.
- * @property {string} [flags] Regular expression flags for the given pattern.
- * Supported flag are the same as for the standard JavaScript RegExp constructor:
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Advanced_searching_with_flags_2
- * The 'g' (global matching) is always enabled though.
- * @property {string} [replacer] The replacer value to use. By default
- * equals to `DEFAULT_SECURE_REPLACER`
- */
-
 /**
  * @typedef SecureValuePreprocessingRule
  * @property {RegExp} pattern The parsed pattern which is going to be used for replacement

package/lib/logging.js

@@ -137,10 +137,9 @@ function getLogger(prefix = null) {
  * appear in Appium logs.
  * Each call to this method replaces the previously loaded rules if any existed.
  *
- * @param {string|string[]|import('./log-internal').Rule[]} rulesJsonPath The full path to the JSON file containing
+ * @param {string|string[]|import('@appium/types').LogFiltersConfig} rulesJsonPath The full path to the JSON file containing
  * the replacement rules. Each rule could either be a string to be replaced
- * or an object with predefined properties. See the `Rule` type definition in
- * `log-internals.js` to get more details on its format.
+ * or an object with predefined properties.
  * @throws {Error} If the given file cannot be loaded
  * @returns {Promise<LoadResult>}
  */

package/lib/net.js

@@ -10,19 +10,28 @@ import FormData from 'form-data';
 
 const DEFAULT_TIMEOUT_MS = 4 * 60 * 1000;
 
+/**
+ * Type guard for param to {@linkcode toAxiosAuth}
+ * @param {any} value
+ * @returns {value is AuthCredentials | import('axios').AxiosBasicCredentials}
+ */
+function isAxiosAuth(value) {
+  return _.isPlainObject(value);
+}
+
 /**
  * Converts {@linkcode AuthCredentials} to credentials understood by {@linkcode axios}.
  * @param {AuthCredentials | import('axios').AxiosBasicCredentials} [auth]
  * @returns {import('axios').AxiosBasicCredentials?}
  */
 function toAxiosAuth(auth) {
-  if (!_.isPlainObject(auth)) {
+  if (!isAxiosAuth(auth)) {
     return null;
   }
 
   const axiosAuth = {
-    username: _.get(auth, 'username', _.get(auth, 'user')),
-    password: _.get(auth, 'password', _.get(auth, 'pass')),
+    username: 'username' in auth ? auth.username : auth.user,
+    password: 'password' in auth ? auth.password : auth.pass,
   };
   return axiosAuth.username && axiosAuth.password ? axiosAuth : null;
 }
@@ -136,7 +145,7 @@ async function uploadFileToFtp(
  */
 function isHttpUploadOptions(opts, url) {
   try {
-    const {protocol} = new URL(url);
+    const {protocol} = url;
     return protocol === 'http:' || protocol === 'https:';
   } catch {
     return false;
@@ -151,7 +160,7 @@ function isHttpUploadOptions(opts, url) {
  */
 function isNotHttpUploadOptions(opts, url) {
   try {
-    const {protocol} = new URL(url);
+    const {protocol} = url;
     return protocol === 'ftp:';
   } catch {
     return false;
@@ -243,7 +252,7 @@ async function downloadFile(
   try {
     const writer = fs.createWriteStream(dstPath);
     const {data: responseStream, headers: responseHeaders} = await axios(requestOpts);
-    responseLength = parseInt(responseHeaders['content-length'], 10);
+    responseLength = parseInt(responseHeaders['content-length'] || '0', 10);
     responseStream.pipe(writer);
 
     await new B((resolve, reject) => {

package/lib/npm.js

@@ -41,13 +41,13 @@ export class NPM {
    * @param {string} cmd
    * @param {string[]} args
    * @param {ExecOpts} opts
-   * @param {Omit<import('teen_process').ExecOptions, 'cwd'>} [execOpts]
+   * @param {Omit<TeenProcessExecOptions, 'cwd'>} [execOpts]
    */
   async exec(cmd, args, opts, execOpts = {}) {
     let {cwd, json, lockFile} = opts;
 
     // make sure we perform the current operation in cwd
-    /** @type {import('teen_process').ExecOptions} */
+    /** @type {TeenProcessExecOptions} */
     const teenProcessExecOpts = {...execOpts, cwd};
 
     args.unshift(cmd);
@@ -62,7 +62,7 @@ export class NPM {
       runner = async () => await acquireLock(_runner);
     }
 
-    /** @type {import('teen_process').ExecResult<string> & {json?: any}} */
+    /** @type {import('teen_process').TeenProcessExecResult<string> & {json?: any}} */
     let ret;
     try {
       const {stdout, stderr, code} = await runner();
@@ -156,14 +156,14 @@ export class NPM {
    */
   getLatestSafeUpgradeFromVersions(curVersion, allVersions) {
     let safeUpgradeVer = null;
-    const curSemver = semver.parse(curVersion);
+    const curSemver = semver.parse(curVersion) ?? semver.parse(semver.coerce(curVersion));
     if (curSemver === null) {
       throw new Error(`Could not parse current version '${curVersion}'`);
     }
     for (const testVer of allVersions) {
-      const testSemver = semver.parse(testVer);
+      const testSemver = semver.parse(testVer) ?? semver.parse(semver.coerce(testVer));
       if (testSemver === null) {
-        throw new Error(`Could not parse version to test against: '${testVer}'`);
+        continue;
       }
       // if the test version is a prerelease, ignore it
       if (testSemver.prerelease.length > 0) {
@@ -194,9 +194,9 @@ export class NPM {
    * @param {string} cwd
    * @param {string} pkgName
    * @param {InstallPackageOpts} [opts]
-   * @returns {Promise<import('type-fest').PackageJson>}
+   * @returns {Promise<NpmInstallReceipt>}
    */
-  async installPackage(cwd, pkgName, {pkgVer} = {}) {
+  async installPackage(cwd, pkgName, {pkgVer, installType}) {
     /** @type {any} */
     let dummyPkgJson;
     const dummyPkgPath = path.join(cwd, 'package.json');
@@ -219,15 +219,12 @@ export class NPM {
       installOpts.push('--save-exact', '--global-style', '--no-package-lock');
     }
 
-    const res = await this.exec(
-      'install',
-      [...installOpts, pkgVer ? `${pkgName}@${pkgVer}` : pkgName],
-      {
-        cwd,
-        json: true,
-        lockFile: this._getInstallLockfilePath(cwd),
-      }
-    );
+    const cmd = installType === 'local' ? 'link' : 'install';
+    const res = await this.exec(cmd, [...installOpts, pkgVer ? `${pkgName}@${pkgVer}` : pkgName], {
+      cwd,
+      json: true,
+      lockFile: this._getInstallLockfilePath(cwd),
+    });
 
     if (res.json) {
       // we parsed a valid json response, so if we got an error here, return that
@@ -243,7 +240,9 @@ export class NPM {
     // (even on Windows!)
     const pkgJsonPath = resolveFrom(cwd, `${pkgName}/package.json`);
     try {
-      return require(pkgJsonPath);
+      const pkgJson = await fs.readFile(pkgJsonPath, 'utf8');
+      const pkg = JSON.parse(pkgJson);
+      return {installPath: path.dirname(pkgJsonPath), pkg};
     } catch {
       throw new Error(
         'The package was not downloaded correctly; its package.json ' +
@@ -270,6 +269,7 @@ export const npm = new NPM();
 /**
  * Options for {@link NPM.installPackage}
  * @typedef InstallPackageOpts
+ * @property {import('type-fest').LiteralUnion<'local', string>} [installType] - whether to install from a local path or from npm
  * @property {string} [pkgVer] - the version of the package to install
  */
 
@@ -280,3 +280,13 @@ export const npm = new NPM();
  * @property {boolean} [json] - If `true`, supply `--json` flag to npm and resolve w/ parsed JSON
  * @property {string} [lockFile] - Path to lockfile to use
  */
+
+/**
+ * @typedef {import('teen_process').TeenProcessExecOptions} TeenProcessExecOptions
+ */
+
+/**
+ * @typedef NpmInstallReceipt
+ * @property {string} installPath - Path to installed package
+ * @property {import('type-fest').PackageJson} pkg - Package data
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/support",
-  "version": "2.61.1",
+  "version": "3.0.1",
   "description": "Support libs used across appium packages",
   "keywords": [
     "automation",
@@ -33,18 +33,13 @@
     "build"
   ],
   "scripts": {
-    "build": "babel lib --root-mode=upward --out-dir=build/lib",
-    "dev": "npm run build -- --watch",
-    "fix": "npm run lint -- --fix",
-    "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
-    "prepare": "npm run build",
     "test": "npm run test:unit",
-    "test:e2e": "mocha --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
+    "test:e2e": "mocha -p --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
     "test:smoke": "node ./index.js",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/types": "^0.5.0",
+    "@appium/types": "^0.7.0",
     "@colors/colors": "1.5.0",
     "@types/archiver": "5.3.1",
     "@types/base64-stream": "1.0.2",
@@ -59,13 +54,13 @@
     "@types/pluralize": "0.0.29",
     "@types/pngjs": "6.0.1",
     "@types/rimraf": "3.0.2",
-    "@types/semver": "7.3.12",
+    "@types/semver": "7.3.13",
     "@types/shell-quote": "1.7.1",
     "@types/supports-color": "8.1.1",
-    "@types/teen_process": "1.16.1",
-    "@types/uuid": "8.3.4",
+    "@types/teen_process": "2.0.0",
+    "@types/uuid": "9.0.0",
     "archiver": "5.3.1",
-    "axios": "0.27.2",
+    "axios": "1.2.1",
     "base64-stream": "1.0.0",
     "bluebird": "3.7.2",
     "bplist-creator": "0.1.1",
@@ -75,14 +70,14 @@
     "glob": "8.0.3",
     "jimp": "0.16.2",
     "jsftp": "2.1.3",
-    "klaw": "3.0.0",
+    "klaw": "4.0.1",
     "lockfile": "1.0.4",
     "lodash": "4.17.21",
     "log-symbols": "4.1.0",
     "moment": "2.29.4",
     "mv": "2.1.1",
     "ncp": "2.0.0",
-    "npmlog": "6.0.2",
+    "npmlog": "7.0.1",
     "opencv-bindings": "4.5.5",
     "pkg-dir": "5.0.0",
     "plist": "3.0.6",
@@ -97,17 +92,23 @@
     "source-map-support": "0.5.21",
     "supports-color": "8.1.1",
     "teen_process": "2.0.2",
-    "type-fest": "3.1.0",
-    "uuid": "8.3.2",
-    "which": "2.0.2",
+    "type-fest": "3.4.0",
+    "uuid": "9.0.0",
+    "which": "3.0.0",
     "yauzl": "2.10.0"
   },
   "engines": {
-    "node": ">=14",
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
     "npm": ">=8"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6b3cc1a8743f78c1f50320364f25f3011d2b2136"
+  "gitHead": "2e76ba9607729f59ca967e47c2cba738e90a57b8",
+  "typedoc": {
+    "entryPoint": "./build/lib/index.js"
+  },
+  "overrides": {
+    "jpeg-js": "0.4.4"
+  }
 }