@limrun/appium-xcuitest-driver 10.4.3-lim.1 → 10.10.1-lim.2

package/lib/{method-map.js → method-map.ts}

@@ -1,4 +1,7 @@
-export const newMethodMap = /** @type {const} */ ({
+import type { MethodMap } from '@appium/types';
+import type { XCUITestDriver } from './driver';
+
+export const newMethodMap = {
   '/session/:sessionId/timeouts/async_script': {
     POST: {
       command: 'asyncScriptTimeout',
@@ -193,4 +196,4 @@ export const newMethodMap = /** @type {const} */ ({
       deprecated: true,
     },
   },
-});
+} as const satisfies MethodMap<XCUITestDriver>;

package/lib/utils.js

@@ -1,4 +1,4 @@
-import * as xcode from '@limrun/appium-xcode';
+import * as xcode from 'appium-xcode';
 import {errors} from 'appium/driver';
 import {fs, net, util} from 'appium/support';
 import B from 'bluebird';
@@ -8,7 +8,6 @@ import path from 'node:path';
 import url from 'node:url';
 import * as semver from 'semver';
 import {exec} from 'teen_process';
-import iosGenericSimulators from './ios-generic-simulators';
 import log from './logger';
 import {PLATFORM_NAME_TVOS, PLATFORM_NAME_IOS} from './desired-caps';
 
@@ -50,61 +49,12 @@ async function getAndCheckXcodeVersion() {
  */
 async function getAndCheckIosSdkVersion() {
   try {
-    return '26';
     return await xcode.getMaxIOSSDK();
   } catch (err) {
     throw log.errorWithException(`Could not determine iOS SDK version: ${err.message}`);
   }
 }
 
-/**
- * Get the generic simulator for a given IOS version and device type (iPhone, iPad)
- *
- * @param {string|number} platformVersion IOS version. e.g.) 13.0
- * @param {string} deviceName Type of IOS device. Can be iPhone, iPad (possibly more in the future)
- *
- * @returns {string?} Generic iPhone or iPad simulator (if applicable)
- */
-function getGenericSimulatorForIosVersion(platformVersion, deviceName) {
-  const genericSimulators = iosGenericSimulators[deviceName];
-  if (!genericSimulators) {
-    return null;
-  }
-
-  // Find the highest iOS version in the list that is below the provided version
-  let result = null;
-  const compareVersions = ([simOne], [simTwo]) =>
-    util.compareVersions(simOne, '<', simTwo) ? -1 : 1;
-  for (const [platformVersionFromList, iosSimulator] of genericSimulators.sort(compareVersions)) {
-    if (util.compareVersions(platformVersionFromList, '>', String(platformVersion))) {
-      break;
-    }
-    result = iosSimulator;
-  }
-  return result;
-}
-
-/**
- *
- * @param {string} platformVersion
- * @param {string} deviceName
- * @returns {string}
- */
-function translateDeviceName(platformVersion, deviceName) {
-  if (!deviceName) {
-    return deviceName;
-  }
-  const deviceNameTranslated = getGenericSimulatorForIosVersion(
-    platformVersion,
-    `${deviceName}`.toLowerCase().trim(),
-  );
-  if (!deviceNameTranslated) {
-    return deviceName;
-  }
-
-  log.debug(`Changing deviceName from '${deviceName}' to '${deviceNameTranslated}'`);
-  return deviceNameTranslated;
-}
 
 /**
  * @param {string[]} locations
@@ -531,7 +481,6 @@ export {
   checkAppPresent,
   getDriverInfo,
   clearSystemFiles,
-  translateDeviceName,
   normalizeCommandTimeouts,
   DEFAULT_TIMEOUT_KEY,
   markSystemFilesForCleanup,
@@ -545,7 +494,7 @@ export {
 };
 
 /**
- * @typedef {import('@limrun/appium-xcode').XcodeVersion} XcodeVersion
- * @typedef {import('@limrun/appium-ios-simulator').Simulator} Simulator
+ * @typedef {import('appium-xcode').XcodeVersion} XcodeVersion
+ * @typedef {import('appium-ios-simulator').Simulator} Simulator
  * @typedef {import('./driver').XCUITestDriver} XCUITestDriver
  */

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "10.4.3-lim.1",
+  "version": "10.10.1-lim.2",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -84,10 +84,10 @@
     "@colors/colors": "^1.6.0",
     "appium-idb": "^2.0.0",
     "appium-ios-device": "^3.0.0",
-    "@limrun/appium-ios-simulator": "7.0.2-lim.1",
-    "appium-remote-debugger": "^15.0.3",
-    "appium-webdriveragent": "^10.2.1",
-    "@limrun/appium-xcode": "6.1.2-lim.1",
+    "appium-ios-simulator": "npm:@limrun/appium-ios-simulator@8.0.5-lim.4",
+    "appium-remote-debugger": "^15.2.0",
+    "appium-webdriveragent": "npm:@limrun/appium-webdriveragent@10.4.0-lim.1",
+    "appium-xcode": "npm:@limrun/appium-xcode@6.1.3-lim.1",
     "async-lock": "^1.4.0",
     "asyncbox": "^3.0.0",
     "bluebird": "^3.7.2",
@@ -99,10 +99,9 @@
     "moment": "^2.29.4",
     "moment-timezone": "^0.x",
     "node-devicectl": "^1.1.0",
-    "@limrun/node-simctl": "^8.0.5-lim.1",
+    "node-simctl": "npm:@limrun/node-simctl@8.0.5-lim.3",
     "portscanner": "^2.2.0",
     "semver": "^7.5.4",
-    "source-map-support": "^0.x",
     "teen_process": "^3.0.0",
     "winston": "^3.17.0",
     "ws": "^8.13.0"
@@ -124,15 +123,15 @@
     "install-docs-deps": "appium-docs init --no-mkdocs",
     "prepare": "npm run rebuild",
     "rebuild": "npm run clean; npm run build",
-    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\"",
-    "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.js\"",
-    "e2e-test:basic": "mocha \"./test/functional/basic\" --exit --timeout 10m",
-    "e2e-test:device": "mocha \"./test/functional/device\" --exit --timeout 10m",
-    "e2e-test:driver": "mocha \"./test/functional/driver\" --exit --timeout 10m",
-    "e2e-test:long": "mocha \"./test/functional/long\" --exit --timeout 10m",
-    "e2e-test:parallel": "mocha \"./test/functional/parallel\" --exit --timeout 10m",
-    "e2e-test:web": "mocha \"./test/functional/web\" --exit --timeout 10m",
-    "e2e-test:native-web-tap": "mocha \"./test/functional/web/safari-nativewebtap-e2e-specs.js\" --exit --timeout 10m",
+    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\"",
+    "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.ts\"",
+    "e2e-test:basic": "mocha \"./test/functional/basic/**/*-specs.ts\" --exit --timeout 10m",
+    "e2e-test:device": "mocha \"./test/functional/device/**/*-specs.ts\" --exit --timeout 10m",
+    "e2e-test:driver": "mocha \"./test/functional/driver/**/*-specs.ts\" --exit --timeout 10m",
+    "e2e-test:long": "mocha \"./test/functional/long/**/*-specs.ts\" --exit --timeout 10m",
+    "e2e-test:parallel": "mocha \"./test/functional/parallel/**/*-specs.ts\" --exit --timeout 10m",
+    "e2e-test:web": "mocha \"./test/functional/web/**/*-specs.ts\" --exit --timeout 10m",
+    "e2e-test:native-web-tap": "mocha \"./test/functional/web/safari-nativewebtap-e2e-specs.ts\" --exit --timeout 10m",
     "start": "appium --relaxed-security --port 4567 --keep-alive-timeout 1200"
   },
   "prettier": {
@@ -146,7 +145,6 @@
   "devDependencies": {
     "@appium/docutils": "^2.0.0-rc.1",
     "@appium/eslint-config-appium-ts": "^2.0.0-rc.1",
-    "@appium/test-support": "^4.0.0-rc.1",
     "@appium/tsconfig": "^1.0.0-rc.1",
     "@appium/types": "^1.0.0-rc.1",
     "@semantic-release/changelog": "^6.0.3",
@@ -154,7 +152,7 @@
     "@types/bluebird": "^3.5.38",
     "@types/lodash": "^4.14.196",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^24.0.1",
+    "@types/node": "^25.0.0",
     "@types/portscanner": "^2.1.1",
     "axios": "^1.4.0",
     "chai": "^6.0.0",
@@ -165,7 +163,7 @@
     "mocha-multi-reporters": "^1.5.1",
     "pem": "^1.14.8",
     "prettier": "^3.0.0",
-    "semantic-release": "^25.0.0",
+    "semantic-release": "^25.0.2",
     "sharp": "^0.x",
     "sinon": "^21.0.0",
     "ts-node": "^10.9.1",

package/scripts/build-wda.js

@@ -1,7 +1,7 @@
 const {WebDriverAgent} = require('appium-webdriveragent');
-const xcode = require('@limrun/appium-xcode');
-const {Simctl} = require('@limrun/node-simctl');
-const {getSimulator} = require('@limrun/appium-ios-simulator');
+const xcode = require('appium-xcode');
+const {Simctl} = require('node-simctl');
+const {getSimulator} = require('appium-ios-simulator');
 const {logger} = require('appium/support');
 const {parseArgValue} = require('./utils');
 

package/lib/ios-fs-helpers.js

@@ -1,355 +0,0 @@
-import _ from 'lodash';
-import B, {TimeoutError} from 'bluebird';
-import {fs, tempDir, mkdirp, zip, util, timing} from 'appium/support';
-import path from 'path';
-import log from './logger';
-
-export const IO_TIMEOUT_MS = 4 * 60 * 1000;
-// Mobile devices use NAND memory modules for the storage,
-// and the parallelism there is not as performant as on regular SSDs
-const MAX_IO_CHUNK_SIZE = 8;
-
-/**
- * Retrieve a file from a real device
- *
- * @param {any} afcService Apple File Client service instance from
- * 'appium-ios-device' module
- * @param {string} remotePath Relative path to the file on the device
- * @returns {Promise<Buffer>} The file content as a buffer
- */
-export async function pullFile(afcService, remotePath) {
-  const stream = await afcService.createReadStream(remotePath, {autoDestroy: true});
-  const pullPromise = new B((resolve, reject) => {
-    stream.on('close', resolve);
-    stream.on('error', reject);
-  }).timeout(IO_TIMEOUT_MS);
-  const buffers = [];
-  stream.on('data', (data) => buffers.push(data));
-  await pullPromise;
-  return Buffer.concat(buffers);
-}
-
-/**
- * Checks a presence of a local folder.
- *
- * @param {string} folderPath Full path to the local folder
- * @returns {Promise<boolean>} True if the folder exists and is actually a folder
- */
-async function folderExists(folderPath) {
-  try {
-    return (await fs.stat(folderPath)).isDirectory();
-  } catch {
-    return false;
-  }
-}
-
-/**
- * Retrieve a folder from a real device
- *
- * @param {any} afcService Apple File Client service instance from
- * 'appium-ios-device' module
- * @param {string} remoteRootPath Relative path to the folder on the device
- * @returns {Promise<Buffer>} The folder content as a zipped base64-encoded buffer
- */
-export async function pullFolder(afcService, remoteRootPath) {
-  const tmpFolder = await tempDir.openDir();
-  try {
-    let localTopItem = null;
-    let countFilesSuccess = 0;
-    let countFilesFail = 0;
-    let countFolders = 0;
-    const pullPromises = [];
-    await afcService.walkDir(remoteRootPath, true, async (remotePath, isDir) => {
-      const localPath = path.join(tmpFolder, remotePath);
-      const dirname = isDir ? localPath : path.dirname(localPath);
-      if (!(await folderExists(dirname))) {
-        await mkdirp(dirname);
-      }
-      if (!localTopItem || localPath.split(path.sep).length < localTopItem.split(path.sep).length) {
-        localTopItem = localPath;
-      }
-      if (isDir) {
-        ++countFolders;
-        return;
-      }
-
-      const readStream = await afcService.createReadStream(remotePath, {autoDestroy: true});
-      const writeStream = fs.createWriteStream(localPath, {autoClose: true});
-      pullPromises.push(
-        new B((resolve) => {
-          writeStream.on('close', () => {
-            ++countFilesSuccess;
-            resolve();
-          });
-          const onStreamingError = (e) => {
-            readStream.unpipe(writeStream);
-            log.warn(
-              `Cannot pull '${remotePath}' to '${localPath}'. ` +
-                `The file will be skipped. Original error: ${e.message}`,
-            );
-            ++countFilesFail;
-            resolve();
-          };
-          writeStream.on('error', onStreamingError);
-          readStream.on('error', onStreamingError);
-        }).timeout(IO_TIMEOUT_MS),
-      );
-      readStream.pipe(writeStream);
-      if (pullPromises.length >= MAX_IO_CHUNK_SIZE) {
-        await B.any(pullPromises);
-        for (let i = pullPromises.length - 1; i >= 0; i--) {
-          if (pullPromises[i].isFulfilled()) {
-            pullPromises.splice(i, 1);
-          }
-        }
-      }
-    });
-    // Wait for the rest of files to be pulled
-    if (!_.isEmpty(pullPromises)) {
-      await B.all(pullPromises);
-    }
-    log.info(
-      `Pulled ${util.pluralize('file', countFilesSuccess, true)} out of ` +
-        `${countFilesSuccess + countFilesFail} and ${util.pluralize(
-          'folder',
-          countFolders,
-          true,
-        )} ` +
-        `from '${remoteRootPath}'`,
-    );
-    return await zip.toInMemoryZip(localTopItem ? path.dirname(localTopItem) : tmpFolder, {
-      encodeToBase64: true,
-    });
-  } finally {
-    await fs.rimraf(tmpFolder);
-  }
-}
-
-/**
- * Creates remote folder path recursively. Noop if the given path
- * already exists
- *
- * @param {any} afcService Apple File Client service instance from
- * 'appium-ios-device' module
- * @param {string} remoteRoot The relative path to the remote folder structure
- * to be created
- */
-async function remoteMkdirp(afcService, remoteRoot) {
-  if (remoteRoot === '.' || remoteRoot === '/') {
-    return;
-  }
-  try {
-    await afcService.listDirectory(remoteRoot);
-    return;
-  } catch {
-    // This means that the directory is missing and we got an object not found error.
-    // Therefore, we are going to the parent
-    await remoteMkdirp(afcService, path.dirname(remoteRoot));
-  }
-  await afcService.createDirectory(remoteRoot);
-}
-
-/**
- * @typedef {Object} PushFileOptions
- * @property {number} [timeoutMs=240000] The maximum count of milliceconds to wait until
- * file push is completed. Cannot be lower than 60000ms
- */
-
-/**
- * Pushes a file to a real device
- *
- * @param {any} afcService afcService Apple File Client service instance from
- * 'appium-ios-device' module
- * @param {string|Buffer} localPathOrPayload Either full path to the source file
- * or a buffer payload to be written into the remote destination
- * @param {string} remotePath Relative path to the file on the device. The remote
- * folder structure is created automatically if necessary.
- * @param {PushFileOptions} [opts={}]
- */
-export async function pushFile(afcService, localPathOrPayload, remotePath, opts = {}) {
-  const {timeoutMs = IO_TIMEOUT_MS} = opts;
-  const timer = new timing.Timer().start();
-  await remoteMkdirp(afcService, path.dirname(remotePath));
-  const source = Buffer.isBuffer(localPathOrPayload)
-    ? localPathOrPayload
-    : fs.createReadStream(localPathOrPayload, {autoClose: true});
-  const writeStream = await afcService.createWriteStream(remotePath, {
-    autoDestroy: true,
-  });
-  writeStream.on('finish', writeStream.destroy);
-  let pushError = null;
-  const filePushPromise = new B((resolve, reject) => {
-    writeStream.on('close', () => {
-      if (pushError) {
-        reject(pushError);
-      } else {
-        resolve();
-      }
-    });
-    const onStreamError = (e) => {
-      if (!Buffer.isBuffer(source)) {
-        source.unpipe(writeStream);
-      }
-      log.debug(e);
-      pushError = e;
-    };
-    writeStream.on('error', onStreamError);
-    if (!Buffer.isBuffer(source)) {
-      source.on('error', onStreamError);
-    }
-  });
-  if (Buffer.isBuffer(source)) {
-    writeStream.write(source);
-    writeStream.end();
-  } else {
-    source.pipe(writeStream);
-  }
-  await filePushPromise.timeout(Math.max(timeoutMs, 60000));
-  const fileSize = Buffer.isBuffer(localPathOrPayload)
-    ? localPathOrPayload.length
-    : (await fs.stat(localPathOrPayload)).size;
-  log.debug(
-    `Successfully pushed the file payload (${util.toReadableSizeString(fileSize)}) ` +
-      `to the remote location '${remotePath}' in ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
-  );
-}
-
-/**
- * @typedef {Object} PushFolderOptions
- *
- * @property {number} [timeoutMs=240000] The maximum timeout to wait until a
- * single file is copied
- * @property {boolean} [enableParallelPush=false] Whether to push files in parallel.
- * This usually gives better performance, but might sometimes be less stable.
- */
-
-/**
- * Pushes a folder to a real device
- *
- * @param {any} afcService Apple File Client service instance from
- * 'appium-ios-device' module
- * @param {string} srcRootPath The full path to the source folder
- * @param {string} dstRootPath The relative path to the destination folder. The folder
- * will be deleted if already exists.
- * @param {PushFolderOptions} opts
- */
-export async function pushFolder(afcService, srcRootPath, dstRootPath, opts = {}) {
-  const {timeoutMs = IO_TIMEOUT_MS, enableParallelPush = false} = opts;
-
-  const timer = new timing.Timer().start();
-  const allItems = /** @type {import('path-scurry').Path[]} */ (
-    /** @type {unknown} */ (
-      await fs.glob('**', {
-        cwd: srcRootPath,
-        withFileTypes: true,
-      })
-    )
-  );
-  log.debug(`Successfully scanned the tree structure of '${srcRootPath}'`);
-  // top-level folders go first
-  /** @type {string[]} */
-  const foldersToPush = allItems
-    .filter((x) => x.isDirectory())
-    .map((x) => x.relative())
-    .sort((a, b) => a.split(path.sep).length - b.split(path.sep).length);
-  // larger files go first
-  /** @type {string[]} */
-  const filesToPush = allItems
-    .filter((x) => !x.isDirectory())
-    .sort((a, b) => (b.size ?? 0) - (a.size ?? 0))
-    .map((x) => x.relative());
-  log.debug(
-    `Got ${util.pluralize('folder', foldersToPush.length, true)} and ` +
-      `${util.pluralize('file', filesToPush.length, true)} to push`,
-  );
-  // create the folder structure first
-  try {
-    await afcService.deleteDirectory(dstRootPath);
-  } catch {}
-  await afcService.createDirectory(dstRootPath);
-  for (const relativeFolderPath of foldersToPush) {
-    // createDirectory does not accept folder names ending with a path separator
-    const absoluteFolderPath = _.trimEnd(path.join(dstRootPath, relativeFolderPath), path.sep);
-    if (absoluteFolderPath) {
-      await afcService.createDirectory(absoluteFolderPath);
-    }
-  }
-  // do not forget about the root folder
-  log.debug(
-    `Successfully created the remote folder structure ` +
-      `(${util.pluralize('item', foldersToPush.length + 1, true)})`,
-  );
-
-  const _pushFile = async (/** @type {string} */ relativePath) => {
-    const absoluteSourcePath = path.join(srcRootPath, relativePath);
-    const readStream = fs.createReadStream(absoluteSourcePath, {autoClose: true});
-    const absoluteDestinationPath = path.join(dstRootPath, relativePath);
-    const writeStream = await afcService.createWriteStream(absoluteDestinationPath, {
-      autoDestroy: true,
-    });
-    writeStream.on('finish', writeStream.destroy);
-    let pushError = null;
-    const filePushPromise = new B((resolve, reject) => {
-      writeStream.on('close', () => {
-        if (pushError) {
-          reject(pushError);
-        } else {
-          resolve();
-        }
-      });
-      const onStreamError = (e) => {
-        readStream.unpipe(writeStream);
-        log.debug(e);
-        pushError = e;
-      };
-      writeStream.on('error', onStreamError);
-      readStream.on('error', onStreamError);
-    });
-    readStream.pipe(writeStream);
-    await filePushPromise.timeout(Math.max(timeoutMs - timer.getDuration().asMilliSeconds, 60000));
-  };
-
-  if (enableParallelPush) {
-    log.debug(`Proceeding to parallel files push (max ${MAX_IO_CHUNK_SIZE} writers)`);
-    const pushPromises = [];
-    for (const relativeFilePath of filesToPush) {
-      pushPromises.push(B.resolve(_pushFile(relativeFilePath)));
-      // keep the push queue filled
-      if (pushPromises.length >= MAX_IO_CHUNK_SIZE) {
-        await B.any(pushPromises);
-        const elapsedMs = timer.getDuration().asMilliSeconds;
-        if (elapsedMs > timeoutMs) {
-          throw new TimeoutError(`Timed out after ${elapsedMs} ms`);
-        }
-      }
-      for (let i = pushPromises.length - 1; i >= 0; i--) {
-        if (pushPromises[i].isFulfilled()) {
-          pushPromises.splice(i, 1);
-        }
-      }
-    }
-    if (!_.isEmpty(pushPromises)) {
-      const remainingPromises = pushPromises.filter((p) => !p.isFulfilled());
-      if (remainingPromises.length > 0) {
-        await B.all(remainingPromises).timeout(
-          Math.max(timeoutMs - timer.getDuration().asMilliSeconds, 60000),
-        );
-      }
-    }
-  } else {
-    log.debug(`Proceeding to serial files push`);
-    for (const relativeFilePath of filesToPush) {
-      await _pushFile(relativeFilePath);
-      const elapsedMs = timer.getDuration().asMilliSeconds;
-      if (elapsedMs > timeoutMs) {
-        throw new TimeoutError(`Timed out after ${elapsedMs} ms`);
-      }
-    }
-  }
-
-  log.debug(
-    `Successfully pushed ${util.pluralize('folder', foldersToPush.length, true)} ` +
-      `and ${util.pluralize('file', filesToPush.length, true)} ` +
-      `within ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
-  );
-}

package/lib/ios-generic-simulators.js

@@ -1,11 +0,0 @@
-export default {
-  'ipad simulator': [
-    ['0.0', 'iPad Retina'],
-    ['10.3', 'iPad Air'],
-    ['13.0', 'iPad (5th generation)'],
-  ],
-  'iphone simulator': [
-    ['0.0', 'iPhone 6'],
-    ['13.0', 'iPhone X'],
-  ],
-};