@xenon-device-management/xenon 2.0.0 → 2.1.0

package/lib/test/unit/stream-leave-route.spec.js

@@ -49,7 +49,7 @@ require("reflect-metadata");
 const chai_1 = require("chai");
 const sinon_1 = __importDefault(require("sinon"));
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const typedi_1 = require("typedi");
 const control_1 = __importStar(require("../../src/app/routers/control"));
 const device_store_1 = require("../../src/data-service/device-store");
@@ -60,6 +60,8 @@ const IOSStreamService_1 = __importDefault(require("../../src/device-managers/io
 const AndroidStreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidStreamService"));
 const AndroidH264StreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidH264StreamService"));
 const authMiddleware_1 = require("../../src/middleware/authMiddleware");
+const container_registration_1 = require("../helpers/container-registration");
+const loopbackServer_1 = require("../helpers/loopbackServer");
 const UDID = 'DEV-1';
 const ALICE = 'usr_alice';
 const BOB = 'usr_bob';
@@ -90,7 +92,12 @@ describe('POST /control/:udid/stream/leave', () => {
     let h264Clients;
     let mjpegViewers;
     let iosViewers;
+    let restoreContainer;
+    // Served on 127.0.0.1: request(app) listens on every address and connects
+    // to 127.0.0.1, where another process's listener on that port can answer.
+    const loopback = (0, loopbackServer_1.loopbackServers)();
     beforeEach(() => {
+        restoreContainer = (0, container_registration_1.saveRegistrations)(ApiKeyService_1.ApiKeyService, AndroidStreamService_1.default, AndroidH264StreamService_1.default, IOSStreamService_1.default, recording_store_1.RecordingStore);
         deviceRow = {
             udid: UDID,
             host: '127.0.0.1',
@@ -126,14 +133,15 @@ describe('POST /control/:udid/stream/leave', () => {
             isRecording: () => __awaiter(void 0, void 0, void 0, function* () { return false; }),
         });
     });
-    afterEach(() => {
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
         sinon_1.default.restore();
-        typedi_1.Container.reset();
-    });
+        restoreContainer();
+        yield loopback.closeAll();
+    }));
     describe('the route', () => {
         it('schedules the leave for the holder and answers at once', () => __awaiter(void 0, void 0, void 0, function* () {
             const leave = sinon_1.default.stub(control_1.previewLeaves, 'leave');
-            const res = yield (0, supertest_1.default)(buildApp(ALICE)).post(`/xenon/api/control/${UDID}/stream/leave`);
+            const res = yield (0, loopbackRequest_1.default)(yield loopback.serve(buildApp(ALICE))).post(`/xenon/api/control/${UDID}/stream/leave`);
             (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(202);
             (0, chai_1.expect)(leave.calledOnceWith(UDID)).to.equal(true);
             // Nothing is stopped yet: that waits for the grace and the viewer count.
@@ -141,14 +149,14 @@ describe('POST /control/:udid/stream/leave', () => {
         }));
         it('refuses someone else’s hold', () => __awaiter(void 0, void 0, void 0, function* () {
             const leave = sinon_1.default.stub(control_1.previewLeaves, 'leave');
-            const res = yield (0, supertest_1.default)(buildApp(BOB)).post(`/xenon/api/control/${UDID}/stream/leave`);
+            const res = yield (0, loopbackRequest_1.default)(yield loopback.serve(buildApp(BOB))).post(`/xenon/api/control/${UDID}/stream/leave`);
             (0, chai_1.expect)(res.status).to.equal(403);
             (0, chai_1.expect)(leave.called).to.equal(false);
         }));
         // A reload leaves and then starts again; the start must win.
         it('stream/start cancels a pending leave', () => __awaiter(void 0, void 0, void 0, function* () {
             const cancel = sinon_1.default.stub(control_1.previewLeaves, 'cancel');
-            yield (0, supertest_1.default)(buildApp(ALICE)).post(`/xenon/api/control/${UDID}/stream/start`);
+            yield (0, loopbackRequest_1.default)(yield loopback.serve(buildApp(ALICE))).post(`/xenon/api/control/${UDID}/stream/start`);
             (0, chai_1.expect)(cancel.calledWith(UDID)).to.equal(true);
         }));
     });

package/lib/test/unit/stream-own-device-row.spec.js

@@ -0,0 +1,164 @@
+"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 IOSStreamService_1 = __importDefault(require("../../src/device-managers/ios/IOSStreamService"));
+const AndroidStreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidStreamService"));
+const AndroidH264StreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidH264StreamService"));
+const previewHold_1 = require("../../src/device-managers/android/previewHold");
+const singleFlight_1 = require("../../src/helpers/singleFlight");
+const device_store_1 = require("../../src/data-service/device-store");
+const deviceService = __importStar(require("../../src/data-service/device-service"));
+const PluginContext_1 = require("../../src/PluginContext");
+const PortAllocator_1 = require("../../src/services/PortAllocator");
+const recording_store_1 = require("../../src/services/recording/recording-store");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+/**
+ * A hub's table holds its nodes' rows too, and a node on the same machine
+ * sees the same phones (an iPhone, emulator-5554). The stream services
+ * looked a phone up by udid alone, so on such a hub they could act on the
+ * node's row: release the node's preview hold, or judge "an Appium session
+ * holds this phone" from the node's session. A phone's own row is the one
+ * filed under a host this server's discovery writes (localDeviceHosts).
+ *
+ * The store fake matches every key of the filter, as Prisma's findFirst does.
+ */
+const IP = '192.168.0.104';
+const HUB = `http://${IP}:4724`;
+const NODE = `http://${IP}:4725`;
+const UDID = 'shared-phone-1';
+/** A live-preview hold on the phone, as formatManualLock writes it. */
+const hold = (userId) => `manual_${userId}_${UDID}`;
+describe("stream services act on this server's own row for a udid", () => {
+    let rows;
+    let unblock;
+    beforeEach(() => {
+        rows = [];
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
+            findDevice: (filter) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                return ((_a = rows.find((r) => Object.entries(filter).every(([k, v]) => r[k] === v))) !== null && _a !== void 0 ? _a : null);
+            }),
+            updateDevice: () => __awaiter(void 0, void 0, void 0, function* () { return undefined; }),
+        });
+        const hub = new PluginContext_1.PluginContext();
+        hub.setContext(Object.assign({}, IPluginArgs_1.DefaultPluginArgs, { bindHostOrIp: IP }), 4724, 'hub', '');
+        const real = typedi_1.Container.get.bind(typedi_1.Container);
+        sinon_1.default.stub(typedi_1.Container, 'get').callsFake((token) => {
+            if (token === PluginContext_1.PluginContext)
+                return hub;
+            if (token === PortAllocator_1.PortAllocator)
+                return { release: () => __awaiter(void 0, void 0, void 0, function* () { return undefined; }) };
+            if (token === recording_store_1.RecordingStore)
+                return { isRecording: () => __awaiter(void 0, void 0, void 0, function* () { return false; }) };
+            if (token === AndroidH264StreamService_1.default)
+                return { getMultiplexer: () => undefined };
+            if (token === AndroidStreamService_1.default)
+                return { getStreamStatus: () => undefined };
+            return real(token);
+        });
+        unblock = sinon_1.default.stub(deviceService, 'unblockDevice').resolves();
+        sinon_1.default.stub(process, 'kill');
+    });
+    afterEach(() => sinon_1.default.restore());
+    function iosService() {
+        // Bypass the constructor: it starts watchdog intervals.
+        const svc = Object.create(IOSStreamService_1.default.prototype);
+        svc.sessions = new Map();
+        svc.startFlight = new singleFlight_1.SingleFlight();
+        svc.recoveryCooldowns = new Map();
+        svc.cleanupOrphanTunnels = () => __awaiter(this, void 0, void 0, function* () { return undefined; });
+        return svc;
+    }
+    it("iOS: stopping the hub's stream never releases the node's preview hold", () => __awaiter(void 0, void 0, void 0, function* () {
+        rows = [
+            { udid: UDID, host: NODE, platform: 'ios', busy: true, session_id: `manual_usr_bob_${UDID}` },
+            { udid: UDID, host: HUB, platform: 'ios', busy: false, session_id: undefined },
+        ];
+        const svc = iosService();
+        svc.sessions.set(UDID, {
+            udid: UDID,
+            wdaProcess: null,
+            forwardWDAProcess: null,
+            forwardMJPEGProcess: null,
+            tunnelProcess: null,
+            wdaPort: 28101,
+            mjpegPort: 29101,
+            status: 'running',
+            lastViewerAt: Date.now(),
+            viewerCount: 0,
+        });
+        yield svc.stopStream(UDID);
+        (0, chai_1.expect)(unblock.called, `unblocked ${JSON.stringify(unblock.args)}`).to.equal(false);
+    }));
+    it("iOS: whether an Appium session holds the phone is read from the hub's own row", () => __awaiter(void 0, void 0, void 0, function* () {
+        rows = [
+            { udid: UDID, host: NODE, platform: 'ios', busy: false, session_id: undefined },
+            { udid: UDID, host: HUB, platform: 'ios', busy: true, session_id: 'hub-appium-session' },
+        ];
+        (0, chai_1.expect)(yield iosService().appiumSessionMayUse(UDID, 'go-ios tunnels')).to.equal(true);
+    }));
+    it("Android: a stopping preview never releases the node's preview hold", () => __awaiter(void 0, void 0, void 0, function* () {
+        rows = [
+            { udid: UDID, host: NODE, platform: 'android', busy: true, session_id: hold('usr_bob') },
+            { udid: UDID, host: HUB, platform: 'android', busy: false, session_id: undefined },
+        ];
+        (0, chai_1.expect)(yield (0, previewHold_1.releaseIdlePreviewHold)(UDID)).to.equal(false);
+        (0, chai_1.expect)(unblock.called).to.equal(false);
+    }));
+    it("Android: the hub's own preview hold is still released", () => __awaiter(void 0, void 0, void 0, function* () {
+        rows = [
+            { udid: UDID, host: NODE, platform: 'android', busy: false, session_id: undefined },
+            { udid: UDID, host: HUB, platform: 'android', busy: true, session_id: hold('usr_al') },
+        ];
+        (0, chai_1.expect)(yield (0, previewHold_1.releaseIdlePreviewHold)(UDID)).to.equal(true);
+        (0, chai_1.expect)(unblock.calledOnceWith(UDID, HUB)).to.equal(true);
+    }));
+});

package/lib/test/unit/stream-stop-ownership.spec.js

@@ -49,7 +49,7 @@ require("reflect-metadata");
 const chai_1 = require("chai");
 const sinon_1 = __importDefault(require("sinon"));
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const typedi_1 = require("typedi");
 const control_1 = __importDefault(require("../../src/app/routers/control"));
 const device_store_1 = require("../../src/data-service/device-store");
@@ -60,6 +60,8 @@ const IOSStreamService_1 = __importDefault(require("../../src/device-managers/io
 const AndroidStreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidStreamService"));
 const AndroidH264StreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidH264StreamService"));
 const authMiddleware_1 = require("../../src/middleware/authMiddleware");
+const container_registration_1 = require("../helpers/container-registration");
+const loopbackServer_1 = require("../helpers/loopbackServer");
 /**
  * Round-trip guard for POST /control/:udid/stream/stop.
  *
@@ -121,6 +123,10 @@ describe('POST /control/:udid/stream/stop — lock ownership round-trip', () =>
     let androidStop;
     let h264Stop;
     let deviceRow;
+    let restoreContainer;
+    // Served on 127.0.0.1: request(app) listens on every address and connects
+    // to 127.0.0.1, where another process's listener on that port can answer.
+    const loopback = (0, loopbackServer_1.loopbackServers)();
     function setLock(sessionId) {
         deviceRow = {
             udid: UDID,
@@ -131,6 +137,7 @@ describe('POST /control/:udid/stream/stop — lock ownership round-trip', () =>
         };
     }
     beforeEach(() => {
+        restoreContainer = (0, container_registration_1.saveRegistrations)(ApiKeyService_1.ApiKeyService, AndroidStreamService_1.default, AndroidH264StreamService_1.default, IOSStreamService_1.default, recording_store_1.RecordingStore);
         setLock(`manual_${ALICE}_${UDID}`);
         sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
             findDevice: () => __awaiter(void 0, void 0, void 0, function* () { return deviceRow; }),
@@ -145,11 +152,12 @@ describe('POST /control/:udid/stream/stop — lock ownership round-trip', () =>
         // Nothing is being recorded here (see stream-stop-recording.spec.ts).
         typedi_1.Container.set(recording_store_1.RecordingStore, { activeRecordingFor: () => __awaiter(void 0, void 0, void 0, function* () { return null; }) });
     });
-    afterEach(() => {
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
         sinon_1.default.restore();
-        typedi_1.Container.reset();
-    });
-    const stop = (caller) => (0, supertest_1.default)(buildApp(caller)).post(`/xenon/api/control/${UDID}/stream/stop`);
+        restoreContainer();
+        yield loopback.closeAll();
+    }));
+    const stop = (caller) => __awaiter(void 0, void 0, void 0, function* () { return (0, loopbackRequest_1.default)(yield loopback.serve(buildApp(caller))).post(`/xenon/api/control/${UDID}/stream/stop`); });
     it('CRITICAL: the header-pair caller who started the stream can stop it', () => __awaiter(void 0, void 0, void 0, function* () {
         // Exactly what stream/start wrote for this caller: manual_<userId>_<udid>.
         // req.apiKey.id is set and DIFFERENT — the pre-fix reader picked it and 403'd.

package/lib/test/unit/stream-stop-recording.spec.js

@@ -49,7 +49,7 @@ require("reflect-metadata");
 const chai_1 = require("chai");
 const sinon_1 = __importDefault(require("sinon"));
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const typedi_1 = require("typedi");
 const control_1 = __importDefault(require("../../src/app/routers/control"));
 const device_store_1 = require("../../src/data-service/device-store");
@@ -60,6 +60,8 @@ const IOSStreamService_1 = __importDefault(require("../../src/device-managers/io
 const AndroidStreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidStreamService"));
 const AndroidH264StreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidH264StreamService"));
 const authMiddleware_1 = require("../../src/middleware/authMiddleware");
+const container_registration_1 = require("../helpers/container-registration");
+const loopbackServer_1 = require("../helpers/loopbackServer");
 /**
  * POST /control/:udid/stream/stop must not stop the stream under a live
  * recording. The recording reads from that stream: measured 2026-09-26 on a
@@ -96,7 +98,12 @@ describe('POST /control/:udid/stream/stop — a device being recorded', () => {
     let androidStop;
     let h264Stop;
     let active;
+    let restoreContainer;
+    // Served on 127.0.0.1: request(app) listens on every address and connects
+    // to 127.0.0.1, where another process's listener on that port can answer.
+    const loopback = (0, loopbackServer_1.loopbackServers)();
     beforeEach(() => {
+        restoreContainer = (0, container_registration_1.saveRegistrations)(ApiKeyService_1.ApiKeyService, AndroidStreamService_1.default, AndroidH264StreamService_1.default, IOSStreamService_1.default, recording_store_1.RecordingStore);
         active = { id: 'rec-1', groupId: 'grp-1' };
         sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
             findDevice: () => __awaiter(void 0, void 0, void 0, function* () {
@@ -118,11 +125,12 @@ describe('POST /control/:udid/stream/stop — a device being recorded', () => {
         typedi_1.Container.set(IOSStreamService_1.default, { stopStream: sinon_1.default.stub().resolves() });
         typedi_1.Container.set(recording_store_1.RecordingStore, { activeRecordingFor: () => __awaiter(void 0, void 0, void 0, function* () { return active; }) });
     });
-    afterEach(() => {
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
         sinon_1.default.restore();
-        typedi_1.Container.reset();
-    });
-    const stop = (caller) => (0, supertest_1.default)(buildApp(caller)).post(`/xenon/api/control/${UDID}/stream/stop`);
+        restoreContainer();
+        yield loopback.closeAll();
+    }));
+    const stop = (caller) => __awaiter(void 0, void 0, void 0, function* () { return (0, loopbackRequest_1.default)(yield loopback.serve(buildApp(caller))).post(`/xenon/api/control/${UDID}/stream/stop`); });
     it('refuses the owner with 409 and names the recording to stop instead', () => __awaiter(void 0, void 0, void 0, function* () {
         const res = yield stop({ userId: ALICE });
         (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(409);

package/lib/test/unit/stream-ticket-identity.spec.js

@@ -16,7 +16,7 @@ require("reflect-metadata");
 const chai_1 = require("chai");
 const sinon_1 = __importDefault(require("sinon"));
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const typedi_1 = require("typedi");
 const fs_1 = __importDefault(require("fs"));
 const os_1 = __importDefault(require("os"));
@@ -29,6 +29,8 @@ const UserService_1 = require("../../src/services/UserService");
 const ApiKeyService_1 = require("../../src/services/ApiKeyService");
 const UserSessionService_1 = require("../../src/services/UserSessionService");
 const device_store_1 = require("../../src/data-service/device-store");
+const container_registration_1 = require("../helpers/container-registration");
+const loopbackServer_1 = require("../helpers/loopbackServer");
 /**
  * `req.auth.userId` must always hold a User id.
  *
@@ -78,7 +80,12 @@ describe('stream/ticket carries the user identity, not the credential', () => {
         app.use('/xenon/api', apiRouter);
         return app;
     }
+    let restoreContainer;
+    // Served on 127.0.0.1: request(app) listens on every address and connects
+    // to 127.0.0.1, where another process's listener on that port can answer.
+    const loopback = (0, loopbackServer_1.loopbackServers)();
     beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        restoreContainer = (0, container_registration_1.saveRegistrations)(JwtKeyService_1.JwtKeyService, StreamTicketService_1.StreamTicketService, UserService_1.UserService, ApiKeyService_1.ApiKeyService, UserSessionService_1.UserSessionService);
         dir = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'xenon-ticket-identity-'));
         const keySvc = new JwtKeyService_1.JwtKeyService();
         yield keySvc.init(dir);
@@ -101,12 +108,15 @@ describe('stream/ticket carries the user identity, not the credential', () => {
             }),
         });
     }));
-    afterEach(() => {
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
         sinon_1.default.restore();
-        typedi_1.Container.reset();
+        restoreContainer();
+        yield loopback.closeAll();
         fs_1.default.rmSync(dir, { recursive: true, force: true });
+    }));
+    const mint = (caller) => __awaiter(void 0, void 0, void 0, function* () {
+        return (0, loopbackRequest_1.default)(yield loopback.serve(buildApp(caller))).post(`/xenon/api/control/${UDID}/stream/ticket`);
     });
-    const mint = (caller) => (0, supertest_1.default)(buildApp(caller)).post(`/xenon/api/control/${UDID}/stream/ticket`);
     it('mints with the userId even when a different apiKey id is present', () => __awaiter(void 0, void 0, void 0, function* () {
         const res = yield mint({ userId: ALICE_USER, apiKeyId: ALICE_KEY });
         (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(200);
@@ -150,7 +160,7 @@ describe('stream/ticket carries the user identity, not the credential', () => {
     // two must match: minting for any udid would mark the ones that 404 as
     // phones another team owns.
     it("404s a udid that isn't a device, and mints nothing", () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(buildApp({ userId: ALICE_USER })).post('/xenon/api/control/NO-SUCH-DEVICE/stream/ticket');
+        const res = yield (0, loopbackRequest_1.default)(yield loopback.serve(buildApp({ userId: ALICE_USER }))).post('/xenon/api/control/NO-SUCH-DEVICE/stream/ticket');
         (0, chai_1.expect)(res.status).to.equal(404);
         (0, chai_1.expect)(res.text).to.equal('Device not found');
     }));