@xenon-device-management/xenon 2.12.0 → 2.13.0

package/lib/test/unit/openapi-coverage.spec.js

@@ -0,0 +1,114 @@
+"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 swagger_parser_1 = __importDefault(require("@apidevtools/swagger-parser"));
+const index_1 = require("../../src/app/index");
+const swagger_1 = require("../../src/app/swagger");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+const package_json_1 = __importDefault(require("../../package.json"));
+const expressRoutes_1 = require("../helpers/expressRoutes");
+/**
+ * The API reference at /xenon/api-docs is the spec in src/app/openapi/*.yaml.
+ * It had drifted: 61 routes the server served were missing from it, 10 it
+ * described were gone, and the page showed only 46 of its 100 paths,
+ * because tsc dropped the JSDoc comments the spec was written in.
+ *
+ * These checks keep it whole: every route served under /xenon/api is
+ * documented and every documented route is served, the spec is valid
+ * OpenAPI 3, and each operation carries what a reader needs.
+ */
+const METHODS = ['get', 'post', 'put', 'patch', 'delete'];
+// Served but deliberately outside the API reference.
+const NOT_API = new Set([
+    'GET /xenon/*', // the dashboard's own pages (client-side routing)
+    'GET /xenon/api-docs.json', // this spec itself
+]);
+/** "GET /xenon/api/control/:udid/tap" -> "GET /xenon/api/control/{}/tap" */
+const shape = (route) => route.replace(/:[A-Za-z_][\w]*/g, '{}').replace(/\{[^}]+\}/g, '{}');
+function operations() {
+    var _a;
+    const out = [];
+    for (const [path, item] of Object.entries((_a = swagger_1.swaggerSpec.paths) !== null && _a !== void 0 ? _a : {})) {
+        for (const method of METHODS) {
+            const op = item[method];
+            if (op)
+                out.push({ key: `${method.toUpperCase()} /xenon${path}`, op });
+        }
+    }
+    return out;
+}
+describe('the API reference (OpenAPI)', () => {
+    // A hub's node-only routes (/api/node/sessions/...) exist only with `hub`.
+    const served = new Set([
+        // The plugin mounts this router at /xenon.
+        ...(0, expressRoutes_1.routesOf)((0, index_1.createRouter)(Object.assign(Object.assign({}, IPluginArgs_1.DefaultPluginArgs), { hub: 'http://hub.example:4723' })), '/xenon'),
+    ]
+        .filter((r) => r.includes(' /xenon/') && !NOT_API.has(r))
+        .map(shape));
+    const documented = new Set(operations().map(({ key }) => shape(key)));
+    it('documents every route the server serves', () => {
+        const missing = [...served].filter((r) => !documented.has(r)).sort();
+        (0, chai_1.expect)(missing, `served but not documented:\n  ${missing.join('\n  ')}`).to.deep.equal([]);
+    });
+    it('documents no route the server no longer serves', () => {
+        const stale = [...documented].filter((r) => !served.has(r)).sort();
+        (0, chai_1.expect)(stale, `documented but not served:\n  ${stale.join('\n  ')}`).to.deep.equal([]);
+    });
+    it('is valid OpenAPI 3', () => __awaiter(void 0, void 0, void 0, function* () {
+        yield swagger_parser_1.default.validate(JSON.parse(JSON.stringify(swagger_1.swaggerSpec)));
+    }));
+    it("carries the package's version", () => {
+        (0, chai_1.expect)(swagger_1.swaggerSpec.info.version).to.equal(package_json_1.default.version);
+    });
+    it('gives every operation a summary, a description, a known tag and a unique id', () => {
+        var _a, _b, _c, _d;
+        const tags = new Set(((_a = swagger_1.swaggerSpec.tags) !== null && _a !== void 0 ? _a : []).map((t) => t.name));
+        const ids = new Map();
+        const problems = [];
+        for (const { key, op } of operations()) {
+            if (!op.summary)
+                problems.push(`${key}: no summary`);
+            if (!op.description)
+                problems.push(`${key}: no description`);
+            if (!((_b = op.tags) === null || _b === void 0 ? void 0 : _b.length))
+                problems.push(`${key}: no tag`);
+            for (const t of (_c = op.tags) !== null && _c !== void 0 ? _c : [])
+                if (!tags.has(t))
+                    problems.push(`${key}: unknown tag ${t}`);
+            if (!op.operationId)
+                problems.push(`${key}: no operationId`);
+            else if (ids.has(op.operationId))
+                problems.push(`${key}: operationId ${op.operationId} also on ${ids.get(op.operationId)}`);
+            else
+                ids.set(op.operationId, key);
+            const codes = Object.keys((_d = op.responses) !== null && _d !== void 0 ? _d : {});
+            if (!codes.some((c) => /^[23]\d\d$/.test(c) || c === '101'))
+                problems.push(`${key}: no success response`);
+            const isPublic = Array.isArray(op.security) && op.security.length === 0;
+            if (!isPublic && !codes.includes('401'))
+                problems.push(`${key}: authenticated but no 401`);
+        }
+        (0, chai_1.expect)(problems, problems.join('\n')).to.deep.equal([]);
+    });
+    it('uses every tag it declares', () => {
+        var _a;
+        const used = new Set(operations().flatMap(({ op }) => { var _a; return (_a = op.tags) !== null && _a !== void 0 ? _a : []; }));
+        const unused = ((_a = swagger_1.swaggerSpec.tags) !== null && _a !== void 0 ? _a : [])
+            .map((t) => t.name)
+            .filter((t) => !used.has(t));
+        (0, chai_1.expect)(unused).to.deep.equal([]);
+    });
+});

package/lib/test/unit/profile-router.test.js

@@ -67,6 +67,48 @@ describe('profile router', () => {
         (0, chai_1.expect)(r.status).to.equal(400);
         (0, chai_1.expect)(r.body.error).to.match(/cannot widen/);
     }));
+    it("POST /profile/tokens can't widen past the credential creating it", () => __awaiter(void 0, void 0, void 0, function* () {
+        const create = sinon_1.default
+            .stub(typedi_1.Container.get(ApiKeyService_1.ApiKeyService), 'create')
+            .resolves({ id: 'k3', raw: 'x' });
+        // An admin's read-only key: the role would allow devices, the key does not.
+        const app = appWithAuth({ userId: 'u1', role: 'ADMIN', scopes: 'read' });
+        const widened = yield (0, loopbackRequest_1.default)(app)
+            .post('/profile/tokens')
+            .send({ name: 'CI', scopes: ['devices', 'read'] });
+        (0, chai_1.expect)(widened.status).to.equal(400);
+        // The role's default (devices, sessions, read) is wider than the key too.
+        (0, chai_1.expect)((yield (0, loopbackRequest_1.default)(app).post('/profile/tokens').send({ name: 'CI' })).status).to.equal(400);
+        const narrow = yield (0, loopbackRequest_1.default)(app)
+            .post('/profile/tokens')
+            .send({ name: 'CI', scopes: ['read'] });
+        (0, chai_1.expect)(narrow.status).to.equal(201);
+        (0, chai_1.expect)(create.calledOnce).to.equal(true);
+        (0, chai_1.expect)(create.firstCall.args[0].scopes).to.deep.equal(['read']);
+    }));
+    it('POST /profile/tokens lets a super admin ask for a narrower token', () => __awaiter(void 0, void 0, void 0, function* () {
+        const create = sinon_1.default
+            .stub(typedi_1.Container.get(ApiKeyService_1.ApiKeyService), 'create')
+            .resolves({ id: 'k4', raw: 'x' });
+        const app = appWithAuth({
+            userId: 'u1',
+            role: 'SUPER_ADMIN',
+            scopes: 'admin,devices,sessions,read',
+        });
+        const r = yield (0, loopbackRequest_1.default)(app)
+            .post('/profile/tokens')
+            .send({ name: 'CI', scopes: ['devices'] });
+        (0, chai_1.expect)(r.status).to.equal(201);
+        (0, chai_1.expect)(create.firstCall.args[0].scopes).to.deep.equal(['devices']);
+    }));
+    it('POST /profile/tokens refuses a scope that does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+        const app = appWithAuth({ userId: 'u1', role: 'SUPER_ADMIN', scopes: 'admin' });
+        const r = yield (0, loopbackRequest_1.default)(app)
+            .post('/profile/tokens')
+            .send({ name: 'CI', scopes: ['root'] });
+        (0, chai_1.expect)(r.status).to.equal(400);
+        (0, chai_1.expect)(r.body.error).to.equal('scopes must be some of read, sessions, devices, admin');
+    }));
     it('POST /profile/tokens accepts a future expiresAt and forwards it to the service', () => __awaiter(void 0, void 0, void 0, function* () {
         var _a;
         const create = sinon_1.default.stub(typedi_1.Container.get(ApiKeyService_1.ApiKeyService), 'create')

package/lib/test/unit/rateLimitMiddleware.test.js

@@ -36,4 +36,53 @@ describe('rateLimitMiddleware', () => {
         mw(req, res, next);
         (0, chai_1.expect)(res.status.calledWith(429)).to.be.true;
     });
+    describe('signed-in users and bearer tokens', () => {
+        // Through 2.12 only API keys were limited: a cookie session or a bearer
+        // token, which carry no key, could send without limit.
+        const userReq = (kind, userId, method = 'POST', path = '/control/u1/tap') => ({ auth: { kind, userId, rateLimit: 3 }, method, path });
+        for (const kind of ['user-session', 'bearer']) {
+            it(`limits a ${kind} caller's changes to its budget`, () => {
+                const next = sinon_1.default.stub();
+                const mw = (0, rateLimitMiddleware_1.rateLimitMiddleware)();
+                const res = mockRes();
+                for (let i = 0; i < 4; i++)
+                    mw(userReq(kind, `u-${kind}`), res, next);
+                (0, chai_1.expect)(next.callCount).to.equal(3);
+                (0, chai_1.expect)(res.status.calledWith(429)).to.equal(true);
+            });
+        }
+        it("shares one budget across a user's sessions and tokens", () => {
+            const next = sinon_1.default.stub();
+            const mw = (0, rateLimitMiddleware_1.rateLimitMiddleware)();
+            const res = mockRes();
+            mw(userReq('user-session', 'dana'), res, next);
+            mw(userReq('bearer', 'dana'), res, next);
+            mw(userReq('user-session', 'dana'), res, next);
+            mw(userReq('bearer', 'dana'), res, next);
+            (0, chai_1.expect)(next.callCount).to.equal(3);
+        });
+        it('keeps users apart', () => {
+            const next = sinon_1.default.stub();
+            const mw = (0, rateLimitMiddleware_1.rateLimitMiddleware)();
+            for (let i = 0; i < 3; i++)
+                mw(userReq('user-session', 'dana'), mockRes(), next);
+            mw(userReq('user-session', 'lee'), mockRes(), next);
+            (0, chai_1.expect)(next.callCount).to.equal(4);
+        });
+        it('gives their reads ten times the budget', () => {
+            const next = sinon_1.default.stub();
+            const mw = (0, rateLimitMiddleware_1.rateLimitMiddleware)();
+            const res = mockRes();
+            for (let i = 0; i < 31; i++)
+                mw(userReq('user-session', 'reader', 'GET', '/devices'), res, next);
+            (0, chai_1.expect)(next.callCount).to.equal(30);
+        });
+        it('leaves single-use tickets unlimited', () => {
+            const next = sinon_1.default.stub();
+            const mw = (0, rateLimitMiddleware_1.rateLimitMiddleware)();
+            for (let i = 0; i < 5; i++)
+                mw(userReq('stream-ticket', 'dana', 'GET', '/control/u1/stream'), mockRes(), next);
+            (0, chai_1.expect)(next.callCount).to.equal(5);
+        });
+    });
 });

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

@@ -493,6 +493,86 @@ describe('RecordingOrchestrator.stop', () => {
         (0, chai_1.expect)(store.finalize.firstCall.args[1].status).to.equal('FAILED');
         (0, chai_1.expect)(leaveDeviceFn.calledOnceWith('U1')).to.equal(true);
     }));
+    // A second stop, or a stop after one phone's source ended, finalized every
+    // row again: it overwrote ended_at, the duration and fail_reason
+    // (`source_ended` was lost), and let go of the phone a second time.
+    it('leaves phones whose recording already ended as they are', () => __awaiter(void 0, void 0, void 0, function* () {
+        const finished = {
+            id: 'r1',
+            device_udid: 'U1',
+            device_host: '127.0.0.1',
+            file_path: '/nonexistent/r1.mp4',
+            status: 'STOPPED',
+            duration_ms: 26000,
+            size_bytes: 4200000,
+            fail_reason: 'source_ended',
+            started_at: new Date(Date.now() - 60000),
+        };
+        const store = {
+            listGroup: sinon_1.default.stub().resolves([
+                finished,
+                {
+                    id: 'r2',
+                    device_udid: 'U2',
+                    device_host: '127.0.0.1',
+                    file_path: '/nonexistent/r2.mp4',
+                    status: 'RECORDING',
+                    started_at: new Date(Date.now() - 60000),
+                },
+                {
+                    id: 'r3',
+                    device_udid: 'U3',
+                    device_host: '127.0.0.1',
+                    file_path: '/nonexistent/r3.mp4',
+                    status: 'FAILED',
+                    fail_reason: 'ffmpeg_stop_failed',
+                    started_at: new Date(Date.now() - 60000),
+                },
+            ]),
+            finalize: sinon_1.default.stub().resolves({}),
+        };
+        const videoPipeline = {
+            startRecording: sinon_1.default.stub(),
+            stopRecording: sinon_1.default.stub().resolves('/tmp/x.mp4'),
+            stopComposite: sinon_1.default.stub().resolves(null),
+        };
+        const { orch, leaveDeviceFn } = makeOrch({ store, videoPipeline });
+        const result = yield orch.stop('grp-1');
+        (0, chai_1.expect)(store.finalize.getCalls().map((c) => c.args[0])).to.deep.equal(['r2']);
+        (0, chai_1.expect)(videoPipeline.stopRecording.getCalls().map((c) => c.args[0])).to.deep.equal(['r2']);
+        (0, chai_1.expect)(leaveDeviceFn.getCalls().map((c) => c.args[0])).to.deep.equal(['U2']);
+        // The answer still names every phone, the finished ones as they were.
+        (0, chai_1.expect)(result.recordings.map((r) => [r.id, r.status])).to.deep.equal([
+            ['r1', 'STOPPED'],
+            ['r2', 'FAILED'], // nothing on disk in this test, so it can't be STOPPED
+            ['r3', 'FAILED'],
+        ]);
+        (0, chai_1.expect)(result.recordings[0]).to.include({ durationMs: 26000, sizeBytes: 4200000 });
+    }));
+    it('leaves a recording another path is finalizing right now to that path', () => __awaiter(void 0, void 0, void 0, function* () {
+        const store = {
+            listGroup: sinon_1.default.stub().resolves([
+                {
+                    id: 'r1',
+                    device_udid: 'U1',
+                    device_host: '127.0.0.1',
+                    file_path: '/nonexistent/r1.mp4',
+                    status: 'RECORDING',
+                    started_at: new Date(Date.now() - 1000),
+                },
+            ]),
+            finalize: sinon_1.default.stub().resolves({}),
+        };
+        const videoPipeline = {
+            startRecording: sinon_1.default.stub(),
+            stopRecording: sinon_1.default.stub().resolves('/tmp/x.mp4'),
+            stopComposite: sinon_1.default.stub().resolves(null),
+        };
+        const { orch } = makeOrch({ store, videoPipeline });
+        orch.finalizing.add('r1'); // its source ended a moment ago
+        yield orch.stop('grp-1');
+        (0, chai_1.expect)(store.finalize.called).to.equal(false);
+    }));
 });
 describe('RecordingOrchestrator.recoverOnBoot', () => {
     // compositeOutputPath and per-device paths resolve through ArtifactStore.

package/lib/test/unit/recordings-library-routes.spec.js

@@ -57,6 +57,7 @@ const stream_1 = require("stream");
 const typedi_1 = require("typedi");
 const recordings_1 = __importStar(require("../../src/app/routers/recordings"));
 const recording_store_1 = require("../../src/services/recording/recording-store");
+const proof_bundle_1 = require("../../src/services/recording/proof-bundle");
 const annotation_render_1 = require("../../src/services/recording/annotation-render");
 const deviceService = __importStar(require("../../src/data-service/device-service"));
 const recordingFiles = __importStar(require("../../src/services/recording/recordingFiles"));
@@ -1017,4 +1018,40 @@ describe('recordings library routes', () => {
             }));
         });
     });
+    // composite.mp4 said `Accept-Ranges: bytes` and then sent the whole file,
+    // with 200, for every request: a player couldn't seek in a long composite.
+    describe('GET /recordings/:groupId/composite.mp4', () => {
+        let file;
+        beforeEach(() => {
+            rows = [rec({ id: 'a', group_id: 'g1' })];
+            file = path.join(fs.mkdtempSync(path.join(os.tmpdir(), 'xenon-composite-')), 'composite.mp4');
+            fs.writeFileSync(file, '0123456789');
+            const bundle = typedi_1.Container.get(proof_bundle_1.ProofBundleService);
+            sinon_1.default.stub(bundle, 'compositeAllowed').returns(true);
+            sinon_1.default.stub(bundle, 'resolveCompositeFile').resolves(file);
+        });
+        it('sends the whole video without a Range', () => __awaiter(void 0, void 0, void 0, function* () {
+            const res = yield (0, loopbackRequest_1.default)(buildApp(alice)).get('/xenon/api/recordings/g1/composite.mp4');
+            (0, chai_1.expect)(res.status).to.equal(200);
+            (0, chai_1.expect)(res.headers['content-type']).to.match(/^video\/mp4/);
+            (0, chai_1.expect)(res.headers['accept-ranges']).to.equal('bytes');
+            (0, chai_1.expect)(String(res.body)).to.equal('0123456789');
+        }));
+        it('answers a Range with 206 and only those bytes', () => __awaiter(void 0, void 0, void 0, function* () {
+            const res = yield (0, loopbackRequest_1.default)(buildApp(alice))
+                .get('/xenon/api/recordings/g1/composite.mp4')
+                .set('Range', 'bytes=2-5');
+            (0, chai_1.expect)(res.status).to.equal(206);
+            (0, chai_1.expect)(res.headers['content-range']).to.equal('bytes 2-5/10');
+            (0, chai_1.expect)(String(res.body)).to.equal('2345');
+        }));
+        it('answers a Range past the end with 416, as JSON', () => __awaiter(void 0, void 0, void 0, function* () {
+            const res = yield (0, loopbackRequest_1.default)(buildApp(alice))
+                .get('/xenon/api/recordings/g1/composite.mp4')
+                .set('Range', 'bytes=50-60');
+            (0, chai_1.expect)(res.status).to.equal(416);
+            (0, chai_1.expect)(res.body).to.deep.equal({ error: 'range_not_satisfiable' });
+            (0, chai_1.expect)(res.headers['content-range']).to.equal('bytes */10');
+        }));
+    });
 });

package/lib/test/unit/reservation-team-visibility.spec.js

@@ -52,6 +52,7 @@ const express_1 = __importDefault(require("express"));
 const loopbackRequest_1 = __importDefault(require("../helpers/loopbackRequest"));
 const reservation_1 = __importDefault(require("../../src/app/routers/reservation"));
 const deviceService = __importStar(require("../../src/data-service/device-service"));
+const device_store_1 = require("../../src/data-service/device-store");
 const prisma_1 = require("../../src/prisma");
 const authMiddleware_1 = require("../../src/middleware/authMiddleware");
 /**
@@ -116,9 +117,9 @@ describe('reservations respect the team boundary', () => {
     let reserveDevice;
     let releaseReservation;
     beforeEach(() => {
-        sinon_1.default
-            .stub(deviceService, 'getDevice')
-            .callsFake((f) => __awaiter(void 0, void 0, void 0, function* () { return (f.udid[0] in TEAM_OF ? device(f.udid[0]) : undefined); }));
+        sinon_1.default.stub(device_store_1.DeviceStoreFactory, 'getStore').returns({
+            findDevice: (f) => __awaiter(void 0, void 0, void 0, function* () { return f.udid in TEAM_OF && f.host === HOST ? device(f.udid) : null; }),
+        });
         sinon_1.default
             .stub(deviceService, 'getReservedDevices')
             .resolves([SHARED, PHONE_A, PHONE_B].map(device));

package/lib/test/unit/reset-link.test.js

@@ -33,7 +33,8 @@ function usersApp(auth) {
     const app = (0, express_1.default)();
     app.use(express_1.default.json());
     app.use((req, _res, next) => {
-        req.auth = auth;
+        // A dashboard admin's scopes: /users also needs the admin scope.
+        req.auth = Object.assign({ scopes: 'admin,devices,sessions,read' }, auth);
         next();
     });
     app.use('/users', (0, users_1.usersRouter)());

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

@@ -172,7 +172,7 @@ describe('stream/ticket carries the user identity, not the credential', () => {
     it("404s a udid that isn't a device, and mints nothing", () => __awaiter(void 0, void 0, void 0, function* () {
         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');
+        (0, chai_1.expect)(res.body).to.deep.equal({ error: 'not_found', message: 'Device not found' });
     }));
     it('401s an unauthenticated mint', () => __awaiter(void 0, void 0, void 0, function* () {
         const res = yield mint({});

package/lib/test/unit/users-router.test.js

@@ -25,7 +25,8 @@ function appWithAuth(auth) {
     const app = (0, express_1.default)();
     app.use(express_1.default.json());
     app.use((req, _res, next) => {
-        req.auth = auth;
+        // A dashboard admin's scopes, unless the test names its own.
+        req.auth = Object.assign({ scopes: 'admin,devices,sessions,read' }, auth);
         next();
     });
     app.use('/users', (0, users_1.usersRouter)());
@@ -33,6 +34,18 @@ function appWithAuth(auth) {
 }
 describe('/users router', () => {
     afterEach(() => sinon_1.default.restore());
+    it("refuses an admin's key that lacks the admin scope", () => __awaiter(void 0, void 0, void 0, function* () {
+        const list = sinon_1.default.stub(typedi_1.Container.get(UserService_1.UserService), 'listUsers').resolves([]);
+        const create = sinon_1.default.stub(typedi_1.Container.get(UserService_1.UserService), 'createUser');
+        const app = appWithAuth({ userId: 'admin', role: 'ADMIN', scopes: 'read' });
+        (0, chai_1.expect)((yield (0, loopbackRequest_1.default)(app).get('/users')).status).to.equal(403);
+        const r = yield (0, loopbackRequest_1.default)(app)
+            .post('/users')
+            .send({ email: 'new@x.local', name: 'New', role: 'MEMBER' });
+        (0, chai_1.expect)(r.status).to.equal(403);
+        (0, chai_1.expect)(list.called).to.equal(false);
+        (0, chai_1.expect)(create.called).to.equal(false);
+    }));
     it('GET /users returns the listUsers result, filtered by caller role', () => __awaiter(void 0, void 0, void 0, function* () {
         sinon_1.default.stub(typedi_1.Container.get(UserService_1.UserService), 'listUsers').resolves([{ id: 'u1' }]);
         const app = appWithAuth({ userId: 'admin', role: 'ADMIN' });

package/lib/test/unit/wda-client-failures.spec.js

@@ -0,0 +1,90 @@
+"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 WDAClient_1 = require("../../src/device-managers/ios/WDAClient");
+/**
+ * Device control on an iPhone answered 200 for a clipboard write, a lock or
+ * an unlock that WebDriverAgent refused: WDAClient caught the error and only
+ * logged it at debug level. A key the phone doesn't have was also "pressed"
+ * successfully. The failures now reach the caller.
+ */
+describe('WDAClient reports what WebDriverAgent refused', () => {
+    const PHONE = '00008110-00084CE80E51401E';
+    let send;
+    beforeEach(() => {
+        send = sinon_1.default.stub(WDAClient_1.WDAClient.prototype, 'sendWDACommand');
+    });
+    afterEach(() => sinon_1.default.restore());
+    // WDA answered and refused: axios puts its answer on `response`.
+    const refuse = (path) => send.withArgs(PHONE, 'post', path).rejects(Object.assign(new Error(`WDA request failed: ${path} 500`), {
+        response: { status: 500, data: { value: { error: 'unknown error' } } },
+    }));
+    for (const [name, path, call] of [
+        ['setClipboard', '/wda/setPasteboard', (c) => c.setClipboard(PHONE, 'hello')],
+        ['lock', '/wda/lock', (c) => c.lock(PHONE)],
+        ['unlock', '/wda/unlock', (c) => c.unlock(PHONE)],
+    ]) {
+        it(`${name} fails when WebDriverAgent refuses`, () => __awaiter(void 0, void 0, void 0, function* () {
+            refuse(path);
+            const err = yield call(new WDAClient_1.WDAClient()).then(() => null, (e) => e);
+            (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.include(path);
+        }));
+        it(`${name} succeeds when WebDriverAgent accepts`, () => __awaiter(void 0, void 0, void 0, function* () {
+            send.resolves({});
+            yield call(new WDAClient_1.WDAClient());
+        }));
+    }
+    it('pressKey refuses a key the iPhone does not have', () => __awaiter(void 0, void 0, void 0, function* () {
+        refuse('/wda/pressButton');
+        const err = yield new WDAClient_1.WDAClient().pressKey(PHONE, 'F13').then(() => null, (e) => e);
+        (0, chai_1.expect)(err).to.be.instanceOf(WDAClient_1.UnsupportedKeyError);
+        (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.equal('The key "F13" isn\'t available on an iPhone.');
+    }));
+    it('pressKey reports WebDriverAgent being unreachable, not an unsupported key', () => __awaiter(void 0, void 0, void 0, function* () {
+        send
+            .withArgs(PHONE, 'post', '/wda/pressButton')
+            .rejects(Object.assign(new Error('connect ECONNREFUSED 127.0.0.1:8100'), { code: 'ECONNREFUSED' }));
+        const err = yield new WDAClient_1.WDAClient().pressKey(PHONE, 'f13').then(() => null, (e) => e);
+        (0, chai_1.expect)(err).not.to.be.instanceOf(WDAClient_1.UnsupportedKeyError);
+        (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.include('ECONNREFUSED');
+    }));
+    it('pressKey fails when a hardware button and its fallback both fail', () => __awaiter(void 0, void 0, void 0, function* () {
+        refuse('/wda/pressButton');
+        refuse('/wda/homescreen');
+        const err = yield new WDAClient_1.WDAClient().pressKey(PHONE, 'home').then(() => null, (e) => e);
+        (0, chai_1.expect)(err).to.be.an('error');
+        (0, chai_1.expect)(err).not.to.be.instanceOf(WDAClient_1.UnsupportedKeyError);
+    }));
+    it('pressKey still falls back to the home screen on an old WebDriverAgent', () => __awaiter(void 0, void 0, void 0, function* () {
+        refuse('/wda/pressButton');
+        send.withArgs(PHONE, 'post', '/wda/homescreen').resolves({});
+        yield new WDAClient_1.WDAClient().pressKey(PHONE, 'home');
+    }));
+    it('pressKey fails a keyboard key only when both ways of typing it fail', () => __awaiter(void 0, void 0, void 0, function* () {
+        refuse('/wda/keys');
+        send.withArgs(PHONE, 'post', '/wda/type').resolves({});
+        yield new WDAClient_1.WDAClient().pressKey(PHONE, 'enter');
+        send.withArgs(PHONE, 'post', '/wda/type').rejects(new Error('WDA request failed: /wda/type'));
+        const err = yield new WDAClient_1.WDAClient().pressKey(PHONE, 'enter').then(() => null, (e) => e);
+        (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.include('/wda/type');
+    }));
+    it('pressKey fails a volume button WebDriverAgent refuses', () => __awaiter(void 0, void 0, void 0, function* () {
+        refuse('/wda/pressButton');
+        const err = yield new WDAClient_1.WDAClient().pressKey(PHONE, 'volume_up').then(() => null, (e) => e);
+        (0, chai_1.expect)(err === null || err === void 0 ? void 0 : err.message).to.include('/wda/pressButton');
+    }));
+});