appium-xcuitest-driver 11.2.3 → 11.2.4

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [11.2.4](https://github.com/appium/appium-xcuitest-driver/compare/v11.2.3...v11.2.4) (2026-05-08)
+
+### Bug Fixes
+
+* Tunnels cleanup ([#2834](https://github.com/appium/appium-xcuitest-driver/issues/2834)) ([e17218c](https://github.com/appium/appium-xcuitest-driver/commit/e17218c49111c500bef98aeee8d3739aafdfeb24))
+
 ## [11.2.3](https://github.com/appium/appium-xcuitest-driver/compare/v11.2.2...v11.2.3) (2026-05-07)
 
 ### Miscellaneous Chores

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "11.2.3",
+  "version": "11.2.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "11.2.3",
+      "version": "11.2.4",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^1.0.0-rc.1",
@@ -35,7 +35,7 @@
         "ws": "^8.13.0"
       },
       "devDependencies": {
-        "@appium/docutils": "^2.0.0-rc.1",
+        "@appium/docutils": "^2.4.0",
         "@appium/eslint-config-appium-ts": "^3.0.0",
         "@appium/tsconfig": "^1.0.0-rc.1",
         "@appium/types": "^1.0.0-rc.1",
@@ -595,12 +595,12 @@
       }
     },
     "node_modules/appium-ios-simulator": {
-      "version": "8.1.2",
-      "resolved": "https://registry.npmjs.org/appium-ios-simulator/-/appium-ios-simulator-8.1.2.tgz",
-      "integrity": "sha512-rA5FXFMMPYYNqStHK9k4OBlpqiogXnHASp3QdLtDOEEzjQZMPV1QPHfeoa/W3jmlLGxICkHSdlP2NB5CbJBJmA==",
+      "version": "8.1.3",
+      "resolved": "https://registry.npmjs.org/appium-ios-simulator/-/appium-ios-simulator-8.1.3.tgz",
+      "integrity": "sha512-ED3dNbxTO7YC/8UNKECY2mvePELtTKp9AXj+qwccK0UOMPWLURPszB1vVmZA5UGIykyeOeHBVcKbkSk709R8Gg==",
       "license": "Apache-2.0",
       "dependencies": {
-        "@appium/support": "^7.0.0-rc.1",
+        "@appium/support": "^7.2.2",
         "@xmldom/xmldom": "^0.x",
         "appium-xcode": "^6.0.0",
         "async-lock": "^1.0.0",
@@ -676,12 +676,12 @@
       }
     },
     "node_modules/appium-xcode": {
-      "version": "6.2.1",
-      "resolved": "https://registry.npmjs.org/appium-xcode/-/appium-xcode-6.2.1.tgz",
-      "integrity": "sha512-vY7D7GSm/m9KvRwJjk0AP9U+hT/MRoLN5OEohC2/vvbe5hxGp2H0nhUFYal2/6VwrL5U/P1zQKEIFUe3O8g0Dw==",
+      "version": "6.2.2",
+      "resolved": "https://registry.npmjs.org/appium-xcode/-/appium-xcode-6.2.2.tgz",
+      "integrity": "sha512-THnFNNPW2M680OzSdyHHcvF46CusrvW+/t+zCvVA+MK/sO1AE22GIHoUScbl8HeRxVI9gf1SsXravNSh8OoNaA==",
       "license": "Apache-2.0",
       "dependencies": {
-        "@appium/support": "^7.0.0-rc.1",
+        "@appium/support": "^7.2.2",
         "asyncbox": "^6.0.1",
         "semver": "^7.0.0",
         "teen_process": "^4.0.4"
@@ -1062,9 +1062,9 @@
       }
     },
     "node_modules/brace-expansion": {
-      "version": "5.0.5",
-      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz",
-      "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==",
+      "version": "5.0.6",
+      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.6.tgz",
+      "integrity": "sha512-kLpxurY4Z4r9sgMsyG0Z9uzsBlgiU/EFKhj/h91/8yHu0edo7XuixOIH3VcJ8kkxs6/jPzoI6U9Vj3WqbMQ94g==",
       "license": "MIT",
       "dependencies": {
         "balanced-match": "^4.0.2"
@@ -1953,9 +1953,9 @@
       }
     },
     "node_modules/get-east-asian-width": {
-      "version": "1.5.0",
-      "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.5.0.tgz",
-      "integrity": "sha512-CQ+bEO+Tva/qlmw24dCejulK5pMzVnUOFOijVogd3KQs07HnRIgp8TGipvCCRT06xeYEbpbgwaCxglFyiuIcmA==",
+      "version": "1.6.0",
+      "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.6.0.tgz",
+      "integrity": "sha512-QRbvDIbx6YklUe6RxeTeleMR0yv3cYH6PsPZHcnVn7xv7zO1BHN8r0XETu8n6Ye3Q+ahtSarc3WgtNWmehIBfA==",
       "license": "MIT",
       "engines": {
         "node": ">=18"
@@ -2780,9 +2780,9 @@
       }
     },
     "node_modules/node-devicectl": {
-      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/node-devicectl/-/node-devicectl-1.3.0.tgz",
-      "integrity": "sha512-BrX8w5XkqeiZHW6wbfQBTnfu9HUAb/dPdNphtmiO4xrQJQBdxB44nyhtsTHMcdLzZLJJGJhyT+YWMNudFx9/dA==",
+      "version": "1.3.1",
+      "resolved": "https://registry.npmjs.org/node-devicectl/-/node-devicectl-1.3.1.tgz",
+      "integrity": "sha512-hjjE/1RuvQ7BnjHqTfi4yhKGVVcTo/rEPdVzj1sIIQk29cvdsa1yXqfM4v4tQNiRcL2lMMqbO1hSkCBVAJ/w1g==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/logger": "^2.0.0-rc.1",
@@ -2806,9 +2806,9 @@
       }
     },
     "node_modules/node-simctl": {
-      "version": "8.2.2",
-      "resolved": "https://registry.npmjs.org/node-simctl/-/node-simctl-8.2.2.tgz",
-      "integrity": "sha512-VdEsKHI9r1dih0UvYejNG1sFqb/EYjfr4fp5LiV3ny7PEni3j7IzYIqQzJ1XilTdI7mk8vZG7kTOKqr24OCq9Q==",
+      "version": "8.2.3",
+      "resolved": "https://registry.npmjs.org/node-simctl/-/node-simctl-8.2.3.tgz",
+      "integrity": "sha512-udjYoXRsApFQP0fggKwGWFWUqinJKY11zIUmMxMv8Q4sfMLV0Uu9iavRUfiB3QOmJvL4WAXTaHv+tZvkiT+nyQ==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/logger": "^2.0.0-rc.1",

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "11.2.3",
+  "version": "11.2.4",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -143,7 +143,7 @@
     "appium": "^3.0.0-rc.2"
   },
   "devDependencies": {
-    "@appium/docutils": "^2.0.0-rc.1",
+    "@appium/docutils": "^2.4.0",
     "@appium/eslint-config-appium-ts": "^3.0.0",
     "@appium/tsconfig": "^1.0.0-rc.1",
     "@appium/types": "^1.0.0-rc.1",

package/scripts/tunnel-creation.mjs

@@ -41,6 +41,8 @@ class TunnelCreator {
     this._tunnelRegistryPort = 42314;
     /** @type {import('appium-ios-remotexpc').TunnelRegistry | null} */
     this._registry = null;
+    /** @type {import('appium-ios-remotexpc').TunnelRegistryServer | null} */
+    this._registryServer = null;
     /** @type {Map<string, import('appium-ios-remotexpc').UsbmuxDevice>} */
     this._usbDevices = new Map();
     /** @type {Map<string, Promise<void>>} */
@@ -75,6 +77,10 @@ class TunnelCreator {
     return this._registry;
   }
 
+  get registryServer() {
+    return this._registryServer;
+  }
+
   set packetStreamBasePort(port) {
     this._packetStreamBasePort = port;
   }
@@ -97,6 +103,13 @@ class TunnelCreator {
     this._registry = value;
   }
 
+  /**
+   * @param {import('appium-ios-remotexpc').TunnelRegistryServer | null} value
+   */
+  set registryServer(value) {
+    this._registryServer = value;
+  }
+
   /**
    * @param {number | null} maxAttempts - null disables retries; 0 means unlimited retries
    * @param {number} intervalMs
@@ -171,12 +184,29 @@ class TunnelCreator {
   async cleanup() {
     this._isCleaningUp = true;
     log.warn('Cleaning up tunnel resources...');
+    /** @type {Error[]} */
+    const cleanupErrors = [];
+    const recordCleanupError = (message, err) => {
+      const wrapped = err instanceof Error ? err : new Error(String(err));
+      cleanupErrors.push(new Error(message, {cause: wrapped}));
+      log.warn(`${message}: ${wrapped.message}`);
+    };
+
     while (this._registryWatcherStops.length > 0) {
       const stop = this._registryWatcherStops.pop();
       try {
         await stop?.();
       } catch (err) {
-        log.warn(`Failed to stop tunnel registry watcher: ${err}`);
+        recordCleanupError('Failed to stop tunnel registry watcher', err);
+      }
+    }
+    if (this._registryServer) {
+      try {
+        await this._registryServer.stop();
+      } catch (err) {
+        recordCleanupError('Failed to stop tunnel registry server', err);
+      } finally {
+        this._registryServer = null;
       }
     }
 
@@ -194,7 +224,7 @@ class TunnelCreator {
             await server.stop();
             log.info(`Closed packet stream server for device ${udid}`);
           } catch (err) {
-            log.warn(`Failed to close packet stream server for device ${udid}: ${err}`);
+            recordCleanupError(`Failed to close packet stream server for device ${udid}`, err);
           }
         }),
       );
@@ -216,9 +246,18 @@ class TunnelCreator {
     })();
 
     await Promise.allSettled([closeUsbPacketStreamServers, closeAppleTVTunnels]);
+    try {
+      await TunnelManager.closeAllTunnels();
+    } catch (err) {
+      recordCleanupError('Failed to close managed tunnel(s)', err);
+    }
     await Promise.allSettled([...this._reconnectTasks.values()]);
 
-    log.info('Cleanup completed.');
+    if (cleanupErrors.length > 0) {
+      throw new AggregateError(cleanupErrors, 'Tunnel cleanup encountered errors');
+    } else {
+      log.info('Cleanup completed.');
+    }
   }
 
   /**
@@ -914,6 +953,9 @@ function setupCleanupHandlers(tunnelCreator) {
       await tunnelCreator.cleanup();
     } catch (err) {
       log.warn(`Error during tunnel cleanup: ${err?.message ?? err}`);
+      if (!process.exitCode) {
+        process.exitCode = 1;
+      }
     }
   };
 
@@ -923,7 +965,8 @@ function setupCleanupHandlers(tunnelCreator) {
       if (process.exitCode == null) {
         // Follow conventional POSIX exit codes for signals where possible.
         if (signal === 'SIGINT') {
-          process.exitCode = 130;
+          // SIGINT is typically sent by Ctrl+C, so we exit with code 0 to indicate success.
+          process.exitCode = 0;
         } else if (signal === 'SIGTERM') {
           process.exitCode = 143;
         } else {
@@ -1093,7 +1136,10 @@ async function main() {
       return;
     }
 
-    await startTunnelRegistryServer(registry, tunnelCreator.tunnelRegistryPort);
+    tunnelCreator.registryServer = await startTunnelRegistryServer(
+      registry,
+      tunnelCreator.tunnelRegistryPort,
+    );
     tunnelCreator._attachTunnelRegistryLifecycleWatch(watchTunnelRegistrySockets, usbResults, {
       onTunnelDead: async ({udid}) => {
         tunnelCreator._reconnectTunnelByUdid(udid);