appium-espresso-driver 7.1.2 → 7.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [7.2.0](https://github.com/appium/appium-espresso-driver/compare/v7.1.2...v7.2.0) (2026-04-08)
+
+### Features
+
+* Migrate scripts to mjs/ESM format ([#1149](https://github.com/appium/appium-espresso-driver/issues/1149)) ([cffd424](https://github.com/appium/appium-espresso-driver/commit/cffd424917938f83beaea2752ccd9fd73ab67d3f))
+
 ## [7.1.2](https://github.com/appium/appium-espresso-driver/compare/v7.1.1...v7.1.2) (2026-04-08)
 
 ### Miscellaneous Chores

package/espresso-server/library/src/main/java/io/appium/espressoserver/lib/helpers/Version.kt

@@ -2,6 +2,6 @@ package io.appium.espressoserver.lib.helpers
 
 // This value is updated automatically by the NPM versioning script
 // It should be in sync with the NPM module version from package.json
-private const val VERSION = "7.1.2"
+private const val VERSION = "7.2.0"
 
 fun getEspressoServerVersion() = VERSION

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-espresso-driver",
-  "version": "7.1.2",
+  "version": "7.2.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-espresso-driver",
-      "version": "7.1.2",
+      "version": "7.2.0",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^14.0.0",
@@ -14,6 +14,7 @@
         "asyncbox": "^6.1.0",
         "axios": "^1.12.2",
         "bluebird": "^3.5.0",
+        "commander": "^14.0.1",
         "io.appium.settings": "^7.0.1",
         "lodash": "^4.17.11",
         "portscanner": "^2.2.0",
@@ -1132,6 +1133,15 @@
         "node": ">= 0.8"
       }
     },
+    "node_modules/commander": {
+      "version": "14.0.3",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.3.tgz",
+      "integrity": "sha512-H+y0Jo/T1RZ9qPP4Eh1pkcQcLRglraJaSLoyOtHxu6AapkjWVCy2Sit1QQ4x3Dng8qDlSsZEet7g5Pq06MvTgw==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=20"
+      }
+    },
     "node_modules/compare-versions": {
       "version": "6.1.1",
       "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-6.1.1.tgz",

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "7.1.2",
+  "version": "7.2.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -34,8 +34,8 @@
     ],
     "mainClass": "EspressoDriver",
     "scripts": {
-      "print-espresso-path": "./scripts/print-espresso-path.js",
-      "build-espresso": "./scripts/build-espresso.js"
+      "print-espresso-path": "./scripts/print-espresso-path.mjs",
+      "build-espresso": "./scripts/build-espresso.mjs"
     },
     "doctor": {
       "checks": [
@@ -78,6 +78,7 @@
     "asyncbox": "^6.1.0",
     "axios": "^1.12.2",
     "bluebird": "^3.5.0",
+    "commander": "^14.0.1",
     "io.appium.settings": "^7.0.1",
     "lodash": "^4.17.11",
     "portscanner": "^2.2.0",
@@ -100,7 +101,7 @@
     "format": "prettier -w ./lib ./test",
     "format:check": "prettier --check ./lib ./test",
     "prepare": "npm run rebuild",
-    "sync-version": "node ./scripts/sync-version.js --package-version=${npm_package_version}",
+    "sync-version": "node ./scripts/sync-version.mjs --package-version=${npm_package_version}",
     "test": "npm run test:node",
     "test:node": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\"",
     "test:server": "cd espresso-server && ./gradlew test --stacktrace || cd ..",

package/scripts/build-espresso.mjs

@@ -0,0 +1,109 @@
+import _ from 'lodash';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {Command} from 'commander';
+import {logger, fs} from 'appium/support.js';
+import {ServerBuilder} from '../build/lib/server-builder.js';
+
+const LOG = logger.getLogger('EspressoBuild');
+
+const ROOT_DIR = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const ESPRESSO_SERVER_ROOT = path.join(ROOT_DIR, 'espresso-server');
+const ESPRESSO_SERVER_BUILD = path.join(ESPRESSO_SERVER_ROOT, 'app', 'build');
+
+/**
+ * @param {BuildOptions} options
+ */
+async function buildEspressoServer(options) {
+  LOG.info(`Building espresso server in '${ESPRESSO_SERVER_BUILD}'`);
+
+  const opts = {
+    serverPath: ESPRESSO_SERVER_ROOT,
+    showGradleLog: options.showGradleLog,
+  };
+
+  if (options.testAppPackage) {
+    opts.testAppPackage = options.testAppPackage;
+  }
+
+  if (options.buildConfig) {
+    if (!(await fs.exists(options.buildConfig))) {
+      throw new Error(
+        `Cannot find build config at '${options.buildConfig}'. Please provide a valid absolute path to it.`
+      );
+    }
+    try {
+      const buildConfigurationStr = await fs.readFile(options.buildConfig, 'utf8');
+      opts.buildConfiguration = JSON.parse(buildConfigurationStr);
+      LOG.info(`The espresso build config is ${JSON.stringify(opts.buildConfiguration)}`);
+    } catch (e) {
+      throw new Error(
+        `Failed to parse the build config at '${options.buildConfig}'. ` +
+          `Please make sure it is a valid JSON file.`, {cause: e}
+      );
+    }
+  }
+
+  const builder = new ServerBuilder(LOG, opts);
+  try {
+    await builder.build();
+  } catch (e) {
+    let errorMessage = `Failed to build the espresso server`;
+    if (!isGradleLogEnabled(options)) {
+      errorMessage += `. Set SHOW_GRADLE_LOG environment variable to true to check the gradle log.`;
+    }
+    throw new Error(errorMessage, {cause: e});
+  }
+
+  const dstPath = path.resolve(
+    ESPRESSO_SERVER_BUILD,
+    'outputs',
+    'apk',
+    'androidTest',
+    'debug',
+    'app-debug-androidTest.apk',
+  );
+  if (await fs.exists(dstPath)) {
+    LOG.info(`Full path to the server APK: ${dstPath}`);
+  } else {
+    LOG.info(`Full path to the server build folder: ${ESPRESSO_SERVER_BUILD}`);
+  }
+}
+
+/**
+ * @param {BuildOptions} options
+ * @returns {boolean}
+ */
+function isGradleLogEnabled(options) {
+  return Boolean(options.showGradleLog ||
+    !_.isEmpty(process.env.SHOW_GRADLE_LOG) && ['1', 'true'].includes(_.toLower(process.env.SHOW_GRADLE_LOG))
+  );
+}
+
+async function main() {
+  const program = new Command();
+  program
+    .name('appium driver run espresso build-espresso')
+    .description('Build the Espresso server APK')
+    .option('--show-gradle-log', 'Show Gradle logs during build')
+    .option('--test-app-package <package>', 'App package to target for test server build')
+    .option('--build-config <path>', 'Absolute path to a JSON build configuration file')
+    .action(async (options) => {
+      await buildEspressoServer({
+        showGradleLog: isGradleLogEnabled(options),
+        testAppPackage: options.testAppPackage ?? process.env.TEST_APP_PACKAGE,
+        buildConfig: options.buildConfig ?? process.env.ESPRESSO_BUILD_CONFIG,
+      });
+    });
+
+  await program.parseAsync(process.argv);
+}
+
+await main();
+
+/**
+ * @typedef {Object} BuildOptions
+ * @property {boolean | undefined} showGradleLog
+ * @property {string | undefined} testAppPackage
+ * @property {string | undefined} buildConfig
+ */

package/scripts/print-espresso-path.mjs

@@ -0,0 +1,25 @@
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {Command} from 'commander';
+
+/**
+ * @returns {void}
+ */
+function printEspressoServerPath() {
+  const dstPath = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'espresso-server');
+  console.log(dstPath); // eslint-disable-line no-console
+}
+
+async function main() {
+  const program = new Command();
+  program
+    .name('appium driver run espresso print-espresso-path')
+    .description('Print the Espresso server path')
+    .action(() => {
+      printEspressoServerPath();
+    });
+
+  await program.parseAsync(process.argv);
+}
+
+await main();

package/scripts/sync-version.mjs

@@ -0,0 +1,65 @@
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {Command} from 'commander';
+import {logger, fs} from 'appium/support.js';
+import semver from 'semver';
+
+const LOG = logger.getLogger('VersionSync');
+
+const ROOT_DIR = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const ESPRESSO_SERVER_ROOT = path.join(ROOT_DIR, 'espresso-server');
+const VERSION_FILE = path.join(
+  ESPRESSO_SERVER_ROOT,
+  'library',
+  'src',
+  'main',
+  'java',
+  'io',
+  'appium',
+  'espressoserver',
+  'lib',
+  'helpers',
+  'Version.kt'
+);
+const VERSION_PATTERN = /VERSION\s*=\s*"([0-9.]+)"/;
+
+/**
+ * @param {string} packageVersion
+ * @returns {Promise<void>}
+ */
+async function syncModuleVersion(packageVersion) {
+  const origContent = await fs.readFile(VERSION_FILE, 'utf8');
+  const espressoVersionMatch = VERSION_PATTERN.exec(origContent);
+  if (!espressoVersionMatch) {
+    throw new Error(`Could not parse Espresso module version from '${VERSION_FILE}'`);
+  }
+  const updatedContent = origContent.replace(espressoVersionMatch[1], packageVersion);
+  await fs.writeFile(VERSION_FILE, updatedContent, 'utf8');
+  LOG.info(`Synchronized module version '${packageVersion}' to '${VERSION_FILE}'`);
+}
+
+async function main() {
+  const program = new Command();
+  program
+    .name('node ./scripts/sync-version.mjs')
+    .description('Sync package version into Espresso server module source')
+    .requiredOption(
+      '--package-version <version>',
+      'Package version to synchronize',
+      (value) => {
+        if (!semver.valid(value)) {
+          throw new Error(
+            `Invalid version specified '${value}'. The value must be a valid semver string like '1.2.3'`
+          );
+        }
+        return value;
+      }
+    )
+    .action(async (options) => {
+      await syncModuleVersion(options.packageVersion);
+    });
+
+  await program.parseAsync(process.argv);
+}
+
+await main();

package/scripts/build-espresso.js

@@ -1,56 +0,0 @@
-const _ = require('lodash');
-const path = require('node:path');
-const { logger, fs } = require('appium/support');
-const { ServerBuilder } = require('../build/lib/server-builder.js');
-
-const LOG = new logger.getLogger('EspressoBuild');
-
-const ROOT_DIR = path.resolve(__dirname, '..');
-const ESPRESSO_SERVER_ROOT = path.join(ROOT_DIR, 'espresso-server');
-
-const ESPRESSO_SERVER_BUILD = path.join(ESPRESSO_SERVER_ROOT, 'app', 'build');
-
-async function buildEspressoServer () {
-
-  LOG.info(`Deleting the build directory ${ESPRESSO_SERVER_BUILD}`);
-
-  const opts = {
-    serverPath: ESPRESSO_SERVER_ROOT,
-    showGradleLog: !_.isEmpty(process.env.SHOW_GRADLE_LOG) && ['1', 'true'].includes(_.toLower(process.env.SHOW_GRADLE_LOG))
-  };
-
-  if (process.env.TEST_APP_PACKAGE) {
-    opts.testAppPackage = process.env.TEST_APP_PACKAGE;
-  }
-
-  if (process.env.ESPRESSO_BUILD_CONFIG) {
-    if (!(await fs.exists(process.env.ESPRESSO_BUILD_CONFIG))) {
-      throw new Error(`'${process.env.ESPRESSO_BUILD_CONFIG}' did not exist. Please set the path as an absolute path.`);
-    }
-    try {
-      const buildConfigurationStr = await fs.readFile(process.env.ESPRESSO_BUILD_CONFIG, 'utf8');
-      opts.buildConfiguration = JSON.parse(buildConfigurationStr);
-      LOG.info(`The espresso build config is ${JSON.stringify(opts.buildConfiguration)}`);
-    } catch (e) {
-      throw new Error(`Failed to parse the ${process.env.ESPRESSO_BUILD_CONFIG}. ` +
-        `Please make sure that the JSON is valid format. Error: ${e}`);
-    }
-  }
-
-  const builder = new ServerBuilder(LOG, opts);
-  try {
-    await builder.build();
-  } catch (e) {
-    throw new Error(`Failed to build the espresso server. ` +
-      `SHOW_GRADLE_LOG=true environment variable helps to check the gradle log. Error: ${e}`);
-  }
-
-  const dstPath = path.resolve(ESPRESSO_SERVER_ROOT, 'app', 'build', 'outputs', 'apk', 'androidTest', 'debug', 'app-debug-androidTest.apk');
-  if (await fs.exists(dstPath)) {
-    LOG.info(`Full path to the server APK: ${dstPath}`);
-  } else {
-    LOG.info(`Full path to the server build folder: ${ESPRESSO_SERVER_BUILD}`);
-  }
-}
-
-(async () => await buildEspressoServer())();

package/scripts/print-espresso-path.js

@@ -1,8 +0,0 @@
-const path = require('node:path');
-
-function printEspressoServerPath () {
-  const dstPath = path.resolve(__dirname, '..', 'espresso-server');
-  console.log(dstPath); // eslint-disable-line no-console
-}
-
-printEspressoServerPath();

package/scripts/sync-version.js

@@ -1,47 +0,0 @@
-const path = require('node:path');
-const { logger, fs } = require('appium/support');
-const semver = require('semver');
-
-const LOG = logger.getLogger('VersionSync');
-
-const ROOT_DIR = path.resolve(__dirname, '..');
-const ESPRESSO_SERVER_ROOT = path.join(ROOT_DIR, 'espresso-server');
-const VERSION_FILE = path.join(
-  ESPRESSO_SERVER_ROOT, 'library', 'src', 'main', 'java',
-  'io', 'appium', 'espressoserver',
-  'lib', 'helpers', 'Version.kt'
-);
-const VERSION_PATTERN = /VERSION\s*=\s*"([0-9.]+)"/;
-
-function parseArgValue (argName) {
-  const argNamePattern = new RegExp(`^--${argName}\\b`);
-  for (let i = 1; i < process.argv.length; ++i) {
-    const arg = process.argv[i];
-    if (argNamePattern.test(arg)) {
-      return arg.includes('=') ? arg.split('=')[1] : process.argv[i + 1];
-    }
-  }
-  return null;
-}
-
-async function syncModuleVersion () {
-  const origContent = await fs.readFile(VERSION_FILE, 'utf8');
-  const espressoVersionMatch = VERSION_PATTERN.exec(origContent);
-  if (!espressoVersionMatch) {
-    throw new Error(`Could not parse Espresso module version from '${VERSION_FILE}'`);
-  }
-  const packageVersion = parseArgValue('package-version');
-  if (!packageVersion) {
-    throw new Error('No package version argument (use `--package-version=xxx`)');
-  }
-  if (!semver.valid(packageVersion)) {
-    throw new Error(
-      `Invalid version specified '${packageVersion}'. Version should be in the form '1.2.3'`
-    );
-  }
-  const updatedContent = origContent.replace(espressoVersionMatch[1], packageVersion);
-  await fs.writeFile(VERSION_FILE, updatedContent, 'utf8');
-  LOG.info(`Synchronized module version '${packageVersion}' to '${VERSION_FILE}'`);
-}
-
-(async () => await syncModuleVersion())();