@xenon-device-management/xenon 2.13.2 → 2.15.0

package/lib/test/unit/phone-network/network-conditioning.spec.js

@@ -0,0 +1,145 @@
+"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 NetworkConditioningService_1 = require("../../../src/services/NetworkConditioningService");
+const PhoneNetworkLedger_1 = require("../../../src/services/network/PhoneNetworkLedger");
+const scratch_database_1 = require("../../helpers/scratch-database");
+const fake_adb_1 = require("../../helpers/fake-adb");
+// The live module object, so a spy sees a call made through any import of it.
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const childProcess = require('child_process');
+const phone = (udid, extra = {}) => (Object.assign({ udid, platform: 'android', deviceType: 'real', host: 'http://127.0.0.1:4723' }, extra));
+const RADIOS_ON = {
+    'shell settings get global wifi_on': '1',
+    'shell settings get global mobile_data': '1',
+};
+describe('NetworkConditioningService', function () {
+    this.timeout(60000);
+    (0, scratch_database_1.useScratchDatabase)();
+    let adb;
+    (0, fake_adb_1.useFakeAdb)(() => adb);
+    let ledger;
+    beforeEach(() => __awaiter(this, void 0, void 0, function* () {
+        adb = (0, fake_adb_1.fakeAdb)(Object.assign({}, RADIOS_ON));
+        ledger = new PhoneNetworkLedger_1.PhoneNetworkLedger();
+        for (const entry of yield ledger.list())
+            yield ledger.forget(entry.sessionId);
+    }));
+    afterEach(() => sinon_1.default.restore());
+    describe('Offline on an Android phone', () => {
+        it('turns mobile data and Wi-Fi off through the resolved adb, never a shell', () => __awaiter(this, void 0, void 0, function* () {
+            const exec = sinon_1.default.spy(childProcess, 'exec');
+            const execFile = sinon_1.default.spy(childProcess, 'execFile');
+            const svc = new NetworkConditioningService_1.NetworkConditioningService();
+            yield svc.applyProfile('s1', phone('R5CT'), 'Offline');
+            (0, chai_1.expect)(adb.commands('R5CT')).to.deep.equal([
+                'shell settings get global wifi_on',
+                'shell settings get global mobile_data',
+                'shell svc data disable',
+                'shell svc wifi disable',
+            ]);
+            (0, chai_1.expect)(adb.calls.every((args) => args[0] === '-s' && args[1] === 'R5CT')).to.equal(true);
+            (0, chai_1.expect)(exec.called, 'child_process.exec').to.equal(false);
+            (0, chai_1.expect)(execFile.called, 'child_process.execFile').to.equal(false);
+        }));
+        it('writes down what it changed before changing it, so a restart can undo it', () => __awaiter(this, void 0, void 0, function* () {
+            adb.answers['shell settings get global mobile_data'] = '0';
+            yield new NetworkConditioningService_1.NetworkConditioningService().applyProfile('s1', phone('R5CT'), 'Offline');
+            const entries = yield ledger.list();
+            (0, chai_1.expect)(entries).to.have.length(1);
+            (0, chai_1.expect)(entries[0]).to.include({ sessionId: 's1', udid: 'R5CT' });
+            (0, chai_1.expect)(entries[0].offline).to.deep.equal({ wifiOn: true, dataOn: false });
+        }));
+        it('puts back what was on, and leaves off what was off', () => __awaiter(this, void 0, void 0, function* () {
+            adb.answers['shell settings get global mobile_data'] = '0';
+            const svc = new NetworkConditioningService_1.NetworkConditioningService();
+            yield svc.applyProfile('s1', phone('R5CT'), 'Offline');
+            adb.calls.length = 0;
+            yield svc.reset('s1');
+            (0, chai_1.expect)(adb.commands('R5CT')).to.deep.equal(['shell svc wifi enable']);
+            (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+            (0, chai_1.expect)(svc.has('s1')).to.equal(false);
+        }));
+        it('turns both back on when it could not read what they were', () => __awaiter(this, void 0, void 0, function* () {
+            adb.answers['shell settings get global wifi_on'] = new Error('device offline');
+            adb.answers['shell settings get global mobile_data'] = 'null';
+            const svc = new NetworkConditioningService_1.NetworkConditioningService();
+            yield svc.applyProfile('s1', phone('R5CT'), 'Offline');
+            adb.calls.length = 0;
+            yield svc.reset('s1');
+            (0, chai_1.expect)(adb.commands('R5CT')).to.deep.equal([
+                'shell svc data enable',
+                'shell svc wifi enable',
+            ]);
+        }));
+        it('keeps the record when the phone cannot be reached at the end', () => __awaiter(this, void 0, void 0, function* () {
+            const svc = new NetworkConditioningService_1.NetworkConditioningService();
+            yield svc.applyProfile('s1', phone('R5CT'), 'Offline');
+            adb.answers['shell svc data enable'] = new Error("device 'R5CT' not found");
+            yield svc.reset('s1');
+            const entries = yield ledger.list();
+            (0, chai_1.expect)(entries.map((e) => e.sessionId)).to.deep.equal(['s1']);
+            (0, chai_1.expect)(svc.has('s1')).to.equal(false);
+        }));
+        it('undoes a session once, however many times it is asked', () => __awaiter(this, void 0, void 0, function* () {
+            const svc = new NetworkConditioningService_1.NetworkConditioningService();
+            yield svc.applyProfile('s1', phone('R5CT'), 'Offline');
+            adb.calls.length = 0;
+            yield Promise.all([svc.reset('s1'), svc.reset('s1')]);
+            yield svc.reset('s1');
+            (0, chai_1.expect)(adb.commands('R5CT')).to.deep.equal([
+                'shell svc data enable',
+                'shell svc wifi enable',
+            ]);
+        }));
+    });
+    it("changes nothing on the phone for 3G, at the start or the end; it's a delay", () => __awaiter(this, void 0, void 0, function* () {
+        const svc = new NetworkConditioningService_1.NetworkConditioningService();
+        yield svc.applyProfile('s1', phone('R5CT'), '3G');
+        (0, chai_1.expect)(svc.getLatency('s1')).to.equal(100);
+        yield svc.reset('s1');
+        (0, chai_1.expect)(adb.calls).to.deep.equal([]);
+        (0, chai_1.expect)(svc.getLatency('s1')).to.equal(0);
+        (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+    }));
+    it('turns the network on for Normal, and has nothing to undo at the end', () => __awaiter(this, void 0, void 0, function* () {
+        const svc = new NetworkConditioningService_1.NetworkConditioningService();
+        yield svc.applyProfile('s1', phone('R5CT'), 'Normal');
+        (0, chai_1.expect)(adb.commands('R5CT')).to.deep.equal(['shell svc data enable', 'shell svc wifi enable']);
+        adb.calls.length = 0;
+        yield svc.reset('s1');
+        (0, chai_1.expect)(adb.calls).to.deep.equal([]);
+        (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+    }));
+    it("doesn't run xcrun for an iOS simulator, and says once that only the delay applies", () => __awaiter(this, void 0, void 0, function* () {
+        const exec = sinon_1.default.spy(childProcess, 'exec');
+        const execFile = sinon_1.default.spy(childProcess, 'execFile');
+        const svc = new NetworkConditioningService_1.NetworkConditioningService();
+        const said = sinon_1.default.spy(svc.log, 'info');
+        const sim = { udid: 'SIM-1', platform: 'ios', deviceType: 'simulator' };
+        yield svc.applyProfile('s1', sim, 'Offline');
+        yield svc.applyProfile('s2', Object.assign(Object.assign({}, sim), { udid: 'SIM-2' }), 'Edge');
+        yield svc.reset('s1');
+        yield svc.reset('s2');
+        (0, chai_1.expect)(exec.called).to.equal(false);
+        (0, chai_1.expect)(execFile.called).to.equal(false);
+        (0, chai_1.expect)(adb.calls).to.deep.equal([]);
+        const notes = said.args.filter((a) => /only .*delay/i.test(String(a[0])));
+        (0, chai_1.expect)(notes, said.args.map((a) => a[0]).join('\n')).to.have.length(1);
+        (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+    }));
+});

package/lib/test/unit/phone-network/phone-network-restore.spec.js

@@ -0,0 +1,246 @@
+"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 net_1 = __importDefault(require("net"));
+const typedi_1 = require("typedi");
+const PhoneNetworkRestore_1 = require("../../../src/services/network/PhoneNetworkRestore");
+const PhoneNetworkLedger_1 = require("../../../src/services/network/PhoneNetworkLedger");
+const NetworkConditioningService_1 = require("../../../src/services/NetworkConditioningService");
+const InterceptorService_1 = require("../../../src/services/InterceptorService");
+const PortAllocator_1 = require("../../../src/services/PortAllocator");
+const prisma_1 = require("../../../src/prisma");
+const container_registration_1 = require("../../helpers/container-registration");
+const scratch_database_1 = require("../../helpers/scratch-database");
+const fake_adb_1 = require("../../helpers/fake-adb");
+const DAY = 24 * 60 * 60 * 1000;
+function deferred() {
+    let resolve;
+    const promise = new Promise((r) => (resolve = r));
+    return { promise, resolve };
+}
+/** Stand-ins for the two services that change a phone's network for a session. */
+function fakeServices(live) {
+    const net = {
+        has: (id) => live.net.has(id),
+        sessionIds: () => [...live.net],
+        reset: sinon_1.default.stub().callsFake((id) => __awaiter(this, void 0, void 0, function* () { return void live.net.delete(id); })),
+    };
+    const icp = {
+        isActive: (id) => live.icp.has(id),
+        sessionIds: () => [...live.icp],
+        stop: sinon_1.default.stub().callsFake((id) => __awaiter(this, void 0, void 0, function* () { return void live.icp.delete(id); })),
+    };
+    return { net, icp };
+}
+describe('PhoneNetworkRestore', function () {
+    this.timeout(60000);
+    (0, scratch_database_1.useScratchDatabase)();
+    let adb;
+    (0, fake_adb_1.useFakeAdb)(() => adb);
+    let restoreRegs;
+    let live;
+    let fakes;
+    let ledger;
+    let range;
+    beforeEach(() => __awaiter(this, void 0, void 0, function* () {
+        adb = (0, fake_adb_1.fakeAdb)();
+        restoreRegs = (0, container_registration_1.saveRegistrations)(NetworkConditioningService_1.NetworkConditioningService, InterceptorService_1.InterceptorService, PortAllocator_1.PortAllocator, PhoneNetworkLedger_1.PhoneNetworkLedger);
+        live = { net: new Set(), icp: new Set() };
+        fakes = fakeServices(live);
+        typedi_1.Container.set(NetworkConditioningService_1.NetworkConditioningService, fakes.net);
+        typedi_1.Container.set(InterceptorService_1.InterceptorService, fakes.icp);
+        range = [11100, 11199];
+        typedi_1.Container.set(PortAllocator_1.PortAllocator, { rangeOf: () => range });
+        ledger = new PhoneNetworkLedger_1.PhoneNetworkLedger();
+        typedi_1.Container.set(PhoneNetworkLedger_1.PhoneNetworkLedger, ledger);
+        for (const entry of yield ledger.list())
+            yield ledger.forget(entry.sessionId);
+    }));
+    afterEach(() => {
+        sinon_1.default.restore();
+        restoreRegs();
+    });
+    describe('restoreSession', () => {
+        it('resets the profile and stops the interceptor of a session', () => __awaiter(this, void 0, void 0, function* () {
+            live.net.add('s1');
+            live.icp.add('s1');
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreSession('s1', 'test');
+            (0, chai_1.expect)(fakes.net.reset.calledOnceWith('s1')).to.equal(true);
+            (0, chai_1.expect)(fakes.icp.stop.calledOnceWith('s1')).to.equal(true);
+        }));
+        it('does nothing for a session that changed nothing, or no session', () => __awaiter(this, void 0, void 0, function* () {
+            const restore = new PhoneNetworkRestore_1.PhoneNetworkRestore();
+            yield restore.restoreSession('s-plain', 'test');
+            yield restore.restoreSession(undefined, 'test');
+            yield restore.restoreSession(null, 'test');
+            (0, chai_1.expect)(fakes.net.reset.called).to.equal(false);
+            (0, chai_1.expect)(fakes.icp.stop.called).to.equal(false);
+        }));
+        it('runs once when two endings race, and both wait until it is done', () => __awaiter(this, void 0, void 0, function* () {
+            live.net.add('s1');
+            const gate = deferred();
+            fakes.net.reset.callsFake((id) => __awaiter(this, void 0, void 0, function* () {
+                yield gate.promise;
+                live.net.delete(id);
+            }));
+            const restore = new PhoneNetworkRestore_1.PhoneNetworkRestore();
+            let firstDone = false;
+            let secondDone = false;
+            const first = restore.restoreSession('s1', 'deleted').then(() => (firstDone = true));
+            const second = restore.restoreSession('s1', 'idle').then(() => (secondDone = true));
+            yield new Promise((r) => setImmediate(r));
+            (0, chai_1.expect)(firstDone || secondDone, 'nobody may go on before the network is back').to.equal(false);
+            gate.resolve();
+            yield Promise.all([first, second]);
+            yield restore.restoreSession('s1', 'later');
+            (0, chai_1.expect)(fakes.net.reset.callCount).to.equal(1);
+        }));
+        it("never throws: one service's failure doesn't stop the other's restore", () => __awaiter(this, void 0, void 0, function* () {
+            live.net.add('s1');
+            live.icp.add('s1');
+            fakes.net.reset.rejects(new Error('boom'));
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreSession('s1', 'test');
+            (0, chai_1.expect)(fakes.icp.stop.calledOnceWith('s1')).to.equal(true);
+        }));
+    });
+    it('restoreAll restores every session either service still has', () => __awaiter(this, void 0, void 0, function* () {
+        live.net.add('a');
+        live.icp.add('a');
+        live.icp.add('b');
+        yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreAll('shutdown');
+        (0, chai_1.expect)(fakes.net.reset.args.map((a) => a[0])).to.deep.equal(['a']);
+        (0, chai_1.expect)(fakes.icp.stop.args.map((a) => a[0]).sort()).to.deep.equal(['a', 'b']);
+    }));
+    describe('restoreLeftovers: what an ended run wrote down', () => {
+        beforeEach(() => {
+            adb.answers['P1 shell settings get global http_proxy'] = '127.0.0.1:11150';
+        });
+        it('turns back on what was on, and puts back the proxy it set', () => __awaiter(this, void 0, void 0, function* () {
+            yield ledger.note('old', 'P1', { offline: { wifiOn: true, dataOn: false } });
+            yield ledger.note('old', 'P1', {
+                proxy: { set: '127.0.0.1:11150', previous: null, reversePort: 11150 },
+            });
+            const done = yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreLeftovers({});
+            (0, chai_1.expect)(done).to.equal(1);
+            (0, chai_1.expect)(adb.commands('P1')).to.deep.equal([
+                'shell svc wifi enable',
+                'shell settings get global http_proxy',
+                'shell settings put global http_proxy :0',
+                'reverse --remove tcp:11150',
+            ]);
+            (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+        }));
+        it("puts back the phone's own proxy when it had one", () => __awaiter(this, void 0, void 0, function* () {
+            yield ledger.note('old', 'P1', {
+                proxy: { set: '127.0.0.1:11150', previous: 'proxy.corp:3128' },
+            });
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreLeftovers({});
+            (0, chai_1.expect)(adb.commands('P1')).to.include('shell settings put global http_proxy proxy.corp:3128');
+        }));
+        it('leaves a proxy alone that someone changed since, and forgets it', () => __awaiter(this, void 0, void 0, function* () {
+            adb.answers['P1 shell settings get global http_proxy'] = 'proxy.corp:3128';
+            yield ledger.note('old', 'P1', { proxy: { set: '127.0.0.1:11150', previous: null } });
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreLeftovers({});
+            (0, chai_1.expect)(adb.commands('P1')).to.deep.equal(['shell settings get global http_proxy']);
+            (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+        }));
+        it('skips a session this server still runs', () => __awaiter(this, void 0, void 0, function* () {
+            live.net.add('running');
+            yield ledger.note('running', 'P1', { offline: { wifiOn: true, dataOn: true } });
+            (0, chai_1.expect)(yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreLeftovers({})).to.equal(0);
+            (0, chai_1.expect)(adb.calls).to.deep.equal([]);
+            (0, chai_1.expect)((yield ledger.list()).map((e) => e.sessionId)).to.deep.equal(['running']);
+        }));
+        it('touches only the phone it is asked about', () => __awaiter(this, void 0, void 0, function* () {
+            yield ledger.note('old-1', 'P1', { offline: { wifiOn: true, dataOn: true } });
+            yield ledger.note('old-2', 'P2', { offline: { wifiOn: true, dataOn: true } });
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreLeftovers({ udid: 'P2' });
+            (0, chai_1.expect)(adb.commands('P1')).to.deep.equal([]);
+            (0, chai_1.expect)(adb.commands('P2')).to.deep.equal(['shell svc data enable', 'shell svc wifi enable']);
+            (0, chai_1.expect)((yield ledger.list()).map((e) => e.sessionId)).to.deep.equal(['old-1']);
+        }));
+        it('keeps what it could not undo for next time, and gives up after a week', () => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            adb.answers['P1 shell svc data enable'] = new Error("device 'P1' not found");
+            adb.answers['P9 shell svc data enable'] = new Error("device 'P9' not found");
+            yield ledger.note('recent', 'P1', { offline: { wifiOn: true, dataOn: true } });
+            yield ledger.note('ancient', 'P9', { offline: { wifiOn: true, dataOn: true } });
+            const row = yield prisma_1.prisma.webConfig.findUnique({ where: { name: 'phone-network:ancient' } });
+            (0, chai_1.expect)(row, 'the record').to.not.equal(null);
+            const value = JSON.parse((_a = row === null || row === void 0 ? void 0 : row.value) !== null && _a !== void 0 ? _a : '{}');
+            yield prisma_1.prisma.webConfig.update({
+                where: { name: 'phone-network:ancient' },
+                data: { value: JSON.stringify(Object.assign(Object.assign({}, value), { at: Date.now() - 8 * DAY })) },
+            });
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().restoreLeftovers({});
+            (0, chai_1.expect)((yield ledger.list()).map((e) => e.sessionId)).to.deep.equal(['recent']);
+        }));
+    });
+    describe('cleanUpAtBoot: a proxy left pointing at a dead capture port', () => {
+        let server;
+        let livePort;
+        let deadPort;
+        beforeEach(() => __awaiter(this, void 0, void 0, function* () {
+            server = net_1.default.createServer((s) => s.destroy());
+            yield new Promise((r) => server.listen(0, '127.0.0.1', () => r()));
+            livePort = server.address().port;
+            const closed = net_1.default.createServer();
+            yield new Promise((r) => closed.listen(0, '127.0.0.1', () => r()));
+            deadPort = closed.address().port;
+            yield new Promise((r) => closed.close(() => r()));
+            range = [Math.min(livePort, deadPort), Math.max(livePort, deadPort)];
+        }));
+        afterEach(() => __awaiter(this, void 0, void 0, function* () {
+            yield new Promise((r) => server.close(() => r()));
+        }));
+        it("clears only a proxy that points at this machine's capture ports where nothing answers", () => __awaiter(this, void 0, void 0, function* () {
+            adb.answers['DEAD shell settings get global http_proxy'] = `127.0.0.1:${deadPort}`;
+            adb.answers['EMU shell settings get global http_proxy'] = `10.0.2.2:${deadPort}`;
+            adb.answers['LIVE shell settings get global http_proxy'] = `127.0.0.1:${livePort}`;
+            adb.answers['CORP shell settings get global http_proxy'] = 'proxy.corp:3128';
+            adb.answers['NONE shell settings get global http_proxy'] = ':0';
+            adb.answers['FAR shell settings get global http_proxy'] = '127.0.0.1:1';
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().cleanUpAtBoot(['DEAD', 'EMU', 'LIVE', 'CORP', 'NONE', 'FAR']);
+            (0, chai_1.expect)(adb.commands('DEAD')).to.deep.equal([
+                'shell settings get global http_proxy',
+                'shell settings put global http_proxy :0',
+                `reverse --remove tcp:${deadPort}`,
+            ]);
+            (0, chai_1.expect)(adb.commands('EMU')).to.deep.equal([
+                'shell settings get global http_proxy',
+                'shell settings put global http_proxy :0',
+            ]);
+            for (const kept of ['LIVE', 'CORP', 'NONE', 'FAR']) {
+                (0, chai_1.expect)(adb.commands(kept), kept).to.deep.equal(['shell settings get global http_proxy']);
+            }
+        }));
+        it('undoes what the ledger holds first, then checks the phones', () => __awaiter(this, void 0, void 0, function* () {
+            yield ledger.note('old', 'P1', { offline: { wifiOn: true, dataOn: true } });
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().cleanUpAtBoot([]);
+            (0, chai_1.expect)(adb.commands('P1')).to.deep.equal(['shell svc data enable', 'shell svc wifi enable']);
+        }));
+        it('never throws, even when a phone cannot be read', () => __awaiter(this, void 0, void 0, function* () {
+            adb.answers['shell settings get global http_proxy'] = new Error('unauthorized');
+            yield new PhoneNetworkRestore_1.PhoneNetworkRestore().cleanUpAtBoot(['X']);
+        }));
+    });
+    it('can be built by the container', () => {
+        restoreRegs();
+        restoreRegs = (0, container_registration_1.saveRegistrations)(PhoneNetworkRestore_1.PhoneNetworkRestore);
+        (0, chai_1.expect)(() => typedi_1.Container.get(PhoneNetworkRestore_1.PhoneNetworkRestore)).not.to.throw();
+    });
+});

package/lib/test/unit/phone-network/session-end-paths.spec.js

@@ -0,0 +1,182 @@
+"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 plugin_1 = require("../../../src/plugin");
+const NodeDevices_1 = __importDefault(require("../../../src/device-managers/NodeDevices"));
+const DeviceService = __importStar(require("../../../src/data-service/device-service"));
+const ActiveLeases = __importStar(require("../../../src/services/lease/activeLeases"));
+const device_utils_1 = require("../../../src/device-utils");
+const SessionLifecycleService_1 = require("../../../src/services/SessionLifecycleService");
+const SessionMetricsService_1 = require("../../../src/services/metrics/SessionMetricsService");
+const OrphanSweeper_1 = require("../../../src/services/OrphanSweeper");
+const ShutdownCoordinator_1 = require("../../../src/services/ShutdownCoordinator");
+const PhoneNetworkRestore_1 = require("../../../src/services/network/PhoneNetworkRestore");
+const event_manager_1 = require("../../../src/dashboard/event-manager");
+const SessionManager_1 = require("../../../src/sessions/SessionManager");
+const prisma_1 = require("../../../src/prisma");
+const container_registration_1 = require("../../helpers/container-registration");
+const scratch_database_1 = require("../../helpers/scratch-database");
+/**
+ * A network profile or the interceptor changes the whole phone. Its network
+ * was put back only when the test deleted a session Xenon kept in memory.
+ * Every other ending (Appium's new-command timeout, Xenon's idle release, a
+ * shutdown, a stale heartbeat) left an Offline phone offline and an
+ * intercepted phone pointing at a proxy that no longer exists.
+ *
+ * Each ending now asks PhoneNetworkRestore, keyed by the session id, and
+ * before the phone is released: a phone handed to the next session while its
+ * network is still being put back could have that session's own profile
+ * undone.
+ */
+describe('a session’s phone network is put back however the session ends', function () {
+    this.timeout(30000);
+    const scratch = (0, scratch_database_1.useScratchDatabase)();
+    let restoreRegs;
+    let order;
+    let restoreSession;
+    let restoreAll;
+    beforeEach(() => {
+        restoreRegs = (0, container_registration_1.saveRegistrations)(PhoneNetworkRestore_1.PhoneNetworkRestore, SessionMetricsService_1.SessionMetricsService);
+        order = [];
+        restoreSession = sinon_1.default.stub().callsFake((id) => __awaiter(this, void 0, void 0, function* () {
+            order.push(`restore ${id}`);
+        }));
+        restoreAll = sinon_1.default.stub().callsFake(() => __awaiter(this, void 0, void 0, function* () {
+            order.push('restore all');
+        }));
+        typedi_1.Container.set(PhoneNetworkRestore_1.PhoneNetworkRestore, { restoreSession, restoreAll });
+        typedi_1.Container.set(SessionMetricsService_1.SessionMetricsService, { stop: sinon_1.default.stub().resolves() });
+        sinon_1.default.stub(DeviceService, 'releaseSessionDevices').callsFake((id) => __awaiter(this, void 0, void 0, function* () {
+            order.push(`release ${id}`);
+        }));
+        sinon_1.default.stub(event_manager_1.DASHBORD_EVENT_MANAGER, 'onSessionStopped').resolves();
+    });
+    afterEach(() => {
+        sinon_1.default.restore();
+        restoreRegs();
+    });
+    it('when the test deletes a session Xenon keeps no record of', () => __awaiter(this, void 0, void 0, function* () {
+        (0, chai_1.expect)(SessionManager_1.SESSION_MANAGER.getSession('s-untracked')).to.equal(undefined);
+        const next = sinon_1.default.stub().callsFake(() => __awaiter(this, void 0, void 0, function* () {
+            order.push('driver quit');
+        }));
+        yield typedi_1.Container.get(SessionLifecycleService_1.SessionLifecycleService).deleteSession(next, 's-untracked');
+        (0, chai_1.expect)(restoreSession.callCount).to.equal(1);
+        (0, chai_1.expect)(order.indexOf('restore s-untracked')).to.be.lessThan(order.indexOf('release s-untracked'));
+    }));
+    it("when Appium ends the session itself (new-command timeout), on this server's own phone", () => __awaiter(this, void 0, void 0, function* () {
+        const plugin = { pluginArgs: {}, xenonLog: { withSession: () => ({ info() { } }) } };
+        yield plugin_1.XenonPlugin.prototype.onUnexpectedShutdown.call(plugin, { sessionId: 's-timeout', caps: { udid: 'R5CT' } }, new Error('New command timeout'));
+        (0, chai_1.expect)(restoreSession.callCount).to.equal(1);
+        (0, chai_1.expect)(restoreSession.firstCall.args[0]).to.equal('s-timeout');
+        (0, chai_1.expect)(order).to.deep.equal(['restore s-timeout', 'release s-timeout']);
+    }));
+    it('when Appium ends the session on a node', () => __awaiter(this, void 0, void 0, function* () {
+        const unblock = sinon_1.default.stub(NodeDevices_1.default.prototype, 'unblockDevice').callsFake(() => __awaiter(this, void 0, void 0, function* () {
+            order.push('hub unblock');
+            return undefined;
+        }));
+        const plugin = { pluginArgs: { hub: 'http://hub:4723' } };
+        yield plugin_1.XenonPlugin.prototype.onUnexpectedShutdown.call(plugin, { sessionId: 's-node', caps: {} }, null);
+        (0, chai_1.expect)(unblock.calledOnce).to.equal(true);
+        (0, chai_1.expect)(order).to.deep.equal(['restore s-node', 'hub unblock']);
+    }));
+    it("when Xenon's idle check releases the phone", () => __awaiter(this, void 0, void 0, function* () {
+        const idle = {
+            udid: 'R5CT',
+            host: 'http://127.0.0.1:4723',
+            busy: true,
+            userBlocked: false,
+            session_id: 's-idle',
+            claimSessionId: 's-idle',
+            lastCmdExecutedAt: Date.now() - 10 * 60 * 1000,
+        };
+        sinon_1.default.stub(DeviceService, 'getAllDevices').resolves([idle]);
+        sinon_1.default.stub(ActiveLeases, 'activeLeasesByDevice').resolves(new Map());
+        sinon_1.default.stub(DeviceService, 'releaseSessionDevice').callsFake((_u, _h, id) => __awaiter(this, void 0, void 0, function* () {
+            order.push(`release ${id}`);
+            return true;
+        }));
+        yield (0, device_utils_1.releaseBlockedDevices)(60);
+        (0, chai_1.expect)(restoreSession.callCount).to.equal(1);
+        (0, chai_1.expect)(order).to.deep.equal(['restore s-idle', 'release s-idle']);
+    }));
+    it('when a graceful shutdown drains a session', () => __awaiter(this, void 0, void 0, function* () {
+        yield typedi_1.Container.get(SessionLifecycleService_1.SessionLifecycleService).stopSessionForShutdown('s-down', 'shutdown');
+        (0, chai_1.expect)(order.slice(0, 2)).to.deep.equal(['restore s-down', 'release s-down']);
+    }));
+    it('when a graceful shutdown ends, for sessions Xenon keeps no record of', () => __awaiter(this, void 0, void 0, function* () {
+        sinon_1.default.stub(SessionManager_1.SESSION_MANAGER, 'getAllSessions').returns([]);
+        yield new ShutdownCoordinator_1.ShutdownCoordinator().drain(1000, 500);
+        (0, chai_1.expect)(restoreAll.calledOnce).to.equal(true);
+    }));
+    it("when a session's heartbeat goes stale", () => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        yield scratch.db.session.deleteMany({});
+        yield scratch.db.session.create({
+            data: {
+                id: 's-stale',
+                status: 'running',
+                desired_capabilities: '{}',
+                session_capabilities: '{}',
+                node_id: 'n',
+                has_live_video: false,
+                device_udid: 'R5CT',
+                device_platform: 'android',
+                device_version: '14',
+                last_heartbeat_at: new Date(Date.now() - 60 * 60 * 1000),
+            },
+        });
+        yield new OrphanSweeper_1.OrphanSweeper().sweep({ heartbeatIntervalMs: 1000 });
+        (0, chai_1.expect)(order.slice(0, 2)).to.deep.equal(['restore s-stale', 'release s-stale']);
+        (0, chai_1.expect)((_a = (yield prisma_1.prisma.session.findUnique({ where: { id: 's-stale' } }))) === null || _a === void 0 ? void 0 : _a.status).to.equal('failed');
+    }));
+});