@xenon-device-management/xenon 2.2.0 → 2.3.0

package/lib/src/generated/client/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "prisma-client-2fecbe6024329bf05b69cdf448f1b687e32645450beda6a210a882d44a7ffb8d",
+  "name": "prisma-client-631e8540dfbb77c390eb0db189885974a87d3fa754d038cb48bcc6a9f3489314",
   "main": "index.js",
   "types": "index.d.ts",
   "browser": "index-browser.js",

package/lib/src/generated/client/schema.prisma

@@ -204,6 +204,10 @@ model Device {
   // On a hub, what the phone's node last reported: busy there. `busy` is the
   // claim OR this. Always false for a phone this server drives.
   nodeBusy                     Boolean? @default(false)
+  // On a hub, who holds the phone there: the preview hold (manual_<user>_<udid>)
+  // in the node's report of its session_id, else null. Shown, never judged:
+  // the node decides access. Always null for a phone this server drives.
+  nodeHold                     String?
 
   @@id([udid, host])
   @@index([owningSessionId])

package/lib/src/generated/client/wasm.js

@@ -285,7 +285,8 @@ exports.Prisma.DeviceScalarFieldEnum = {
   teamId: 'teamId',
   claimSessionId: 'claimSessionId',
   claimedAt: 'claimedAt',
-  nodeBusy: 'nodeBusy'
+  nodeBusy: 'nodeBusy',
+  nodeHold: 'nodeHold'
 };
 
 exports.Prisma.PendingSessionScalarFieldEnum = {

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

@@ -166,6 +166,18 @@ describe('Android Device Manager', () => {
         (0, chai_1.expect)(devices.length).to.be.equal(1);
         (0, chai_1.expect)(devices[0]).to.have.property('udid', 'emulator-7777');
     }));
+    // adb install answers when the phone has installed the app, and appium-adb
+    // cut every adbExec at 20 s (adbExecTimeout): an install that took longer
+    // was reported as failed though it had worked.
+    it('gives adb install as long as an install takes, not adbExec’s 20 s', () => __awaiter(void 0, void 0, void 0, function* () {
+        const manager = (0, test_container_1.createTestAndroidManager)({ platform: 'android' });
+        const adbExec = sandbox.stub().resolves('Success');
+        sandbox.stub(manager, 'getAdb').resolves({ adbInstance: { adbExec } });
+        yield manager.installApp('p1', '/tmp/app.apk');
+        (0, chai_1.expect)(adbExec.firstCall.args[0]).to.deep.equal(['-s', 'p1', 'install', '-r', '/tmp/app.apk']);
+        (0, chai_1.expect)(adbExec.firstCall.args[1]).to.deep.equal({ timeout: AndroidDeviceManager_1.ANDROID_INSTALL_TIMEOUT_MS });
+        (0, chai_1.expect)(AndroidDeviceManager_1.ANDROID_INSTALL_TIMEOUT_MS).to.be.at.least(5 * 60000);
+    }));
     // A phone adb reports as plugged (and every phone connected when the server
     // starts) went through onDeviceAdded with no androidDeviceType check: a
     // hub set to emulators only listed a real phone until its next sync pruned

package/lib/test/unit/hub-node-control-forward.spec.js

@@ -73,6 +73,7 @@ const container_registration_1 = require("../helpers/container-registration");
 const scratch_database_1 = require("../helpers/scratch-database");
 const loopbackServer_1 = require("../helpers/loopbackServer");
 const InspectorService_1 = require("../../src/services/InspectorService");
+const OmniVisionService_1 = require("../../src/services/omni-vision/OmniVisionService");
 const http_1 = __importDefault(require("http"));
 const AndroidStreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidStreamService"));
 const AndroidH264StreamService_1 = __importDefault(require("../../src/device-managers/android/AndroidH264StreamService"));
@@ -130,7 +131,11 @@ class AndroidDeviceManager {
             this.at('executeShell');
             return 'uid=2000(shell)';
         });
-        this.installApp = () => __awaiter(this, void 0, void 0, function* () { return this.at('installApp'); });
+        this.installedBytes = [];
+        this.installApp = (_udid, appPath) => __awaiter(this, void 0, void 0, function* () {
+            this.at('installApp');
+            this.installedBytes.push(fs_1.default.readFileSync(appPath, 'utf8'));
+        });
     }
     at(name) {
         this.calls.push(`${typedi_1.Container.get(PluginContext_1.PluginContext).nodeId}:${name}`);
@@ -155,7 +160,7 @@ describe('the hub’s device control on a node’s phone', () => {
         dirs = [fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'xenon-control-keys-'))];
         hubKeys = new JwtKeyService_1.JwtKeyService();
         yield hubKeys.init(dirs[0]);
-        restore = (0, container_registration_1.saveRegistrations)(JwtKeyService_1.JwtKeyService, hubSessionToken_1.HubSessionTokenIssuer, device_managers_1.XenonManager, SessionOwnerResolver_1.SessionOwnerResolver, LiveSessionOwners_1.LiveSessionOwners, InspectorService_1.InspectorService);
+        restore = (0, container_registration_1.saveRegistrations)(JwtKeyService_1.JwtKeyService, hubSessionToken_1.HubSessionTokenIssuer, device_managers_1.XenonManager, SessionOwnerResolver_1.SessionOwnerResolver, LiveSessionOwners_1.LiveSessionOwners, InspectorService_1.InspectorService, OmniVisionService_1.OmniVisionService);
         typedi_1.Container.set(JwtKeyService_1.JwtKeyService, hubKeys);
         typedi_1.Container.set(hubSessionToken_1.HubSessionTokenIssuer, new hubSessionToken_1.HubSessionTokenIssuer());
         typedi_1.Container.set(SessionOwnerResolver_1.SessionOwnerResolver, new SessionOwnerResolver_1.SessionOwnerResolver());
@@ -388,16 +393,10 @@ describe('the hub’s device control on a node’s phone', () => {
             (0, chai_1.expect)(res.body).to.include({ status: 'success', sessionId: 's-1' });
             (0, chai_1.expect)(nodeSaw('appium-session')).to.have.length(0);
         }));
-        // Not passed on yet: uploads need a relayed body, an app from the hub's
-        // library isn't on the node, and a path is a path on one machine.
-        // Omni's AI settings are the hub's. Anything added later is refused the
-        // same way until it is on the list.
+        // Not passed on: a path is a path on one machine. Anything added later is
+        // refused the same way until it is on a list.
         const REFUSED = [
             ['post', 'install', { appPath: '/tmp/app.apk' }],
-            ['post', 'install-repository-app', { appId: 'app-1' }],
-            ['post', 'upload-install'],
-            ['get', 'omni-scan'],
-            ['post', 'test-locator', { strategy: '-custom:ai-text', selector: 'OK' }],
             ['post', 'an-action-added-later'],
         ];
         describe('the live preview', () => {
@@ -493,6 +492,63 @@ describe('the hub’s device control on a node’s phone', () => {
                 yield preview('post', 'stream/stop').expect(200);
             }));
         });
+        describe('apps and Omni-Vision', () => {
+            it('installs an upload on the node, streamed through the hub', () => __awaiter(void 0, void 0, void 0, function* () {
+                const res = yield (0, loopbackRequest_1.default)(hubApp)
+                    .post('/xenon/api/control/phone-1/upload-install')
+                    .set('x-test-user', 'alice')
+                    .attach('app', Buffer.from('uploaded-apk'), 'build-42.apk');
+                (0, chai_1.expect)(res.status, res.text).to.equal(200);
+                (0, chai_1.expect)(res.body.success).to.equal(true);
+                (0, chai_1.expect)(manager.calls).to.deep.equal(['node-1:installApp']);
+                (0, chai_1.expect)(manager.installedBytes).to.deep.equal(['uploaded-apk']);
+            }));
+            it('installs an app from the hub’s library on the node, sending the file there', () => __awaiter(void 0, void 0, void 0, function* () {
+                const dir = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'xenon-library-'));
+                dirs.push(dir);
+                const file = path_1.default.join(dir, 'stored-app');
+                fs_1.default.writeFileSync(file, 'library-apk');
+                const app = yield scratch.db.app.create({
+                    data: {
+                        name: 'Library App',
+                        filename: 'library-app.apk',
+                        filepath: file,
+                        mimetype: 'application/vnd.android.package-archive',
+                        size: 11,
+                    },
+                });
+                const res = yield asAlice('post', 'install-repository-app', { appId: app.id });
+                (0, chai_1.expect)(res.status, res.text).to.equal(200);
+                (0, chai_1.expect)(manager.calls).to.deep.equal(['node-1:installApp']);
+                (0, chai_1.expect)(manager.installedBytes).to.deep.equal(['library-apk']);
+                const upload = nodeSaw('upload-install');
+                (0, chai_1.expect)(upload).to.have.length(1);
+                (0, chai_1.expect)(String(upload[0].headers['content-type'])).to.match(/^multipart\/form-data/);
+            }));
+            it('runs Omni-Vision here, on the node’s screenshot', () => __awaiter(void 0, void 0, void 0, function* () {
+                const seen = [];
+                typedi_1.Container.set(OmniVisionService_1.OmniVisionService, {
+                    analyzeScreen: (driver) => __awaiter(void 0, void 0, void 0, function* () {
+                        seen.push(`scan:${(yield driver.getScreenshot()).length}`);
+                        return { elements: [] };
+                    }),
+                    findByText: (driver, text) => __awaiter(void 0, void 0, void 0, function* () {
+                        seen.push(`text:${text}:${(yield driver.getScreenshot()).length}`);
+                        return [{ text }];
+                    }),
+                });
+                const scan = yield asAlice('get', 'omni-scan');
+                (0, chai_1.expect)(scan.status, scan.text).to.equal(200);
+                const locator = yield asAlice('post', 'test-locator', {
+                    strategy: '-custom:ai-text',
+                    selector: 'Sign in',
+                });
+                (0, chai_1.expect)(locator.status, locator.text).to.equal(200);
+                (0, chai_1.expect)(locator.body.value).to.deep.equal([{ text: 'Sign in' }]);
+                (0, chai_1.expect)(seen).to.deep.equal(['scan:200', 'text:Sign in:200']);
+                (0, chai_1.expect)(manager.calls).to.deep.equal(['node-1:getScreenshot', 'node-1:getScreenshot']);
+            }));
+        });
         it('refuses the rest, naming the node, and runs none of it on the hub', () => __awaiter(void 0, void 0, void 0, function* () {
             for (const [method, action, body] of REFUSED) {
                 const res = yield asAlice(method, action, body);

package/lib/test/unit/hub-node-race.spec.js

@@ -381,8 +381,13 @@ describe('The hub/node busy race', function () {
             yield scratch.db.device.create({ data: nodePhone('s9') });
             // The node answered a forwarded stream/start: it holds the phone now,
             // though its last report said free.
-            yield device_store_1.DeviceStoreFactory.getStore().markNodeBusy('s9', NODE);
-            (0, chai_1.expect)(yield row('s9')).to.include({ busy: true, nodeBusy: true, session_id: null });
+            yield device_store_1.DeviceStoreFactory.getStore().markNodeBusy('s9', NODE, 'manual_u1_s9');
+            (0, chai_1.expect)(yield row('s9')).to.include({
+                busy: true,
+                nodeBusy: true,
+                nodeHold: 'manual_u1_s9',
+                session_id: null,
+            });
             let session;
             try {
                 session = yield (0, device_utils_1.allocateDeviceForSession)(caps('s9'), 200, 50, pluginArgs);
@@ -393,7 +398,7 @@ describe('The hub/node busy race', function () {
             (0, chai_1.expect)(session, 'not handed to a session').to.be.an('error');
             // The preview ended, and the node says so.
             yield report(nodePhone('s9', { busy: false }));
-            (0, chai_1.expect)(yield row('s9')).to.include({ busy: false, nodeBusy: false });
+            (0, chai_1.expect)(yield row('s9')).to.include({ busy: false, nodeBusy: false, nodeHold: null });
         }));
         it('touches no other server’s row for the same udid', () => __awaiter(this, void 0, void 0, function* () {
             yield scratch.db.device.create({ data: nodePhone('s9') });
@@ -401,6 +406,27 @@ describe('The hub/node busy race', function () {
             (0, chai_1.expect)(yield row('s9')).to.include({ busy: false, nodeBusy: false });
         }));
     });
+    // The node's report is its own row, session_id included. A preview's hold
+    // there (manual_<user>_<udid>) is who holds the phone, which the hub shows
+    // (nodeHold); session_id itself stays the hub's.
+    describe('who holds a node’s phone', () => {
+        it('is the node’s preview hold, from its report, until the node lets the phone go', () => __awaiter(this, void 0, void 0, function* () {
+            yield scratch.db.device.create({ data: nodePhone('s9') });
+            yield report(nodePhone('s9', { busy: true, session_id: 'manual_u1_s9' }));
+            (0, chai_1.expect)(yield row('s9')).to.include({ nodeHold: 'manual_u1_s9', session_id: null });
+            yield report(nodePhone('s9', { busy: false, session_id: null }));
+            (0, chai_1.expect)(yield row('s9')).to.include({ nodeHold: null, busy: false });
+        }));
+        it('is not a session the node runs', () => __awaiter(this, void 0, void 0, function* () {
+            yield scratch.db.device.create({ data: nodePhone('s9') });
+            yield report(nodePhone('s9', { busy: true, session_id: 'appium-9' }));
+            (0, chai_1.expect)(yield row('s9')).to.include({ nodeHold: null, nodeBusy: true, session_id: null });
+        }));
+        it('is taken from the report of a phone the hub didn’t know yet', () => __awaiter(this, void 0, void 0, function* () {
+            yield report(nodePhone('s9', { busy: true, session_id: 'manual_u1_s9' }));
+            (0, chai_1.expect)(yield row('s9')).to.include({ nodeHold: 'manual_u1_s9', busy: true });
+        }));
+    });
     describe('a standalone server', () => {
         it('allocates, runs and frees its own phone as before', () => __awaiter(this, void 0, void 0, function* () {
             yield scratch.db.device.create({

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

@@ -38,14 +38,27 @@ describe('markNodeBusy (in-memory store)', () => {
         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);
+        yield device_store_1.DeviceStoreFactory.getStore().markNodeBusy('mark-node-busy-s9', NODE, 'manual_u1_s9');
         const rows = model.find({ udid: 'mark-node-busy-s9' });
-        const byHost = Object.fromEntries(rows.map((r) => [r.host, [r.busy, r.nodeBusy]]));
+        const byHost = Object.fromEntries(rows.map((r) => { var _a; return [r.host, [r.busy, r.nodeBusy, (_a = r.nodeHold) !== null && _a !== void 0 ? _a : null]]; }));
         (0, chai_1.expect)(byHost).to.deep.equal({
-            [NODE]: [true, true],
-            'http://10.0.0.8:4725': [false, false],
+            [NODE]: [true, true, 'manual_u1_s9'],
+            'http://10.0.0.8:4725': [false, false, null],
         });
     }));
+    it('takes the holder from a node’s report: a preview hold, not a session', () => __awaiter(void 0, void 0, void 0, function* () {
+        const model = yield db_1.XenonDatabase.DeviceModel;
+        model.insert(phone(NODE));
+        const store = device_store_1.DeviceStoreFactory.getStore();
+        const reported = (session_id, busy) => store.addDevices([Object.assign(Object.assign({}, phone(NODE)), { busy, session_id })], { nodeReport: true });
+        const hold = () => model.findOne({ udid: 'mark-node-busy-s9', host: NODE }).nodeHold;
+        yield reported('manual_u1_mark-node-busy-s9', true);
+        (0, chai_1.expect)(hold()).to.equal('manual_u1_mark-node-busy-s9');
+        yield reported('appium-9', true);
+        (0, chai_1.expect)(hold()).to.equal(null);
+        yield reported(null, false);
+        (0, chai_1.expect)(hold()).to.equal(null);
+    }));
     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-phone-control.spec.js

@@ -100,7 +100,7 @@ describe('nodePhoneControl', () => {
         yield (0, loopbackRequest_1.default)(app()).get('/xenon/api/control/p/stream/status?ticket=spent&t=1&r=2').expect(200);
         (0, chai_1.expect)(seen).to.deep.equal(['/xenon/api/control/p/stream/status?t=1&r=2']);
     }));
-    it('marks the phone busy for its node once the node has started a preview, and only then', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('marks the phone busy for its node, held by the caller, once the node has started a preview', () => __awaiter(void 0, void 0, void 0, function* () {
         let answer = 200;
         const node = (0, express_1.default)();
         node.use((_req, res) => res.status(answer).json({}));
@@ -109,10 +109,15 @@ describe('nodePhoneControl', () => {
         const marked = [];
         const a = (0, express_1.default)();
         a.use(express_1.default.json());
+        a.use((req, _res, next) => {
+            req.auth = { kind: 'user-session', userId: 'alice', role: 'MEMBER', scopes: 'devices' };
+            next();
+        });
         a.use('/xenon/api/control', (0, nodePhoneControl_1.nodePhoneControl)({
             findDevice: (udid) => findDevice(udid),
-            markNodeBusy: (udid, host) => __awaiter(void 0, void 0, void 0, function* () {
-                marked.push(`${udid}@${host}`);
+            controlToken: () => __awaiter(void 0, void 0, void 0, function* () { return null; }),
+            markNodeBusy: (udid, host, hold) => __awaiter(void 0, void 0, void 0, function* () {
+                marked.push(`${udid}@${host} ${hold}`);
             }),
         }));
         yield (0, loopbackRequest_1.default)(a).post('/xenon/api/control/p/stream/start').send({}).expect(200);
@@ -120,7 +125,96 @@ describe('nodePhoneControl', () => {
         yield (0, loopbackRequest_1.default)(a).post('/xenon/api/control/p/stream/start').send({}).expect(409);
         answer = 200;
         yield (0, loopbackRequest_1.default)(a).get('/xenon/api/control/p/stream/status').expect(200);
-        (0, chai_1.expect)(marked).to.deep.equal([`p@${origin}`]);
+        // The hold the node writes for the same user (formatManualLock).
+        (0, chai_1.expect)(marked).to.deep.equal([`p@${origin} manual_alice_p`]);
+    }));
+    describe('a node’s refusal because someone holds the phone', () => {
+        // The node knows the holder's id but not their name: its database has
+        // no rows for the hub's users. The hub has, and fills it in.
+        const refusal = (holder) => ({
+            success: false,
+            error: 'device_held_by_another_user',
+            message: 'Device is being controlled by another user. Ask them to release it, or use an admin key to force-release.',
+            holder,
+        });
+        const through = (body, names) => __awaiter(void 0, void 0, void 0, function* () {
+            const node = (0, express_1.default)();
+            node.use((_req, res) => res.status(409).json(body));
+            const origin = `http://127.0.0.1:${(yield loopback.serve(node)).address().port}`;
+            findDevice = () => __awaiter(void 0, void 0, void 0, function* () { return ({ udid: 'p', host: origin, nodeId: 'node-1' }); });
+            const a = (0, express_1.default)();
+            a.use(express_1.default.json());
+            a.use('/xenon/api/control', (0, nodePhoneControl_1.nodePhoneControl)({
+                findDevice: (udid) => findDevice(udid),
+                describeHolder: (id) => __awaiter(void 0, void 0, void 0, function* () { var _a; return (_a = names[id]) !== null && _a !== void 0 ? _a : null; }),
+            }));
+            return (0, loopbackRequest_1.default)(a).post('/xenon/api/control/p/tap').send({ x: 1, y: 2 });
+        });
+        it('names the holder the node could not', () => __awaiter(void 0, void 0, void 0, function* () {
+            const res = yield through(refusal({ userId: 'bob' }), { bob: 'bob@example.com' });
+            (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.include('bob@example.com');
+            (0, chai_1.expect)(res.body.holder).to.deep.equal({ userId: 'bob', name: 'bob@example.com' });
+        }));
+        it('passes it on unchanged when this server doesn’t know the holder either', () => __awaiter(void 0, void 0, void 0, function* () {
+            const body = refusal({ userId: 'someone-of-the-node' });
+            const res = yield through(body, {});
+            (0, chai_1.expect)(res.status).to.equal(409);
+            (0, chai_1.expect)(res.body).to.deep.equal(body);
+        }));
+        it('passes on any other 409 unchanged', () => __awaiter(void 0, void 0, void 0, function* () {
+            const body = {
+                success: false,
+                error: 'device_recording',
+                message: 'Stop the recording first.',
+            };
+            const res = yield through(body, { bob: 'bob@example.com' });
+            (0, chai_1.expect)(res.body).to.deep.equal(body);
+        }));
+    });
+    it('streams an upload to the node as it came, and waits as long as an install takes', () => __awaiter(void 0, void 0, void 0, function* () {
+        const node = (0, express_1.default)();
+        let got;
+        node.post('/xenon/api/control/p/upload-install', (req, res) => {
+            const chunks = [];
+            req.on('data', (c) => chunks.push(c));
+            req.on('end', () => {
+                got = { type: req.headers['content-type'], body: Buffer.concat(chunks).toString() };
+                // Past the ordinary limit: an install answers when it is done.
+                setTimeout(() => res.json({ success: true }), 400);
+            });
+        });
+        const origin = `http://127.0.0.1:${(yield loopback.serve(node)).address().port}`;
+        findDevice = () => __awaiter(void 0, void 0, void 0, function* () { return ({ udid: 'p', host: origin, nodeId: 'node-1' }); });
+        const a = (0, express_1.default)();
+        a.use(express_1.default.json());
+        a.use('/xenon/api/control', (0, nodePhoneControl_1.nodePhoneControl)({
+            findDevice: (udid) => findDevice(udid),
+            timeoutMs: 150,
+            installTimeoutMs: 5000,
+        }));
+        const res = yield (0, loopbackRequest_1.default)(a)
+            .post('/xenon/api/control/p/upload-install')
+            .attach('app', Buffer.from('apk-bytes'), 'build-42.apk');
+        (0, chai_1.expect)(res.status, res.text).to.equal(200);
+        (0, chai_1.expect)(got === null || got === void 0 ? void 0 : got.type).to.match(/^multipart\/form-data; boundary=/);
+        (0, chai_1.expect)(got === null || got === void 0 ? void 0 : got.body).to.include('filename="build-42.apk"');
+        (0, chai_1.expect)(got === null || got === void 0 ? void 0 : got.body).to.include('apk-bytes');
+    }));
+    it('leaves the library install and Omni to this server for a node’s phone, not a cloud one', () => __awaiter(void 0, void 0, void 0, function* () {
+        for (const [method, action] of [
+            ['post', 'install-repository-app'],
+            ['get', 'omni-scan'],
+            ['post', 'test-locator'],
+        ]) {
+            findDevice = () => __awaiter(void 0, void 0, void 0, function* () { return ({ udid: 'p', host: 'http://10.0.0.9:4725', nodeId: 'node-1' }); });
+            yield (0, loopbackRequest_1.default)(app())[method](`/xenon/api/control/p/${action}`).expect(299);
+            findDevice = () => __awaiter(void 0, void 0, void 0, function* () { return ({ udid: 'p', host: 'http://10.0.0.9:4725', cloud: '{"x":1}' }); });
+            const cloud = yield (0, loopbackRequest_1.default)(app())[method](`/xenon/api/control/p/${action}`);
+            (0, chai_1.expect)(cloud.status, action).to.equal(501);
+            (0, chai_1.expect)(cloud.body.error, action).to.equal('not_available_for_cloud_phone');
+        }
     }));
     it('refuses a host it must never call', () => __awaiter(void 0, void 0, void 0, function* () {
         findDevice = () => __awaiter(void 0, void 0, void 0, function* () { return ({ udid: 'p', host: 'http://169.254.169.254', nodeId: 'node-1' }); });

package/lib/test/unit/screenshot-route.spec.js

@@ -0,0 +1,104 @@
+"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 ApiKeyService_1 = require("../../src/services/ApiKeyService");
+const device_managers_1 = require("../../src/device-managers");
+const authMiddleware_1 = require("../../src/middleware/authMiddleware");
+const container_registration_1 = require("../helpers/container-registration");
+const loopbackServer_1 = require("../helpers/loopbackServer");
+const own_node_id_1 = require("../helpers/own-node-id");
+/**
+ * GET /control/:udid/screenshot. A capture that threw left the request
+ * unanswered: the handler had no catch, and Express 4 doesn't catch a
+ * rejected async handler. An iPhone with no live preview (no WebDriverAgent,
+ * no go-ios tunnel) did exactly that, and its Screenshot tab spun forever.
+ */
+const UDID = 'DEV-SHOT';
+// The route finds the manager by constructor name.
+class IOSDeviceManager {
+    constructor() {
+        this.getScreenshot = sinon_1.default.stub();
+    }
+}
+function buildApp() {
+    const app = (0, express_1.default)();
+    app.use(express_1.default.json());
+    const apiRouter = express_1.default.Router();
+    apiRouter.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(apiRouter);
+    app.use('/xenon/api', apiRouter);
+    return app;
+}
+describe('GET /control/:udid/screenshot', () => {
+    // The fake row is this server's own phone.
+    (0, own_node_id_1.useOwnNodeId)();
+    let manager;
+    let restoreContainer;
+    const loopback = (0, loopbackServer_1.loopbackServers)();
+    const app = () => __awaiter(void 0, void 0, void 0, function* () { return loopback.serve(buildApp()); });
+    beforeEach(() => {
+        restoreContainer = (0, container_registration_1.saveRegistrations)(ApiKeyService_1.ApiKeyService, device_managers_1.XenonManager);
+        manager = new IOSDeviceManager();
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
+            findDevice: () => __awaiter(void 0, void 0, void 0, function* () {
+                return ({
+                    udid: UDID,
+                    host: '127.0.0.1',
+                    nodeId: own_node_id_1.OWN_NODE_ID,
+                    platform: 'ios',
+                    busy: false,
+                    session_id: null,
+                });
+            }),
+        });
+        typedi_1.Container.set(ApiKeyService_1.ApiKeyService, new ApiKeyService_1.ApiKeyService());
+        typedi_1.Container.set(device_managers_1.XenonManager, { deviceInstances: () => __awaiter(void 0, void 0, void 0, function* () { return [manager]; }) });
+    });
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        sinon_1.default.restore();
+        restoreContainer();
+        yield loopback.closeAll();
+    }));
+    it('returns the screenshot', () => __awaiter(void 0, void 0, void 0, function* () {
+        manager.getScreenshot.resolves('A'.repeat(200));
+        const res = yield (0, loopbackRequest_1.default)(yield app()).get(`/xenon/api/control/${UDID}/screenshot`);
+        (0, chai_1.expect)(res.status).to.equal(200);
+        (0, chai_1.expect)(res.body.screenshot).to.have.length(200);
+    }));
+    it('answers a capture that failed with 502 and the reason, rather than never', () => __awaiter(void 0, void 0, void 0, function* () {
+        manager.getScreenshot.rejects(new Error('connect ECONNREFUSED 127.0.0.1:8100'));
+        const res = yield (0, loopbackRequest_1.default)(yield app())
+            .get(`/xenon/api/control/${UDID}/screenshot`)
+            .timeout(5000);
+        (0, chai_1.expect)(res.status).to.equal(502);
+        (0, chai_1.expect)(res.body.error).to.include('ECONNREFUSED');
+    }));
+});