@xenon-device-management/xenon 2.0.0 → 2.2.0

package/lib/test/unit/ios-discovery-same-host.spec.js

@@ -0,0 +1,193 @@
+"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 = require("chai");
+const sinon_1 = __importDefault(require("sinon"));
+const typedi_1 = require("typedi");
+const appium_ios_device_1 = require("appium-ios-device");
+const simctlModule = __importStar(require("node-simctl"));
+const IOSDiscoveryService_1 = require("../../src/device-managers/ios/IOSDiscoveryService");
+const IOSDeviceManager_1 = __importDefault(require("../../src/device-managers/IOSDeviceManager"));
+const IOSStreamService_1 = __importDefault(require("../../src/device-managers/ios/IOSStreamService"));
+const device_store_1 = require("../../src/data-service/device-store");
+const deviceUtils = __importStar(require("../../src/device-utils"));
+const PluginContext_1 = require("../../src/PluginContext");
+const PortAllocator_1 = require("../../src/services/PortAllocator");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+/**
+ * A hub on :4724 and a node on :4725 on one Mac both see the same iPhone and
+ * the same simulators, and the hub's table holds the node's rows too. A row
+ * is a server's own only by udid AND host, as the Android discovery and
+ * localDeviceHosts have it. iOS discovery looked rows up by udid alone, so
+ * the hub could take the node's row for its own: its host, ports and busy
+ * state.
+ *
+ * Nothing real is asked: usbmux, go-ios, simctl and the store are fakes.
+ */
+const IP = '192.168.0.104';
+const HUB = `http://${IP}:4724`;
+const NODE = `http://${IP}:4725`;
+const IPHONE = 'test-iphone-00008150-shared';
+const SIM = 'TEST-SIM-5A0C-shared';
+function context(args, port) {
+    const ctx = new PluginContext_1.PluginContext();
+    ctx.setContext(Object.assign({}, IPluginArgs_1.DefaultPluginArgs, args), port, 'test-hub', '');
+    return ctx;
+}
+describe("iOS discovery takes only its own host's row for a udid", () => {
+    let rows;
+    const nodeRow = (udid, over = {}) => (Object.assign({ udid, host: NODE, platform: 'ios', realDevice: true, wdaLocalPort: 8200, mjpegServerPort: 9200, busy: true, session_id: 'node-session-1', screenWidth: '1320', screenHeight: '2868' }, over));
+    // resetTestContainer() (test/helpers/test-container.ts) stubs these two on
+    // the prototype for the rest of the process, so in a full run discovery
+    // never reaches them. Put the real ones on this instance.
+    const real = (fn) => { var _a; return (_a = fn.wrappedMethod) !== null && _a !== void 0 ? _a : fn; };
+    function hubDiscovery(connected = [IPHONE]) {
+        const svc = new IOSDiscoveryService_1.IOSDiscoveryService(context({ bindHostOrIp: IP }, 4724));
+        const proto = IOSDiscoveryService_1.IOSDiscoveryService.prototype;
+        Object.assign(svc, {
+            fetchLocalIOSDevices: real(proto.fetchLocalIOSDevices),
+            fetchLocalSimulators: real(proto.fetchLocalSimulators),
+        });
+        svc.trackingInitialized = true; // no usbmux listener
+        sinon_1.default.stub(svc, 'getConnectedDevices').resolves(connected);
+        sinon_1.default.stub(svc, 'fetchRealDeviceNetworkIp').resolves(''); // no go-ios
+        return svc;
+    }
+    beforeEach(() => {
+        rows = [];
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
+            findDevice: (filter) => __awaiter(void 0, void 0, void 0, function* () { var _a; return (_a = rows.find((r) => Object.entries(filter).every(([k, v]) => r[k] === v))) !== null && _a !== void 0 ? _a : null; }),
+        });
+        const real = typedi_1.Container.get.bind(typedi_1.Container);
+        sinon_1.default.stub(typedi_1.Container, 'get').callsFake((token) => {
+            if (token === PortAllocator_1.PortAllocator) {
+                return { tryAcquire: (purpose) => __awaiter(void 0, void 0, void 0, function* () { return (purpose === 'wda' ? 28400 : 29400); }) };
+            }
+            if (token === IOSStreamService_1.default)
+                return { getStreamStatus: () => undefined };
+            return real(token);
+        });
+        sinon_1.default.stub(deviceUtils, 'getUtilizationTime').resolves(0);
+        sinon_1.default.stub(appium_ios_device_1.utilities, 'getOSVersion').resolves('26.7');
+        sinon_1.default.stub(appium_ios_device_1.utilities, 'getDeviceName').resolves('iPhone 17 Pro');
+        sinon_1.default.stub(appium_ios_device_1.utilities, 'getDeviceInfo').rejects(new Error('no lockdown in tests'));
+    });
+    afterEach(() => sinon_1.default.restore());
+    describe('a real iPhone', () => {
+        it("builds the hub's own row when only the node's row for the udid is known", () => __awaiter(void 0, void 0, void 0, function* () {
+            rows = [nodeRow(IPHONE)];
+            const [phone] = yield hubDiscovery().fetchLocalIOSDevices(rows);
+            (0, chai_1.expect)(phone.host).to.equal(HUB);
+            (0, chai_1.expect)(phone.busy, "the node's session is not the hub's").to.equal(false);
+            (0, chai_1.expect)(phone.session_id).to.not.equal('node-session-1');
+            (0, chai_1.expect)(phone.wdaLocalPort, "the hub's own port").to.equal(28400);
+        }));
+        it("reuses the hub's own row", () => __awaiter(void 0, void 0, void 0, function* () {
+            const own = nodeRow(IPHONE, {
+                host: HUB,
+                wdaLocalPort: 28123,
+                busy: false,
+                session_id: undefined,
+            });
+            rows = [nodeRow(IPHONE), own];
+            const svc = hubDiscovery();
+            const getDeviceInfo = sinon_1.default.spy(svc, 'getDeviceInfo');
+            const [phone] = yield svc.fetchLocalIOSDevices(rows);
+            (0, chai_1.expect)(getDeviceInfo.called, 'no need to ask the phone again').to.equal(false);
+            (0, chai_1.expect)(phone.host).to.equal(HUB);
+            (0, chai_1.expect)(phone.wdaLocalPort).to.equal(28123);
+        }));
+        it("an attach (getDeviceInfo) never takes the node's row", () => __awaiter(void 0, void 0, void 0, function* () {
+            rows = [nodeRow(IPHONE)];
+            const phone = yield hubDiscovery().getDeviceInfo(IPHONE);
+            (0, chai_1.expect)(phone.host).to.equal(HUB);
+            (0, chai_1.expect)(phone.wdaLocalPort).to.equal(28400);
+            (0, chai_1.expect)(phone.mjpegServerPort).to.equal(29400);
+            (0, chai_1.expect)(phone.busy).to.equal(false);
+        }));
+    });
+    it("a simulator on the shared Mac gets the hub's own ports, not the node's row's", () => __awaiter(void 0, void 0, void 0, function* () {
+        class FakeSimctl {
+            list() {
+                return __awaiter(this, void 0, void 0, function* () {
+                    return { runtimes: [] };
+                });
+            }
+            getDevicesByParsing(platform) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    return platform === 'iOS'
+                        ? { '26.0': [{ udid: SIM, name: 'iPhone 17', state: 'Booted', sdk: '26.0' }] }
+                        : {};
+                });
+            }
+        }
+        sinon_1.default.stub(simctlModule, 'default').value(FakeSimctl);
+        rows = [nodeRow(SIM, { realDevice: false })];
+        const [sim] = yield hubDiscovery([]).fetchLocalSimulators();
+        (0, chai_1.expect)(sim.host).to.equal(HUB);
+        (0, chai_1.expect)(sim.wdaLocalPort).to.equal(28400);
+        (0, chai_1.expect)(sim.mjpegServerPort).to.equal(29400);
+    }));
+    it("IOSDeviceManager reads a phone's stored screen size from that phone's own row", () => __awaiter(void 0, void 0, void 0, function* () {
+        rows = [
+            nodeRow(IPHONE),
+            nodeRow(IPHONE, { host: HUB, screenWidth: '750', screenHeight: '1334' }),
+        ];
+        // Bypass the constructor: it checks ideviceinstaller.
+        const manager = Object.create(IOSDeviceManager_1.default.prototype);
+        manager.context = context({ bindHostOrIp: IP }, 4724);
+        manager.log = { info: () => undefined, debug: () => undefined, warn: () => undefined };
+        const info = yield manager.getAdditionalDeviceInfo({
+            udid: IPHONE,
+            host: HUB,
+            realDevice: true,
+        });
+        (0, chai_1.expect)(info.screenWidth).to.equal('750');
+        (0, chai_1.expect)(info.screenHeight).to.equal('1334');
+    }));
+});

package/lib/test/unit/ios-stream-appium-tunnel.spec.js

@@ -0,0 +1,317 @@
+"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 = require("chai");
+const child_process_1 = __importDefault(require("child_process"));
+const events_1 = require("events");
+const sinon_1 = __importDefault(require("sinon"));
+const tcp_port_used_1 = __importDefault(require("tcp-port-used"));
+const typedi_1 = require("typedi");
+const util_1 = require("util");
+const IOSStreamService_1 = __importDefault(require("../../src/device-managers/ios/IOSStreamService"));
+const singleFlight_1 = require("../../src/helpers/singleFlight");
+const PortAllocator_1 = require("../../src/services/PortAllocator");
+const ProcessRegistry_1 = require("../../src/services/ProcessRegistry");
+const device_store_1 = require("../../src/data-service/device-store");
+const deviceService = __importStar(require("../../src/data-service/device-service"));
+const control_1 = require("../../src/app/routers/control");
+/**
+ * go-ios's tunnel process serves its tunnel-info API on 60105 and the first
+ * phone's userspace tunnel on 60106. On iOS 17+ a WDA that go-ios launched
+ * (`runwda`) reaches the phone through it, and an Appium session rides such a
+ * WDA whenever it was allocated while a stream ran: iOSCapabilities points
+ * `webDriverAgentUrl` at the stream's WDA.
+ *
+ * The stream service's orphan sweep kill -9'd whatever listened on those
+ * ports, and a viewer's stop killed the stream's own WDA and tunnel, with a
+ * live Appium session on the phone either way.
+ *
+ * Nothing real runs here. Every `exec` goes to a fake `execFile` (exec calls
+ * `module.exports.execFile`, promisified or not), `process.kill` is stubbed,
+ * and processes are fakes.
+ */
+const IPHONE = 'test-iphone-00008150-tunnel';
+const TUNNEL_PID = 424242;
+const AGENT_LISTENER_PID = '515151';
+class FakeProcess extends events_1.EventEmitter {
+    constructor(pid) {
+        super();
+        this.pid = pid;
+        this.exitCode = null;
+        this.killed = false;
+        this.stdout = new events_1.EventEmitter();
+        this.stderr = new events_1.EventEmitter();
+    }
+    kill() {
+        this.killed = true;
+        if (this.exitCode === null)
+            this.exitCode = 137;
+        return true;
+    }
+}
+function iosService() {
+    // Bypass the constructor: it starts watchdog intervals.
+    const svc = Object.create(IOSStreamService_1.default.prototype);
+    svc.sessions = new Map();
+    svc.startFlight = new singleFlight_1.SingleFlight();
+    svc.recoveryCooldowns = new Map();
+    svc.RECOVERY_COOLDOWN_MS = 30000;
+    svc.STREAM_PORT_TTL_MS = 90 * 60 * 1000;
+    svc.goIOSPath = '/nonexistent/go-ios';
+    return svc;
+}
+describe('go-ios tunnels under a live Appium session (fake exec, fake processes)', () => {
+    let device;
+    let findDevice;
+    let commands;
+    let kill;
+    let allocator;
+    let svc;
+    const killed = () => commands.filter((c) => /^kill\b|^pkill\b/.test(c));
+    const swept = () => commands.filter((c) => /^lsof\b|^pgrep\b/.test(c));
+    /** A stream that launched its own WDA, forwarders and go-ios tunnel. */
+    function ownStream() {
+        const s = {
+            udid: IPHONE,
+            wdaProcess: new FakeProcess(),
+            forwardWDAProcess: new FakeProcess(),
+            forwardMJPEGProcess: new FakeProcess(),
+            tunnelProcess: new FakeProcess(TUNNEL_PID),
+            wdaPort: 28101,
+            mjpegPort: 29101,
+            status: 'running',
+            lastViewerAt: Date.now(),
+            viewerCount: 0,
+        };
+        svc.sessions.set(IPHONE, s);
+        return s;
+    }
+    /** A stream attached to the WDA the Appium session forwards: only its MJPEG forwarder is its own. */
+    function attachedStream() {
+        const s = {
+            udid: IPHONE,
+            wdaProcess: null,
+            forwardWDAProcess: null,
+            forwardMJPEGProcess: new FakeProcess(),
+            tunnelProcess: null,
+            wdaPort: 28123,
+            mjpegPort: 29101,
+            status: 'running',
+            lastViewerAt: Date.now(),
+            viewerCount: 0,
+        };
+        svc.sessions.set(IPHONE, s);
+        return s;
+    }
+    beforeEach(() => {
+        device = {
+            udid: IPHONE,
+            host: 'http://127.0.0.1:4723',
+            platform: 'ios',
+            busy: true,
+            session_id: '7f0c5a52-appium-session',
+            wdaLocalPort: 28123,
+        };
+        commands = [];
+        // Refuse everything real. lsof names the go-ios agent's listener, pgrep a
+        // tunnel for this udid; both exit 1 with nothing to report otherwise.
+        sinon_1.default.stub(child_process_1.default, 'execFile').callsFake(((cmd, _opts, cb) => {
+            commands.push(cmd);
+            const stdout = /^lsof -ti :6010[56]$/.test(cmd) ? `${AGENT_LISTENER_PID}\n` : '';
+            const nothingFound = /^(lsof|pgrep)\b/.test(cmd) && !stdout;
+            const done = typeof cb === 'function' ? cb : () => undefined;
+            process.nextTick(() => nothingFound
+                ? done(Object.assign(new Error('exit 1'), { code: 1 }), '', '')
+                : done(null, stdout, ''));
+            return new events_1.EventEmitter();
+        }));
+        kill = sinon_1.default.stub(process, 'kill');
+    });
+    // Prove the fake takes exec before anything could run a real kill.
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, util_1.promisify)(child_process_1.default.exec)('echo xenon-exec-guard');
+        (0, chai_1.expect)(commands, 'exec must reach the fake').to.deep.equal(['echo xenon-exec-guard']);
+        commands.length = 0;
+    }));
+    beforeEach(() => {
+        allocator = {
+            claim: sinon_1.default.stub().resolves(true),
+            acquire: sinon_1.default.stub().resolves(29102),
+            release: sinon_1.default.stub().resolves(),
+        };
+        svc = iosService();
+        const real = typedi_1.Container.get.bind(typedi_1.Container);
+        sinon_1.default.stub(typedi_1.Container, 'get').callsFake((token) => {
+            if (token === IOSStreamService_1.default)
+                return svc;
+            if (token === PortAllocator_1.PortAllocator)
+                return allocator;
+            if (token === ProcessRegistry_1.ProcessRegistry)
+                return { track: () => undefined };
+            return real(token);
+        });
+        findDevice = sinon_1.default.stub().callsFake(() => __awaiter(void 0, void 0, void 0, function* () { return device; }));
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
+            findDevice,
+            updateDevice: () => __awaiter(void 0, void 0, void 0, function* () { return undefined; }),
+        });
+        sinon_1.default.stub(deviceService, 'unblockDevice').resolves();
+    });
+    afterEach(() => sinon_1.default.restore());
+    describe("a viewer's stop (stream/stop, stream/leave)", () => {
+        it("leaves a stream's own WDA and go-ios tunnel running while an Appium session holds the phone", () => __awaiter(void 0, void 0, void 0, function* () {
+            const stream = ownStream();
+            yield control_1.previewLeaveDeps.stop(IPHONE);
+            (0, chai_1.expect)(stream.wdaProcess.killed, 'the WDA the session may be driving').to.equal(false);
+            (0, chai_1.expect)(stream.forwardWDAProcess.killed, "that WDA's forwarder").to.equal(false);
+            (0, chai_1.expect)(kill.called, 'no process group is signalled (the tunnel)').to.equal(false);
+            (0, chai_1.expect)(killed(), 'no kill is run').to.deep.equal([]);
+            (0, chai_1.expect)(svc.getStreamStatus(IPHONE), 'the stream stays, for the session teardown').to.equal(stream);
+            (0, chai_1.expect)(allocator.release.called, 'its ports stay leased').to.equal(false);
+        }));
+        it('sweeps no go-ios port when the stream is attached to the Appium session’s own WDA', () => __awaiter(void 0, void 0, void 0, function* () {
+            const stream = attachedStream();
+            yield control_1.previewLeaveDeps.stop(IPHONE);
+            (0, chai_1.expect)(swept(), 'no lsof/pgrep for go-ios processes').to.deep.equal([]);
+            (0, chai_1.expect)(killed(), 'no kill -9 of the go-ios listener').to.deep.equal([]);
+            (0, chai_1.expect)(kill.called).to.equal(false);
+            (0, chai_1.expect)(stream.forwardMJPEGProcess.killed, 'its own MJPEG forwarder still goes').to.equal(true);
+            (0, chai_1.expect)(svc.getStreamStatus(IPHONE)).to.equal(undefined);
+        }));
+        it('still stops everything and sweeps real orphans once no Appium session holds the phone', () => __awaiter(void 0, void 0, void 0, function* () {
+            Object.assign(device, { busy: false, session_id: null });
+            const stream = ownStream();
+            yield control_1.previewLeaveDeps.stop(IPHONE);
+            (0, chai_1.expect)(stream.wdaProcess.killed).to.equal(true);
+            (0, chai_1.expect)(stream.forwardWDAProcess.killed).to.equal(true);
+            (0, chai_1.expect)(stream.forwardMJPEGProcess.killed).to.equal(true);
+            (0, chai_1.expect)(kill.calledWith(-TUNNEL_PID, 'SIGKILL'), "the stream's tunnel group").to.equal(true);
+            (0, chai_1.expect)(commands).to.include(`pgrep -f "ios tunnel.*${IPHONE}"`);
+            (0, chai_1.expect)(commands).to.include('lsof -ti :60105');
+            (0, chai_1.expect)(commands).to.include('lsof -ti :60106');
+            (0, chai_1.expect)(killed()).to.include(`kill -9 ${AGENT_LISTENER_PID}`);
+            (0, chai_1.expect)(svc.getStreamStatus(IPHONE)).to.equal(undefined);
+        }));
+        it('treats a live-preview hold as no Appium session', () => __awaiter(void 0, void 0, void 0, function* () {
+            Object.assign(device, { session_id: `manual_usr_alice_${IPHONE}` });
+            const stream = ownStream();
+            yield control_1.previewLeaveDeps.stop(IPHONE);
+            (0, chai_1.expect)(stream.wdaProcess.killed).to.equal(true);
+            (0, chai_1.expect)(killed()).to.include(`kill -9 ${AGENT_LISTENER_PID}`);
+        }));
+    });
+    describe('a start that attaches to the WDA the Appium session forwards', () => {
+        it('stops the stale stream without touching the go-ios tunnel', () => __awaiter(void 0, void 0, void 0, function* () {
+            // A start that failed earlier: its session stays in the map, errored.
+            svc.sessions.set(IPHONE, {
+                udid: IPHONE,
+                wdaProcess: null,
+                forwardWDAProcess: null,
+                forwardMJPEGProcess: null,
+                tunnelProcess: null,
+                wdaPort: 28101,
+                mjpegPort: 29101,
+                status: 'error',
+                lastViewerAt: Date.now(),
+                viewerCount: 0,
+            });
+            svc.isWDARunning = (port) => __awaiter(void 0, void 0, void 0, function* () { return port === device.wdaLocalPort; });
+            svc.updateWDASettings = () => __awaiter(void 0, void 0, void 0, function* () { return undefined; });
+            sinon_1.default.stub(tcp_port_used_1.default, 'check').resolves(true);
+            const { wdaPort } = yield svc.startStream(IPHONE);
+            (0, chai_1.expect)(wdaPort, 'attached to the session’s WDA').to.equal(device.wdaLocalPort);
+            (0, chai_1.expect)(swept(), 'no lsof/pgrep for go-ios processes').to.deep.equal([]);
+            (0, chai_1.expect)(killed(), 'no kill -9 of the go-ios listener').to.deep.equal([]);
+            (0, chai_1.expect)(kill.called).to.equal(false);
+        }));
+    });
+    describe('a start over a running stream whose WDA does not answer', () => {
+        beforeEach(() => {
+            // WDA doesn't answer /status: busy with a long command, or dead.
+            svc.isWDARunning = () => __awaiter(void 0, void 0, void 0, function* () { return false; });
+            // A restart that gets past the stop fails right after: no go-ios here.
+            svc.isGoIOSAvailable = () => __awaiter(void 0, void 0, void 0, function* () { return false; });
+        });
+        it('never restarts it while an Appium session holds the phone, and says why', () => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            const stream = ownStream();
+            const err = yield svc.startStream(IPHONE).then(() => null, (e) => e);
+            (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.match(/Appium session .* holds the device/);
+            (0, chai_1.expect)(stream.wdaProcess.killed, 'the WDA the session may be driving').to.equal(false);
+            (0, chai_1.expect)(stream.forwardWDAProcess.killed).to.equal(false);
+            (0, chai_1.expect)(kill.called, 'no process group is signalled (the tunnel)').to.equal(false);
+            (0, chai_1.expect)(commands, 'nothing is exec’d').to.deep.equal([]);
+            (0, chai_1.expect)((_a = svc.getStreamStatus(IPHONE)) === null || _a === void 0 ? void 0 : _a.status, 'the stream is left as it was').to.equal('running');
+            (0, chai_1.expect)(svc.recoveryCooldowns.has(IPHONE), 'no failed start to cool down from').to.equal(false);
+        }));
+        it("never restarts one attached to the session's own WDA either", () => __awaiter(void 0, void 0, void 0, function* () {
+            // A restart would launch a second WebDriverAgent over the session's.
+            const stream = attachedStream();
+            const err = yield svc.startStream(IPHONE).then(() => null, (e) => e);
+            (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.match(/Appium session .* holds the device/);
+            (0, chai_1.expect)(stream.forwardMJPEGProcess.killed).to.equal(false);
+            (0, chai_1.expect)(svc.getStreamStatus(IPHONE)).to.equal(stream);
+        }));
+        it('still restarts it when no session holds the phone, to recover a dead WDA', () => __awaiter(void 0, void 0, void 0, function* () {
+            Object.assign(device, { busy: false, session_id: null });
+            const stream = ownStream();
+            const err = yield svc.startStream(IPHONE).then(() => null, (e) => e);
+            (0, chai_1.expect)(stream.wdaProcess.killed, 'the dead stream is stopped').to.equal(true);
+            (0, chai_1.expect)(kill.calledWith(-TUNNEL_PID, 'SIGKILL')).to.equal(true);
+            (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message, 'and a new start is attempted').to.equal('go-ios not available');
+        }));
+    });
+    it("leaves go-ios processes alone when the phone's row can't be read", () => __awaiter(void 0, void 0, void 0, function* () {
+        attachedStream();
+        findDevice.rejects(new Error('database is locked'));
+        yield svc.stopStream(IPHONE);
+        (0, chai_1.expect)(swept()).to.deep.equal([]);
+        (0, chai_1.expect)(killed()).to.deep.equal([]);
+        (0, chai_1.expect)(kill.called).to.equal(false);
+    }));
+});