@xenon-device-management/xenon 2.0.0 → 2.2.0

package/lib/test/unit/lease/lease-token-oracle.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 sdk_leases_1 = require("../../../src/app/routers/sdk-leases");
 const LeaseService_1 = require("../../../src/services/lease/LeaseService");
 const leaseToken = __importStar(require("../../../src/services/lease/leaseToken"));
@@ -107,7 +107,10 @@ describe('lease token routes reveal nothing without the token', () => {
             },
             portLease: { deleteMany: sinon_1.default.stub().resolves({ count: 0 }) },
         };
-        store = { updateDevice: sinon_1.default.stub().resolves() };
+        store = {
+            updateDevice: sinon_1.default.stub().resolves(),
+            releaseLeaseLock: sinon_1.default.stub().resolves(true),
+        };
         const svc = new LeaseService_1.LeaseService(db, store, {}, { nodePairAuth: () => __awaiter(void 0, void 0, void 0, function* () { return ({ accessKey: '', token: '' }); }) });
         const app = (0, express_1.default)();
         app.use(express_1.default.json());
@@ -136,8 +139,8 @@ describe('lease token routes reveal nothing without the token', () => {
     function call(op, id, token) {
         const url = `/xenon/api/sdk/leases/${id}`;
         if (op === 'release')
-            return (0, supertest_1.default)(server).delete(url).set('x-xenon-lease-token', token);
-        const r = (0, supertest_1.default)(server).post(`${url}/${op}`).set('x-xenon-lease-token', token);
+            return (0, loopbackRequest_1.default)(server).delete(url).set('x-xenon-lease-token', token);
+        const r = (0, loopbackRequest_1.default)(server).post(`${url}/${op}`).set('x-xenon-lease-token', token);
         return op === 'extend' ? r.send({ durationMs: 60000 }) : r;
     }
     const answer = (r) => ({
@@ -177,6 +180,7 @@ describe('lease token routes reveal nothing without the token', () => {
                 (0, chai_1.expect)(db.lease.updateMany.called).to.equal(false);
                 (0, chai_1.expect)(db.portLease.deleteMany.called).to.equal(false);
                 (0, chai_1.expect)(store.updateDevice.called).to.equal(false);
+                (0, chai_1.expect)(store.releaseLeaseLock.called).to.equal(false);
             }));
             it(`the right token on an expired lease gets ${GONE[op]}`, () => __awaiter(void 0, void 0, void 0, function* () {
                 (0, chai_1.expect)((yield call(op, 'lse_expired', TOKEN)).status).to.equal(GONE[op]);
@@ -189,9 +193,18 @@ describe('lease token routes reveal nothing without the token', () => {
             }));
         });
     }
-    it('heartbeat: the right token on a lease past its expiry, not yet swept, gets 410', () => __awaiter(void 0, void 0, void 0, function* () {
-        (0, chai_1.expect)((yield call('heartbeat', 'lse_lapsed', TOKEN)).status).to.equal(410);
-    }));
+    // Neither may keep a lapsed lease alive: extend used to push its expiresAt
+    // out again and reset its heartbeat clock, so the sweeper never took it.
+    for (const op of ['heartbeat', 'extend']) {
+        it(`${op}: the right token on a lease past its expiry, not yet swept, gets 410 and changes nothing`, () => __awaiter(void 0, void 0, void 0, function* () {
+            const r = yield call(op, 'lse_lapsed', TOKEN);
+            (0, chai_1.expect)({ status: r.status, error: r.body.error }).to.deep.equal({
+                status: 410,
+                error: 'gone',
+            });
+            (0, chai_1.expect)(db.lease.updateMany.called).to.equal(false);
+        }));
+    }
     it('an unknown id still costs one token comparison, against one fixed hash', () => __awaiter(void 0, void 0, void 0, function* () {
         const verify = sinon_1.default.spy(leaseToken, 'verifyToken');
         yield call('heartbeat', 'lse_nope', WRONG);

package/lib/test/unit/lease/session-lease-proof.spec.js

@@ -65,6 +65,7 @@ const logger_1 = require("../../../src/logger");
 const RequestLogService_1 = require("../../../src/services/RequestLogService");
 const EventBus_1 = require("../../../src/services/EventBus");
 const JwtKeyService_1 = require("../../../src/services/token/JwtKeyService");
+const hubSessionToken_1 = require("../../../src/gateway/hubSessionToken");
 const prisma_1 = require("../../../src/prisma");
 const container_registration_1 = require("../../helpers/container-registration");
 // createSession end to end, from the capabilities a client sends to the
@@ -184,7 +185,7 @@ describe('createSession — a lease-bound session proves it holds the lease', ()
         }));
         sinon_1.default.stub(pendingSessions, 'removePendingSession').resolves();
         sinon_1.default.stub(deviceService, 'updateDeviceProgress').resolves();
-        sinon_1.default.stub(deviceService, 'updatedAllocatedDevice').resolves();
+        sinon_1.default.stub(deviceService, 'claimDeviceForSession').resolves(true);
         svc = new SessionLifecycleService_1.SessionLifecycleService();
         // Everything past finalizeSession's own bookkeeping is out of scope here;
         // what matters is the session response that becomes the Session row.
@@ -343,11 +344,15 @@ describe('createSession — a lease-bound session proves it holds the lease', ()
                     forwardedCaps = JSON.parse(JSON.stringify(c));
                     return { protocol: 'W3C', value: ['sess-1', {}, 'W3C'] };
                 }));
+                // The hub's token needs its signing key, which this spec has no use for.
+                sinon_1.default.stub(hubSessionToken_1.HubSessionTokenIssuer.prototype, 'createTokenFor').resolves('HUB-TOKEN');
             });
-            it('forwards the token to a peer Xenon node, which runs the same check', () => __awaiter(void 0, void 0, void 0, function* () {
+            it('forwards neither the lease id nor its token to a peer Xenon node: the hub resolved the lease to its phone', () => __awaiter(void 0, void 0, void 0, function* () {
                 device.nodeId = 'node-peer';
                 yield create(sessionCaps({ leaseToken: TOKEN }));
-                (0, chai_1.expect)(forwardedCaps.alwaysMatch['xe:options'].leaseToken).to.equal(TOKEN);
+                (0, chai_1.expect)(JSON.stringify(forwardedCaps)).to.not.include(TOKEN);
+                (0, chai_1.expect)(JSON.stringify(forwardedCaps)).to.not.include('lse_1');
+                (0, chai_1.expect)(forwardedCaps.alwaysMatch['appium:udid']).to.equal('u1');
                 (0, chai_1.expect)(JSON.stringify(finalCaps)).to.not.include(TOKEN);
                 (0, chai_1.expect)(JSON.stringify(pendingCopy)).to.not.include(TOKEN);
             }));

package/lib/test/unit/logcat-ws.spec.js

@@ -92,7 +92,10 @@ function harness(over) {
         if (over.maxBufferedBytes !== undefined)
             deps.maxBufferedBytes = over.maxBufferedBytes;
         (0, logcatWs_1.attachLogcatWs)(server, deps);
-        yield new Promise((r) => server.listen(0, r));
+        // 127.0.0.1, where the client connects. A listener on every address can
+        // share its port with another process's 127.0.0.1 listener, which then
+        // answers the handshake instead ("Unexpected server response: 501").
+        yield new Promise((r) => server.listen(0, '127.0.0.1', r));
         const port = server.address().port;
         return {
             port,
@@ -416,6 +419,14 @@ describe('makeTicketActorAuthorizer', () => {
         });
         return { fn, calls };
     };
+    it('leaves a node’s phone busy only by its node’s report to the node', () => __awaiter(void 0, void 0, void 0, function* () {
+        // The hub relays this socket from the node, whose own check knows the
+        // holder (deviceAccessGuard's spec says why).
+        const { fn } = authorizer({ busy: true, nodeBusy: true, session_id: null }, ALICE);
+        (0, chai_1.expect)(yield fn(UDID, { actorId: BOB })).to.equal(true);
+        const routed = authorizer({ busy: true, nodeBusy: true, session_id: 'appium-1', claimSessionId: 'appium-1' }, ALICE);
+        (0, chai_1.expect)(yield routed.fn(UDID, { actorId: BOB })).to.equal(false);
+    }));
     it('denies a device the store cannot resolve', () => __awaiter(void 0, void 0, void 0, function* () {
         // Fail-closed, and deliberately unlike deviceAccessGuard's fall-through:
         // there is no 404 behind this call, and getAdbForDevice happily runs

package/lib/test/unit/loopback-request.spec.js

@@ -0,0 +1,81 @@
+"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 });
+const chai_1 = require("chai");
+const express_1 = __importDefault(require("express"));
+const http_1 = __importDefault(require("http"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
+// The drop-in for supertest's request(app) that listens on 127.0.0.1, where
+// it connects, instead of on every address. See test/helpers/loopbackRequest.ts.
+describe('loopbackRequest', () => {
+    function echoApp() {
+        const app = (0, express_1.default)();
+        app.use(express_1.default.json());
+        app.all('/echo', (req, res) => {
+            res.json({ method: req.method, query: req.query, body: req.body });
+        });
+        return app;
+    }
+    it('serves the app on 127.0.0.1, not on every address', () => __awaiter(void 0, void 0, void 0, function* () {
+        const server = http_1.default.createServer(echoApp());
+        let bound;
+        server.on('listening', () => {
+            bound = server.address();
+        });
+        const res = yield (0, loopbackRequest_1.default)(server).get('/echo');
+        (0, chai_1.expect)(res.status).to.equal(200);
+        (0, chai_1.expect)(bound === null || bound === void 0 ? void 0 : bound.address).to.equal('127.0.0.1');
+    }));
+    it('closes the server it started once the request is answered', () => __awaiter(void 0, void 0, void 0, function* () {
+        const server = http_1.default.createServer(echoApp());
+        yield (0, loopbackRequest_1.default)(server).get('/echo');
+        (0, chai_1.expect)(server.listening).to.equal(false);
+    }));
+    it('keeps what supertest does with a request: method, query, body', () => __awaiter(void 0, void 0, void 0, function* () {
+        const res = yield (0, loopbackRequest_1.default)(echoApp()).post('/echo').query({ a: '1' }).send({ b: 2 });
+        (0, chai_1.expect)(res.body).to.deep.equal({ method: 'POST', query: { a: '1' }, body: { b: 2 } });
+    }));
+    it('answers several requests sent to one server at once', () => __awaiter(void 0, void 0, void 0, function* () {
+        const server = http_1.default.createServer(echoApp());
+        const answers = yield Promise.all([
+            (0, loopbackRequest_1.default)(server).get('/echo').query({ n: '1' }),
+            (0, loopbackRequest_1.default)(server).get('/echo').query({ n: '2' }),
+        ]);
+        (0, chai_1.expect)(answers.map((r) => r.body.query.n)).to.deep.equal(['1', '2']);
+    }));
+    it('uses a server that is already listening, and leaves it open', () => __awaiter(void 0, void 0, void 0, function* () {
+        const server = http_1.default.createServer(echoApp());
+        yield new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
+        try {
+            const res = yield (0, loopbackRequest_1.default)(server).get('/echo');
+            (0, chai_1.expect)(res.status).to.equal(200);
+            (0, chai_1.expect)(server.listening).to.equal(true);
+        }
+        finally {
+            yield new Promise((resolve) => server.close(resolve));
+        }
+    }));
+    it('sends to a URL as given', () => __awaiter(void 0, void 0, void 0, function* () {
+        const server = http_1.default.createServer(echoApp());
+        yield new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
+        try {
+            const { port } = server.address();
+            const res = yield (0, loopbackRequest_1.default)(`http://127.0.0.1:${port}`).get('/echo');
+            (0, chai_1.expect)(res.body.method).to.equal('GET');
+        }
+        finally {
+            yield new Promise((resolve) => server.close(resolve));
+        }
+    }));
+});

package/lib/test/unit/mark-node-busy-loki.spec.js

@@ -0,0 +1,53 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const chai_1 = require("chai");
+const db_1 = require("../../src/data-service/db");
+const device_store_1 = require("../../src/data-service/device-store");
+const loki_stores_1 = require("../helpers/loki-stores");
+/**
+ * markNodeBusy on the in-memory store: the hub's note that a node has just
+ * taken its phone for a preview. The Prisma store is covered with the hub's
+ * allocation in hub-node-race.spec.ts.
+ */
+describe('markNodeBusy (in-memory store)', () => {
+    (0, loki_stores_1.useLokiStores)();
+    const NODE = 'http://10.0.0.9:4725';
+    const phone = (host) => ({
+        udid: 'mark-node-busy-s9',
+        host,
+        platform: 'android',
+        busy: false,
+        nodeBusy: false,
+        offline: false,
+        userBlocked: false,
+    });
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        (yield db_1.XenonDatabase.DeviceModel).findAndRemove({ udid: 'mark-node-busy-s9' });
+    }));
+    it('sets nodeBusy and busy on that phone of that node only', () => __awaiter(void 0, void 0, void 0, function* () {
+        const model = yield db_1.XenonDatabase.DeviceModel;
+        model.insert(phone(NODE));
+        model.insert(phone('http://10.0.0.8:4725'));
+        yield device_store_1.DeviceStoreFactory.getStore().markNodeBusy('mark-node-busy-s9', NODE);
+        const rows = model.find({ udid: 'mark-node-busy-s9' });
+        const byHost = Object.fromEntries(rows.map((r) => [r.host, [r.busy, r.nodeBusy]]));
+        (0, chai_1.expect)(byHost).to.deep.equal({
+            [NODE]: [true, true],
+            'http://10.0.0.8:4725': [false, false],
+        });
+    }));
+    it('does nothing for a phone it doesn’t have', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield device_store_1.DeviceStoreFactory.getStore().markNodeBusy('mark-node-busy-s9', NODE);
+        (0, chai_1.expect)((yield db_1.XenonDatabase.DeviceModel).find({ udid: 'mark-node-busy-s9' })).to.deep.equal([]);
+    }));
+});

package/lib/test/unit/node-create-caps.spec.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const nodeCreateCaps_1 = require("../../src/services/session/nodeCreateCaps");
+/**
+ * The capabilities a hub sends the node whose phone it allocated. The hub has
+ * checked the credentials, applied the team rule and resolved the lease; the
+ * node gets a request that stands on its own: that one phone, and nothing the
+ * node can't act on.
+ */
+describe('capsForNode — the copy of a create a node gets', () => {
+    const sent = () => ({
+        alwaysMatch: {
+            platformName: 'Android',
+            'appium:udids': 'phone-1,phone-2',
+            'xe:options': { leaseId: 'lse_1', buildId: 'b-1', token: 'SECRET' },
+        },
+        firstMatch: [
+            { 'appium:udid': 'phone-1', 'appium:systemPort': 8201 },
+            { 'appium:udid': 'phone-2', 'xenon:options': { leaseId: 'lse_1', leaseToken: 'SECRET' } },
+        ],
+    });
+    it('names exactly the phone the hub allocated, once, in alwaysMatch', () => {
+        const copy = (0, nodeCreateCaps_1.capsForNode)(sent(), 'phone-1');
+        (0, chai_1.expect)(copy.alwaysMatch['appium:udid']).to.equal('phone-1');
+        (0, chai_1.expect)(copy.alwaysMatch['appium:udids']).to.equal(undefined);
+        for (const entry of copy.firstMatch) {
+            (0, chai_1.expect)(entry['appium:udid']).to.equal(undefined);
+            (0, chai_1.expect)(entry['appium:udids']).to.equal(undefined);
+        }
+        // What the hub allocated for it travels.
+        (0, chai_1.expect)(copy.firstMatch[0]['appium:systemPort']).to.equal(8201);
+    });
+    it('drops the lease id, which only the hub can resolve, from both namespaces', () => {
+        const copy = (0, nodeCreateCaps_1.capsForNode)(sent(), 'phone-1');
+        (0, chai_1.expect)(JSON.stringify(copy)).to.not.include('lse_1');
+        (0, chai_1.expect)(copy.alwaysMatch['xe:options']).to.deep.equal({ buildId: 'b-1' });
+    });
+    it('never carries a credential', () => {
+        (0, chai_1.expect)(JSON.stringify((0, nodeCreateCaps_1.capsForNode)(sent(), 'phone-1'))).to.not.include('SECRET');
+    });
+    it('does not modify the caps the hub keeps', () => {
+        const caps = sent();
+        const before = JSON.stringify(caps);
+        (0, nodeCreateCaps_1.capsForNode)(caps, 'phone-1');
+        (0, chai_1.expect)(JSON.stringify(caps)).to.equal(before);
+    });
+    it('copes with missing buckets', () => {
+        (0, chai_1.expect)((0, nodeCreateCaps_1.capsForNode)({ alwaysMatch: undefined }, 'p')).to.deep.equal({
+            alwaysMatch: { 'appium:udid': 'p' },
+            firstMatch: [{}],
+        });
+    });
+});