appium-ios-device 3.1.12 → 3.1.14

package/lib/afc/index.js

@@ -4,19 +4,39 @@ import {AfcWritableFileStream, AfcReadableFileStream} from './streams';
 import {AfcEncoder} from './transformer/afcencoder';
 import {AfcDecoder} from './transformer/afcdecoder';
 import {MB} from '../constants';
-import B from 'bluebird';
 import path from 'node:path';
 import _ from 'lodash';
 import {BaseServiceSocket} from '../base-service';
 import {getMaxFrameLength} from '../utilities';
 
-const AFC_SERVICE_NAME = 'com.apple.afc';
+export const AFC_SERVICE_NAME = 'com.apple.afc';
 const MAX_FRAME_SIZE = 1 * MB;
 
 const NULL_DELIMITER_CODE = 0x00;
 const IGNORED_PATHS = ['.', '..'];
 
-class AfcService extends BaseServiceSocket {
+class FileInfo {
+  constructor({st_size, st_blocks, st_nlink, st_ifmt, st_mtime, st_birthtime}) {
+    this.size = parseInt(st_size, 10);
+    this.blocks = parseInt(st_blocks, 10);
+    this.nlink = parseInt(st_nlink, 10);
+    this.ifmt = st_ifmt;
+    // ns to ms
+    this.mtimeMs = parseInt(st_mtime, 10) / 1000000;
+    // ns to ms
+    this.birthtimeMs = parseInt(st_birthtime, 10) / 1000000;
+  }
+
+  isDirectory() {
+    return this.ifmt === 'S_IFDIR';
+  }
+
+  isFile() {
+    return this.ifmt === 'S_IFREG';
+  }
+}
+
+export class AfcService extends BaseServiceSocket {
   constructor(socketClient) {
     super(socketClient);
 
@@ -325,40 +345,32 @@ class AfcService extends BaseServiceSocket {
 
   _createPacketPromise(message, timeout = 10000) {
     const packetNumber = this._packetNumber++;
-    const response = new B((resolve, reject) => {
-      this._responseCallbacks[packetNumber] = resolve;
-      setTimeout(function () {
+    const response = new Promise((resolve, reject) => {
+      let isSettled = false;
+      const timeoutHandler = setTimeout(() => {
+        if (isSettled) {
+          return;
+        }
+        isSettled = true;
+        delete this._responseCallbacks[packetNumber];
         reject(
           new Error(
             `Could not finish the operation '${message}'. Failed to receive any data within the ${timeout}ms timeout`,
           ),
         );
       }, timeout);
+      this._responseCallbacks[packetNumber] = (data) => {
+        if (isSettled) {
+          return;
+        }
+        isSettled = true;
+        clearTimeout(timeoutHandler);
+        delete this._responseCallbacks[packetNumber];
+        resolve(data);
+      };
     });
     return {packetNumber, response};
   }
 }
 
-class FileInfo {
-  constructor({st_size, st_blocks, st_nlink, st_ifmt, st_mtime, st_birthtime}) {
-    this.size = parseInt(st_size, 10);
-    this.blocks = parseInt(st_blocks, 10);
-    this.nlink = parseInt(st_nlink, 10);
-    this.ifmt = st_ifmt;
-    // ns to ms
-    this.mtimeMs = parseInt(st_mtime, 10) / 1000000;
-    // ns to ms
-    this.birthtimeMs = parseInt(st_birthtime, 10) / 1000000;
-  }
-
-  isDirectory() {
-    return this.ifmt === 'S_IFDIR';
-  }
-
-  isFile() {
-    return this.ifmt === 'S_IFREG';
-  }
-}
-
 export default AfcService;
-export {AfcService, AFC_SERVICE_NAME};

package/lib/afc/protocol.js

@@ -1,10 +1,10 @@
 import _ from 'lodash';
 
-const MAGIC_NUMBER = Buffer.from('CFA6LPAA');
+export const MAGIC_NUMBER = Buffer.from('CFA6LPAA');
 
-const AFC_PACKET_HEADER_SIZE = 40;
+export const AFC_PACKET_HEADER_SIZE = 40;
 
-const Operations = {
+export const Operations = {
   INVALID: 0x00000000, // Invalid
   STATUS: 0x00000001, // Status
   DATA: 0x00000002, // Data
@@ -50,11 +50,16 @@ const Operations = {
 
 const Operations_Code = _.invert(Operations);
 
-function operationCode(code) {
+/**
+ * Resolves an AFC operation code to its symbolic name.
+ * @param {number} code
+ * @returns {string | undefined}
+ */
+export function operationCode(code) {
   return Operations_Code[code];
 }
 
-const Errors = {
+export const Errors = {
   SUCCESS: 0,
   UNKNOWN: 1,
   INVALID_HEADER: 2,
@@ -83,11 +88,16 @@ const Errors = {
 
 const Errors_Code = _.invert(Errors);
 
-function errorCode(code) {
+/**
+ * Resolves an AFC error code to its symbolic name.
+ * @param {number} code
+ * @returns {string | undefined}
+ */
+export function errorCode(code) {
   return Errors_Code[code];
 }
 
-const FileModes = {
+export const FileModes = {
   r: 0x00000001, // O_RDONLY
   'r+': 0x00000002, // O_RDWR   | O_CREAT
   w: 0x00000003, // O_WRONLY | O_CREAT  | O_TRUNC
@@ -95,13 +105,3 @@ const FileModes = {
   a: 0x00000005, // O_WRONLY | O_APPEND | O_CREAT
   'a+': 0x00000006, // O_RDWR   | O_APPEND | O_CREAT
 };
-
-export {
-  MAGIC_NUMBER,
-  AFC_PACKET_HEADER_SIZE,
-  Operations,
-  operationCode,
-  Errors,
-  errorCode,
-  FileModes,
-};

package/lib/afc/transformer/afcdecoder.js

@@ -1,7 +1,7 @@
 import Stream from 'node:stream';
 import {MAGIC_NUMBER, AFC_PACKET_HEADER_SIZE} from '../protocol';
 
-class AfcDecoder extends Stream.Transform {
+export class AfcDecoder extends Stream.Transform {
   constructor() {
     super({objectMode: true});
   }
@@ -33,5 +33,4 @@ class AfcDecoder extends Stream.Transform {
   }
 }
 
-export {AfcDecoder};
 export default AfcDecoder;

package/lib/afc/transformer/afcencoder.js

@@ -1,7 +1,7 @@
 import Stream from 'node:stream';
 import {MAGIC_NUMBER, AFC_PACKET_HEADER_SIZE} from '../protocol';
 
-class AfcEncoder extends Stream.Transform {
+export class AfcEncoder extends Stream.Transform {
   constructor() {
     super({objectMode: true});
   }
@@ -34,5 +34,4 @@ class AfcEncoder extends Stream.Transform {
   }
 }
 
-export {AfcEncoder};
 export default AfcEncoder;

package/lib/base-service.js

@@ -1,4 +1,4 @@
-class BaseServiceSocket {
+export class BaseServiceSocket {
   /**
    * @param {import('net').Socket} socketClient
    */
@@ -22,7 +22,7 @@ class BaseServiceSocket {
   }
 }
 
-class BaseServicePlist {
+export class BaseServicePlist {
   /**
    * @param {import('./plist-service').PlistService} plistService
    */
@@ -37,5 +37,3 @@ class BaseServicePlist {
     this._plistService.close();
   }
 }
-
-export {BaseServiceSocket, BaseServicePlist};

package/lib/constants.js

@@ -1,4 +1,2 @@
-const KB = 1024;
-const MB = KB * KB;
-
-export {KB, MB};
+export const KB = 1024;
+export const MB = KB * KB;

package/lib/house-arrest/index.js

@@ -3,14 +3,13 @@ import {PlistServiceEncoder} from '../plist-service/transformer/plist-service-en
 import {LengthBasedSplitter} from '../util/transformer/length-based-splitter';
 import {KB} from '../constants';
 import {AfcService} from '../afc';
-import B from 'bluebird';
 import {BaseServiceSocket} from '../base-service';
 import {getMaxFrameLength} from '../utilities';
 
-const HOUSE_ARREST_SERVICE_NAME = 'com.apple.mobile.house_arrest';
+export const HOUSE_ARREST_SERVICE_NAME = 'com.apple.mobile.house_arrest';
 const MAX_FRAME_SIZE = 1 * KB;
 
-class HouseArrestService extends BaseServiceSocket {
+export class HouseArrestService extends BaseServiceSocket {
   constructor(socketClient) {
     super(socketClient);
 
@@ -73,7 +72,7 @@ class HouseArrestService extends BaseServiceSocket {
   }
 
   _receivePlistPromise(timeout = 10000) {
-    return new B((resolve, reject) => {
+    return new Promise((resolve, reject) => {
       this._decoder.once('data', resolve);
       setTimeout(
         () => reject(new Error(`Failed to receive any data within the timeout: ${timeout}`)),
@@ -83,5 +82,4 @@ class HouseArrestService extends BaseServiceSocket {
   }
 }
 
-export {HouseArrestService, HOUSE_ARREST_SERVICE_NAME};
 export default HouseArrestService;

package/lib/imagemounter/index.js

@@ -1,40 +1,13 @@
 import {BaseServicePlist} from '../base-service';
 import {fs} from '@appium/support';
-import B from 'bluebird';
 import {log} from '../logger';
 const {lstat, readFile, createReadStream} = fs;
 
-const MOBILE_IMAGE_MOUNTER_SERVICE_NAME = 'com.apple.mobile.mobile_image_mounter';
+export const MOBILE_IMAGE_MOUNTER_SERVICE_NAME = 'com.apple.mobile.mobile_image_mounter';
 const FILE_TYPE_IMAGE = 'image';
 const FILE_TYPE_SIGNATURE = 'signature';
 
-function checkIfError(ret) {
-  if (ret.Error) {
-    throw new Error(ret.Error);
-  }
-  return ret;
-}
-
-async function assertIsFile(filePath, fileType) {
-  /** @type {import('fs').Stats | undefined} */
-  let fileStat;
-  try {
-    fileStat = await lstat(filePath);
-  } catch (err) {
-    if (/** @type {NodeJS.ErrnoException} */ (err).code === 'ENOENT') {
-      throw new Error(`The provided ${fileType} path does not exist: ${filePath}`);
-    }
-    throw err;
-  }
-  if (fileStat.isDirectory()) {
-    throw new Error(
-      `The provided ${fileType} path is expected to be a file, but a directory was given: ${filePath}`,
-    );
-  }
-  return fileStat;
-}
-
-class ImageMounter extends BaseServicePlist {
+export class ImageMounter extends BaseServicePlist {
   /**
    * Lookup for mounted images.
    * @param {string} imageType Type of image, `Developer` by default.
@@ -63,7 +36,7 @@ class ImageMounter extends BaseServicePlist {
    */
   async mount(imageFilePath, imageSignatureFilePath, imageType = 'Developer') {
     //check file stats
-    const [imageFileStat] = await B.all([
+    const [imageFileStat] = await Promise.all([
       assertIsFile(imageFilePath, FILE_TYPE_IMAGE),
       assertIsFile(imageSignatureFilePath, FILE_TYPE_SIGNATURE),
     ]);
@@ -91,7 +64,7 @@ class ImageMounter extends BaseServicePlist {
     //push image to device
     const stream = createReadStream(imageFilePath);
     try {
-      await new B((resolve, reject) => {
+      await new Promise((resolve, reject) => {
         stream.on('end', resolve);
         stream.on('error', reject);
         stream.on('data', async (data) => {
@@ -124,4 +97,29 @@ class ImageMounter extends BaseServicePlist {
     checkIfError(mountResult);
   }
 }
-export {ImageMounter, MOBILE_IMAGE_MOUNTER_SERVICE_NAME};
+
+function checkIfError(ret) {
+  if (ret.Error) {
+    throw new Error(ret.Error);
+  }
+  return ret;
+}
+
+async function assertIsFile(filePath, fileType) {
+  /** @type {import('fs').Stats | undefined} */
+  let fileStat;
+  try {
+    fileStat = await lstat(filePath);
+  } catch (err) {
+    if (/** @type {NodeJS.ErrnoException} */ (err).code === 'ENOENT') {
+      throw new Error(`The provided ${fileType} path does not exist: ${filePath}`, {cause: err});
+    }
+    throw err;
+  }
+  if (fileStat.isDirectory()) {
+    throw new Error(
+      `The provided ${fileType} path is expected to be a file, but a directory was given: ${filePath}`,
+    );
+  }
+  return fileStat;
+}

package/lib/imagemounter/utils/list_developer_image.js

@@ -40,6 +40,52 @@ const DEFAULT_IMAGE_DIR_NAME = 'iOSDeviceSupport';
 const DEVELOPER_IMAGE_FILE_NAME = 'DeveloperDiskImage.dmg';
 const DEVELOPER_IMAGE_SIGNATURE_FILE_NAME = 'DeveloperDiskImage.dmg.signature';
 
+/**
+ * Find developer image for certain version. If developer image does not exists,
+ * this will try to find and download developer image, unzip to `${APPIUM_HOME}/iOSSupport/`
+ * @param {string} version full version of iOS device. The first two parts of version
+ * will be preserved when sending the request, e.g. `14.7.1` will be changed to `14.7`
+ * @param {ImageFromGithubRepo} githubImageOption
+ * @returns {Promise<ImagePath>}
+ * @throws If developer image is not found, or error while downloading or unzipping.
+ */
+export async function findDeveloperImage(version, githubImageOption) {
+  const finalVersion = version.split('.').splice(0, 2).join('.');
+  const fileName = `${finalVersion}.zip`;
+  const DEFAULT_IMAGE_DIR = joinPath(await env.resolveAppiumHome(), DEFAULT_IMAGE_DIR_NAME);
+  const fullDownloadPath = joinPath(DEFAULT_IMAGE_DIR, fileName);
+  if (!(await exists(DEFAULT_IMAGE_DIR))) {
+    await mkdir(DEFAULT_IMAGE_DIR, {recursive: true});
+  }
+  if (!(await exists(fullDownloadPath))) {
+    await searchAndDownloadDeveloperImageFromGithub(
+      finalVersion,
+      fullDownloadPath,
+      githubImageOption,
+    );
+  }
+  const decompressPath = joinPath(DEFAULT_IMAGE_DIR, finalVersion);
+  /** @type {string | undefined} */
+  let developerImageParentFolder;
+  if (await exists(decompressPath)) {
+    developerImageParentFolder = await findDeveloperImageFromDirectory(decompressPath);
+  }
+  if (!developerImageParentFolder) {
+    await zip.extractAllTo(fullDownloadPath, decompressPath);
+    developerImageParentFolder = await findDeveloperImageFromDirectory(decompressPath);
+  }
+  if (!developerImageParentFolder) {
+    throw new Error(`Unable to find unzipped developer image in ${decompressPath}`);
+  }
+  return {
+    developerImage: joinPath(developerImageParentFolder, DEVELOPER_IMAGE_FILE_NAME),
+    developerImageSignature: joinPath(
+      developerImageParentFolder,
+      DEVELOPER_IMAGE_SIGNATURE_FILE_NAME,
+    ),
+  };
+}
+
 /**
  * Use list api to return the file list of folder.
  * @param {ImageFromGithubRepo} githubImageOption
@@ -84,6 +130,12 @@ async function listGithubImageList(githubImageOption) {
   }
 }
 
+/**
+ * @typedef {Object} ImagePath
+ * @property {string} developerImage
+ * @property {string} developerImageSignature
+ */
+
 /**
  * Find `DeveloperDiskImage.dmg` recursively under folder and subfolder.
  * @param {string} entry current folder
@@ -106,58 +158,6 @@ async function findDeveloperImageFromDirectory(entry) {
   }
 }
 
-/**
- * @typedef {Object} ImagePath
- * @property {string} developerImage
- * @property {string} developerImageSignature
- */
-
-/**
- * Find developer image for certain version. If developer image does not exists,
- * this will try to find and download developer image, unzip to `${APPIUM_HOME}/iOSSupport/`
- * @param {string} version full version of iOS device. The first two parts of version
- * will be preserved when sending the request, e.g. `14.7.1` will be changed to `14.7`
- * @param {ImageFromGithubRepo} githubImageOption
- * @returns {Promise<ImagePath>}
- * @throws If developer image is not found, or error while downloading or unzipping.
- */
-async function findDeveloperImage(version, githubImageOption) {
-  const finalVersion = version.split('.').splice(0, 2).join('.');
-  const fileName = `${finalVersion}.zip`;
-  const DEFAULT_IMAGE_DIR = joinPath(await env.resolveAppiumHome(), DEFAULT_IMAGE_DIR_NAME);
-  const fullDownloadPath = joinPath(DEFAULT_IMAGE_DIR, fileName);
-  if (!(await exists(DEFAULT_IMAGE_DIR))) {
-    await mkdir(DEFAULT_IMAGE_DIR, {recursive: true});
-  }
-  if (!(await exists(fullDownloadPath))) {
-    await searchAndDownloadDeveloperImageFromGithub(
-      finalVersion,
-      fullDownloadPath,
-      githubImageOption,
-    );
-  }
-  const decompressPath = joinPath(DEFAULT_IMAGE_DIR, finalVersion);
-  /** @type {string | undefined} */
-  let developerImageParentFolder;
-  if (await exists(decompressPath)) {
-    developerImageParentFolder = await findDeveloperImageFromDirectory(decompressPath);
-  }
-  if (!developerImageParentFolder) {
-    await zip.extractAllTo(fullDownloadPath, decompressPath);
-    developerImageParentFolder = await findDeveloperImageFromDirectory(decompressPath);
-  }
-  if (!developerImageParentFolder) {
-    throw new Error(`Unable to find unzipped developer image in ${decompressPath}`);
-  }
-  return {
-    developerImage: joinPath(developerImageParentFolder, DEVELOPER_IMAGE_FILE_NAME),
-    developerImageSignature: joinPath(
-      developerImageParentFolder,
-      DEVELOPER_IMAGE_SIGNATURE_FILE_NAME,
-    ),
-  };
-}
-
 /**
  *
  * @param {string} finalVersion
@@ -196,5 +196,3 @@ async function searchAndDownloadDeveloperImageFromGithub(
     throw e;
   }
 }
-
-export {findDeveloperImage};

package/lib/installation-proxy/index.js

@@ -5,9 +5,9 @@ import {BaseServicePlist} from '../base-service';
  * https://github.com/tmothy20013/libimobiledevice-master/blob/ecd89b42021cf6f7efe9ad271b3bddc7dd4b281e/src/installation_proxy.c
  */
 
-const INSTALLATION_PROXY_SERVICE_NAME = 'com.apple.mobile.installation_proxy';
+export const INSTALLATION_PROXY_SERVICE_NAME = 'com.apple.mobile.installation_proxy';
 
-class InstallationProxyService extends BaseServicePlist {
+export class InstallationProxyService extends BaseServicePlist {
   /**
    * Install the application on the relative path on the phone
    * @param {string} path The path where the .app and .ipa is located at on the phone
@@ -165,5 +165,4 @@ class InstallationProxyService extends BaseServicePlist {
   }
 }
 
-export {InstallationProxyService, INSTALLATION_PROXY_SERVICE_NAME};
 export default InstallationProxyService;