@xenon-device-management/xenon 2.13.1 → 2.14.0

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');
+    }));
+});

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

@@ -0,0 +1,110 @@
+"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 SessionLifecycleService_1 = require("../../../src/services/SessionLifecycleService");
+const NetworkConditioningService_1 = require("../../../src/services/NetworkConditioningService");
+const InterceptorService_1 = require("../../../src/services/InterceptorService");
+const PhoneNetworkRestore_1 = require("../../../src/services/network/PhoneNetworkRestore");
+const PluginContext_1 = require("../../../src/PluginContext");
+const IPluginArgs_1 = require("../../../src/interfaces/IPluginArgs");
+const XenonCapabilityManager_1 = require("../../../src/XenonCapabilityManager");
+const SessionManager_1 = require("../../../src/sessions/SessionManager");
+const SessionType_1 = __importDefault(require("../../../src/enums/SessionType"));
+const container_registration_1 = require("../../helpers/container-registration");
+const scratch_database_1 = require("../../helpers/scratch-database");
+const android = { udid: 'R5CT', platform: 'android', deviceType: 'real', host: 'h' };
+const sessionOf = (type) => ({
+    getId: () => 's1',
+    getType: () => type,
+    getCapabilities: () => ({}),
+    apiKeyId: null,
+    userId: null,
+    startVideoRecording: sinon_1.default.stub().resolves(),
+});
+const capsWith = (extra) => (Object.assign({ [XenonCapabilityManager_1.XENON_CAPABILITIES.VIDEO_RECORDING]: false, [XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_MOCKS]: [], [XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_INCLUDE_HOSTS]: [], [XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_EXCLUDE_HOSTS]: [] }, extra));
+/**
+ * Where a session's network changes are made. Only the server that drives the
+ * phone makes them: a hub used to run its own adb against a node's phone (on
+ * one Mac, the very same phone), and start a second proxy for it.
+ */
+describe('a session’s network changes at its start', function () {
+    this.timeout(30000);
+    // The row a hub writes for a session another server runs (recordRoutedSession).
+    const scratch = (0, scratch_database_1.useScratchDatabase)();
+    let restoreRegs;
+    let order;
+    let applyProfile;
+    let start;
+    let restoreLeftovers;
+    let context;
+    beforeEach(() => {
+        restoreRegs = (0, container_registration_1.saveRegistrations)(NetworkConditioningService_1.NetworkConditioningService, InterceptorService_1.InterceptorService, PhoneNetworkRestore_1.PhoneNetworkRestore, PluginContext_1.PluginContext);
+        order = [];
+        applyProfile = sinon_1.default.stub().callsFake(() => __awaiter(this, void 0, void 0, function* () { return void order.push('profile'); }));
+        start = sinon_1.default.stub().callsFake(() => __awaiter(this, void 0, void 0, function* () { return void order.push('interceptor'); }));
+        restoreLeftovers = sinon_1.default.stub().callsFake(() => __awaiter(this, void 0, void 0, function* () {
+            order.push('leftovers');
+            return 0;
+        }));
+        typedi_1.Container.set(NetworkConditioningService_1.NetworkConditioningService, { applyProfile });
+        typedi_1.Container.set(InterceptorService_1.InterceptorService, { start });
+        typedi_1.Container.set(PhoneNetworkRestore_1.PhoneNetworkRestore, { restoreLeftovers });
+        context = new PluginContext_1.PluginContext();
+        context.pluginArgs = Object.assign(Object.assign({}, IPluginArgs_1.DefaultPluginArgs), { enableDashboard: false });
+        typedi_1.Container.set(PluginContext_1.PluginContext, context);
+    });
+    afterEach(() => __awaiter(this, void 0, void 0, function* () {
+        sinon_1.default.restore();
+        SessionManager_1.SESSION_MANAGER.removeSession('s1');
+        restoreRegs();
+        yield scratch.db.session.deleteMany({});
+    }));
+    const apply = (type, caps) => typedi_1.Container.get(SessionLifecycleService_1.SessionLifecycleService).applyPostSessionLogic(sessionOf(type), caps, android);
+    it('puts back what an earlier session left on the phone, then applies its own', () => __awaiter(this, void 0, void 0, function* () {
+        yield apply(SessionType_1.default.LOCAL, capsWith({
+            [XenonCapabilityManager_1.XENON_CAPABILITIES.NETWORK_PROFILE]: 'Offline',
+            [XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_ENABLED]: true,
+        }));
+        (0, chai_1.expect)(restoreLeftovers.calledOnceWith({ udid: 'R5CT' })).to.equal(true);
+        (0, chai_1.expect)(order).to.deep.equal(['leftovers', 'profile', 'interceptor']);
+    }));
+    it("doesn't touch a phone another server drives", () => __awaiter(this, void 0, void 0, function* () {
+        for (const type of [SessionType_1.default.REMOTE, SessionType_1.default.CLOUD]) {
+            yield apply(type, capsWith({
+                [XenonCapabilityManager_1.XENON_CAPABILITIES.NETWORK_PROFILE]: 'Offline',
+                [XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_ENABLED]: true,
+            }));
+            SessionManager_1.SESSION_MANAGER.removeSession('s1');
+        }
+        (0, chai_1.expect)(order).to.deep.equal([]);
+    }));
+    it("starts the interceptor by the server's option when the session doesn't say", () => __awaiter(this, void 0, void 0, function* () {
+        context.pluginArgs = Object.assign(Object.assign({}, context.pluginArgs), { interceptor: { enabled: true, bufferSize: 9 } });
+        yield apply(SessionType_1.default.LOCAL, capsWith({}));
+        (0, chai_1.expect)(start.calledOnce).to.equal(true);
+        const [sessionId, device, opts] = start.firstCall.args;
+        (0, chai_1.expect)(sessionId).to.equal('s1');
+        (0, chai_1.expect)(device).to.equal(android);
+        (0, chai_1.expect)(opts).to.include({ enabled: true, bufferSize: 9, captureBodies: true });
+    }));
+    it("leaves the interceptor off when the session turns it off over the server's option", () => __awaiter(this, void 0, void 0, function* () {
+        context.pluginArgs = Object.assign(Object.assign({}, context.pluginArgs), { interceptor: { enabled: true } });
+        yield apply(SessionType_1.default.LOCAL, capsWith({ [XenonCapabilityManager_1.XENON_CAPABILITIES.INTERCEPTOR_ENABLED]: false }));
+        (0, chai_1.expect)(start.called).to.equal(false);
+    }));
+});

package/lib/test/unit/phone-network/xenon-proxy.spec.js

@@ -0,0 +1,69 @@
+"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 net_1 = __importDefault(require("net"));
+const xenonProxy_1 = require("../../../src/services/network/xenonProxy");
+describe('a phone proxy setting, read', () => {
+    it('parses host:port', () => {
+        (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)('127.0.0.1:11100')).to.deep.equal({ host: '127.0.0.1', port: 11100 });
+        (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)(' 10.0.2.2:11105 ')).to.deep.equal({ host: '10.0.2.2', port: 11105 });
+    });
+    it('reads no proxy from what Android stores for none', () => {
+        for (const none of [null, undefined, '', 'null', ':0', '  ']) {
+            (0, chai_1.expect)((0, xenonProxy_1.isUnsetProxy)(none), String(none)).to.equal(true);
+            (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)(none)).to.equal(null);
+        }
+        (0, chai_1.expect)((0, xenonProxy_1.isUnsetProxy)('proxy.corp:3128')).to.equal(false);
+    });
+    it('refuses a value that is not host:port', () => {
+        (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)('proxy.corp')).to.equal(null);
+        (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)('a:b')).to.equal(null);
+        (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)('a:0')).to.equal(null);
+        (0, chai_1.expect)((0, xenonProxy_1.parseProxySetting)('a:70000')).to.equal(null);
+    });
+    it('knows the addresses a phone uses to reach this machine', () => {
+        const own = ['192.168.1.20'];
+        (0, chai_1.expect)((0, xenonProxy_1.pointsAtThisMachine)('127.0.0.1', own)).to.equal(true);
+        (0, chai_1.expect)((0, xenonProxy_1.pointsAtThisMachine)('localhost', own)).to.equal(true);
+        (0, chai_1.expect)((0, xenonProxy_1.pointsAtThisMachine)('10.0.2.2', own)).to.equal(true);
+        (0, chai_1.expect)((0, xenonProxy_1.pointsAtThisMachine)('192.168.1.20', own)).to.equal(true);
+        (0, chai_1.expect)((0, xenonProxy_1.pointsAtThisMachine)('192.168.1.21', own)).to.equal(false);
+        (0, chai_1.expect)((0, xenonProxy_1.pointsAtThisMachine)('proxy.corp', own)).to.equal(false);
+    });
+});
+describe('isPortListening', function () {
+    let server;
+    let livePort;
+    let deadPort;
+    before(() => __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()));
+    }));
+    after(() => __awaiter(this, void 0, void 0, function* () {
+        yield new Promise((r) => server.close(() => r()));
+    }));
+    it('says a port with a listener answers', () => __awaiter(this, void 0, void 0, function* () {
+        (0, chai_1.expect)(yield (0, xenonProxy_1.isPortListening)(livePort)).to.equal(true);
+    }));
+    it('says a closed port does not', () => __awaiter(this, void 0, void 0, function* () {
+        (0, chai_1.expect)(yield (0, xenonProxy_1.isPortListening)(deadPort)).to.equal(false);
+    }));
+});

package/lib/test/unit/plugin.spec.js

@@ -81,7 +81,7 @@ describe('Device filter tests', () => {
         (0, chai_1.expect)(filter).to.deep.equal({
             platform: 'ios',
             platformVersion: '14.0',
-            name: 'iPhone',
+            appleFamily: 'iphone',
             deviceType: 'real',
             udid: ['21112-1111-1111-111'],
             minSDK: undefined,
@@ -113,7 +113,7 @@ describe('Device filter tests', () => {
         (0, chai_1.expect)(filter).to.deep.equal({
             platform: 'ios',
             platformVersion: '14.0',
-            name: 'iPhone',
+            appleFamily: 'iphone',
             filterByHost: undefined,
             deviceType: 'simulator',
             udid: [],
@@ -140,7 +140,7 @@ describe('Device filter tests', () => {
             platform: 'ios',
             filterByHost: undefined,
             platformVersion: undefined,
-            name: 'iPhone',
+            appleFamily: 'iphone',
             deviceType: 'simulator',
             udid: [],
             minSDK: '10.2.0',

package/lib/test/unit/recording-options.spec.js

@@ -0,0 +1,181 @@
+"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 plugin_1 = require("../../src/plugin");
+const ServerManager_1 = require("../../src/services/ServerManager");
+const PluginContext_1 = require("../../src/PluginContext");
+const concurrency_gate_1 = require("../../src/services/recording/concurrency-gate");
+const config_1 = require("../../src/config");
+const logger_1 = __importDefault(require("../../src/logger"));
+/**
+ * `maxConcurrentRecordings` and `recordingsAssetsPath` are declared in
+ * schema.json, so Appium accepts them in a config file, but nothing read them:
+ * only the XENON_MAX_CONCURRENT_RECORDINGS and XENON_RECORDINGS_ASSETS_PATH
+ * environment variables reached src/config.ts. The option now wins, the
+ * variable is the fallback, and both are applied at boot before anything that
+ * reads them (the artifact store, the concurrency gate).
+ */
+describe('the recording options', () => {
+    let saved;
+    let env;
+    let statics;
+    beforeEach(() => {
+        saved = { max: config_1.config.maxConcurrentRecordings, path: config_1.config.recordingsAssetsPath };
+        env = {
+            max: process.env.XENON_MAX_CONCURRENT_RECORDINGS,
+            path: process.env.XENON_RECORDINGS_ASSETS_PATH,
+        };
+        delete process.env.XENON_MAX_CONCURRENT_RECORDINGS;
+        delete process.env.XENON_RECORDINGS_ASSETS_PATH;
+        statics = {
+            nodeId: plugin_1.XenonPlugin.NODE_ID,
+            port: plugin_1.XenonPlugin.port,
+            basePath: plugin_1.XenonPlugin.nodeBasePath,
+        };
+    });
+    afterEach(() => {
+        sinon_1.default.restore();
+        (0, config_1.updateConfig)({ maxConcurrentRecordings: saved.max, recordingsAssetsPath: saved.path });
+        for (const [name, value] of [
+            ['XENON_MAX_CONCURRENT_RECORDINGS', env.max],
+            ['XENON_RECORDINGS_ASSETS_PATH', env.path],
+        ]) {
+            if (value === undefined)
+                delete process.env[name];
+            else
+                process.env[name] = value;
+        }
+        plugin_1.XenonPlugin.NODE_ID = statics.nodeId;
+        plugin_1.XenonPlugin.port = statics.port;
+        plugin_1.XenonPlugin.nodeBasePath = statics.basePath;
+    });
+    /**
+     * Boots as far as the database step and says what the options were when it
+     * began: the artifact store is built there from `recordingsAssetsPath`.
+     */
+    function seenAtDatabaseStep(pluginArgs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const seen = {};
+            const boot = ServerManager_1.ServerManager.prototype;
+            sinon_1.default.stub(boot, 'resolvePluginArgs').resolves(pluginArgs);
+            sinon_1.default.stub(logger_1.default, 'banner');
+            sinon_1.default.stub(PluginContext_1.PluginContext.prototype, 'setContext');
+            sinon_1.default.stub(boot, 'syncDatabaseAndAIConfig').resolves();
+            sinon_1.default.stub(boot, 'initializeCoreSubsystems').callsFake(() => __awaiter(this, void 0, void 0, function* () {
+                seen.max = config_1.config.maxConcurrentRecordings;
+                seen.path = config_1.config.recordingsAssetsPath;
+                throw new Error('boot stopped by the test');
+            }));
+            yield typedi_1.Container.get(ServerManager_1.ServerManager)
+                .updateServer({}, null, { port: 4723 })
+                .catch((err) => (0, chai_1.expect)(err.message).to.equal('boot stopped by the test'));
+            return seen;
+        });
+    }
+    describe('applied at boot', () => {
+        it('takes the maxConcurrentRecordings option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const seen = yield seenAtDatabaseStep({ maxConcurrentRecordings: 2 });
+            (0, chai_1.expect)(seen.max).to.equal(2);
+        }));
+        it('takes the recordingsAssetsPath option', () => __awaiter(void 0, void 0, void 0, function* () {
+            const seen = yield seenAtDatabaseStep({ recordingsAssetsPath: '/srv/xenon/recordings' });
+            (0, chai_1.expect)(seen.path).to.equal('/srv/xenon/recordings');
+        }));
+        it('falls back to the environment variables when the options are not set', () => __awaiter(void 0, void 0, void 0, function* () {
+            process.env.XENON_MAX_CONCURRENT_RECORDINGS = '7';
+            process.env.XENON_RECORDINGS_ASSETS_PATH = '/mnt/recordings';
+            const seen = yield seenAtDatabaseStep({});
+            (0, chai_1.expect)(seen).to.deep.equal({ max: 7, path: '/mnt/recordings' });
+        }));
+        it('lets the option win over the environment variable', () => __awaiter(void 0, void 0, void 0, function* () {
+            process.env.XENON_MAX_CONCURRENT_RECORDINGS = '7';
+            process.env.XENON_RECORDINGS_ASSETS_PATH = '/mnt/recordings';
+            const seen = yield seenAtDatabaseStep({
+                maxConcurrentRecordings: 3,
+                recordingsAssetsPath: '/srv/xenon/recordings',
+            });
+            (0, chai_1.expect)(seen).to.deep.equal({ max: 3, path: '/srv/xenon/recordings' });
+        }));
+        it('keeps the default cap of 4 when neither is set', () => __awaiter(void 0, void 0, void 0, function* () {
+            const seen = yield seenAtDatabaseStep({});
+            (0, chai_1.expect)(seen.max).to.equal(4);
+        }));
+        it('ignores a cap that is not a whole number of at least 1', () => __awaiter(void 0, void 0, void 0, function* () {
+            for (const bad of [0, -2, 2.5, NaN, '3', null]) {
+                const seen = yield seenAtDatabaseStep({ maxConcurrentRecordings: bad });
+                (0, chai_1.expect)(seen.max, `option ${JSON.stringify(bad)}`).to.equal(4);
+                sinon_1.default.restore();
+            }
+        }));
+        it('ignores an environment cap that is not a whole number of at least 1', () => __awaiter(void 0, void 0, void 0, function* () {
+            process.env.XENON_MAX_CONCURRENT_RECORDINGS = 'many';
+            const seen = yield seenAtDatabaseStep({});
+            (0, chai_1.expect)(seen.max).to.equal(4);
+        }));
+        it('ignores a blank recordingsAssetsPath', () => __awaiter(void 0, void 0, void 0, function* () {
+            const seen = yield seenAtDatabaseStep({ recordingsAssetsPath: '   ' });
+            (0, chai_1.expect)(seen.path).to.equal(saved.path);
+        }));
+    });
+    describe('the concurrency gate', () => {
+        it('reads the cap when it admits, not when it is built', () => {
+            (0, config_1.updateConfig)({ maxConcurrentRecordings: 4 });
+            const gate = new concurrency_gate_1.ConcurrencyGate();
+            (0, config_1.updateConfig)({ maxConcurrentRecordings: 1 });
+            (0, chai_1.expect)(gate.getLimit()).to.equal(1);
+            (0, chai_1.expect)(gate.tryAcquire(['r1'])).to.equal(true);
+            (0, chai_1.expect)(gate.tryAcquire(['r2'])).to.equal(false);
+        });
+        it('keeps an explicit limit over the configured one', () => {
+            (0, config_1.updateConfig)({ maxConcurrentRecordings: 4 });
+            (0, chai_1.expect)(new concurrency_gate_1.ConcurrencyGate(2).getLimit()).to.equal(2);
+        });
+    });
+});
+describe('resolving the recording options', () => {
+    describe('maxConcurrentRecordings', () => {
+        it('takes the option, then the variable, then 4', () => {
+            (0, chai_1.expect)((0, config_1.resolveMaxConcurrentRecordings)(2, '7')).to.equal(2);
+            (0, chai_1.expect)((0, config_1.resolveMaxConcurrentRecordings)(undefined, '7')).to.equal(7);
+            (0, chai_1.expect)((0, config_1.resolveMaxConcurrentRecordings)(undefined, undefined)).to.equal(4);
+        });
+        it('passes over a value that is not a whole number of at least 1', () => {
+            for (const bad of [0, -1, 1.5, NaN, Infinity, '2', null, {}]) {
+                (0, chai_1.expect)((0, config_1.resolveMaxConcurrentRecordings)(bad, '7'), JSON.stringify(bad)).to.equal(7);
+            }
+            for (const bad of ['', ' ', '0', '-3', '2.5', 'many', 'NaN']) {
+                (0, chai_1.expect)((0, config_1.resolveMaxConcurrentRecordings)(undefined, bad), JSON.stringify(bad)).to.equal(4);
+            }
+        });
+    });
+    describe('recordingsAssetsPath', () => {
+        it('takes the option, then the variable, then the default folder', () => {
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)('/a', '/b')).to.equal('/a');
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)(undefined, '/b')).to.equal('/b');
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)(undefined, undefined)).to.match(/\.cache\/xenon\/assets\/sessions\/recordings$/);
+        });
+        it('counts a blank value as unset', () => {
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)('  ', '/b')).to.equal('/b');
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)(undefined, '')).to.match(/recordings$/);
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)(42, undefined)).to.match(/recordings$/);
+        });
+        it('trims what it is given', () => {
+            (0, chai_1.expect)((0, config_1.resolveRecordingsAssetsPath)(' /a ', undefined)).to.equal('/a');
+        });
+    });
+});

package/lib/test/unit/schema-required-args.spec.js

@@ -2,10 +2,13 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 const chai_1 = require("chai");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires -- a plain Node script's list
+const { ALWAYS_PRESENT_PLUGIN_ARGS } = require('../../scripts/lib/always-present-plugin-args');
 // Adding a plugin arg to schema.json's `required` list is a BREAKING change for
 // every existing config file. Appium validates the config against this schema
 // and refuses to start when a required key is absent:
@@ -18,28 +21,30 @@ const path_1 = __importDefault(require("path"));
 // in 1.12.0 — an already-running server would not come back up after upgrading,
 // with no way to tell from the message that the fix is to edit a YAML file.
 //
-// An arg with a default must be optional: the schema default and the code's own
-// destructuring fallback already supply the value.
+// An arg with a default must be optional: Appium fills in schema defaults after
+// it validates the file, and the plugin merges DefaultPluginArgs as well. Until
+// 2.13.1, 23 args were both required and defaulted, so a config file had to list
+// all of them; even the README's five-option sample was refused. None is now.
 const schema = JSON.parse(fs_1.default.readFileSync(path_1.default.join(__dirname, '..', '..', 'schema.json'), 'utf8'));
-/** Args already both required and defaulted when this guard was added. */
-const KNOWN_REQUIRED_WITH_DEFAULT = 23;
+const required = (_a = schema.required) !== null && _a !== void 0 ? _a : [];
 describe('schema.json required args', () => {
-    it('does not grow the set of args that are required despite having a default', () => {
+    it('requires no arg that has a default', () => {
         // A default means "you may omit this", which is the opposite of required.
-        // 23 args already sit in both lists; they only work because the Mac app
-        // writes every required key into the config it generates, so a hand-written
-        // or older config is already fragile against them. That is pre-existing
-        // debt, not something to fix in a hotfix — but the set must not GROW,
-        // because each addition breaks every config written before it.
-        const contradictory = schema.required.filter((key) => schema.properties[key] && 'default' in schema.properties[key]);
-        (0, chai_1.expect)(contradictory.length, `New required-with-default arg(s): ${contradictory.slice(KNOWN_REQUIRED_WITH_DEFAULT).join(', ')}. ` +
-            'An existing config that omits them fails Appium config validation and the server ' +
-            'will not start. Give the arg a default and leave it out of `required`.').to.equal(KNOWN_REQUIRED_WITH_DEFAULT);
+        const contradictory = required.filter((key) => schema.properties[key] && 'default' in schema.properties[key]);
+        (0, chai_1.expect)(contradictory, 'An existing config that omits these fails Appium config validation and the server ' +
+            'will not start. Give the arg a default and leave it out of `required`.').to.deep.equal([]);
     });
     it('keeps every required arg present in properties', () => {
-        const missing = schema.required.filter((key) => !schema.properties[key]);
+        const missing = required.filter((key) => !schema.properties[key]);
         (0, chai_1.expect)(missing, 'required lists an arg that does not exist').to.deep.equal([]);
     });
+    it('types as always present only args that have a default', () => {
+        // IPluginArgs keeps these fields non-optional (scripts/generate-types-from-schema.js
+        // marks them required for type generation only). That is true only while each
+        // exists and has a default for Appium and DefaultPluginArgs to fill in.
+        const wrong = ALWAYS_PRESENT_PLUGIN_ARGS.filter((key) => !schema.properties[key] || !('default' in schema.properties[key]));
+        (0, chai_1.expect)(wrong, 'listed as always present but missing or without a default').to.deep.equal([]);
+    });
     it('does not require the recording retention args', () => {
         // Named explicitly: this is the regression that took a live server down.
         for (const key of [
@@ -48,7 +53,7 @@ describe('schema.json required args', () => {
             'recordingFailedCleanupDays',
         ]) {
             (0, chai_1.expect)(schema.properties[key], `${key} should exist`).to.be.an('object');
-            (0, chai_1.expect)(schema.required, `${key} must stay optional`).to.not.include(key);
+            (0, chai_1.expect)(required, `${key} must stay optional`).to.not.include(key);
         }
     });
 });