@xenon-device-management/xenon 2.15.0 → 2.17.0

package/lib/test/unit/session-device-logs-ios.spec.js

@@ -0,0 +1,180 @@
+"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 supertest_1 = __importDefault(require("supertest"));
+const SessionDeviceLogs_1 = require("../../src/services/logcat/SessionDeviceLogs");
+const deviceLogBook_1 = require("../../src/services/logcat/deviceLogBook");
+const scratch_database_1 = require("../helpers/scratch-database");
+const selector_health_fixture_1 = require("../helpers/selector-health-fixture");
+// The driver's own log class (test/helpers/driver-log.ts): an iPhone's and a
+// simulator's `logs.syslog` extend it, so what Xenon reads is what the driver keeps.
+const driver_log_1 = require("../helpers/driver-log");
+// How the Device logs tab reads an iPhone line's level (web log-derive.ts).
+const DASHBOARD_SYSLOG = /<(Error|Fault|Warning)>/;
+class TestDeviceLogs extends SessionDeviceLogs_1.SessionDeviceLogs {
+    context() {
+        return { pluginArgs: { bindHostOrIp: '127.0.0.1' }, port: 4723, nodeId: 'this-server' };
+    }
+    flushIntervalMs() {
+        return 60000;
+    }
+}
+const IPHONE = {
+    udid: '00008110-000A',
+    platform: 'ios',
+    realDevice: true,
+    host: 'http://127.0.0.1:4723',
+    nodeId: 'this-server',
+};
+const SIMULATOR = Object.assign(Object.assign({}, IPHONE), { udid: 'SIM-1', realDevice: false });
+const syslog = (n, level = 'Notice') => `Oct  5 20:31:${String(n % 60).padStart(2, '0')} iPhone Shop[4127] <${level}>: line ${n}`;
+function deviceLogs(sessionId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield (0, supertest_1.default)((0, selector_health_fixture_1.selectorHealthApp)(selector_health_fixture_1.ADMIN)).get(`/session/${sessionId}/logs/device`);
+        (0, chai_1.expect)(res.status, res.text).to.equal(200);
+        return res.body;
+    });
+}
+describe("An iPhone or simulator session's Device logs", function () {
+    this.timeout(60000);
+    const scratch = (0, scratch_database_1.useScratchDatabase)();
+    let logs;
+    let sessionId;
+    let driverLog;
+    let count = 0;
+    beforeEach(() => __awaiter(this, void 0, void 0, function* () {
+        count += 1;
+        sessionId = `dl-ios-${count}`;
+        yield scratch.db.session.create({
+            data: {
+                id: sessionId,
+                device_udid: IPHONE.udid,
+                device_platform: 'ios',
+                device_version: '26.0',
+                desired_capabilities: '{}',
+                session_capabilities: '{}',
+                node_id: 'this-server',
+                has_live_video: false,
+            },
+        });
+        logs = new TestDeviceLogs();
+        driverLog = new driver_log_1.TestDriverLog();
+    }));
+    afterEach(() => __awaiter(this, void 0, void 0, function* () {
+        yield logs.stop(sessionId);
+    }));
+    it('keeps the lines from the create and from the run, each once, in order', () => __awaiter(this, void 0, void 0, function* () {
+        // Logged during the create, before Xenon could listen: in the driver's buffer.
+        for (let i = 0; i < 3; i++)
+            driverLog.line(syslog(i));
+        yield logs.start({ sessionId, device: IPHONE, since: Date.now() - 60000, driverLog });
+        for (let i = 3; i < 250; i++)
+            driverLog.line(syslog(i));
+        yield logs.stop(sessionId);
+        (0, chai_1.expect)(driverLog.listenerCount('output')).to.equal(0);
+        driverLog.line(syslog(999)); // after the session: not its line
+        const rows = yield deviceLogs(sessionId);
+        (0, chai_1.expect)(rows.map((r) => r.message)).to.deep.equal(Array.from({ length: 250 }, (_, i) => syslog(i)));
+    }));
+    it("leaves the driver's lines to the test that asks for them", () => __awaiter(this, void 0, void 0, function* () {
+        driverLog.line(syslog(1));
+        yield logs.start({ sessionId, device: IPHONE, since: Date.now() - 60000, driverLog });
+        driverLog.line(syslog(2));
+        yield logs.stop(sessionId);
+        const forTheTest = yield driverLog.getLogs();
+        (0, chai_1.expect)(forTheTest.map((e) => e.message)).to.deep.equal([
+            syslog(1),
+            syslog(2),
+        ]);
+    }));
+    it("keeps each line's text, so Errors only finds the phone's errors, at the time it arrived", () => __awaiter(this, void 0, void 0, function* () {
+        yield logs.start({ sessionId, device: IPHONE, since: Date.now() - 60000, driverLog });
+        const before = Date.now();
+        driverLog.line(syslog(1));
+        driverLog.line(syslog(2, 'Error'));
+        driverLog.line(syslog(3, 'Fault'));
+        const after = Date.now();
+        yield logs.stop(sessionId);
+        const rows = yield deviceLogs(sessionId);
+        (0, chai_1.expect)(rows.map((r) => { var _a, _b; return (_b = (_a = DASHBOARD_SYSLOG.exec(r.message)) === null || _a === void 0 ? void 0 : _a[1]) !== null && _b !== void 0 ? _b : null; })).to.deep.equal([
+            null,
+            'Error',
+            'Fault',
+        ]);
+        for (const r of rows) {
+            const t = new Date(r.timestamp).getTime();
+            (0, chai_1.expect)(t).to.be.within(before, after);
+        }
+    }));
+    it("records a simulator's compact lines, without `log stream`'s banner", () => __awaiter(this, void 0, void 0, function* () {
+        driverLog.line('Filtering the log data using "subsystem != \\"com.apple.CoreTelephony\\""');
+        driverLog.line('Timestamp               Ty Process[PID:TID]');
+        yield logs.start({ sessionId, device: SIMULATOR, since: Date.now() - 60000, driverLog });
+        driverLog.line('2026-10-05 20:31:40.123 F  Shop[4127:8812] Terminating app');
+        driverLog.line('\tThread 0 Crashed:');
+        yield logs.stop(sessionId);
+        (0, chai_1.expect)((yield deviceLogs(sessionId)).map((r) => r.message)).to.deep.equal([
+            '2026-10-05 20:31:40.123 F  Shop[4127:8812] Terminating app',
+            '\tThread 0 Crashed:',
+        ]);
+    }));
+    it("keeps the app's own lines, the errors inside it, the app manager's lines and faults, and says so first", () => __awaiter(this, void 0, void 0, function* () {
+        const line = (proc, text, level = 'Notice') => `Oct  5 23:48:33 Rabindras-iPhone ${proc} <${level}>: ${text}`;
+        // From the create, before Xenon listens: the app's first line comes
+        // before the phone announces its pid.
+        driverLog.line(line('Shop[4127]', 'first line'));
+        driverLog.line(line('runningboardd(RunningBoard)[34]', 'Acquiring [app<com.example.shop(UUID)>:4127]'));
+        yield logs.start({
+            sessionId,
+            device: IPHONE,
+            since: Date.now() - 60000,
+            driverLog,
+            appUnderTest: 'com.example.shop',
+        });
+        driverLog.line(line('duetexpertd[412]', 'chatter'));
+        driverLog.line(line('Shop(Networking)[4127]', 'request failed', 'Error'));
+        driverLog.line(line('wifid[61]', 'link lost', 'Fault'));
+        yield logs.stop(sessionId);
+        (0, chai_1.expect)((yield deviceLogs(sessionId)).map((r) => r.message)).to.deep.equal([
+            "Xenon: Kept here: what the app under test (com.example.shop) logs itself, every error inside it, what the phone says about its launch, state, crashes and end, and faults. The rest of the phone's log is left out.",
+            line('Shop[4127]', 'first line'),
+            line('runningboardd(RunningBoard)[34]', 'Acquiring [app<com.example.shop(UUID)>:4127]'),
+            line('Shop(Networking)[4127]', 'request failed', 'Error'),
+            line('wifid[61]', 'link lost', 'Fault'),
+        ]);
+    }));
+    it('records nothing for a session that skips log capture', () => __awaiter(this, void 0, void 0, function* () {
+        yield logs.start({ sessionId, device: IPHONE, since: Date.now(), driverLog: undefined });
+        (0, chai_1.expect)(logs.isRecording(sessionId)).to.equal(false);
+        (0, chai_1.expect)(yield deviceLogs(sessionId)).to.deep.equal([]);
+    }));
+    it(`holds to the same limit as Android, ${deviceLogBook_1.DEVICE_LOG_LINE_LIMIT} lines then errors`, () => __awaiter(this, void 0, void 0, function* () {
+        yield logs.start({ sessionId, device: IPHONE, since: Date.now() - 60000, driverLog });
+        for (let i = 0; i < deviceLogBook_1.DEVICE_LOG_LINE_LIMIT + 100; i++) {
+            driverLog.line(syslog(i, i >= deviceLogBook_1.DEVICE_LOG_LINE_LIMIT && i % 2 === 0 ? 'Error' : 'Notice'));
+        }
+        yield logs.stop(sessionId);
+        const rows = yield deviceLogs(sessionId);
+        (0, chai_1.expect)(rows).to.have.length(deviceLogBook_1.DEVICE_LOG_LINE_LIMIT + 1 + 50 + 1);
+        (0, chai_1.expect)(rows[deviceLogBook_1.DEVICE_LOG_LINE_LIMIT].message).to.match(/^Xenon: This session reached 10,000/);
+        (0, chai_1.expect)(rows[rows.length - 1].message).to.match(/^Xenon: 50 device log lines were left out/);
+    }));
+    it("doesn't record a node's iPhone, whose driver is the node's", () => {
+        (0, chai_1.expect)(logs.appliesTo(IPHONE)).to.equal(true);
+        (0, chai_1.expect)(logs.appliesTo(SIMULATOR)).to.equal(true);
+        (0, chai_1.expect)(logs.appliesTo(Object.assign(Object.assign({}, IPHONE), { nodeId: 'a-node' }))).to.equal(false);
+    });
+});

package/lib/test/unit/session-device-logs-lifecycle.spec.js

@@ -0,0 +1,137 @@
+"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 typedi_1 = require("typedi");
+const plugin_1 = require("../../src/plugin");
+const NodeDevices_1 = __importDefault(require("../../src/device-managers/NodeDevices"));
+const SessionLifecycleService_1 = require("../../src/services/SessionLifecycleService");
+const SessionMetricsService_1 = require("../../src/services/metrics/SessionMetricsService");
+const SessionDeviceLogs_1 = require("../../src/services/logcat/SessionDeviceLogs");
+const event_manager_1 = require("../../src/dashboard/event-manager");
+const SessionManager_1 = require("../../src/sessions/SessionManager");
+const device_store_1 = require("../../src/data-service/device-store");
+const prisma_store_1 = require("../../src/data-service/prisma-store");
+const PluginContext_1 = require("../../src/PluginContext");
+const IPluginArgs_1 = require("../../src/interfaces/IPluginArgs");
+const container_registration_1 = require("../helpers/container-registration");
+const scratch_database_1 = require("../helpers/scratch-database");
+/**
+ * A session's device log stops however the session ends on this server, its
+ * dashboard on or off: on a node that ends the lines it holds for the hub.
+ */
+describe('a session’s device log stops however the session ends', function () {
+    this.timeout(30000);
+    (0, scratch_database_1.useScratchDatabase)();
+    let restore;
+    let stop;
+    beforeEach(() => {
+        restore = (0, container_registration_1.saveRegistrations)(SessionMetricsService_1.SessionMetricsService, SessionDeviceLogs_1.SessionDeviceLogs);
+        stop = sinon_1.default.stub().resolves();
+        typedi_1.Container.set(SessionMetricsService_1.SessionMetricsService, { stop: sinon_1.default.stub().resolves() });
+        typedi_1.Container.set(SessionDeviceLogs_1.SessionDeviceLogs, { stop });
+    });
+    afterEach(() => {
+        sinon_1.default.restore();
+        restore();
+    });
+    it('at shutdown', () => __awaiter(this, void 0, void 0, function* () {
+        sinon_1.default.stub(event_manager_1.DASHBORD_EVENT_MANAGER, 'onSessionStopped').resolves();
+        yield typedi_1.Container.get(SessionLifecycleService_1.SessionLifecycleService).stopSessionForShutdown('s-down', 'shutdown');
+        (0, chai_1.expect)(stop.calledWith('s-down')).to.equal(true);
+    }));
+    it('when the driver shuts down unexpectedly on a node', () => __awaiter(this, void 0, void 0, function* () {
+        sinon_1.default.stub(NodeDevices_1.default.prototype, 'unblockDevice').resolves();
+        const plugin = { pluginArgs: { hub: 'http://hub:4723' } };
+        yield plugin_1.XenonPlugin.prototype.onUnexpectedShutdown.call(plugin, { sessionId: 's-crash', caps: {} }, null);
+        (0, chai_1.expect)(stop.calledWith('s-crash')).to.equal(true);
+    }));
+});
+/**
+ * After a hub restart, a node session's device log goes on being collected
+ * where the hub records sessions: after the newest line it stored.
+ */
+describe('a hub restart resumes collecting a node session’s device log', function () {
+    this.timeout(30000);
+    const scratch = (0, scratch_database_1.useScratchDatabase)();
+    let restore;
+    let start;
+    let savedStore;
+    let savedArgs;
+    beforeEach(() => __awaiter(this, void 0, void 0, function* () {
+        restore = (0, container_registration_1.saveRegistrations)(SessionMetricsService_1.SessionMetricsService, SessionDeviceLogs_1.SessionDeviceLogs);
+        start = sinon_1.default.stub().resolves();
+        typedi_1.Container.set(SessionMetricsService_1.SessionMetricsService, { start: sinon_1.default.stub() });
+        typedi_1.Container.set(SessionDeviceLogs_1.SessionDeviceLogs, { start });
+        savedArgs = typedi_1.Container.get(PluginContext_1.PluginContext).pluginArgs;
+        savedStore = device_store_1.DeviceStoreFactory._deviceStore;
+        device_store_1.DeviceStoreFactory._deviceStore = new prisma_store_1.PrismaDeviceStore();
+        yield scratch.db.session.deleteMany({});
+        yield scratch.db.device.deleteMany({});
+        const phone = (udid, extra) => scratch.db.device.create({
+            data: Object.assign({ udid, host: 'http://127.0.0.1:1', nodeId: 'node-2', platform: 'android', name: udid, sdk: '10', busy: true, userBlocked: false, offline: false }, extra),
+        });
+        yield phone('node-phone', {});
+        yield phone('cloud-phone', {
+            cloud: JSON.stringify('browserstack'),
+            host: 'https://hub.example.com',
+        });
+        for (const [id, udid, desired] of [
+            ['on-node', 'node-phone', '{}'],
+            ['logs-off', 'node-phone', JSON.stringify({ 'xe:save_device_logs': false })],
+            ['in-cloud', 'cloud-phone', '{}'],
+        ]) {
+            yield scratch.db.session.create({
+                data: {
+                    id,
+                    device_udid: udid,
+                    device_platform: 'android',
+                    device_version: '10',
+                    desired_capabilities: desired,
+                    session_capabilities: '{}',
+                    node_id: 'node-2',
+                    has_live_video: false,
+                    status: 'running',
+                },
+            });
+        }
+    }));
+    afterEach(() => {
+        for (const s of SessionManager_1.SESSION_MANAGER.getAllSessions())
+            SessionManager_1.SESSION_MANAGER.removeSession(s.getId());
+        device_store_1.DeviceStoreFactory._deviceStore = savedStore;
+        typedi_1.Container.get(PluginContext_1.PluginContext).pluginArgs = savedArgs;
+        sinon_1.default.restore();
+        restore();
+    });
+    const recover = (enableDashboard) => __awaiter(this, void 0, void 0, function* () {
+        typedi_1.Container.get(PluginContext_1.PluginContext).pluginArgs = Object.assign(Object.assign({}, IPluginArgs_1.DefaultPluginArgs), { enableDashboard });
+        yield new SessionManager_1.SessionManager().recoverActiveSessions('hub-1', '/wd/hub');
+        // The device log is resumed without waiting on it.
+        yield new Promise((r) => setImmediate(r));
+    });
+    it('resumes a node session’s, through the node, never a cloud provider’s nor one turned off', () => __awaiter(this, void 0, void 0, function* () {
+        yield recover(true);
+        (0, chai_1.expect)(start.getCalls().map((c) => c.args[0].sessionId)).to.deep.equal(['on-node']);
+        const args = start.firstCall.args[0];
+        (0, chai_1.expect)(args.resume).to.equal(true);
+        (0, chai_1.expect)(typeof args.source.nodeDeviceLogs).to.equal('function');
+    }));
+    it('resumes none on a hub with its dashboard off, which records no device logs', () => __awaiter(this, void 0, void 0, function* () {
+        yield recover(false);
+        (0, chai_1.expect)(start.called).to.equal(false);
+    }));
+});

package/lib/test/unit/session-device-logs.spec.js

@@ -15,65 +15,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require("reflect-metadata");
 const chai_1 = require("chai");
 const supertest_1 = __importDefault(require("supertest"));
-const stream_1 = require("stream");
-const LogcatStreamService_1 = require("../../src/device-managers/android/LogcatStreamService");
-const PackageResolver_1 = require("../../src/services/logcat/PackageResolver");
 const SessionDeviceLogs_1 = require("../../src/services/logcat/SessionDeviceLogs");
 const deviceLogBook_1 = require("../../src/services/logcat/deviceLogBook");
 const scratch_database_1 = require("../helpers/scratch-database");
 const selector_health_fixture_1 = require("../helpers/selector-health-fixture");
-const pad = (n, w = 2) => String(n).padStart(w, '0');
+const fake_logcat_1 = require("../helpers/fake-logcat");
 // How the Device logs tab reads a line's level for its "Errors only" filter
 // (web log-derive.ts `logLineLevel`, whose own tests hold it to lines in the
 // shape these rows have; the web package can't be imported here).
 const DASHBOARD_THREADTIME = /^\d{2}-\d{2}\s+\d{2}:\d{2}:\d{2}\.\d+\s+\d+\s+\d+\s+([VDIWEF])\s/;
 const levelOf = (message) => { var _a, _b; return (_b = (_a = DASHBOARD_THREADTIME.exec(message)) === null || _a === void 0 ? void 0 : _a[1]) !== null && _b !== void 0 ? _b : null; };
-/** A threadtime line logged at `at` by this machine's local clock. */
-function lineAt(at, msg, level = 'I', tag = 'Tag', pid = 4127) {
-    const t = new Date(at);
-    return (`${pad(t.getMonth() + 1)}-${pad(t.getDate())} ${pad(t.getHours())}:${pad(t.getMinutes())}:` +
-        `${pad(t.getSeconds())}.${pad(t.getMilliseconds(), 3)}  ${pid}  ${pid} ${level} ${tag}: ${msg}\n`);
-}
-/** An `adb logcat` child whose output the test writes. */
-function fakeProc() {
-    const stdout = new stream_1.PassThrough();
-    const handlers = {};
-    return {
-        stdout,
-        killed: false,
-        on(ev, cb) {
-            (handlers[ev] || (handlers[ev] = [])).push(cb);
-        },
-        /** The process ends, as when the phone restarts or is unplugged. */
-        exit() {
-            stdout.end();
-            (handlers.close || []).forEach((h) => h());
-        },
-        kill() {
-            this.killed = true;
-        },
-    };
-}
-/** The real stream service, its `adb logcat` children fake. */
-class FakeLogcatStreams extends LogcatStreamService_1.LogcatStreamService {
-    constructor() {
-        super(...arguments);
-        this.procs = [];
-    }
-    spawnLogcat() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const proc = fakeProc();
-            this.procs.push(proc);
-            return proc;
-        });
-    }
-    makeResolver() {
-        return new PackageResolver_1.PackageResolver(() => __awaiter(this, void 0, void 0, function* () { return '  PID NAME\n 4127 com.example.app\n'; }));
-    }
-    get proc() {
-        return this.procs[this.procs.length - 1];
-    }
-}
 class TestDeviceLogs extends SessionDeviceLogs_1.SessionDeviceLogs {
     constructor(logcat) {
         super();
@@ -115,19 +66,6 @@ const PHONE = {
     host: 'http://127.0.0.1:4723',
     nodeId: 'this-server',
 };
-/** Lets readline, the stream's package lookups and the mux deliver what was written. */
-const settle = () => __awaiter(void 0, void 0, void 0, function* () {
-    for (let i = 0; i < 5; i++)
-        yield new Promise((r) => setImmediate(r));
-});
-const until = (check_1, ...args_1) => __awaiter(void 0, [check_1, ...args_1], void 0, function* (check, ms = 2000) {
-    const end = Date.now() + ms;
-    while (!check()) {
-        if (Date.now() > end)
-            throw new Error('timed out');
-        yield new Promise((r) => setTimeout(r, 5));
-    }
-});
 /** The session's Device logs as the session page gets them. */
 function deviceLogs(sessionId) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -159,7 +97,7 @@ describe("An Android session's Device logs", function () {
                 has_live_video: false,
             },
         });
-        logcat = new FakeLogcatStreams();
+        logcat = new fake_logcat_1.FakeLogcatStreams();
         logs = new TestDeviceLogs(logcat);
     }));
     afterEach(() => __awaiter(this, void 0, void 0, function* () {
@@ -171,14 +109,14 @@ describe("An Android session's Device logs", function () {
         yield logs.start({ sessionId, device: PHONE, since });
         // History from before the session, as `logcat -T` sends it first.
         for (let i = 0; i < 20; i++)
-            logcat.proc.stdout.write(lineAt(since - 600000 + i, `old ${i}`));
+            logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since - 600000 + i, `old ${i}`));
         // 250 lines over the run, a batch between each "command".
         for (let batch = 0; batch < 5; batch++) {
             for (let i = 0; i < 50; i++) {
                 const n = batch * 50 + i;
-                logcat.proc.stdout.write(lineAt(since + 1000 + n, `line ${n}`));
+                logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 1000 + n, `line ${n}`));
             }
-            yield settle();
+            yield (0, fake_logcat_1.settle)();
         }
         yield logs.stop(sessionId);
         const rows = yield deviceLogs(sessionId);
@@ -188,11 +126,11 @@ describe("An Android session's Device logs", function () {
         const since = Date.now() - 60000;
         yield logs.start({ sessionId, device: PHONE, since });
         const crashAt = since + 30123;
-        logcat.proc.stdout.write(lineAt(crashAt - 5, 'Start proc com.example.app', 'I', 'ActivityManager'));
-        logcat.proc.stdout.write(lineAt(crashAt, 'FATAL EXCEPTION: main', 'E', 'AndroidRuntime'));
-        logcat.proc.stdout.write(lineAt(crashAt, 'Process: com.example.app, PID: 4127', 'E', 'AndroidRuntime'));
-        logcat.proc.stdout.write(lineAt(crashAt + 1, 'Sending signal. PID: 4127 SIG: 9', 'I', 'Process'));
-        yield settle();
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(crashAt - 5, 'Start proc com.example.app', 'I', 'ActivityManager'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(crashAt, 'FATAL EXCEPTION: main', 'E', 'AndroidRuntime'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(crashAt, 'Process: com.example.app, PID: 4127', 'E', 'AndroidRuntime'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(crashAt + 1, 'Sending signal. PID: 4127 SIG: 9', 'I', 'Process'));
+        yield (0, fake_logcat_1.settle)();
         yield logs.stop(sessionId);
         const rows = yield deviceLogs(sessionId);
         (0, chai_1.expect)(rows.map((r) => levelOf(r.message))).to.deep.equal(['I', 'E', 'E', 'I']);
@@ -210,8 +148,8 @@ describe("An Android session's Device logs", function () {
         const at = since + 10000;
         const frames = Array.from({ length: 40 }, (_, i) => `\tat com.example.Frame${i}.run(Frame.java:${i})`);
         for (const frame of frames)
-            logcat.proc.stdout.write(lineAt(at, frame, 'E', 'AndroidRuntime'));
-        yield settle();
+            logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(at, frame, 'E', 'AndroidRuntime'));
+        yield (0, fake_logcat_1.settle)();
         yield logs.stop(sessionId);
         const rows = yield deviceLogs(sessionId);
         (0, chai_1.expect)(rows.map((r) => r.message.replace(/^.*AndroidRuntime: /, ''))).to.deep.equal(frames);
@@ -224,14 +162,14 @@ describe("An Android session's Device logs", function () {
         const since = Date.now() - 60000;
         yield logs.start({ sessionId, device: PHONE, since });
         for (let i = 0; i < SessionDeviceLogs_1.WRITE_BATCH + 10; i++)
-            logcat.proc.stdout.write(lineAt(since + i, `line ${i}`));
-        yield settle();
+            logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + i, `line ${i}`));
+        yield (0, fake_logcat_1.settle)();
         // A full batch is written while the session runs, without waiting for
         // its end or the interval (a minute here).
         const written = () => scratch.db.log.count({ where: { session_id: sessionId } });
         const end = Date.now() + 2000;
         while ((yield written()) < SessionDeviceLogs_1.WRITE_BATCH && Date.now() < end)
-            yield settle();
+            yield (0, fake_logcat_1.settle)();
         (0, chai_1.expect)(yield written()).to.be.at.least(SessionDeviceLogs_1.WRITE_BATCH);
         (0, chai_1.expect)(logs.isRecording(sessionId)).to.equal(true);
         yield logs.stop(sessionId);
@@ -243,18 +181,18 @@ describe("An Android session's Device logs", function () {
         const since = Date.now() - 60000;
         yield logs.start({ sessionId, device: PHONE, since });
         const first = logcat.proc;
-        first.stdout.write(lineAt(since + 1000, 'before 1'));
-        first.stdout.write(lineAt(since + 2000, 'before 2'));
-        yield settle();
+        first.stdout.write((0, fake_logcat_1.lineAt)(since + 1000, 'before 1'));
+        first.stdout.write((0, fake_logcat_1.lineAt)(since + 2000, 'before 2'));
+        yield (0, fake_logcat_1.settle)();
         first.exit();
-        yield until(() => logcat.procs.length === 2);
+        yield (0, fake_logcat_1.until)(() => logcat.procs.length === 2);
         // The new stream starts with history the session already has, then a
         // line of the same millisecond it hadn't seen, then new lines.
-        logcat.proc.stdout.write(lineAt(since + 1000, 'before 1'));
-        logcat.proc.stdout.write(lineAt(since + 2000, 'before 2'));
-        logcat.proc.stdout.write(lineAt(since + 2000, 'also at 2'));
-        logcat.proc.stdout.write(lineAt(since + 9000, 'after'));
-        yield settle();
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 1000, 'before 1'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 2000, 'before 2'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 2000, 'also at 2'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 9000, 'after'));
+        yield (0, fake_logcat_1.settle)();
         yield logs.stop(sessionId);
         (0, chai_1.expect)(textOf(yield deviceLogs(sessionId))).to.deep.equal([
             'before 1',
@@ -271,8 +209,8 @@ describe("An Android session's Device logs", function () {
         mux.addClient((r) => viewer.push(r.message), () => true);
         yield logs.start({ sessionId, device: PHONE, since });
         (0, chai_1.expect)(logcat.procs).to.have.length(1);
-        logcat.proc.stdout.write(lineAt(since + 1, 'shared'));
-        yield settle();
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 1, 'shared'));
+        yield (0, fake_logcat_1.settle)();
         yield logs.stop(sessionId);
         (0, chai_1.expect)(viewer).to.deep.equal(['shared']);
         (0, chai_1.expect)(logcat.proc.killed).to.equal(false);
@@ -294,14 +232,14 @@ describe("An Android session's Device logs", function () {
         for (let i = 0; i < total; i++) {
             // Past the limit, five lines in six are errors: 2,500 errors, 500 others.
             const level = i >= deviceLogBook_1.DEVICE_LOG_LINE_LIMIT && i % 6 !== 0 ? 'E' : 'D';
-            chunk += lineAt(since + 1000 + i, `line ${i}`, level);
+            chunk += (0, fake_logcat_1.lineAt)(since + 1000 + i, `line ${i}`, level);
             if (i % 1000 === 999) {
                 logcat.proc.stdout.write(chunk);
                 chunk = '';
-                yield settle();
+                yield (0, fake_logcat_1.settle)();
             }
         }
-        yield settle();
+        yield (0, fake_logcat_1.settle)();
         yield logs.stop(sessionId);
         const rows = yield deviceLogs(sessionId);
         (0, chai_1.expect)(rows).to.have.length(deviceLogBook_1.DEVICE_LOG_LINE_LIMIT + 1 + deviceLogBook_1.DEVICE_LOG_ERROR_LIMIT + 1);
@@ -311,10 +249,12 @@ describe("An Android session's Device logs", function () {
         (0, chai_1.expect)(errors.every((r) => levelOf(r.message) === 'E')).to.equal(true);
         (0, chai_1.expect)(rows[rows.length - 1].message).to.equal("Xenon: 1,000 device log lines were left out to keep this session's log within its limit.");
     }));
-    it("only records this server's own Android phones", () => {
+    it("only records this server's own phones", () => {
         (0, chai_1.expect)(logs.appliesTo(PHONE)).to.equal(true);
         (0, chai_1.expect)(logs.appliesTo(Object.assign(Object.assign({}, PHONE), { nodeId: 'a-node' }))).to.equal(false);
-        (0, chai_1.expect)(logs.appliesTo(Object.assign(Object.assign({}, PHONE), { platform: 'ios' }))).to.equal(false);
+        // An iPhone is recorded from its driver's log (session-device-logs-ios.spec.ts).
+        (0, chai_1.expect)(logs.appliesTo(Object.assign(Object.assign({}, PHONE), { platform: 'ios' }))).to.equal(true);
+        (0, chai_1.expect)(logs.appliesTo(Object.assign(Object.assign({}, PHONE), { platform: 'windows' }))).to.equal(false);
         (0, chai_1.expect)(logs.appliesTo(Object.assign(Object.assign({}, PHONE), { cloud: true }))).to.equal(false);
         (0, chai_1.expect)(logs.appliesTo(undefined)).to.equal(false);
     });
@@ -322,12 +262,19 @@ describe("An Android session's Device logs", function () {
         logs.clock = null;
         const since = Date.now() - 60000;
         yield logs.start({ sessionId, device: PHONE, since });
-        logcat.proc.stdout.write(lineAt(since - 600000, 'before'));
-        logcat.proc.stdout.write(lineAt(since + 10, 'during'));
-        yield settle();
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since - 600000, 'before'));
+        logcat.proc.stdout.write((0, fake_logcat_1.lineAt)(since + 10, 'during'));
+        yield (0, fake_logcat_1.settle)();
         yield logs.stop(sessionId);
         (0, chai_1.expect)(textOf(yield deviceLogs(sessionId))).to.deep.equal(['during']);
     }));
+    it('says in the log when the session turned it off', () => __awaiter(this, void 0, void 0, function* () {
+        yield logs.noteOff(sessionId);
+        (0, chai_1.expect)((yield deviceLogs(sessionId)).map((r) => r.message)).to.deep.equal([
+            "Xenon: This session's device log wasn't kept: the test turned it off.",
+        ]);
+        (0, chai_1.expect)(logcat.procs).to.have.length(0);
+    }));
     it('stops however often it is told to', () => __awaiter(this, void 0, void 0, function* () {
         yield logs.start({ sessionId, device: PHONE, since: Date.now() });
         yield logs.stop(sessionId);

package/lib/test/unit/session-end-failure-analysis.spec.js

@@ -100,10 +100,10 @@ describe('ending a failed session', () => {
         notify: false,
     });
     it('returns while the AI is still explaining the failure', () => __awaiter(void 0, void 0, void 0, function* () {
-        (0, chai_1.expect)(yield within(2000, end())).to.equal('ended');
+        (0, chai_1.expect)(yield within(10000, end())).to.equal('ended');
         // The AI is still asked, once the session has ended.
         const analyzeFailure = AIService_1.AI_SERVICE.analyzeFailure;
-        for (let i = 0; i < 100 && !analyzeFailure.called; i++) {
+        for (let i = 0; i < 500 && !analyzeFailure.called; i++) {
             yield new Promise((r) => setTimeout(r, 20));
         }
         (0, chai_1.expect)(analyzeFailure.calledOnce).to.equal(true);
@@ -113,17 +113,17 @@ describe('ending a failed session', () => {
         });
     }));
     it('has filed the session under its category when it returns', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield within(2000, end());
+        yield within(10000, end());
         const saved = yield row();
         (0, chai_1.expect)(saved.status).to.equal(SessionStatus_1.SessionStatus.FAILED);
         (0, chai_1.expect)(saved.failure_category).to.equal('ELEMENT_NOT_FOUND');
         (0, chai_1.expect)(saved.ai_analysis).to.equal(null);
     }));
     it("saves the AI's explanation when it comes", () => __awaiter(void 0, void 0, void 0, function* () {
-        yield within(2000, end());
+        yield within(10000, end());
         explain.resolve('Root Cause: the Login button was covered by a dialog.');
         let saved = yield row();
-        for (let i = 0; i < 100 && !saved.ai_analysis; i++) {
+        for (let i = 0; i < 500 && !saved.ai_analysis; i++) {
             yield new Promise((r) => setTimeout(r, 20));
             saved = yield row();
         }

package/lib/test/unit/session-log-indexes.spec.js

@@ -18,6 +18,7 @@ const supertest_1 = __importDefault(require("supertest"));
 const typedi_1 = require("typedi");
 const CleanupService_1 = require("../../src/services/CleanupService");
 const SelectorVerificationJob_1 = require("../../src/services/SelectorVerificationJob");
+const SessionDeviceLogs_1 = require("../../src/services/logcat/SessionDeviceLogs");
 const scratch_database_1 = require("../helpers/scratch-database");
 const selector_health_fixture_1 = require("../helpers/selector-health-fixture");
 /** The SQL statements `run` makes. */
@@ -145,6 +146,20 @@ describe("A session's logs and profiling are read through an index", function ()
             (0, chai_1.expect)(scansOf(table, steps), steps.join('\n')).to.deep.equal([]);
         }));
     }
+    it("finds a session's newest device log lines without a scan, as a hub resumes after a restart", () => __awaiter(this, void 0, void 0, function* () {
+        class Reader extends SessionDeviceLogs_1.SessionDeviceLogs {
+            tail(sessionId) {
+                return this.storedTail(sessionId);
+            }
+        }
+        let tail = [];
+        const steps = yield stepsOn(scratch, 'Log', yield sqlOf(scratch, () => __awaiter(this, void 0, void 0, function* () {
+            tail = yield new Reader().tail('ix-session');
+        })));
+        (0, chai_1.expect)(tail.map((l) => l.message)).to.deep.equal(['I/ActivityManager: start']);
+        (0, chai_1.expect)(steps, 'no Log statement was captured').to.not.be.empty;
+        (0, chai_1.expect)(scansOf('Log', steps), steps.join('\n')).to.deep.equal([]);
+    }));
     it("deletes a session's commands, logs and profiling without a scan", () => __awaiter(this, void 0, void 0, function* () {
         const ran = yield sqlOf(scratch, () => typedi_1.Container.get(CleanupService_1.CleanupService).purgeBuild('ix-build', false));
         for (const table of ['SessionLog', 'Log', 'Profiling']) {
@@ -199,7 +214,7 @@ describe('The selector verification reads SessionLog through an index', function
         });
     }));
     it("reads a selector's finds without a scan", () => __awaiter(this, void 0, void 0, function* () {
-        const socket = { emitToDashboard: () => undefined };
+        const socket = { emitToDashboardForSelector: () => __awaiter(this, void 0, void 0, function* () { return undefined; }) };
         const ran = yield sqlOf(scratch, () => new SelectorVerificationJob_1.SelectorVerificationJob(scratch.db, socket).run());
         const steps = yield stepsOn(scratch, 'SessionLog', ran);
         (0, chai_1.expect)(steps, 'no SessionLog statement was captured').to.not.be.empty;