@xenon-device-management/xenon 2.0.0 → 2.1.0

package/lib/test/unit/control-device-lookup.spec.js

@@ -15,7 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const chai_1 = require("chai");
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const deviceTeamGuard_1 = require("../../src/middleware/deviceTeamGuard");
 const deviceAccessGuard_1 = require("../../src/middleware/deviceAccessGuard");
 /**
@@ -71,41 +71,41 @@ function appWith(caller) {
 describe('the /control guards share one device lookup', () => {
     it("costs a member's tap one lookup, not one per guard", () => __awaiter(void 0, void 0, void 0, function* () {
         const { app, lookups } = appWith(ALICE);
-        const res = yield (0, supertest_1.default)(app).post(`/control/${PHONE_A}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(app).post(`/control/${PHONE_A}/tap`);
         (0, chai_1.expect)(res.status, res.text).to.equal(200);
         (0, chai_1.expect)(lookups).to.deep.equal([PHONE_A]);
     }));
     it("costs a member's clipboard read, which both guards check, one lookup", () => __awaiter(void 0, void 0, void 0, function* () {
         const { app, lookups } = appWith(ALICE);
-        const res = yield (0, supertest_1.default)(app).get(`/control/${PHONE_A}/clipboard`);
+        const res = yield (0, loopbackRequest_1.default)(app).get(`/control/${PHONE_A}/clipboard`);
         (0, chai_1.expect)(res.status, res.text).to.equal(200);
         (0, chai_1.expect)(lookups).to.deep.equal([PHONE_A]);
     }));
     it("costs a member's screenshot one lookup", () => __awaiter(void 0, void 0, void 0, function* () {
         const { app, lookups } = appWith(ALICE);
-        yield (0, supertest_1.default)(app).get(`/control/${PHONE_A}/screenshot`);
+        yield (0, loopbackRequest_1.default)(app).get(`/control/${PHONE_A}/screenshot`);
         (0, chai_1.expect)(lookups).to.deep.equal([PHONE_A]);
     }));
     // The same count either way, so the time an answer takes can't tell a
     // hidden phone from an unknown udid either.
     it('costs a hidden phone and an unknown udid the same single lookup', () => __awaiter(void 0, void 0, void 0, function* () {
         const hidden = appWith(ALICE);
-        yield (0, supertest_1.default)(hidden.app).post(`/control/${PHONE_B}/tap`);
+        yield (0, loopbackRequest_1.default)(hidden.app).post(`/control/${PHONE_B}/tap`);
         const unknown = appWith(ALICE);
-        yield (0, supertest_1.default)(unknown.app).post(`/control/${UNKNOWN}/tap`);
+        yield (0, loopbackRequest_1.default)(unknown.app).post(`/control/${UNKNOWN}/tap`);
         (0, chai_1.expect)(hidden.lookups).to.deep.equal([PHONE_B]);
         (0, chai_1.expect)(unknown.lookups).to.deep.equal([UNKNOWN]);
     }));
     it("costs an admin's tap one lookup (the team guard skips admins)", () => __awaiter(void 0, void 0, void 0, function* () {
         const { app, lookups } = appWith(ADMIN);
-        const res = yield (0, supertest_1.default)(app).post(`/control/${PHONE_B}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(app).post(`/control/${PHONE_B}/tap`);
         (0, chai_1.expect)(res.status, res.text).to.equal(200);
         (0, chai_1.expect)(lookups).to.deep.equal([PHONE_B]);
     }));
     it('does not share a lookup between two requests', () => __awaiter(void 0, void 0, void 0, function* () {
         const { app, lookups } = appWith(ALICE);
-        yield (0, supertest_1.default)(app).post(`/control/${PHONE_A}/tap`);
-        yield (0, supertest_1.default)(app).post(`/control/${PHONE_A}/tap`);
+        yield (0, loopbackRequest_1.default)(app).post(`/control/${PHONE_A}/tap`);
+        yield (0, loopbackRequest_1.default)(app).post(`/control/${PHONE_A}/tap`);
         (0, chai_1.expect)(lookups).to.deep.equal([PHONE_A, PHONE_A]);
     }));
 });

package/lib/test/unit/control-forward-decision.spec.js

@@ -0,0 +1,115 @@
+"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 express_1 = __importDefault(require("express"));
+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");
+const device_managers_1 = require("../../src/device-managers");
+const InternalHttpClient_1 = require("../../src/InternalHttpClient");
+const PluginContext_1 = require("../../src/PluginContext");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+const authMiddleware_1 = require("../../src/middleware/authMiddleware");
+const container_registration_1 = require("../helpers/container-registration");
+/**
+ * Whether a /control action is forwarded to another server is decided by the
+ * phone's own row (its nodeId, else its exact host against this server's own
+ * hosts), never by the Host header the caller happened to use. It was a
+ * substring match on that header: a lab reached as `localhost` forwarded its
+ * own phone's tap back to itself with no login, and the tap failed. A
+ * forwarded tap is also sent once: InternalHttpClient's retry on a 5xx or a
+ * timeout could land the same tap twice on a slow node.
+ */
+// The route finds the manager by constructor name.
+class AndroidDeviceManager {
+    constructor() {
+        this.taps = [];
+        this.tap = (udid) => __awaiter(this, void 0, void 0, function* () {
+            this.taps.push(udid);
+        });
+    }
+}
+const OWN_HOST = 'http://192.168.0.104:4723';
+function buildApp() {
+    const app = (0, express_1.default)();
+    app.use(express_1.default.json());
+    const api = express_1.default.Router();
+    api.use((req, _res, next) => {
+        req.auth = {
+            kind: 'user-session',
+            userId: 'usr_me',
+            role: 'MEMBER',
+            scopes: (0, authMiddleware_1.scopesForRole)('MEMBER'),
+            rateLimit: 100,
+        };
+        next();
+    });
+    control_1.default.register(api);
+    app.use('/xenon/api', api);
+    return app;
+}
+describe('/control forwards only another server’s phone', () => {
+    let manager;
+    let post;
+    let restore;
+    let context;
+    let savedContext;
+    let device;
+    beforeEach(() => {
+        restore = (0, container_registration_1.saveRegistrations)(device_managers_1.XenonManager);
+        manager = new AndroidDeviceManager();
+        typedi_1.Container.set(device_managers_1.XenonManager, { deviceInstances: () => __awaiter(void 0, void 0, void 0, function* () { return [manager]; }) });
+        context = typedi_1.Container.get(PluginContext_1.PluginContext);
+        savedContext = Object.assign({}, context);
+        context.setContext(Object.assign(Object.assign({}, IPluginArgs_1.DefaultPluginArgs), { bindHostOrIp: '192.168.0.104' }), 4723, 'lab-1', '');
+        sinon_1.default
+            .stub(device_store_1.DeviceStoreFactory, 'getStore')
+            .returns({ findDevice: () => __awaiter(void 0, void 0, void 0, function* () { return (Object.assign({}, device)); }) });
+        post = sinon_1.default.stub(InternalHttpClient_1.InternalHttpClient, 'post').resolves({ data: {} });
+    });
+    afterEach(() => {
+        Object.assign(context, savedContext);
+        sinon_1.default.restore();
+        restore();
+    });
+    const tap = (udid, hostHeader) => (0, loopbackRequest_1.default)(buildApp())
+        .post(`/xenon/api/control/${udid}/tap`)
+        .set('Host', hostHeader)
+        .send({ x: 1, y: 2 });
+    it('taps this server’s own phone here, whatever name the caller used for the server', () => __awaiter(void 0, void 0, void 0, function* () {
+        device = { udid: 'own-1', host: OWN_HOST, nodeId: 'lab-1', platform: 'android' };
+        const res = yield tap('own-1', 'localhost:4723');
+        (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(200);
+        (0, chai_1.expect)(manager.taps).to.deep.equal(['own-1']);
+        (0, chai_1.expect)(post.called, 'never forwarded to itself').to.equal(false);
+    }));
+    it('forwards a node’s phone once, never retried', () => __awaiter(void 0, void 0, void 0, function* () {
+        device = {
+            udid: 'node-phone',
+            host: 'http://10.0.0.9:4725',
+            nodeId: 'node-9',
+            platform: 'android',
+        };
+        const res = yield tap('node-phone', '192.168.0.104:4723');
+        (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(200);
+        (0, chai_1.expect)(manager.taps).to.deep.equal([]);
+        (0, chai_1.expect)(post.calledOnce).to.equal(true);
+        (0, chai_1.expect)(post.firstCall.args[0]).to.equal('http://10.0.0.9:4725/xenon/api/control/node-phone/tap');
+        (0, chai_1.expect)(post.firstCall.args[2]).to.include({ retry: false });
+    }));
+});

package/lib/test/unit/control-lookup-failure.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 control_1 = __importDefault(require("../../src/app/routers/control"));
 const device_store_1 = require("../../src/data-service/device-store");
@@ -71,7 +71,7 @@ describe('stream/ticket and inspector/snapshot answer a failed device lookup', (
     it('POST stream/ticket gets 503, not a hung request', function () {
         return __awaiter(this, void 0, void 0, function* () {
             this.timeout(5000);
-            const res = yield (0, supertest_1.default)(buildApp())
+            const res = yield (0, loopbackRequest_1.default)(buildApp())
                 .post('/xenon/api/control/DEV-1/stream/ticket')
                 .timeout(2000);
             (0, chai_1.expect)(res.status).to.equal(503);
@@ -81,7 +81,7 @@ describe('stream/ticket and inspector/snapshot answer a failed device lookup', (
     it('GET inspector/snapshot gets 503, not a hung request', function () {
         return __awaiter(this, void 0, void 0, function* () {
             this.timeout(5000);
-            const res = yield (0, supertest_1.default)(buildApp())
+            const res = yield (0, loopbackRequest_1.default)(buildApp())
                 .get('/xenon/api/control/DEV-1/inspector/snapshot')
                 .timeout(2000);
             (0, chai_1.expect)(res.status).to.equal(503);

package/lib/test/unit/create-error-message.spec.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const chai_1 = require("chai");
+const base_driver_1 = require("@appium/base-driver");
+const SessionLifecycleService_1 = require("../../src/services/SessionLifecycleService");
+/**
+ * Appium's createSession answers a failure as `{ error: <Error> }`. The old
+ * message JSON.stringify'd that Error, which is `{}`, so a create Appium
+ * refused (no driver for the automationName, bad capabilities) reached the
+ * client as "Failed to create session on node <host>. Error: {}" with a 500,
+ * instead of Appium's own reason and status.
+ */
+describe('SessionLifecycleService.throwProperError', () => {
+    const throwProperError = (session) => SessionLifecycleService_1.SessionLifecycleService.prototype.throwProperError.call({}, session, 'http://node:4723');
+    function thrown(session) {
+        try {
+            throwProperError(session);
+        }
+        catch (error) {
+            return error;
+        }
+        throw new Error('expected throwProperError to throw');
+    }
+    it("rethrows the Error in Appium's `{ error }` answer, keeping its type and reason", () => {
+        const cause = new base_driver_1.errors.SessionNotCreatedError("Could not find a driver for automationName 'NoSuchDriver'");
+        const error = thrown({ error: cause });
+        (0, chai_1.expect)(error).to.equal(cause);
+        (0, chai_1.expect)(error.message).to.include("automationName 'NoSuchDriver'");
+    });
+    it('keeps a string reason, naming the node', () => {
+        const error = thrown({ error: 'no device' });
+        (0, chai_1.expect)(error.message).to.equal('Failed to create session on node http://node:4723. Error: no device');
+    });
+    it('keeps a plain object reason as JSON', () => {
+        const error = thrown({ error: { code: 'X' } });
+        (0, chai_1.expect)(error.message).to.include('{"code":"X"}');
+    });
+    it('rethrows an Error it is given directly', () => {
+        const cause = new Error('boom');
+        (0, chai_1.expect)(thrown(cause)).to.equal(cause);
+    });
+});

package/lib/test/unit/create-handoff.spec.js

@@ -0,0 +1,86 @@
+"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 sinon_1 = __importDefault(require("sinon"));
+const createHandoff_1 = require("../../src/gateway/createHandoff");
+/**
+ * The allocation the session gateway made for one `POST /session`, on its way
+ * through Appium's route to the plugin's createSession. Taken once by the
+ * plugin, or given back once if the plugin never takes it.
+ */
+describe('CreateHandoff', () => {
+    afterEach(() => sinon_1.default.restore());
+    it('hands its allocation over exactly once', () => {
+        const release = sinon_1.default.spy();
+        const handoff = new createHandoff_1.CreateHandoff({ udid: 'u1' }, release);
+        (0, chai_1.expect)(handoff.take()).to.deep.equal({ udid: 'u1' });
+        (0, chai_1.expect)(() => handoff.take()).to.throw(/already/);
+        handoff.abandon();
+        (0, chai_1.expect)(release.called, 'a taken allocation is the taker’s to release').to.equal(false);
+    });
+    it('gives an allocation nobody took back once, and cannot be taken after', () => {
+        const release = sinon_1.default.spy();
+        const handoff = new createHandoff_1.CreateHandoff({ udid: 'u1' }, release);
+        handoff.abandon();
+        handoff.abandon();
+        (0, chai_1.expect)(release.callCount).to.equal(1);
+        (0, chai_1.expect)(release.firstCall.args[0]).to.deep.equal({ udid: 'u1' });
+        (0, chai_1.expect)(() => handoff.take()).to.throw(/closed/);
+    });
+    it('keeps no reference to the allocation once it is taken or released', () => {
+        const taken = new createHandoff_1.CreateHandoff({ udid: 'u1' }, () => undefined);
+        taken.take();
+        (0, chai_1.expect)(taken.allocation).to.equal(undefined);
+        const released = new createHandoff_1.CreateHandoff({ udid: 'u2' }, () => undefined);
+        released.abandon();
+        (0, chai_1.expect)(released.allocation).to.equal(undefined);
+    });
+    it('a release that throws is contained', () => {
+        const handoff = new createHandoff_1.CreateHandoff({ udid: 'u1' }, () => {
+            throw new Error('store down');
+        });
+        (0, chai_1.expect)(() => handoff.abandon()).to.not.throw();
+    });
+    describe('the request context', () => {
+        it('is none outside a request', () => {
+            (0, chai_1.expect)((0, createHandoff_1.currentCreateHandoff)()).to.equal(undefined);
+        });
+        it('follows the request through awaits, timers and callbacks', () => __awaiter(void 0, void 0, void 0, function* () {
+            const handoff = new createHandoff_1.CreateHandoff({ udid: 'u1' }, () => undefined);
+            const seen = yield (0, createHandoff_1.runWithCreateHandoff)(handoff, () => __awaiter(void 0, void 0, void 0, function* () {
+                yield Promise.resolve();
+                yield new Promise((resolve) => setTimeout(resolve, 5));
+                return new Promise((resolve) => setImmediate(() => resolve((0, createHandoff_1.currentCreateHandoff)())));
+            }));
+            (0, chai_1.expect)(seen).to.equal(handoff);
+        }));
+        it('keeps two requests apart', () => __awaiter(void 0, void 0, void 0, function* () {
+            const a = new createHandoff_1.CreateHandoff({ udid: 'a' }, () => undefined);
+            const b = new createHandoff_1.CreateHandoff({ udid: 'b' }, () => undefined);
+            const [seenA, seenB] = yield Promise.all([
+                (0, createHandoff_1.runWithCreateHandoff)(a, () => __awaiter(void 0, void 0, void 0, function* () {
+                    yield new Promise((resolve) => setTimeout(resolve, 10));
+                    return (0, createHandoff_1.currentCreateHandoff)();
+                })),
+                (0, createHandoff_1.runWithCreateHandoff)(b, () => __awaiter(void 0, void 0, void 0, function* () {
+                    yield new Promise((resolve) => setTimeout(resolve, 1));
+                    return (0, createHandoff_1.currentCreateHandoff)();
+                })),
+            ]);
+            (0, chai_1.expect)(seenA).to.equal(a);
+            (0, chai_1.expect)(seenB).to.equal(b);
+        }));
+    });
+});

package/lib/test/unit/dashboard-events-team-scope.spec.js

@@ -52,7 +52,7 @@ const fs_1 = __importDefault(require("fs"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 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 SocketServer_1 = require("../../src/services/SocketServer");
 const SocketEvents_1 = require("../../src/enums/SocketEvents");
@@ -370,6 +370,9 @@ describe('Dashboard events name their phone (team-scoped call sites)', () => {
             entries: [{ name: 'a.txt', source: { kind: 'buffer', data: Buffer.from('hi') } }],
             cleanup: () => __awaiter(void 0, void 0, void 0, function* () { }),
         });
+        // The route looks the session up first. No row: it assembles as before.
+        // Unstubbed, that read the developer's database, and hung without it.
+        sinon_1.default.stub(prisma_1.prisma.session, 'findUnique').resolves(null);
         const app = (0, express_1.default)();
         app.use((req, _res, next) => {
             req.auth = {
@@ -382,7 +385,7 @@ describe('Dashboard events name their phone (team-scoped call sites)', () => {
             next();
         });
         bug_report_1.default.register(app);
-        yield (0, supertest_1.default)(app)
+        yield (0, loopbackRequest_1.default)(app)
             .post('/sessions/s5/bug-report?mode=full')
             .buffer(true)
             .parse((r, cb) => {
@@ -419,7 +422,7 @@ describe('Dashboard events name their phone (team-scoped call sites)', () => {
         const router = express_1.default.Router();
         grid_1.default.register(router, {});
         app.use(router);
-        const res = yield (0, supertest_1.default)(app).put('/device/phone-a/team').send({ teamId: 'team-c' });
+        const res = yield (0, loopbackRequest_1.default)(app).put('/device/phone-a/team').send({ teamId: 'team-c' });
         (0, chai_1.expect)(res.status).to.equal(200);
         (0, chai_1.expect)(yield resolver.resolve('phone-a')).to.deep.equal({ known: true, teamId: 'team-c' });
         (0, chai_1.expect)(lookups).to.deep.equal(['phone-a']);

package/lib/test/unit/device-access-guard.spec.js

@@ -15,7 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const chai_1 = require("chai");
 const express_1 = __importDefault(require("express"));
-const supertest_1 = __importDefault(require("supertest"));
+const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const deviceAccessGuard_1 = require("../../src/middleware/deviceAccessGuard");
 const UDID = 'DEV-1';
 const ALICE = 'usr_alice';
@@ -66,19 +66,19 @@ function appWith(opts) {
 }
 describe('deviceAccessGuard', () => {
     it('lets the lock owner through', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: ALICE })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: ALICE })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(200);
         (0, chai_1.expect)(res.body.reached).to.equal(true);
     }));
     it('denies a foreign holder with 409 and names them', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(409);
         (0, chai_1.expect)(res.body.error).to.equal('device_held_by_another_user');
         (0, chai_1.expect)(res.body.message).to.contain('alice@example.com');
         (0, chai_1.expect)(res.body.holder).to.deep.equal({ userId: ALICE, name: 'alice@example.com' });
     }));
     it('never blocks a GET', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/screenshot`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/screenshot`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     // The clipboard is the one read that is credential-shaped: it routinely holds
@@ -88,26 +88,26 @@ describe('deviceAccessGuard', () => {
     // reading a stranger's clipboard, so it takes the ownership check despite
     // being a GET.
     it('blocks reading the clipboard of a device another user holds', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/clipboard`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/clipboard`);
         (0, chai_1.expect)(res.status).to.equal(409);
         (0, chai_1.expect)(res.body.error).to.equal('device_held_by_another_user');
         (0, chai_1.expect)(JSON.stringify(res.body)).to.not.contain('hunter2');
     }));
     it('lets the holder read their own clipboard', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: ALICE })).get(`/control/${UDID}/clipboard`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: ALICE })).get(`/control/${UDID}/clipboard`);
         (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(200);
         (0, chai_1.expect)(res.body.content).to.equal('hunter2');
     }));
     it('lets an admin read the clipboard', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, scopes: 'admin' })).get(`/control/${UDID}/clipboard`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, scopes: 'admin' })).get(`/control/${UDID}/clipboard`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('allows the clipboard read when the device is free', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, busy: false })).get(`/control/${UDID}/clipboard`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, busy: false })).get(`/control/${UDID}/clipboard`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('blocks the clipboard of a device running another user’s Appium session', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, sessionId: 'appium-1', sessionOwner: ALICE })).get(`/control/${UDID}/clipboard`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, sessionId: 'appium-1', sessionOwner: ALICE })).get(`/control/${UDID}/clipboard`);
         (0, chai_1.expect)(res.status).to.equal(409);
         (0, chai_1.expect)(res.body.error).to.equal('device_in_use_by_session');
     }));
@@ -118,28 +118,28 @@ describe('deviceAccessGuard', () => {
     // made that check decorative, since a reader refused at the socket could GET
     // the identical bytes here.
     it('blocks reading the logs of a device another user holds', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/logs`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/logs`);
         (0, chai_1.expect)(res.status).to.equal(409);
         (0, chai_1.expect)(res.body.error).to.equal('device_held_by_another_user');
         (0, chai_1.expect)(JSON.stringify(res.body)).to.not.contain('SECRETLOGLINE');
     }));
     it('blocks the logs of a device running another user’s Appium session', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, sessionId: 'appium-1', sessionOwner: ALICE })).get(`/control/${UDID}/logs`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, sessionId: 'appium-1', sessionOwner: ALICE })).get(`/control/${UDID}/logs`);
         (0, chai_1.expect)(res.status).to.equal(409);
         (0, chai_1.expect)(res.body.error).to.equal('device_in_use_by_session');
         (0, chai_1.expect)(JSON.stringify(res.body)).to.not.contain('SECRETLOGLINE');
     }));
     it('lets the holder read their own logs', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: ALICE })).get(`/control/${UDID}/logs`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: ALICE })).get(`/control/${UDID}/logs`);
         (0, chai_1.expect)(res.status, JSON.stringify(res.body)).to.equal(200);
         (0, chai_1.expect)(res.body.logs[0]).to.contain('SECRETLOGLINE');
     }));
     it('lets an admin read the logs', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, scopes: 'admin' })).get(`/control/${UDID}/logs`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, scopes: 'admin' })).get(`/control/${UDID}/logs`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('allows the logs read when the device is free', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, busy: false })).get(`/control/${UDID}/logs`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, busy: false })).get(`/control/${UDID}/logs`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     // Deliberately NOT extended to the other reads: screenshot and the MJPEG
@@ -147,39 +147,39 @@ describe('deviceAccessGuard', () => {
     // decision for this guard was mutations-only. Clipboard and logs are the
     // documented exceptions, so this pins the boundary.
     it('does not extend the ownership check to other reads', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/screenshot`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB })).get(`/control/${UDID}/screenshot`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('skips stream/start, stream/stop, stream/leave and stream/ticket', () => __awaiter(void 0, void 0, void 0, function* () {
         const app = appWith({ actorUserId: BOB });
         for (const p of ['stream/start', 'stream/stop', 'stream/leave', 'stream/ticket']) {
-            const res = yield (0, supertest_1.default)(app).post(`/control/${UDID}/${p}`);
+            const res = yield (0, loopbackRequest_1.default)(app).post(`/control/${UDID}/${p}`);
             (0, chai_1.expect)(res.status, p).to.equal(200);
         }
     }));
     it('lets an admin-scoped key through', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, scopes: 'admin' })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, scopes: 'admin' })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('lets a SUPER_ADMIN through', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, role: 'SUPER_ADMIN' })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, role: 'SUPER_ADMIN' })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('does not treat a scope merely containing "admin" as admin', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, scopes: 'nonadmin,devices' })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, scopes: 'nonadmin,devices' })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(409);
     }));
     it('401s when there is no actor', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({})).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({})).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(401);
     }));
     it('denies a foreign Appium session', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB, sessionId: 'appium-1', sessionOwner: ALICE })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB, sessionId: 'appium-1', sessionOwner: ALICE })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(409);
         (0, chai_1.expect)(res.body.error).to.equal('device_in_use_by_session');
     }));
     it('allows the owner of the running Appium session', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: ALICE, sessionId: 'appium-1', sessionOwner: ALICE })).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: ALICE, sessionId: 'appium-1', sessionOwner: ALICE })).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(200);
     }));
     it('falls through to the handler when the device is unknown', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -198,7 +198,7 @@ describe('deviceAccessGuard', () => {
         router.use((0, deviceAccessGuard_1.deviceAccessGuard)({ findDevice: () => __awaiter(void 0, void 0, void 0, function* () { return null; }) }));
         router.post('/:udid/tap', (_req, res) => res.status(404).send('Device not found'));
         app.use('/control', router);
-        const res = yield (0, supertest_1.default)(app).post(`/control/${UDID}/tap`);
+        const res = yield (0, loopbackRequest_1.default)(app).post(`/control/${UDID}/tap`);
         (0, chai_1.expect)(res.status).to.equal(404);
     }));
     it('responds instead of hanging on a malformed-percent udid', function () {
@@ -209,13 +209,13 @@ describe('deviceAccessGuard', () => {
             // this test's timeout well under the file default so a regression fails
             // fast instead of silently eating the full 60s.
             this.timeout(5000);
-            const res = yield (0, supertest_1.default)(appWith({ actorUserId: ALICE })).post('/control/100%/tap');
+            const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: ALICE })).post('/control/100%/tap');
             (0, chai_1.expect)(res.status).to.equal(400);
             (0, chai_1.expect)(res.body.success).to.equal(false);
         });
     });
     it('fails closed with 503 when the device lookup throws, never reaching the handler', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({
+        const res = yield (0, loopbackRequest_1.default)(appWith({
             actorUserId: ALICE,
             findDeviceImpl: () => __awaiter(void 0, void 0, void 0, function* () {
                 throw new Error('store hiccup');
@@ -230,7 +230,7 @@ describe('deviceAccessGuard', () => {
         (0, chai_1.expect)(res.body.reached).to.equal(undefined);
     }));
     it('fails closed with 503 when resolveSessionOwner throws, never reaching the handler', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({
+        const res = yield (0, loopbackRequest_1.default)(appWith({
             actorUserId: BOB,
             sessionId: 'appium-1',
             resolveSessionOwnerImpl: () => __awaiter(void 0, void 0, void 0, function* () {
@@ -242,7 +242,7 @@ describe('deviceAccessGuard', () => {
         (0, chai_1.expect)(res.body.reached).to.equal(undefined);
     }));
     it('still denies with 409 (no holder name) when describeHolder throws', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({
+        const res = yield (0, loopbackRequest_1.default)(appWith({
             actorUserId: BOB,
             describeHolderImpl: () => __awaiter(void 0, void 0, void 0, function* () {
                 throw new Error('lookup hiccup');
@@ -256,7 +256,7 @@ describe('deviceAccessGuard', () => {
         (0, chai_1.expect)(res.body.holder.name).to.equal(undefined);
     }));
     it('skips a mixed-case allowlisted action like Stream/Start', () => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield (0, supertest_1.default)(appWith({ actorUserId: BOB })).post(`/control/${UDID}/Stream/Start`);
+        const res = yield (0, loopbackRequest_1.default)(appWith({ actorUserId: BOB })).post(`/control/${UDID}/Stream/Start`);
         (0, chai_1.expect)(res.status).to.equal(200);
         (0, chai_1.expect)(res.body.reached).to.equal(true);
     }));

package/lib/test/unit/device-service.spec.js

@@ -25,7 +25,10 @@ const db_1 = require("../../src/data-service/db");
 const chai_1 = require("chai");
 const semver_1 = __importDefault(require("semver"));
 const test_container_1 = require("../helpers/test-container");
+const loki_stores_1 = require("../helpers/loki-stores");
 describe('Get device', () => {
+    // The in-memory store, also when this file runs on its own.
+    (0, loki_stores_1.useLokiStores)();
     before('Set devices in memory', () => __awaiter(void 0, void 0, void 0, function* () {
         var _a, e_1, _b, _c;
         yield (0, test_container_1.resetTestContainer)();
@@ -146,6 +149,7 @@ describe('Get device', () => {
             finally { if (e_1) throw e_1.error; }
         }
     }));
+    after(() => (0, test_container_1.resetTestContainer)());
     it('Get android device based on filter with minSDK', () => __awaiter(void 0, void 0, void 0, function* () {
         const filterOptions = {
             platform: 'android',

package/lib/test/unit/device-store-clear-at-boot.spec.js

@@ -0,0 +1,48 @@
+"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 device_store_1 = require("../../src/data-service/device-store");
+/**
+ * clearStorage(onlyHosts) on the in-memory (Loki) store, the one the unit
+ * suite runs: a hub starting up forgets its own phones and keeps its nodes'.
+ * The Prisma store's side is in session-recovery-routing.spec.ts.
+ */
+describe('LokiDeviceStore.clearStorage(onlyHosts)', () => {
+    const HUB = 'http://clear-at-boot-hub:4724';
+    const NODE = 'http://clear-at-boot-hub:4725';
+    let savedStore;
+    let store;
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        savedStore = device_store_1.DeviceStoreFactory._deviceStore;
+        device_store_1.DeviceStoreFactory._deviceStore = undefined;
+        const env = process.env.NODE_ENV;
+        process.env.NODE_ENV = 'test';
+        store = device_store_1.DeviceStoreFactory.getStore();
+        process.env.NODE_ENV = env;
+        (0, chai_1.expect)(store.constructor.name).to.equal('LokiDeviceStore');
+        yield store.addDevices([
+            { udid: 'clear-hub-phone', host: HUB, platform: 'android' },
+            { udid: 'clear-node-phone', host: NODE, platform: 'android' },
+        ]);
+    }));
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        yield store.removeDevices({ udid: 'clear-hub-phone' });
+        yield store.removeDevices({ udid: 'clear-node-phone' });
+        device_store_1.DeviceStoreFactory._deviceStore = savedStore;
+    }));
+    it('deletes only the phones filed under the given hosts', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield store.clearStorage([HUB]);
+        (0, chai_1.expect)(yield store.findDevice({ udid: 'clear-hub-phone' })).to.equal(null);
+        (0, chai_1.expect)(yield store.findDevice({ udid: 'clear-node-phone' })).to.include({ host: NODE });
+    }));
+});