@xenon-device-management/xenon 2.13.2 → 2.15.0

package/lib/test/unit/omni-vision-tap-text.spec.js

@@ -0,0 +1,129 @@
+"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 OmniVisionService_1 = require("../../src/services/omni-vision/OmniVisionService");
+const AIService_1 = require("../../src/services/AIService");
+/**
+ * `xenon: smartTap { text }` (and `omniClick`) compared the text with one OCR
+ * word at a time, so any text with a space in it ("Sign in", "Forgot
+ * password?") never matched: the answer was `clicked: false`. The
+ * `-custom:ai-text` locator had the same rule. Now the text is looked for
+ * across neighbouring words on one line, and the tap goes to the middle of
+ * the words it covers.
+ */
+describe('Omni-Vision text taps match phrases', () => {
+    // Tesseract's words, in screenshot pixels. One line holds "Sign in" and,
+    // far to the right, "Help"; "Sign" and "in" also appear on two lines.
+    const word = (text, x0, y0, x1, y1) => ({
+        text,
+        confidence: 90,
+        bbox: { x0, y0, x1, y1 },
+    });
+    const WORDS = [
+        word('Sign', 100, 200, 150, 224),
+        word('in', 158, 200, 180, 224),
+        word('Help', 600, 200, 650, 224),
+        word('Forgot', 100, 300, 170, 324),
+        word('password?', 178, 300, 290, 324),
+        word('Sign', 100, 400, 150, 424),
+        word('in', 100, 440, 120, 464),
+    ];
+    let service;
+    let driver;
+    beforeEach(() => {
+        service = new OmniVisionService_1.OmniVisionService();
+        sinon_1.default.stub(service, 'performOcr').resolves({ text: '', words: WORDS });
+        driver = {
+            sessionId: 'session-1',
+            // An Android driver: its W3C coordinates are the screenshot's pixels.
+            caps: { platformName: 'Android' },
+            getScreenshot: sinon_1.default.stub().resolves('aGVsbG8='),
+            performActions: sinon_1.default.stub().resolves(),
+            releaseActions: sinon_1.default.stub().resolves(),
+        };
+    });
+    afterEach(() => sinon_1.default.restore());
+    const tappedAt = () => {
+        const move = driver.performActions.firstCall.args[0][0].actions[0];
+        return { x: move.x, y: move.y };
+    };
+    it('taps the middle of a two-word text', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield service.omniClickByText(driver, { text: 'Sign in' });
+        (0, chai_1.expect)(result.clicked, result.message).to.equal(true);
+        (0, chai_1.expect)(result.target).to.deep.include({
+            text: 'Sign in',
+            x: 140,
+            y: 212,
+            rect: { x: 100, y: 200, width: 80, height: 24 },
+        });
+        (0, chai_1.expect)(tappedAt()).to.deep.equal({ x: 140, y: 212 });
+    }));
+    it('matches a phrase whatever its case, and part of a word at either end', () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const result = yield service.omniClickByText(driver, { text: 'forgot PASSWORD' });
+        (0, chai_1.expect)(result.clicked, result.message).to.equal(true);
+        (0, chai_1.expect)((_a = result.target) === null || _a === void 0 ? void 0 : _a.text).to.equal('Forgot password?');
+        (0, chai_1.expect)(tappedAt()).to.deep.equal({ x: 195, y: 312 });
+    }));
+    it('does not join words on different lines, or far apart on one line', () => __awaiter(void 0, void 0, void 0, function* () {
+        for (const text of ['in Help', 'Sign in Help', 'password? Sign']) {
+            const result = yield service.omniClickByText(driver, { text });
+            (0, chai_1.expect)(result.clicked, text).to.equal(false);
+        }
+        (0, chai_1.expect)(driver.performActions.called).to.equal(false);
+    }));
+    it('still matches a single word, as before', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield service.omniClickByText(driver, { text: 'help' });
+        (0, chai_1.expect)(result.clicked, result.message).to.equal(true);
+        (0, chai_1.expect)(tappedAt()).to.deep.equal({ x: 625, y: 212 });
+    }));
+    it('finds a phrase with the -custom:ai-text locator too', () => __awaiter(void 0, void 0, void 0, function* () {
+        const found = yield service.findByText(driver, 'Sign in');
+        (0, chai_1.expect)(found).to.have.lengthOf(1);
+        (0, chai_1.expect)(found[0].text).to.equal('Sign in');
+        (0, chai_1.expect)(found[0].rect).to.deep.equal({ x: 100, y: 200, width: 80, height: 24 });
+    }));
+});
+/**
+ * `xenon: smartTap { icon }` / `visualTap` answered `clicked: false`, "No visual
+ * match found", when it never looked: no AI provider, or the AI call failed.
+ * It now fails with the reason; `clicked: false` means the AI looked and found
+ * nothing.
+ */
+describe('Omni-Vision icon taps that cannot look', () => {
+    const driver = {
+        sessionId: 'session-1',
+        caps: { platformName: 'Android' },
+        getScreenshot: () => __awaiter(void 0, void 0, void 0, function* () { return 'aGVsbG8='; }),
+        performActions: sinon_1.default.stub().resolves(),
+    };
+    beforeEach(() => {
+        sinon_1.default.stub(AIService_1.AI_SERVICE, 'initializeProvider');
+    });
+    afterEach(() => sinon_1.default.restore());
+    it('fails when no AI provider is configured', () => __awaiter(void 0, void 0, void 0, function* () {
+        sinon_1.default.stub(AIService_1.AI_SERVICE, 'provider').value(null);
+        const err = yield new OmniVisionService_1.OmniVisionService().omniClickByIcon(driver, { icon: 'the gear' }).then(() => null, (e) => e);
+        (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.match(/No AI provider is configured/);
+    }));
+    it('answers clicked: false when the AI looked and found nothing', () => __awaiter(void 0, void 0, void 0, function* () {
+        sinon_1.default.stub(AIService_1.AI_SERVICE, 'visualFind').resolves(null);
+        const result = yield new OmniVisionService_1.OmniVisionService().omniClickByIcon(driver, { icon: 'the gear' });
+        (0, chai_1.expect)(result.clicked).to.equal(false);
+        (0, chai_1.expect)(result.message).to.match(/No visual match/);
+    }));
+});

package/lib/test/unit/omni-vision.spec.js

@@ -70,16 +70,14 @@ describe('OmniVisionService Unit Tests', () => {
         (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.id).to.contain('omni_ai_');
         (0, chai_1.expect)(result === null || result === void 0 ? void 0 : result.rect).to.deep.equal({ x: 30, y: 30, width: 40, height: 40 });
     }));
-    it('getVirtualElement should retrieve stored elements', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('getVirtualElement gives back an element kept for its session, to that session only', () => __awaiter(void 0, void 0, void 0, function* () {
         sinon_1.default.stub(AIService_1.AI_SERVICE, 'visualFind').resolves({ x: 50, y: 50 });
         const created = yield omniService.findByIcon(mockDriver, 'back');
-        if (created) {
-            const retrieved = omniService.getVirtualElement(created.id);
-            (0, chai_1.expect)(retrieved).to.deep.equal(created);
-        }
-        else {
+        if (!created)
             throw new Error('Failed to create mock virtual element');
-        }
+        omniService.remember('session-1', created);
+        (0, chai_1.expect)(omniService.getVirtualElement(created.id, 'session-1')).to.deep.equal(created);
+        (0, chai_1.expect)(omniService.getVirtualElement(created.id, 'session-2')).to.equal(undefined);
     }));
     it('analyzeScreen should combine OCR and AI insights', () => __awaiter(void 0, void 0, void 0, function* () {
         const mockWorker = {
@@ -95,7 +93,7 @@ describe('OmniVisionService Unit Tests', () => {
             terminate: sinon_1.default.stub().resolves(),
         };
         sinon_1.default.stub(tesseract_js_1.default, 'createWorker').resolves(mockWorker);
-        sinon_1.default.stub(AIService_1.AI_SERVICE, 'analyzeFailure').resolves('AI Insights text');
+        sinon_1.default.stub(AIService_1.AI_SERVICE, 'describeScreen').resolves('AI Insights text');
         const analysis = yield omniService.analyzeScreen(mockDriver);
         (0, chai_1.expect)(analysis.ocr.text).to.equal('Screen Text');
         (0, chai_1.expect)(analysis.ai_insights).to.equal('AI Insights text');

package/lib/test/unit/package-engines.spec.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const root = path_1.default.join(__dirname, '..', '..');
+const readJson = (file) => JSON.parse(fs_1.default.readFileSync(file, 'utf8'));
+const pkg = readJson(path_1.default.join(root, 'package.json'));
+const lock = readJson(path_1.default.join(root, 'package-lock.json'));
+const appium = readJson(require.resolve('appium/package.json'));
+/**
+ * The plugin runs inside Appium, so it supports the Node versions Appium 3
+ * does and no others. `engines` used to say `^14.17.0 || ^16.13.0 || >=18.0.0`
+ * while every Appium 3 release needs 20.19, 22.12 or 24 and later.
+ */
+describe('package.json engines', () => {
+    it("are the installed Appium 3's, the Appium the plugin is built and tested against", () => {
+        (0, chai_1.expect)(appium.version).to.match(/^3\./);
+        (0, chai_1.expect)(pkg.engines).to.deep.equal({ node: appium.engines.node, npm: appium.engines.npm });
+    });
+    it('match the copy in package-lock.json', () => {
+        (0, chai_1.expect)(lock.packages[''].engines).to.deep.equal(pkg.engines);
+    });
+});

package/lib/test/unit/partial-config-file.spec.js

@@ -73,6 +73,20 @@ describe('An Appium config file for Xenon', function () {
             (0, chai_1.expect)((_a = result.reason) !== null && _a !== void 0 ? _a : result.errors).to.be.empty;
         });
     });
+    it('is accepted with the network capture option Xenon Control writes', function () {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // The server's `interceptor` option is now each session's default
+            // (resolveInterceptorOptions); configs that set it must keep starting.
+            const result = yield load(`${README_SAMPLE}      interceptor:\n        enabled: true\n        bufferSize: 50\n        captureBodies: false\n`);
+            (0, chai_1.expect)((_a = result.reason) !== null && _a !== void 0 ? _a : result.errors).to.be.empty;
+            (0, chai_1.expect)(result.config.server.plugin.xenon.interceptor).to.deep.equal({
+                enabled: true,
+                bufferSize: 50,
+                captureBodies: false,
+            });
+        });
+    });
     it('is still refused when a value is invalid', function () {
         return __awaiter(this, void 0, void 0, function* () {
             const result = yield load(README_SAMPLE.replace('platform: both', 'platform: windows'));

package/lib/test/unit/passwordResetMode.test.js

@@ -3,8 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const chai_1 = require("chai");
 const passwordResetMode_1 = require("../../src/services/passwordResetMode");
 describe('passwordResetMode', () => {
-    it('is email when an SMTP URL is configured', () => {
-        (0, chai_1.expect)((0, passwordResetMode_1.passwordResetMode)({ smtpUrl: 'smtp://mail.example.com:587' })).to.equal('email');
+    it('is email when an SMTP URL and XENON_PUBLIC_URL are configured', () => {
+        (0, chai_1.expect)((0, passwordResetMode_1.passwordResetMode)({
+            smtpUrl: 'smtp://mail.example.com:587',
+            publicUrl: 'https://xenon.example.com',
+        })).to.equal('email');
+    });
+    // The emailed link points at XENON_PUBLIC_URL, never at the request's Host:
+    // without it Xenon emails no link, so the form must not promise one.
+    it('is admin with SMTP but no XENON_PUBLIC_URL', () => {
+        (0, chai_1.expect)((0, passwordResetMode_1.passwordResetMode)({ smtpUrl: 'smtp://mail.example.com:587' })).to.equal('admin');
     });
     it('is admin without SMTP, even though the log fallback defaults on', () => {
         // The fallback writes the link to the server log, which the person who

package/lib/test/unit/phone-network/boot-clean-up.spec.js

@@ -0,0 +1,64 @@
+"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 ServerManager_1 = require("../../../src/services/ServerManager");
+const PhoneNetworkRestore_1 = require("../../../src/services/network/PhoneNetworkRestore");
+const device_store_1 = require("../../../src/data-service/device-store");
+const container_registration_1 = require("../../helpers/container-registration");
+const ME = 'http://10.0.0.5:4723';
+const NODE_ID = 'node-me';
+/**
+ * At its start a server checks the network of the Android phones it drives:
+ * never a phone another server on the same machine drives (a hub keeps its
+ * nodes' rows), a cloud phone or an iPhone.
+ */
+describe('the phone network check at boot', () => {
+    let restoreRegs;
+    let cleanUpAtBoot;
+    beforeEach(() => {
+        restoreRegs = (0, container_registration_1.saveRegistrations)(PhoneNetworkRestore_1.PhoneNetworkRestore);
+        cleanUpAtBoot = sinon_1.default.stub().resolves();
+        typedi_1.Container.set(PhoneNetworkRestore_1.PhoneNetworkRestore, { cleanUpAtBoot });
+    });
+    afterEach(() => {
+        sinon_1.default.restore();
+        restoreRegs();
+    });
+    it("checks this server's own Android phones, once each", () => __awaiter(void 0, void 0, void 0, function* () {
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
+            getAllDevices: () => __awaiter(void 0, void 0, void 0, function* () {
+                return [
+                    { udid: 'MINE', platform: 'android', host: ME, nodeId: NODE_ID },
+                    { udid: 'MINE', platform: 'android', host: ME, nodeId: NODE_ID },
+                    { udid: 'NO-ID', platform: 'android', host: ME },
+                    { udid: 'NODE', platform: 'android', host: 'http://10.0.0.5:4724', nodeId: 'node-b' },
+                    { udid: 'CLOUD', platform: 'android', host: ME, nodeId: NODE_ID, cloud: { name: 'x' } },
+                    { udid: 'IPHONE', platform: 'ios', host: ME, nodeId: NODE_ID },
+                ];
+            }),
+        });
+        yield typedi_1.Container.get(ServerManager_1.ServerManager).cleanUpPhoneNetworks({ origin: ME, hosts: new Set([ME]) }, NODE_ID);
+        (0, chai_1.expect)(cleanUpAtBoot.calledOnce).to.equal(true);
+        (0, chai_1.expect)(cleanUpAtBoot.firstCall.args[0]).to.deep.equal(['MINE', 'NO-ID']);
+    }));
+    it('never fails the boot', () => __awaiter(void 0, void 0, void 0, function* () {
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').throws(new Error('no store'));
+        yield typedi_1.Container.get(ServerManager_1.ServerManager).cleanUpPhoneNetworks({ origin: ME, hosts: new Set([ME]) }, NODE_ID);
+        (0, chai_1.expect)(cleanUpAtBoot.called).to.equal(false);
+    }));
+});

package/lib/test/unit/phone-network/interceptor-options.spec.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const chai_1 = require("chai");
+const XenonCapabilityManager_1 = require("../../../src/XenonCapabilityManager");
+const interceptorOptions_1 = require("../../../src/services/interceptor/interceptorOptions");
+const capsOf = (alwaysMatch) => (0, XenonCapabilityManager_1.getXenonCapabilities)({ alwaysMatch, firstMatch: [{}] });
+/**
+ * The server's `interceptor` option was declared in schema.json and shown in
+ * Xenon Control, but nothing read it: turning it on did nothing. It is now the
+ * default for this server's sessions, and a session's own capability wins
+ * field by field.
+ */
+describe('resolveInterceptorOptions: the server option is the default, the session decides', () => {
+    it('leaves capture off when neither the session nor the server turns it on', () => {
+        (0, chai_1.expect)((0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({}), undefined).enabled).to.equal(false);
+        (0, chai_1.expect)((0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({}), {}).enabled).to.equal(false);
+    });
+    it("turns capture on for a session that doesn't say, when the server's option is on", () => {
+        const opts = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({}), { enabled: true });
+        (0, chai_1.expect)(opts.enabled).to.equal(true);
+        (0, chai_1.expect)(opts.captureBodies).to.equal(true);
+        (0, chai_1.expect)(opts.mocks).to.deep.equal([]);
+    });
+    it("lets a session turn capture off when the server's option is on", () => {
+        const object = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({ 'xe:interceptor': { enabled: false } }), {
+            enabled: true,
+        });
+        (0, chai_1.expect)(object.enabled).to.equal(false);
+        const flat = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({ 'xe:interceptorEnabled': false }), {
+            enabled: true,
+        });
+        (0, chai_1.expect)(flat.enabled).to.equal(false);
+    });
+    it("lets a session turn capture on when the server's option is off", () => {
+        const opts = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({ 'xe:interceptor': { enabled: true } }), {
+            enabled: false,
+        });
+        (0, chai_1.expect)(opts.enabled).to.equal(true);
+    });
+    it("takes bufferSize and captureBodies from the server when the session doesn't set them", () => {
+        const opts = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({ 'xe:interceptor': { enabled: true } }), {
+            bufferSize: 50,
+            captureBodies: false,
+        });
+        (0, chai_1.expect)(opts.bufferSize).to.equal(50);
+        (0, chai_1.expect)(opts.captureBodies).to.equal(false);
+    });
+    it("keeps the session's own bufferSize and captureBodies over the server's", () => {
+        const opts = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({ 'xe:interceptor': { enabled: true, bufferSize: 7, captureBodies: true } }), { bufferSize: 50, captureBodies: false });
+        (0, chai_1.expect)(opts.bufferSize).to.equal(7);
+        (0, chai_1.expect)(opts.captureBodies).to.equal(true);
+    });
+    it('keeps mocks and host filters from the session only', () => {
+        const mocks = [{ match: { url: '**/x' }, respondWith: { status: 204 } }];
+        const opts = (0, interceptorOptions_1.resolveInterceptorOptions)(capsOf({
+            'xe:interceptor': { mocks, includeHosts: ['a.example'], excludeHosts: ['b.example'] },
+        }), { enabled: true });
+        (0, chai_1.expect)(opts.mocks).to.deep.equal(mocks);
+        (0, chai_1.expect)(opts.includeHosts).to.deep.equal(['a.example']);
+        (0, chai_1.expect)(opts.excludeHosts).to.deep.equal(['b.example']);
+    });
+    it('reads a session that sets nothing about capture as unset, not as off', () => {
+        const caps = capsOf({});
+        (0, chai_1.expect)(caps[XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_ENABLED]).to.equal(undefined);
+        (0, chai_1.expect)(caps[XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_CAPTURE_BODIES]).to.equal(undefined);
+    });
+    it('reads an interceptor object without `enabled` as unset', () => {
+        const caps = capsOf({ 'xe:interceptor': { bufferSize: 3 } });
+        (0, chai_1.expect)(caps[XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_ENABLED]).to.equal(undefined);
+        (0, chai_1.expect)((0, interceptorOptions_1.resolveInterceptorOptions)(caps, { enabled: true }).enabled).to.equal(true);
+    });
+    it("reads `enabled: 'false'` as off", () => {
+        const caps = capsOf({ 'xe:interceptor': { enabled: 'false' } });
+        (0, chai_1.expect)(caps[XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_ENABLED]).to.equal(false);
+    });
+});

package/lib/test/unit/phone-network/interceptor-proxy-restore.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 fs_1 = __importDefault(require("fs"));
+const net_1 = __importDefault(require("net"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const typedi_1 = require("typedi");
+const InterceptorService_1 = require("../../../src/services/InterceptorService");
+const CertManager_1 = require("../../../src/services/interceptor/CertManager");
+const MitmProxyHost_1 = require("../../../src/services/interceptor/MitmProxyHost");
+const PortAllocator_1 = require("../../../src/services/PortAllocator");
+const PhoneNetworkLedger_1 = require("../../../src/services/network/PhoneNetworkLedger");
+const config_1 = require("../../../src/config");
+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 PROXY_PORT = 11150;
+const phone = { udid: 'R5CT', platform: 'android', deviceType: 'real', host: 'h' };
+const ON = { enabled: true, mocks: [], includeHosts: [], excludeHosts: [] };
+/**
+ * The interceptor points the whole phone at its proxy. When the session ends
+ * it puts back the proxy the phone had (Xenon used to write ":0" over a lab's
+ * own proxy), and records the change while it lasts so a restart can undo it.
+ */
+describe('InterceptorService and the phone proxy', function () {
+    this.timeout(60000);
+    (0, scratch_database_1.useScratchDatabase)();
+    let adb;
+    (0, fake_adb_1.useFakeAdb)(() => adb);
+    let restoreRegs;
+    let assetsBefore;
+    let assetsDir;
+    let ledger;
+    let range;
+    beforeEach(() => __awaiter(this, void 0, void 0, function* () {
+        adb = (0, fake_adb_1.fakeAdb)({ 'shell settings get global http_proxy': 'proxy.corp:3128' });
+        restoreRegs = (0, container_registration_1.saveRegistrations)(PortAllocator_1.PortAllocator);
+        range = [11100, 11199];
+        typedi_1.Container.set(PortAllocator_1.PortAllocator, {
+            acquire: () => __awaiter(this, void 0, void 0, function* () { return PROXY_PORT; }),
+            releaseForUdid: () => __awaiter(this, void 0, void 0, function* () { return undefined; }),
+            rangeOf: () => range,
+        });
+        sinon_1.default.stub(CertManager_1.CertManager.prototype, 'ensure').resolves({
+            certPath: '/nonexistent/ca.pem',
+            keyPath: '/nonexistent/ca.key',
+            subjectHash: 'abc',
+        });
+        sinon_1.default.stub(CertManager_1.CertManager.prototype, 'androidCertFilename').returns('abc.0');
+        sinon_1.default.stub(MitmProxyHost_1.MitmProxyHost.prototype, 'start').resolves();
+        sinon_1.default.stub(MitmProxyHost_1.MitmProxyHost.prototype, 'stop').resolves();
+        assetsBefore = config_1.config.sessionAssetsPath;
+        assetsDir = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'xenon-icp-'));
+        (0, config_1.updateConfig)({ sessionAssetsPath: assetsDir });
+        ledger = new PhoneNetworkLedger_1.PhoneNetworkLedger();
+        for (const entry of yield ledger.list())
+            yield ledger.forget(entry.sessionId);
+    }));
+    afterEach(() => {
+        sinon_1.default.restore();
+        restoreRegs();
+        (0, config_1.updateConfig)({ sessionAssetsPath: assetsBefore });
+        fs_1.default.rmSync(assetsDir, { recursive: true, force: true });
+    });
+    it('reads the proxy the phone had and writes its own down before setting it', () => __awaiter(this, void 0, void 0, function* () {
+        const svc = new InterceptorService_1.InterceptorService();
+        yield svc.start('s1', phone, ON);
+        const cmds = adb.commands('R5CT');
+        const read = cmds.indexOf('shell settings get global http_proxy');
+        const set = cmds.indexOf(`shell settings put global http_proxy 127.0.0.1:${PROXY_PORT}`);
+        (0, chai_1.expect)(read, cmds.join('\n')).to.be.greaterThan(-1);
+        (0, chai_1.expect)(set).to.be.greaterThan(read);
+        const [entry] = yield ledger.list();
+        (0, chai_1.expect)(entry).to.include({ sessionId: 's1', udid: 'R5CT' });
+        (0, chai_1.expect)(entry.proxy).to.deep.equal({
+            set: `127.0.0.1:${PROXY_PORT}`,
+            previous: 'proxy.corp:3128',
+            reversePort: PROXY_PORT,
+        });
+        yield svc.stop('s1');
+    }));
+    it("puts the phone's own proxy back at the end, and saves the capture", () => __awaiter(this, void 0, void 0, function* () {
+        const svc = new InterceptorService_1.InterceptorService();
+        yield svc.start('s1', phone, ON);
+        adb.calls.length = 0;
+        yield svc.stop('s1');
+        (0, chai_1.expect)(adb.commands('R5CT')).to.include('shell settings put global http_proxy proxy.corp:3128');
+        (0, chai_1.expect)(adb.commands('R5CT')).not.to.include('shell settings put global http_proxy :0');
+        (0, chai_1.expect)(yield ledger.list()).to.deep.equal([]);
+        (0, chai_1.expect)(fs_1.default.existsSync(path_1.default.join(assetsDir, 's1', 'interceptor', 'requests.json'))).to.equal(true);
+    }));
+    it('clears the proxy at the end when the phone had none', () => __awaiter(this, void 0, void 0, function* () {
+        adb.answers['shell settings get global http_proxy'] = ':0';
+        const svc = new InterceptorService_1.InterceptorService();
+        yield svc.start('s1', phone, ON);
+        adb.calls.length = 0;
+        yield svc.stop('s1');
+        (0, chai_1.expect)(adb.commands('R5CT')).to.include('shell settings put global http_proxy :0');
+    }));
+    it("doesn't put back a proxy an earlier run left pointing at a dead capture port", () => __awaiter(this, void 0, void 0, function* () {
+        const closed = net_1.default.createServer();
+        yield new Promise((r) => closed.listen(0, '127.0.0.1', () => r()));
+        const dead = closed.address().port;
+        yield new Promise((r) => closed.close(() => r()));
+        range = [Math.min(dead, PROXY_PORT), Math.max(dead, PROXY_PORT)];
+        adb.answers['shell settings get global http_proxy'] = `127.0.0.1:${dead}`;
+        const svc = new InterceptorService_1.InterceptorService();
+        yield svc.start('s1', phone, ON);
+        adb.calls.length = 0;
+        yield svc.stop('s1');
+        (0, chai_1.expect)(adb.commands('R5CT')).to.include('shell settings put global http_proxy :0');
+        (0, chai_1.expect)(adb.commands('R5CT')).not.to.include(`shell settings put global http_proxy 127.0.0.1:${dead}`);
+    }));
+    it('keeps the record when the proxy could not be put back', () => __awaiter(this, void 0, void 0, function* () {
+        const svc = new InterceptorService_1.InterceptorService();
+        yield svc.start('s1', phone, ON);
+        adb.answers['shell settings put global http_proxy proxy.corp:3128'] = new Error('offline');
+        yield svc.stop('s1');
+        (0, chai_1.expect)((yield ledger.list()).map((e) => e.sessionId)).to.deep.equal(['s1']);
+        (0, chai_1.expect)(svc.isActive('s1')).to.equal(false);
+    }));
+    it('stops once, however many times it is asked', () => __awaiter(this, void 0, void 0, function* () {
+        const svc = new InterceptorService_1.InterceptorService();
+        yield svc.start('s1', phone, ON);
+        adb.calls.length = 0;
+        yield Promise.all([svc.stop('s1'), svc.stop('s1')]);
+        const puts = adb.commands('R5CT').filter((c) => c.startsWith('shell settings put'));
+        (0, chai_1.expect)(puts).to.deep.equal(['shell settings put global http_proxy proxy.corp:3128']);
+    }));
+});