@xenon-device-management/xenon 2.15.0 → 2.16.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.spec.js

@@ -311,10 +311,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);
     });
@@ -328,6 +330,13 @@ describe("An Android session's Device logs", function () {
         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

@@ -199,7 +199,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;