@xenon-device-management/xenon 2.14.0 → 2.16.0

package/lib/test/unit/interceptor-visual-elements.spec.js

@@ -0,0 +1,192 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const chai_1 = require("chai");
+const sinon_1 = __importDefault(require("sinon"));
+const typedi_1 = require("typedi");
+const CommandInterceptor_1 = require("../../src/interceptors/CommandInterceptor");
+const HealingOrchestrator_1 = require("../../src/services/healing/HealingOrchestrator");
+const types_1 = require("../../src/services/healing/types");
+const OmniVisionService_1 = require("../../src/services/omni-vision/OmniVisionService");
+const SelfHealingSwitch_1 = require("../../src/services/settings/SelfHealingSwitch");
+const event_manager_1 = require("../../src/dashboard/event-manager");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+const container_registration_1 = require("../helpers/container-registration");
+const scratch_database_1 = require("../helpers/scratch-database");
+/**
+ * Elements Xenon found in a screenshot (Omni-Vision's `-custom:ai-*` locators,
+ * and self-healing's OCR and Visual AI tiers) are boxes on the screen with an
+ * id of Xenon's own (`omni_*`, `healed_ocr*`, `healed_visual*`). The
+ * interceptor answers their commands itself. Through 2.14:
+ *
+ * - a `-custom:ai-*` findElement that matched nothing answered `unknown error`
+ *   ("NoSuchElement: AI Vision failed…"), and self-healing then ran on it;
+ * - a healed OCR or Visual AI element was tapped during the find, and the
+ *   test's own click tapped it again;
+ * - `getText` on a healed element answered Xenon's note about the match;
+ * - `setValue` never reached the element: Appium passes it (text, elementId),
+ *   and the interceptor read the text as the element id.
+ *
+ * No AI provider, OCR or phone: healing, OCR and the driver are stubbed.
+ */
+describe('Elements Xenon found in a screenshot', () => {
+    (0, scratch_database_1.useScratchDatabase)();
+    const SESSION = 'visual-session';
+    let pluginArgs;
+    let restoreContainer;
+    let attemptHealing;
+    let driver;
+    let omni;
+    beforeEach(() => {
+        pluginArgs = Object.assign({}, IPluginArgs_1.DefaultPluginArgs);
+        restoreContainer = (0, container_registration_1.saveRegistrations)(HealingOrchestrator_1.HealingOrchestrator, SelfHealingSwitch_1.SelfHealingSwitch);
+        typedi_1.Container.set(SelfHealingSwitch_1.SelfHealingSwitch, new SelfHealingSwitch_1.SelfHealingSwitch());
+        attemptHealing = sinon_1.default.stub().resolves(null);
+        typedi_1.Container.set(HealingOrchestrator_1.HealingOrchestrator, { attemptHealing });
+        sinon_1.default.stub(event_manager_1.DASHBORD_EVENT_MANAGER, 'afterSessionCommand').resolves();
+        omni = typedi_1.Container.get(OmniVisionService_1.OmniVisionService);
+        driver = {
+            sessionId: SESSION,
+            caps: { platformName: 'Android' },
+            performActions: sinon_1.default.stub().resolves(),
+            releaseActions: sinon_1.default.stub().resolves(),
+            findElement: sinon_1.default.stub().rejects(new Error('unexpected find')),
+            active: sinon_1.default.stub().resolves({ 'element-6066-11e4-a52e-4f735466cecf': 'field-1' }),
+            setValue: sinon_1.default.stub().resolves(null),
+            elementEnabled: sinon_1.default.stub().resolves(true),
+        };
+    });
+    afterEach(() => {
+        restoreContainer();
+        sinon_1.default.restore();
+    });
+    const run = (command, args, next = () => undefined) => typedi_1.Container.get(CommandInterceptor_1.CommandInterceptor).handle(() => __awaiter(void 0, void 0, void 0, function* () { return next(); }), driver, command, [...args, SESSION], pluginArgs, false);
+    const failure = (promise) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            yield promise;
+        }
+        catch (err) {
+            return err;
+        }
+        throw new Error('expected the command to fail');
+    });
+    const tapsAt = () => driver.performActions.getCalls().map((c) => {
+        const move = c.args[0][0].actions[0];
+        return { x: move.x, y: move.y };
+    });
+    describe('a -custom:ai-* find that matches nothing', () => {
+        it('fails with the standard "no such element" error for ai-text', () => __awaiter(void 0, void 0, void 0, function* () {
+            sinon_1.default.stub(omni, 'findByText').resolves([]);
+            const err = yield failure(run('findElement', ['-custom:ai-text', 'Checkout']));
+            (0, chai_1.expect)(err.error).to.equal('no such element');
+            (0, chai_1.expect)(err.w3cStatus).to.equal(404);
+        }));
+        it('fails with the standard "no such element" error for ai-icon', () => __awaiter(void 0, void 0, void 0, function* () {
+            sinon_1.default.stub(omni, 'findByIcon').resolves(null);
+            const err = yield failure(run('findElement', ['-custom:ai-icon', 'a cart icon']));
+            (0, chai_1.expect)(err.error).to.equal('no such element');
+        }));
+        it('is not handed to self-healing', () => __awaiter(void 0, void 0, void 0, function* () {
+            sinon_1.default.stub(omni, 'findByText').resolves([]);
+            yield failure(run('findElement', ['-custom:ai-text', 'Checkout']));
+            (0, chai_1.expect)(attemptHealing.called).to.equal(false);
+        }));
+        it('still answers an empty list to findElements', () => __awaiter(void 0, void 0, void 0, function* () {
+            sinon_1.default.stub(omni, 'findByText').resolves([]);
+            (0, chai_1.expect)(yield run('findElements', ['-custom:ai-text', 'Checkout'])).to.deep.equal([]);
+        }));
+    });
+    describe('a healed OCR or Visual AI element', () => {
+        const healedBy = (id, tier, text) => (Object.assign({ id,
+            tier, confidence: 0.9, originalSelector: "//*[@text='Login']", originalStrategy: 'xpath', recommendedSelector: 'ocr:text="Login"', recommendedStrategy: 'xenon:visual', message: 'Found text "Login" via local OCR (90% confidence)', rect: { x: 100, y: 400, width: 80, height: 24 } }, (text !== undefined ? { text } : {})));
+        const findHealed = (healed) => __awaiter(void 0, void 0, void 0, function* () {
+            attemptHealing.resolves(healed);
+            return run('findElement', ['xpath', "//*[@text='Login']"], () => {
+                throw Object.assign(new Error('NoSuchElement: gone'), { name: 'NoSuchElementError' });
+            });
+        });
+        it('is not tapped during the find', () => __awaiter(void 0, void 0, void 0, function* () {
+            const found = yield findHealed(healedBy('healed_ocr_1', types_1.HealingTier.TIER_3_LOCAL_OCR, 'Login'));
+            (0, chai_1.expect)(found).to.deep.include({ 'element-6066-11e4-a52e-4f735466cecf': 'healed_ocr_1' });
+            (0, chai_1.expect)(driver.performActions.called, 'tapped during the find').to.equal(false);
+        }));
+        it("is tapped once, by the test's own click", () => __awaiter(void 0, void 0, void 0, function* () {
+            yield findHealed(healedBy('healed_visual_1', types_1.HealingTier.TIER_4_VISUAL_AI));
+            yield run('click', ['healed_visual_1']);
+            (0, chai_1.expect)(tapsAt()).to.deep.equal([{ x: 140, y: 412 }]);
+        }));
+        it('answers getText with the text OCR read, not a note about the match', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield findHealed(healedBy('healed_ocr_2', types_1.HealingTier.TIER_3_LOCAL_OCR, 'Login'));
+            (0, chai_1.expect)(yield run('getText', ['healed_ocr_2'])).to.equal('Login');
+        }));
+        it('refuses getText when Visual AI found it, since no text was read', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield findHealed(healedBy('healed_visual_2', types_1.HealingTier.TIER_4_VISUAL_AI));
+            const err = yield failure(run('getText', ['healed_visual_2']));
+            (0, chai_1.expect)(err.error).to.equal('unsupported operation');
+            (0, chai_1.expect)(err.message).to.match(/text/i);
+        }));
+    });
+    describe('setValue on an element found in a screenshot', () => {
+        beforeEach(() => {
+            omni.remember(SESSION, {
+                id: 'omni_ocr_field',
+                text: 'Email',
+                rect: { x: 10, y: 20, width: 100, height: 40 },
+                confidence: 0.9,
+            });
+        });
+        it('taps it, then types into the field that has the keyboard focus', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield run('setValue', ['me@example.com', 'omni_ocr_field']);
+            (0, chai_1.expect)(tapsAt()).to.deep.equal([{ x: 60, y: 40 }]);
+            (0, chai_1.expect)(driver.active.calledAfter(driver.performActions)).to.equal(true);
+            (0, chai_1.expect)(driver.setValue.firstCall.args.slice(0, 2)).to.deep.equal([
+                'me@example.com',
+                'field-1',
+            ]);
+        }));
+        it('refuses before tapping when the driver cannot tell which field has the focus', () => __awaiter(void 0, void 0, void 0, function* () {
+            delete driver.active;
+            const err = yield failure(run('setValue', ['me@example.com', 'omni_ocr_field']));
+            (0, chai_1.expect)(err.error).to.equal('unsupported operation');
+            (0, chai_1.expect)(driver.performActions.called, 'tapped').to.equal(false);
+        }));
+        it('says so when no field took the focus after the tap', () => __awaiter(void 0, void 0, void 0, function* () {
+            driver.active.rejects(new Error('no element has focus'));
+            const err = yield failure(run('setValue', ['me@example.com', 'omni_ocr_field']));
+            (0, chai_1.expect)(err.error).to.equal('element not interactable');
+            (0, chai_1.expect)(driver.setValue.called).to.equal(false);
+        }));
+    });
+    describe('other commands on an element found in a screenshot', () => {
+        it("refuses them clearly instead of sending Xenon's id to the driver", () => __awaiter(void 0, void 0, void 0, function* () {
+            omni.remember(SESSION, {
+                id: 'omni_ai_cart',
+                rect: { x: 0, y: 0, width: 40, height: 40 },
+                confidence: 0.85,
+            });
+            const next = sinon_1.default.stub();
+            const err = yield failure(run('getAttribute', ['content-desc', 'omni_ai_cart'], next));
+            (0, chai_1.expect)(err.error).to.equal('unsupported operation');
+            (0, chai_1.expect)(next.called, 'sent to the driver').to.equal(false);
+        }));
+    });
+    describe('autowait before setValue on a real element', () => {
+        it('waits for the element, not for an element named after the text', () => __awaiter(void 0, void 0, void 0, function* () {
+            pluginArgs = Object.assign(Object.assign({}, IPluginArgs_1.DefaultPluginArgs), { autowait: Object.assign(Object.assign({}, IPluginArgs_1.DefaultPluginArgs.autowait), { enabled: true }) });
+            yield run('setValue', ['hello', 'el-1']);
+            (0, chai_1.expect)(driver.elementEnabled.firstCall.args[0]).to.equal('el-1');
+        }));
+    });
+});

package/lib/test/unit/ios-driver-log.spec.js

@@ -0,0 +1,168 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const iosDriverLog_1 = require("../../src/services/logcat/iosDriverLog");
+// The driver's own log class (test/helpers/driver-log.ts): an iPhone's and a
+// simulator's `logs.syslog` extend it, so what Xenon reads is what the driver keeps.
+const driver_log_1 = require("../helpers/driver-log");
+const IPHONE_ERROR = 'Oct  5 20:31:40 iPhone SpringBoard(FrontBoard)[57] <Error>: Failed to launch com.example.shop';
+const IPHONE_NOTICE = 'Oct  5 20:31:41 iPhone backboardd[61] <Notice>: touch began';
+const SIM_FAULT = '2026-10-05 20:31:40.123 F  Shop[4127:8812] (UIKitCore) [com.apple.UIKit:Crash] Terminating app';
+const SIM_DEFAULT = '2026-10-05 20:31:40.200 Df SpringBoard[1234:5678] (FrontBoard) launched';
+describe('iosDriverLog', () => {
+    describe('iosLineLevel', () => {
+        it("reads an iPhone's syslog level", () => {
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(IPHONE_ERROR)).to.equal('E');
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(IPHONE_NOTICE)).to.equal('I');
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(IPHONE_ERROR.replace('<Error>', '<Fault>'))).to.equal('F');
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(IPHONE_ERROR.replace('<Error>', '<Warning>'))).to.equal('W');
+        });
+        it("reads a simulator's compact type", () => {
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(SIM_FAULT)).to.equal('F');
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(SIM_DEFAULT)).to.equal('I');
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(SIM_DEFAULT.replace(' Df ', ' E  '))).to.equal('E');
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)(SIM_DEFAULT.replace(' Df ', ' Db '))).to.equal('D');
+        });
+        it('takes a line with no level of its own as I', () => {
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineLevel)('\t0   Shop   0x0000000100abc123 main + 42')).to.equal('I');
+        });
+    });
+    describe('recordFromDriverLog', () => {
+        it('keeps the line as printed, at the time it reached the server', () => {
+            const rec = (0, iosDriverLog_1.recordFromDriverLog)({
+                timestamp: 1791000000123,
+                level: 'ALL',
+                message: IPHONE_ERROR,
+            });
+            (0, chai_1.expect)(rec).to.include({ ts: 1791000000123, level: 'E', message: IPHONE_ERROR });
+            (0, chai_1.expect)((0, iosDriverLog_1.iosLineText)(rec)).to.equal(IPHONE_ERROR);
+        });
+        it("drops what `log stream` prints before the simulator's first line", () => {
+            for (const banner of [
+                'Filtering the log data using "subsystem != \\"com.apple.CoreTelephony\\""',
+                'Timestamp               Ty Process[PID:TID]',
+            ]) {
+                (0, chai_1.expect)((0, iosDriverLog_1.recordFromDriverLog)({ timestamp: 1, message: banner }), banner).to.equal(null);
+            }
+        });
+        it("keeps a crash report's continuation lines, and drops empty ones", () => {
+            (0, chai_1.expect)((0, iosDriverLog_1.recordFromDriverLog)({ timestamp: 1, message: '\tThread 0 Crashed:' })).to.not.equal(null);
+            (0, chai_1.expect)((0, iosDriverLog_1.recordFromDriverLog)({ timestamp: 1, message: '   ' })).to.equal(null);
+            (0, chai_1.expect)((0, iosDriverLog_1.recordFromDriverLog)(undefined)).to.equal(null);
+        });
+    });
+    describe("the driver's own log", () => {
+        it('is something Xenon can listen to', () => {
+            (0, chai_1.expect)((0, iosDriverLog_1.isDriverLog)(new driver_log_1.TestDriverLog())).to.equal(true);
+            (0, chai_1.expect)((0, iosDriverLog_1.isDriverLog)(undefined)).to.equal(false);
+            (0, chai_1.expect)((0, iosDriverLog_1.isDriverLog)({ on() { } })).to.equal(false);
+        });
+        it('gives the lines it holds, oldest first, without taking them from the test', () => __awaiter(void 0, void 0, void 0, function* () {
+            const driverLog = new driver_log_1.TestDriverLog();
+            driverLog.line('first');
+            driverLog.line('second');
+            driverLog.line('third');
+            (0, chai_1.expect)((0, iosDriverLog_1.bufferedDriverLog)(driverLog).map((e) => e.message)).to.deep.equal([
+                'first',
+                'second',
+                'third',
+            ]);
+            // A test's own `getLog('syslog')` still gets every line.
+            const forTheTest = yield driverLog.getLogs();
+            (0, chai_1.expect)(forTheTest.map((e) => e.message)).to.deep.equal([
+                'first',
+                'second',
+                'third',
+            ]);
+        }));
+        it('gives nothing for a log of another shape', () => {
+            (0, chai_1.expect)((0, iosDriverLog_1.bufferedDriverLog)({})).to.deep.equal([]);
+            (0, chai_1.expect)((0, iosDriverLog_1.bufferedDriverLog)({ logs: { rvalues: () => [1] } })).to.deep.equal([]);
+            (0, chai_1.expect)((0, iosDriverLog_1.bufferedDriverLog)({
+                logs: { rvalues: () => [1] },
+                _deserializeEntry: () => {
+                    throw new Error('changed');
+                },
+            })).to.deep.equal([]);
+        });
+    });
+    // Lines as an iPhone 14 Plus (iOS 26.5) printed them during a session on
+    // Settings (com.apple.Preferences), pid 8429.
+    describe('IosAppLines', () => {
+        const at = (proc, text, level = 'Notice') => `Oct  5 23:48:33 Rabindras-iPhone ${proc} <${level}>: ${text}`;
+        const ANNOUNCE = at('runningboardd(RunningBoard)[34]', 'Acquiring assertion targeting [app<com.apple.Preferences(FEEDEEEE-DDDD)>:8429] from originator [osservice<com.apple.SpringBoard>:36947]');
+        // Written by the app's own code: no library, or the app's own binary.
+        const APP = at('Preferences[8429]', 'loading content for context');
+        const DAEMON = at('duetexpertd(DuetExpertCenter)[412]', 'Updating predictions');
+        const keeps = (f, m) => f.keeps(m, (0, iosDriverLog_1.iosLineLevel)(m));
+        it("keeps the app's own lines, the app manager's lines about it and faults, and leaves the rest", () => {
+            const f = new iosDriverLog_1.IosAppLines('com.apple.Preferences');
+            (0, chai_1.expect)(keeps(f, ANNOUNCE), 'the app manager names the app').to.equal(true);
+            (0, chai_1.expect)(keeps(f, APP), "the app's own code").to.equal(true);
+            (0, chai_1.expect)(keeps(f, at('Preferences(Preferences)[8429]', 'opened a pane')), 'its own binary').to.equal(true);
+            (0, chai_1.expect)(keeps(f, DAEMON), 'daemon chatter').to.equal(false);
+            (0, chai_1.expect)(keeps(f, at('wifid(WiFiPolicy)[61]', 'link quality dropped', 'Fault')), 'a fault').to.equal(true);
+            (0, chai_1.expect)(keeps(f, at('trustd(Security)[127]', 'SecKeyVerifySignature failed', 'Error'))).to.equal(false);
+        });
+        // Measured on Edge: 8,839 lines from its process, 5 of them its own code.
+        it("leaves out the frameworks' ordinary lines inside the app, and keeps their errors", () => {
+            const f = new iosDriverLog_1.IosAppLines('com.apple.Preferences');
+            f.learn(ANNOUNCE);
+            (0, chai_1.expect)(keeps(f, at('Preferences(UIKitCore)[8429]', 'Ending task with identifier 43'))).to.equal(false);
+            (0, chai_1.expect)(keeps(f, at('Preferences(CFNetwork)[8429]', 'Task finished', 'Error'))).to.equal(true);
+            (0, chai_1.expect)(keeps(f, at('Preferences(WebKit)[8429]', 'WebContent crashed', 'Fault'))).to.equal(true);
+        });
+        it('keeps a crash report or a memory kill that names the app by its executable', () => {
+            const f = new iosDriverLog_1.IosAppLines('com.apple.Preferences');
+            f.learn(ANNOUNCE);
+            f.learn(APP);
+            (0, chai_1.expect)(keeps(f, at('ReportCrash[9001]', 'Formulating fatal 309 report for corpse[8429] Preferences'))).to.equal(true);
+            (0, chai_1.expect)(keeps(f, at('ReportCrash[9001]', 'Saved crash report for Preferences[8429]'))).to.equal(true);
+            (0, chai_1.expect)(keeps(f, 'Oct  5 23:48:40 Rabindras-iPhone kernel[0] <Notice>: memorystatus: killing pid 8429 [Preferences]')).to.equal(true);
+            // A relaunch: a new pid, the same executable.
+            (0, chai_1.expect)(keeps(f, at('Preferences[8447]', 'scene connected'))).to.equal(true);
+        });
+        it("leaves out the daemons that only repeat the app's state", () => {
+            const f = new iosDriverLog_1.IosAppLines('com.apple.Preferences');
+            f.learn(ANNOUNCE);
+            for (const line of [
+                at('CommCenter(RunningBoardServices)[100]', 'Received state update for 8429 (app<com.apple.Preferences(FEEDEEEE)>, running-active-NotVisible'),
+                at('mobileassetd(MobileAssetDaemon)[120]', 'com.apple.Preferences issued query command'),
+            ]) {
+                (0, chai_1.expect)(keeps(f, line), line).to.equal(false);
+            }
+            (0, chai_1.expect)(keeps(f, at('SpringBoard(FrontBoard)[36947]', 'Application com.apple.Preferences exited'))).to.equal(true);
+        });
+        it('lets a line with no header follow the line before it', () => {
+            const f = new iosDriverLog_1.IosAppLines('com.apple.Preferences');
+            (0, chai_1.expect)(keeps(f, ANNOUNCE)).to.equal(true);
+            (0, chai_1.expect)(keeps(f, '    AssetLocale = "en_IN";')).to.equal(true);
+            (0, chai_1.expect)(keeps(f, DAEMON)).to.equal(false);
+            (0, chai_1.expect)(keeps(f, '    AssetLocale = "en_IN";')).to.equal(false);
+        });
+        it("reads a simulator's compact lines the same way", () => {
+            const f = new iosDriverLog_1.IosAppLines('com.example.shop');
+            const sim = (proc, text, type = 'Df') => `2026-10-05 20:31:40.123 ${type} ${proc} ${text}`;
+            (0, chai_1.expect)(keeps(f, sim('runningboardd[90:1200]', 'Acquiring assertion [app<com.example.shop(UUID)>:4127]'))).to.equal(true);
+            (0, chai_1.expect)(keeps(f, sim('Shop[4127:8812]', '(Shop) launched'))).to.equal(true);
+            (0, chai_1.expect)(keeps(f, sim('Shop[4127:8812]', '(UIKitCore) scene active'))).to.equal(false);
+            (0, chai_1.expect)(keeps(f, sim('Shop[4127:8812]', '(CFNetwork) task failed', 'E'))).to.equal(true);
+            (0, chai_1.expect)(keeps(f, sim('locationd[77:300]', 'region update'))).to.equal(false);
+            (0, chai_1.expect)(keeps(f, sim('Shop[4127:8812]', 'Terminating app', 'F'))).to.equal(true);
+        });
+        it("doesn't take a bundle id's dots as any character", () => {
+            const f = new iosDriverLog_1.IosAppLines('com.example.shop');
+            f.learn('Oct  5 23:48:33 iPhone runningboardd[34] <Notice>: [app<comXexampleXshop(UUID)>:5555]');
+            (0, chai_1.expect)(keeps(f, 'Oct  5 23:48:33 iPhone Other[5555] <Notice>: hello')).to.equal(false);
+        });
+    });
+});

package/lib/test/unit/ios-simulator-session-readiness.spec.js

@@ -0,0 +1,187 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const chai_1 = __importDefault(require("chai"));
+const sinon_1 = __importDefault(require("sinon"));
+const node_simctl_1 = require("node-simctl");
+const DeviceUtils = __importStar(require("../../src/device-utils"));
+const db_1 = require("../../src/data-service/db");
+const device_service_1 = require("../../src/data-service/device-service");
+const IOSDeviceManager_1 = __importDefault(require("../../src/device-managers/IOSDeviceManager"));
+const IOSStreamService_1 = __importDefault(require("../../src/device-managers/ios/IOSStreamService"));
+const WDAClient_1 = require("../../src/device-managers/ios/WDAClient");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+const XenonCapabilityManager_1 = require("../../src/XenonCapabilityManager");
+const test_container_1 = require("../helpers/test-container");
+const loki_stores_1 = require("../helpers/loki-stores");
+const scratch_database_1 = require("../helpers/scratch-database");
+const expect = chai_1.default.expect;
+/**
+ * A simulator's WebDriverAgent is the XCUITest driver's: the driver builds,
+ * installs and launches it on the session's `wdaLocalPort` once Appium
+ * creates the session, as plain Appium does. Xenon runs WDA only on an
+ * iPhone (go-ios `runwda`, for the live preview).
+ *
+ * Allocation used to require WDA to answer on the simulator's port before
+ * handing it over, and to "recover" it by rebooting the simulator, which
+ * starts no WDA. So every session on a simulator whose WDA wasn't already up
+ * was refused: "Device <udid> is unhealthy and could not be autonomously
+ * recovered."
+ */
+describe('iOS simulator sessions: the driver starts WebDriverAgent', () => {
+    const scratch = (0, scratch_database_1.useScratchDatabase)();
+    (0, loki_stores_1.useLokiStores)();
+    const sandbox = sinon_1.default.createSandbox();
+    const HOST = 'http://127.0.0.1:4723';
+    const SIMULATOR = '35429994-B029-4AF4-9634-880B89DAC782';
+    const IPHONE = '00008150-000E78612168C01C';
+    const pluginArgs = Object.assign({}, IPluginArgs_1.DefaultPluginArgs, {
+        platform: 'ios',
+        iosDeviceType: 'both',
+    });
+    const device = (udid, over = {}) => (Object.assign({ udid, name: 'iPhone 16 Pro', platform: 'ios', sdk: '18.4', host: HOST, busy: false, offline: false, userBlocked: false, state: 'Booted', deviceType: 'simulator', realDevice: false, 
+        // Leased by discovery for a booted simulator; nothing listens on it
+        // until the driver launches WDA there.
+        wdaLocalPort: 8102, mjpegServerPort: 9102, totalUtilizationTimeMilliSec: 0, sessionStartTime: 0 }, over));
+    let wdaAsked;
+    let simctlCommands;
+    before(() => (0, test_container_1.resetTestContainer)());
+    after(() => (0, test_container_1.resetTestContainer)());
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        sandbox.stub(process, 'kill');
+        (yield db_1.XenonDatabase.DeviceModel).removeDataOnly();
+        yield scratch.db.lease.deleteMany({});
+        sandbox.stub(DeviceUtils, 'setUtilizationTime').resolves();
+        sandbox.stub(IOSStreamService_1.default.prototype, 'getStreamStatus').returns(undefined);
+        // Nothing answers on the simulator's port, as on a freshly booted one.
+        wdaAsked = sandbox.stub(WDAClient_1.WDAClient.prototype, 'verifyWDAStatus').resolves(false);
+        // Every simctl call (shutdown, boot, list) goes through exec.
+        simctlCommands = [];
+        sandbox.stub(node_simctl_1.Simctl.prototype, 'exec').callsFake((subcommand) => __awaiter(void 0, void 0, void 0, function* () {
+            simctlCommands.push(subcommand);
+            return { stdout: '', stderr: '', code: 0 };
+        }));
+        (0, test_container_1.createTestXenonManager)(pluginArgs);
+    }));
+    afterEach(() => sandbox.restore());
+    const caps = (udid) => ({
+        alwaysMatch: {
+            platformName: 'iOS',
+            'appium:automationName': 'XCUITest',
+            'appium:udid': udid,
+        },
+        firstMatch: [{}],
+    });
+    it('allocates a booted simulator whose WebDriverAgent is not running yet', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, device_service_1.addNewDevice)([device(SIMULATOR)]);
+        const requested = caps(SIMULATOR);
+        const allocated = yield DeviceUtils.allocateDeviceForSession(requested, 2000, 100, pluginArgs);
+        expect(allocated.udid).to.equal(SIMULATOR);
+        expect(wdaAsked.called, 'asked WebDriverAgent').to.equal(false);
+        expect(simctlCommands, 'rebooted the simulator').to.not.include('shutdown');
+        expect(simctlCommands, 'rebooted the simulator').to.not.include('boot');
+        // The driver gets the port to launch its own WDA on, and no URL of one.
+        const fm = requested.firstMatch[0];
+        expect(fm['appium:wdaLocalPort']).to.equal(8102);
+        expect(fm).to.not.have.property('appium:webDriverAgentUrl');
+    }));
+    it('allocates a shut-down simulator, which the driver boots', () => __awaiter(void 0, void 0, void 0, function* () {
+        // Discovery leases no port to a shut-down simulator.
+        yield (0, device_service_1.addNewDevice)([
+            device(SIMULATOR, { state: 'Shutdown', wdaLocalPort: undefined, mjpegServerPort: 9103 }),
+        ]);
+        const requested = caps(SIMULATOR);
+        const allocated = yield DeviceUtils.allocateDeviceForSession(requested, 2000, 100, pluginArgs);
+        expect(allocated.udid).to.equal(SIMULATOR);
+        expect(wdaAsked.called).to.equal(false);
+        expect(simctlCommands).to.not.include('boot');
+        // It gets one now, for the driver's WDA.
+        expect(requested.firstMatch[0]['appium:wdaLocalPort']).to.be.a('number');
+    }));
+    describe('a live preview open on the phone', () => {
+        // The preview's stream entry for the phone: on an iPhone, the WDA Xenon
+        // runs; on a simulator, at most an attach to a driver's WDA, which goes
+        // with the session that started it.
+        beforeEach(() => {
+            IOSStreamService_1.default.prototype.getStreamStatus.returns({
+                status: 'running',
+                wdaPort: 8150,
+            });
+        });
+        it("never points a simulator session at it: the driver's own WDA, on the simulator's port", () => __awaiter(void 0, void 0, void 0, function* () {
+            const requested = caps(SIMULATOR);
+            yield (0, XenonCapabilityManager_1.iOSCapabilities)(requested, device(SIMULATOR));
+            const fm = requested.firstMatch[0];
+            expect(fm).to.not.have.property('appium:webDriverAgentUrl');
+            expect(fm['appium:wdaLocalPort']).to.equal(8102);
+            expect(fm['appium:mjpegServerPort']).to.equal(9102);
+        }));
+        it('still points an iPhone session at the WDA Xenon runs there', () => __awaiter(void 0, void 0, void 0, function* () {
+            const requested = caps(IPHONE);
+            yield (0, XenonCapabilityManager_1.iOSCapabilities)(requested, device(IPHONE, { realDevice: true, deviceType: 'real' }));
+            const fm = requested.firstMatch[0];
+            expect(fm['appium:webDriverAgentUrl']).to.equal('http://127.0.0.1:8150');
+            expect(fm).to.not.have.property('appium:wdaLocalPort');
+        }));
+    });
+    describe('an iPhone, whose WebDriverAgent Xenon runs', () => {
+        const iphone = () => device(IPHONE, { realDevice: true, deviceType: 'real' });
+        it('is still checked: ready when WebDriverAgent answers', () => __awaiter(void 0, void 0, void 0, function* () {
+            wdaAsked.resolves(true);
+            const manager = new IOSDeviceManager_1.default({ pluginArgs });
+            expect(yield manager.readyForSession(iphone())).to.equal(true);
+            expect(wdaAsked.calledOnceWith(IPHONE)).to.equal(true);
+        }));
+        it('is still refused when WebDriverAgent does not answer and cannot be started', () => __awaiter(void 0, void 0, void 0, function* () {
+            const manager = new IOSDeviceManager_1.default({ pluginArgs });
+            const recover = sandbox.stub(manager, 'recoverHealth').resolves(false);
+            expect(yield manager.readyForSession(iphone())).to.equal(false);
+            expect(recover.calledOnce).to.equal(true);
+        }));
+    });
+});