@xenon-device-management/xenon 1.17.2 → 1.17.3

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@xenon-device-management/xenon",
-    "version": "1.17.2",
+    "version": "1.17.3",
     "description": "Xenon - Intelligent Mobile Infrastructure. A self-healing device orchestration platform for Appium.",
     "main": "./lib/src/index.js",
     "exports": {

package/lib/src/services/SessionLifecycleService.js

@@ -51,7 +51,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionLifecycleService = void 0;
+exports.SessionLifecycleService = exports.XCTRUNNER_SUFFIX = void 0;
+exports.stripXctrunnerSuffix = stripXctrunnerSuffix;
 const typedi_1 = require("typedi");
 const uuid_1 = require("uuid");
 const lodash_1 = __importDefault(require("lodash"));
@@ -88,6 +89,26 @@ const commandsQueueGuard = new async_lock_1.default();
 // Serializes concurrent deleteSession cleanup for the same sessionId so
 // that onSessionStopped events don't fire twice if two clients race.
 const sessionCleanupLock = new async_lock_1.default();
+/** The suffix appium-webdriveragent appends to `updatedWDABundleId`. */
+exports.XCTRUNNER_SUFFIX = '.xctrunner';
+/**
+ * Normalise an installed WebDriverAgent bundle id for `appium:updatedWDABundleId`.
+ *
+ * The driver derives its keep-list entry as
+ * `${updatedWDABundleId ?? WDA_RUNNER_BUNDLE_ID}${'.xctrunner'}`, so the
+ * capability wants the id *without* the runner suffix — it puts it back. Handing
+ * it the id exactly as installed yields `…xctrunner.xctrunner`, which matches
+ * nothing, and the app the keep-list was meant to protect is uninstalled.
+ *
+ * Only a trailing occurrence is removed: a bundle id may legitimately contain
+ * the word elsewhere, and `String.replace` without an anchor would cut the
+ * first one it found.
+ */
+function stripXctrunnerSuffix(bundleId) {
+    return bundleId.endsWith(exports.XCTRUNNER_SUFFIX)
+        ? bundleId.slice(0, -exports.XCTRUNNER_SUFFIX.length)
+        : bundleId;
+}
 let SessionLifecycleService = class SessionLifecycleService {
     constructor() {
         this.logger = logger_1.default.scope('SessionLifecycleService');
@@ -377,9 +398,19 @@ let SessionLifecycleService = class SessionLifecycleService {
         // `webDriverAgentUrl` alone is enough to reuse a running WDA, and it does
         // not enter that cleanup path — so when the bundle id is unknown, the safe
         // move is to say less, not more.
+        //
+        // The suffix matters as much as the value. The keep-list entry is
+        // `bundleIdForXctest`, which the driver builds as
+        // `${updatedWDABundleId ?? WDA_RUNNER_BUNDLE_ID}${'.xctrunner'}` — so this
+        // capability wants the id WITHOUT the runner suffix, and the driver adds
+        // it back. Passing the installed id verbatim produced a keep-list of
+        // `com.qasecret.WebDriverAgentRunner.xctrunner.xctrunner`, which matched
+        // nothing on the device, and the real runner was uninstalled anyway. That
+        // is the same normalisation the driver applies to its own prebuilt path:
+        // `updatedWDABundleId = candidateBundleId.replace('.xctrunner', '')`.
         if (bundleId) {
             target['appium:usePreinstalledWDA'] = true;
-            target['appium:updatedWDABundleId'] = bundleId;
+            target['appium:updatedWDABundleId'] = stripXctrunnerSuffix(bundleId);
         }
         else {
             logger_1.default.warn(`[Xenon] Could not identify the WebDriverAgent bundle on this device; reusing it by URL only. ` +

package/lib/test/unit/wda-cap-injection.spec.js

@@ -34,7 +34,22 @@ describe('WDA capability injection', () => {
         const caps = { alwaysMatch: {}, firstMatch: [{}] };
         inject(caps, WDA_URL, BUNDLE);
         (0, chai_1.expect)(caps.alwaysMatch['appium:usePreinstalledWDA']).to.equal(true);
-        (0, chai_1.expect)(caps.alwaysMatch['appium:updatedWDABundleId']).to.equal(BUNDLE);
+        (0, chai_1.expect)(caps.alwaysMatch['appium:updatedWDABundleId']).to.equal('com.qasecret.WebDriverAgentRunner');
+    });
+    it('sends the id the driver will rebuild into the installed one', () => {
+        // This is the whole contract, and getting it wrong is not a near miss:
+        // the driver's keep-list is `updatedWDABundleId + '.xctrunner'`, so an
+        // id that is off by that suffix protects a bundle that does not exist
+        // and the real runner is uninstalled from the device.
+        const caps = { alwaysMatch: {}, firstMatch: [{}] };
+        inject(caps, WDA_URL, BUNDLE);
+        const keepListEntry = caps.alwaysMatch['appium:updatedWDABundleId'] + SessionLifecycleService_1.XCTRUNNER_SUFFIX;
+        (0, chai_1.expect)(keepListEntry).to.equal(BUNDLE);
+    });
+    it('leaves an id that already lacks the suffix alone', () => {
+        const caps = { alwaysMatch: {}, firstMatch: [{}] };
+        inject(caps, WDA_URL, 'com.qasecret.WebDriverAgentRunner');
+        (0, chai_1.expect)(caps.alwaysMatch['appium:updatedWDABundleId'] + SessionLifecycleService_1.XCTRUNNER_SUFFIX).to.equal(BUNDLE);
     });
     it('never claims a preinstalled WDA it cannot name', () => {
         // The destructive combination. `webDriverAgentUrl` alone still reuses the
@@ -73,6 +88,10 @@ describe('WDA capability injection', () => {
         (0, chai_1.expect)(caps.firstMatch[0]['appium:usePreinstalledWDA']).to.equal(undefined);
         (0, chai_1.expect)(caps.alwaysMatch['appium:webDriverAgentUrl']).to.equal(WDA_URL);
     });
+    it('only strips a trailing suffix, never one embedded in the id', () => {
+        (0, chai_1.expect)((0, SessionLifecycleService_1.stripXctrunnerSuffix)('com.x.xctrunner.WebDriverAgentRunner.xctrunner')).to.equal('com.x.xctrunner.WebDriverAgentRunner');
+        (0, chai_1.expect)((0, SessionLifecycleService_1.stripXctrunnerSuffix)('com.x.WebDriverAgentRunner')).to.equal('com.x.WebDriverAgentRunner');
+    });
     it('strips the caps that conflict with reusing a WDA by URL', () => {
         const caps = {
             alwaysMatch: { 'appium:wdaLocalPort': 8100, 'appium:derivedDataPath': '/tmp/dd' },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xenon-device-management/xenon",
-  "version": "1.17.2",
+  "version": "1.17.3",
   "description": "Xenon - Intelligent Mobile Infrastructure. A self-healing device orchestration platform for Appium.",
   "main": "./lib/src/index.js",
   "exports": {