feat: Save tunnel registry using strong box (#2585)

* Introduce remote xpc tunnel creation

Co-authored-by: SrinivasanTarget <srinivasan.sekar1990@gmail.com>

Author: saikrishna321

docs/reference/scripts.md

@@ -17,3 +17,7 @@ appium driver run xcuitest <script-name>
 |`open-wda`|Opens the WebDriverAgent project in Xcode|
 |`build-wda`|Builds the WebDriverAgent project using the first available iPhone simulator and the latest iOS supported by the current Xcode version by default|
 |`build-wda --sdk=17.5 --name="iPhone 15"`|Builds the WebDriverAgent project using the iPhone 15 simulator with iOS 17.5. If `--sdk` and `--name` params are not specified - the latest iOS and the first available iPhone simulator will be used|
+|`tunnel-creation`|Creates tunnels for connected iOS devices, starts CoreDeviceProxy, and sets up a tunnel registry server. Requires sudo access to communicate with iOS devices|
+|`tunnel-creation --udid=<device-udid>` or `-u <device-udid>`|Creates a tunnel for a specific iOS device with the given UDID|
+|`tunnel-creation --packet-stream-base-port=<port>`|Specifies the base port for packet stream servers (default: 50000)|
+|`tunnel-creation --tunnel-registry-port=<port>`|Specifies the port for the tunnel registry server (default: 42314)|

lib/ios-fs-helpers.js

@@ -97,9 +97,12 @@ export async function pullFolder(afcService, remoteRootPath) {
       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);
+          }
+        }
       }
-      // @ts-ignore
-      _.remove(pullPromises, (p) => p.isFulfilled());
     });
     // Wait for the rest of files to be pulled
     if (!_.isEmpty(pullPromises)) {
@@ -163,10 +166,8 @@ async function remoteMkdirp(afcService, remoteRoot) {
  * folder structure is created automatically if necessary.
  * @param {PushFileOptions} [opts={}]
  */
-export async function pushFile (afcService, localPathOrPayload, remotePath, opts = {}) {
-  const {
-    timeoutMs = IO_TIMEOUT_MS,
-  } = 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)
@@ -209,9 +210,9 @@ export async function pushFile (afcService, localPathOrPayload, remotePath, opts
     : (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`
+      `to the remote location '${remotePath}' in ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
   );
-};
+}
 
 /**
  * @typedef {Object} PushFolderOptions
@@ -236,11 +237,13 @@ 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,
-    }))
+  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
@@ -319,12 +322,19 @@ export async function pushFolder(afcService, srcRootPath, dstRootPath, opts = {}
           throw new TimeoutError(`Timed out after ${elapsedMs} ms`);
         }
       }
-      // @ts-ignore
-      _.remove(pushPromises, (p) => p.isFulfilled());
+      for (let i = pushPromises.length - 1; i >= 0; i--) {
+        if (pushPromises[i].isFulfilled()) {
+          pushPromises.splice(i, 1);
+        }
+      }
     }
     if (!_.isEmpty(pushPromises)) {
-      // handle the rest of push promises
-      await B.all(pushPromises).timeout(Math.max(timeoutMs - timer.getDuration().asMilliSeconds, 60000));
+      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`);

package.json

@@ -32,7 +32,8 @@
     "mainClass": "XCUITestDriver",
     "scripts": {
       "build-wda": "./scripts/build-wda.js",
-      "open-wda": "./scripts/open-wda.js"
+      "open-wda": "./scripts/open-wda.js",
+      "tunnel-creation": "./scripts/tunnel-creation.mjs"
     },
     "schema": {
       "$schema": "http://json-schema.org/draft-07/schema",
@@ -76,6 +77,7 @@
   ],
   "types": "./build/index.d.ts",
   "dependencies": {
+    "@appium/strongbox": "^0.x",
     "@colors/colors": "^1.6.0",
     "appium-idb": "^1.6.13",
     "appium-ios-device": "^2.8.0",
@@ -97,8 +99,8 @@
     "semver": "^7.5.4",
     "source-map-support": "^0.x",
     "teen_process": "^2.2.0",
-    "ws": "^8.13.0",
-    "winston": "3.17.0"
+    "winston": "3.17.0",
+    "ws": "^8.13.0"
   },
   "scripts": {
     "build": "tsc -b",