@xenon-device-management/xenon 2.15.0 → 2.17.0

package/lib/src/services/SelectorVerificationJob.js

@@ -39,6 +39,10 @@ const log = logger_1.default.scope('SelectorVerification');
  * selector that was never found again was verified as fixed.
  */
 const CLEAN_BUILDS_TO_RESOLVE = 3;
+/** The selector a row is about, as the socket server's scoped emit names it. */
+function keyOfRow(row) {
+    return { strategy: row.original_strategy, selector: row.original_selector };
+}
 /**
  * Periodically scans Pending SelectorState rows and promotes them to Resolved
  * once enough clean CI builds have been observed (no heals on the selector
@@ -180,7 +184,7 @@ let SelectorVerificationJob = class SelectorVerificationJob {
                 return promoted;
             }));
             log.info(`[${row.id}] promoted to resolved (${row.original_strategy}=${row.original_selector})`);
-            this.socket.emitToDashboard(SocketEvents_1.SocketEvents.SELECTOR_RESOLVED, this.serialize(updated));
+            void this.socket.emitToDashboardForSelector(SocketEvents_1.SocketEvents.SELECTOR_RESOLVED, this.serialize(updated), keyOfRow(row));
         });
     }
     updateProgress(row, cleanBuildCount) {
@@ -189,7 +193,7 @@ let SelectorVerificationJob = class SelectorVerificationJob {
                 where: { id: row.id },
                 data: { clean_builds_count: cleanBuildCount, last_event_at: new Date() },
             });
-            this.socket.emitToDashboard(SocketEvents_1.SocketEvents.SELECTOR_PROGRESS, this.serialize(updated));
+            void this.socket.emitToDashboardForSelector(SocketEvents_1.SocketEvents.SELECTOR_PROGRESS, this.serialize(updated), keyOfRow(row));
         });
     }
     serialize(row) {

package/lib/src/services/SessionLifecycleService.js

@@ -56,8 +56,6 @@ const typedi_1 = require("typedi");
 const uuid_1 = require("uuid");
 const lodash_1 = __importDefault(require("lodash"));
 const axios_1 = __importDefault(require("axios"));
-const https_proxy_agent_1 = require("https-proxy-agent");
-const http_proxy_agent_1 = require("http-proxy-agent");
 const logger_1 = __importDefault(require("../logger"));
 const helpers_1 = require("../helpers");
 const InternalHttpClient_1 = require("../InternalHttpClient");
@@ -81,6 +79,7 @@ const appVisibility_1 = require("./device-access/appVisibility");
 const LiveSessionOwners_1 = require("./device-access/LiveSessionOwners");
 const sessionMemory_1 = require("../sessions/sessionMemory");
 const SessionMetricsService_1 = require("./metrics/SessionMetricsService");
+const SessionDeviceLogs_1 = require("./logcat/SessionDeviceLogs");
 const appCapability_1 = require("./session/appCapability");
 const CircuitBreaker_1 = require("../data-service/CircuitBreaker");
 const nodeWebDriverUrl_1 = require("../gateway/nodeWebDriverUrl");
@@ -848,7 +847,7 @@ let SessionLifecycleService = class SessionLifecycleService {
     }
     finalizeSession(session_1, device_1, caps_1, driver_1, isRemote_1) {
         return __awaiter(this, arguments, void 0, function* (session, device, caps, driver, isRemote, apiKeyId = null, userId = null, allocatedAt) {
-            var _a;
+            var _a, _b;
             const sessionId = session.value[0];
             const sessionResponse = session.value[1];
             const requestedCaps = Object.assign({}, ((_a = caps.firstMatch) === null || _a === void 0 ? void 0 : _a[0]) || {}, caps.alwaysMatch || {});
@@ -865,6 +864,23 @@ let SessionLifecycleService = class SessionLifecycleService {
                     'xenon.udid': device.udid,
                 });
             }
+            try {
+                yield this.registerSession(sessionId, sessionResponse, device, xenonCapabilities, driver, isRemote, apiKeyId, userId, allocatedAt);
+            }
+            catch (err) {
+                // The create fails, so no ending of the session will come to end it.
+                tracingService.endSessionSpan(sessionId, {
+                    failed: true,
+                    reason: `Xenon could not finish creating the session: ${(_b = err === null || err === void 0 ? void 0 : err.message) !== null && _b !== void 0 ? _b : err}`,
+                });
+                throw err;
+            }
+        });
+    }
+    /** The rest of finalizeSession, once the session's span has started. */
+    registerSession(sessionId, sessionResponse, device, xenonCapabilities, driver, isRemote, apiKeyId, userId, allocatedAt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const context = typedi_1.Container.get(PluginContext_1.PluginContext);
             // The session takes over the pending claim its phone was allocated with.
             yield (0, device_service_1.claimDeviceForSession)(device, sessionId, {
                 session_id: sessionId,
@@ -889,15 +905,26 @@ let SessionLifecycleService = class SessionLifecycleService {
             if (sessionInstance instanceof LocalSession_1.LocalSession) {
                 typedi_1.Container.get(LiveSessionOwners_1.LiveSessionOwners).record(sessionId, userId);
             }
-            // A node samples its own phones for its hub, whatever its dashboard
-            // setting (the hub collects the figures). A hub and a standalone server
-            // start sampling in EventManager.onSessionStarted, once the row exists.
+            // A node samples its own phones for its hub, and records their device
+            // log unless the session turned it off, whatever its dashboard setting
+            // (the hub collects both). A hub and a standalone server start them in
+            // EventManager.onSessionStarted, once the row exists.
             if (!this.isHub(context.pluginArgs) && sessionInstance instanceof LocalSession_1.LocalSession) {
                 typedi_1.Container.get(SessionMetricsService_1.SessionMetricsService).start({
                     sessionId,
                     device: freshDevice,
                     capabilities: sessionResponse,
                 });
+                if (xenonCapabilities[XenonCapabilityManager_1.XENON_CAPABILITIES.SAVE_DEVICE_LOGS] !== false) {
+                    void typedi_1.Container.get(SessionDeviceLogs_1.SessionDeviceLogs).start({
+                        sessionId,
+                        device: freshDevice,
+                        since: allocatedAt,
+                        // An iPhone's or simulator's: the log its driver captures.
+                        driverLog: sessionInstance.deviceLog(),
+                        appUnderTest: sessionInstance.appUnderTest(),
+                    });
+                }
             }
             yield this.applyPostSessionLogic(sessionInstance, xenonCapabilities, freshDevice);
         });
@@ -1063,19 +1090,8 @@ let SessionLifecycleService = class SessionLifecycleService {
                 timeout: exports.REMOTE_CREATE_TIMEOUT_MS,
                 retry: false,
             };
-            if (context.pluginArgs.proxy) {
-                this.logger.info(`Added proxy to axios config: ${JSON.stringify(context.pluginArgs.proxy)}`);
-                const proxyUrl = typeof context.pluginArgs.proxy === 'string'
-                    ? context.pluginArgs.proxy
-                    : `http://${context.pluginArgs.proxy.host}:${context.pluginArgs.proxy.port}`;
-                config.httpsAgent = new https_proxy_agent_1.HttpsProxyAgent(proxyUrl, {
-                    rejectUnauthorized: context.pluginArgs.tlsRejectUnauthorized,
-                });
-                config.httpAgent = new http_proxy_agent_1.HttpProxyAgent(proxyUrl, {
-                    rejectUnauthorized: context.pluginArgs.tlsRejectUnauthorized,
-                });
-                config.proxy = false;
-            }
+            // Its proxy is InternalHttpClient's, by Xenon's one rule: the `proxy`
+            // option, else the environment's (helpers/outboundProxy.ts).
             const createdSession = yield this.invokeSessionRequest(config, context.pluginArgs.tlsRejectUnauthorized);
             if (createdSession instanceof Error) {
                 return createdSession;
@@ -1207,10 +1223,18 @@ let SessionLifecycleService = class SessionLifecycleService {
                 if (sessionId) {
                     typedi_1.Container.get(LiveSessionOwners_1.LiveSessionOwners).forget(sessionId);
                     (0, sessionMemory_1.forgetSessionMemory)(sessionId);
+                    // Whether or not SESSION_MANAGER holds the session (a local one with
+                    // the dashboard off), and once: a second delete finds no span.
+                    typedi_1.Container.get(TracingService_1.TracingService).endSessionSpan(sessionId, {
+                        failed: status === SessionStatus_1.SessionStatus.FAILED,
+                        reason,
+                    });
                     // Before the lock's "still in memory?" check, which a dashboard-off
-                    // node fails. On a node this ends the figures it holds for its hub;
-                    // on a hub it collects a node session's last ones. Idempotent.
+                    // node fails. On a node this ends the figures and device log it
+                    // holds for its hub; on a hub it collects a node session's last ones,
+                    // before onSessionStopped's failure analysis reads the log. Idempotent.
                     yield typedi_1.Container.get(SessionMetricsService_1.SessionMetricsService).stop(sessionId);
+                    yield typedi_1.Container.get(SessionDeviceLogs_1.SessionDeviceLogs).stop(sessionId);
                     yield sessionCleanupLock.acquire(sessionId, () => __awaiter(this, void 0, void 0, function* () {
                         const session = SessionManager_1.SESSION_MANAGER.getSession(sessionId);
                         if (!session) {
@@ -1240,8 +1264,11 @@ let SessionLifecycleService = class SessionLifecycleService {
                     logger_1.default.warn(`Port release failed: ${err.message}`);
                 }
             }
-            // 1. iOS Profiling Archival
-            if (device && ((_a = device.platform) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'ios') {
+            // 1. iOS Profiling Archival. Only on an iPhone, the one place
+            // EventManager.onSessionStarted starts it. A simulator's driver refuses
+            // the stop without relaxed security, and the refused stop counted as a
+            // failed command of the session: every simulator session ended failed.
+            if (device && ((_a = device.platform) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'ios' && device.realDevice === true) {
                 this.logger.info(`[${sessionId}] Stopping iOS profiling for asset archival`);
                 try {
                     const traceBase64 = yield session.stopPerformanceRecording();
@@ -1323,7 +1350,9 @@ let SessionLifecycleService = class SessionLifecycleService {
                 SessionManager_1.SESSION_MANAGER.removeSession(sessionId);
                 typedi_1.Container.get(LiveSessionOwners_1.LiveSessionOwners).forget(sessionId);
                 (0, sessionMemory_1.forgetSessionMemory)(sessionId);
+                typedi_1.Container.get(TracingService_1.TracingService).endSessionSpan(sessionId, { failed: true, reason });
                 yield typedi_1.Container.get(SessionMetricsService_1.SessionMetricsService).stop(sessionId);
+                yield typedi_1.Container.get(SessionDeviceLogs_1.SessionDeviceLogs).stop(sessionId);
             }));
         });
     }

package/lib/src/services/SocketClient.js

@@ -15,6 +15,7 @@ const typedi_1 = require("typedi");
 const logger_1 = __importDefault(require("../logger"));
 const config_1 = require("../config");
 const SocketEvents_1 = require("../enums/SocketEvents");
+const outboundProxy_1 = require("../helpers/outboundProxy");
 let SocketClient = class SocketClient {
     constructor() {
         this.socket = null;
@@ -46,6 +47,16 @@ let SocketClient = class SocketClient {
             reconnectionDelay: 1000,
             reconnectionDelayMax: 5000,
             auth: socketAuth,
+            // The proxy the node's other calls to its hub take (its phone reports,
+            // its JWKS fetch); it used to go straight to the hub whatever the
+            // environment said. Polling goes as plain requests, as axios sends
+            // them; only the WebSocket upgrade needs a CONNECT tunnel, and when the
+            // proxy refuses one (a stock Squid allows port 443 only) the
+            // connection stays on polling.
+            transportOptions: {
+                polling: { agent: (0, outboundProxy_1.proxyAgentFor)(normalizedHubUrl) },
+                websocket: { agent: (0, outboundProxy_1.socketProxyAgentFor)(normalizedHubUrl) },
+            },
         });
         this.socket.on('connect', () => {
             var _a, _b, _c;