@xenon-device-management/xenon 1.1.0

package/lib/src/InternalHttpClient.js

@@ -0,0 +1,212 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 });
+exports.InternalHttpClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+const logger_1 = __importDefault(require("./logger"));
+/**
+ * InternalHttpClient - Centralized HTTP client for all internal communication.
+ *
+ * Features:
+ * - Keep-alive connections for performance
+ * - Automatic retry with exponential backoff
+ * - Request/response logging for debugging
+ * - Correlation ID tracking
+ */
+class InternalHttpClient {
+    constructor(tlsRejectUnauthorized) {
+        this.axiosInstance = axios_1.default.create({
+            httpAgent: this.getHttpAgent(),
+            httpsAgent: this.getHttpsAgent(tlsRejectUnauthorized),
+            timeout: 30000,
+            maxContentLength: Infinity,
+            maxBodyLength: Infinity,
+        });
+        this.setupInterceptors();
+    }
+    getHttpAgent() {
+        return new http_1.default.Agent({
+            keepAlive: true,
+            keepAliveMsecs: 120000,
+        });
+    }
+    getHttpsAgent(tlsRejectUnauthorized) {
+        // Principal Decoupling: Prioritize constructor arg, fall back to env var
+        const rejectUnauthorized = tlsRejectUnauthorized !== undefined
+            ? tlsRejectUnauthorized
+            : process.env.XENON_TLS_REJECT_UNAUTHORIZED !== 'false';
+        return new https_1.default.Agent({
+            // Hardened TLS Security: rejectUnauthorized defaults to true (production-safe).
+            rejectUnauthorized,
+            keepAlive: true,
+            keepAliveMsecs: 120000,
+        });
+    }
+    setupInterceptors() {
+        // Request interceptor - adds timing and logging
+        this.axiosInstance.interceptors.request.use((config) => {
+            var _a;
+            // Add request start time for duration calculation
+            config.metadata = { startTime: Date.now() };
+            // Log outgoing request
+            logger_1.default.debug(`[HTTP →] ${(_a = config.method) === null || _a === void 0 ? void 0 : _a.toUpperCase()} ${config.url}`);
+            return config;
+        }, (error) => {
+            logger_1.default.error(`[HTTP →] Request setup error: ${error.message}`);
+            return Promise.reject(error);
+        });
+        // Response interceptor - logging + retry logic
+        this.axiosInstance.interceptors.response.use((response) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const duration = Date.now() - (((_a = response.config.metadata) === null || _a === void 0 ? void 0 : _a.startTime) || Date.now());
+            // Log successful response
+            if (!response.config.silent) {
+                logger_1.default.debug(`[HTTP ←] ${(_b = response.config.method) === null || _b === void 0 ? void 0 : _b.toUpperCase()} ${response.config.url} ` +
+                    `[${response.status}] ${duration}ms`);
+            }
+            // Principal Decoupling: Emit event for logging/observability
+            try {
+                const { EVENT_BUS } = yield Promise.resolve().then(() => __importStar(require('./services/EventBus')));
+                EVENT_BUS.emit('http:outgoing', {
+                    direction: 'outgoing',
+                    method: ((_c = response.config.method) === null || _c === void 0 ? void 0 : _c.toUpperCase()) || 'GET',
+                    url: response.config.url || '',
+                    requestBody: response.config.data ? JSON.stringify(response.config.data) : undefined,
+                    responseBody: response.data ? JSON.stringify(response.data).slice(0, 2000) : undefined,
+                    statusCode: response.status,
+                    durationMs: duration,
+                    source: 'InternalHttpClient',
+                });
+            }
+            catch (e) {
+                /* ignore */
+            }
+            return response;
+        }), (error) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const config = error.config;
+            const response = error.response;
+            const duration = Date.now() - (((_a = config === null || config === void 0 ? void 0 : config.metadata) === null || _a === void 0 ? void 0 : _a.startTime) || Date.now());
+            // Principal Decoupling: Emit event for logging/observability
+            try {
+                const { EVENT_BUS } = yield Promise.resolve().then(() => __importStar(require('./services/EventBus')));
+                EVENT_BUS.emit('http:outgoing', {
+                    direction: 'outgoing',
+                    method: ((_b = config === null || config === void 0 ? void 0 : config.method) === null || _b === void 0 ? void 0 : _b.toUpperCase()) || 'GET',
+                    url: (config === null || config === void 0 ? void 0 : config.url) || '',
+                    requestBody: (config === null || config === void 0 ? void 0 : config.data) ? JSON.stringify(config.data) : undefined,
+                    responseBody: (response === null || response === void 0 ? void 0 : response.data) ? JSON.stringify(response.data).slice(0, 2000) : undefined,
+                    statusCode: response === null || response === void 0 ? void 0 : response.status,
+                    durationMs: duration,
+                    error: error.message,
+                    source: 'InternalHttpClient',
+                });
+            }
+            catch (e) {
+                /* ignore */
+            }
+            if (!config || config.retryCount === undefined) {
+                config.retryCount = 0;
+            }
+            const maxRetries = 2;
+            const status = response === null || response === void 0 ? void 0 : response.status;
+            // Log failed request
+            if (!(config === null || config === void 0 ? void 0 : config.silent)) {
+                logger_1.default.warn(`[HTTP ←] ${(_c = config === null || config === void 0 ? void 0 : config.method) === null || _c === void 0 ? void 0 : _c.toUpperCase()} ${config === null || config === void 0 ? void 0 : config.url} ` +
+                    `[${status || 'ERR'}] ${duration}ms - ${error.message}`);
+            }
+            // Don't retry client errors (4xx) except for occasional 429
+            if (status && status < 500 && status !== 429) {
+                return Promise.reject(error);
+            }
+            if (config.retryCount < maxRetries) {
+                config.retryCount += 1;
+                const backoff = config.retryCount * 1000;
+                logger_1.default.warn(`[HTTP ↻] Retrying ${config.url} in ${backoff}ms (Attempt ${config.retryCount}/${maxRetries})...`);
+                yield new Promise((resolve) => setTimeout(resolve, backoff));
+                return this.axiosInstance(config);
+            }
+            return Promise.reject(error);
+        }));
+    }
+    static getClient(tlsRejectUnauthorized) {
+        if (tlsRejectUnauthorized !== undefined) {
+            return new InternalHttpClient(tlsRejectUnauthorized).axiosInstance;
+        }
+        if (!this.defaultInstance) {
+            this.defaultInstance = new InternalHttpClient();
+        }
+        return this.defaultInstance.axiosInstance;
+    }
+    static post(url, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getClient().post(url, data, config);
+            return response.data;
+        });
+    }
+    static get(url, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getClient().get(url, config);
+            return response.data;
+        });
+    }
+    static delete(url, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getClient().delete(url, config);
+            return response.data;
+        });
+    }
+    static put(url, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getClient().put(url, data, config);
+            return response.data;
+        });
+    }
+}
+exports.InternalHttpClient = InternalHttpClient;

package/lib/src/PluginContext.js

@@ -0,0 +1,29 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginContext = void 0;
+const typedi_1 = require("typedi");
+const IPluginArgs_1 = require("./interfaces/IPluginArgs");
+let PluginContext = class PluginContext {
+    constructor() {
+        this.pluginArgs = Object.assign({}, IPluginArgs_1.DefaultPluginArgs);
+        this.port = 4723;
+        this.nodeId = '';
+        this.nodeBasePath = '';
+    }
+    setContext(args, port, nodeId, nodeBasePath) {
+        this.pluginArgs = args;
+        this.port = port;
+        this.nodeId = nodeId;
+        this.nodeBasePath = nodeBasePath;
+    }
+};
+exports.PluginContext = PluginContext;
+exports.PluginContext = PluginContext = __decorate([
+    (0, typedi_1.Service)()
+], PluginContext);

package/lib/src/XenonCapabilityManager.js

@@ -0,0 +1,199 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 });
+exports.XENON_CAPABILITIES = void 0;
+exports.androidCapabilities = androidCapabilities;
+exports.iOSCapabilities = iOSCapabilities;
+exports.getXenonCapabilities = getXenonCapabilities;
+const get_port_1 = __importDefault(require("get-port"));
+const lodash_1 = __importDefault(require("lodash"));
+const typedi_1 = require("typedi");
+const logger_1 = __importDefault(require("./logger"));
+var XENON_CAPABILITIES;
+(function (XENON_CAPABILITIES) {
+    XENON_CAPABILITIES["BUILD_NAME"] = "build";
+    XENON_CAPABILITIES["SESSION_NAME"] = "name";
+    XENON_CAPABILITIES["VIDEO_RECORDING"] = "record_video";
+    XENON_CAPABILITIES["RECORD_VIDEO"] = "recordVideo";
+    XENON_CAPABILITIES["VIDEO_RESOLUTION"] = "video_resolution";
+    XENON_CAPABILITIES["LIVE_VIDEO"] = "live_video";
+    XENON_CAPABILITIES["SCREENSHOT_ON_FAILURE"] = "screenshot_on_failure";
+    XENON_CAPABILITIES["SCREENSHOT_ON_FAIL"] = "screenshotOnFailure";
+    XENON_CAPABILITIES["XENON_OPTIONS"] = "xenon:options";
+    XENON_CAPABILITIES["SAVE_DEVICE_LOGS"] = "saveDeviceLogs";
+    XENON_CAPABILITIES["SAVE_LOGS"] = "save_device_logs";
+    XENON_CAPABILITIES["SCREENSHOT_ON_EVERY_COMMAND"] = "screenshot_on_every_command";
+    XENON_CAPABILITIES["SCREENSHOT_EVERY_COMMAND"] = "screenshotOnEveryCommand";
+    XENON_CAPABILITIES["NETWORK_PROFILE"] = "network_profile";
+    XENON_CAPABILITIES["ISOLATION_PROFILE"] = "isolation_profile";
+})(XENON_CAPABILITIES || (exports.XENON_CAPABILITIES = XENON_CAPABILITIES = {}));
+function isCapabilityAlreadyPresent(caps, capabilityName) {
+    return lodash_1.default.has(caps.alwaysMatch, capabilityName) || lodash_1.default.has(caps.firstMatch[0], capabilityName);
+}
+function deleteAlwaysMatch(caps, capabilityName) {
+    if (lodash_1.default.has(caps.alwaysMatch, capabilityName))
+        delete caps.alwaysMatch[capabilityName];
+}
+function androidCapabilities(caps, freeDevice) {
+    return __awaiter(this, void 0, void 0, function* () {
+        caps.firstMatch[0]['appium:udid'] = freeDevice.udid;
+        caps.firstMatch[0]['platformName'] = freeDevice.platform;
+        caps.firstMatch[0]['appium:systemPort'] = yield (0, get_port_1.default)();
+        caps.firstMatch[0]['appium:chromeDriverPort'] = yield (0, get_port_1.default)();
+        caps.firstMatch[0]['appium:adbRemoteHost'] = freeDevice.adbRemoteHost;
+        caps.firstMatch[0]['appium:adbPort'] = freeDevice.adbPort;
+        if (freeDevice.chromeDriverPath)
+            caps.firstMatch[0]['appium:chromedriverExecutable'] = freeDevice.chromeDriverPath;
+        if (!isCapabilityAlreadyPresent(caps, 'appium:mjpegServerPort')) {
+            caps.firstMatch[0]['appium:mjpegServerPort'] = yield (0, get_port_1.default)();
+        }
+        deleteAlwaysMatch(caps, 'platformName');
+        deleteAlwaysMatch(caps, 'appium:udid');
+        deleteAlwaysMatch(caps, 'appium:systemPort');
+        deleteAlwaysMatch(caps, 'appium:chromeDriverPort');
+        deleteAlwaysMatch(caps, 'appium:adbRemoteHost');
+        deleteAlwaysMatch(caps, 'appium:adbPort');
+    });
+}
+function iOSCapabilities(caps, freeDevice) {
+    return __awaiter(this, void 0, void 0, function* () {
+        caps.firstMatch[0]['appium:udid'] = freeDevice.udid;
+        caps.firstMatch[0]['platformName'] = freeDevice.platform;
+        caps.firstMatch[0]['appium:deviceName'] = freeDevice.name;
+        caps.firstMatch[0]['appium:platformVersion'] = freeDevice.sdk;
+        caps.firstMatch[0]['appium:wdaLocalPort'] = freeDevice.wdaLocalPort;
+        caps.firstMatch[0]['appium:mjpegServerPort'] = freeDevice.mjpegServerPort;
+        caps.firstMatch[0]['appium:derivedDataPath'] = freeDevice.derivedDataPath;
+        // Technical Optimization: Reuse existing WDA tunnel if Stream Service is active
+        // This prevents "Port Occupied" errors when the dashboard is open and speeds up startup by 15-30s
+        try {
+            const { default: IOSStreamService } = yield Promise.resolve().then(() => __importStar(require('./device-managers/ios/IOSStreamService')));
+            const streamService = typedi_1.Container.get(IOSStreamService);
+            const streamStatus = streamService.getStreamStatus(freeDevice.udid);
+            logger_1.default.info(`[Xenon] 🔍 Checking Stream Status for ${freeDevice.udid}: ${(streamStatus === null || streamStatus === void 0 ? void 0 : streamStatus.status) || 'None'}`);
+            if (streamStatus && (streamStatus.status === 'running' || streamStatus.status === 'starting')) {
+                const wdaUrl = `http://127.0.0.1:${streamStatus.wdaPort}`;
+                caps.firstMatch[0]['appium:webDriverAgentUrl'] = wdaUrl;
+                // If we are reusing the WDA, we MUST NOT pass wdaLocalPort or mjpegServerPort
+                // as XCUITestDriver will still try to verify they are free and fail if busy.
+                delete caps.firstMatch[0]['appium:wdaLocalPort'];
+                delete caps.firstMatch[0]['appium:mjpegServerPort'];
+                if (caps.alwaysMatch) {
+                    delete caps.alwaysMatch['appium:wdaLocalPort'];
+                    delete caps.alwaysMatch['appium:mjpegServerPort'];
+                }
+                logger_1.default.info(`[Xenon] 🚀 Optimization: Reusing active WDA tunnel at ${wdaUrl} for ${freeDevice.udid}. Port check bypassed.`);
+            }
+        }
+        catch (e) {
+            logger_1.default.warn(`[Xenon] ⚠️ Failed to check Stream Service: ${e.message}`);
+        }
+        // Senior Resiliency: Inject higher defaults for WebDriverAgent in enterprise environments
+        if (!isCapabilityAlreadyPresent(caps, 'appium:wdaLaunchTimeout')) {
+            // 180s is safer for physical devices that might need WDA signing/installation
+            caps.firstMatch[0]['appium:wdaLaunchTimeout'] = 180000;
+        }
+        if (!isCapabilityAlreadyPresent(caps, 'appium:wdaConnectionTimeout')) {
+            // 120s is safer for remote devices
+            caps.firstMatch[0]['appium:wdaConnectionTimeout'] = 120000;
+        }
+        const deleteMatch = [
+            'appium:wdaLocalPort',
+            'appium:mjpegServerPort',
+            'appium:udid',
+            'appium:deviceName',
+            'platformName',
+        ];
+        deleteMatch.forEach((value) => deleteAlwaysMatch(caps, value));
+    });
+}
+function getXenonCapabilities(caps) {
+    const mergedCapabilites = Object.assign({}, caps.firstMatch[0], caps.alwaysMatch);
+    const getAnyCap = (snake, camel) => {
+        // Principal Intelligence: Strict Prefix Resolution
+        // Supports only xe:, appium: and no-prefix, with snake_case and camelCase fallbacks.
+        const prefixes = ['xe:', 'appium:', ''];
+        const names = [snake, camel];
+        for (const prefix of prefixes) {
+            for (const name of names) {
+                const key = prefix ? `${prefix}${name}` : name;
+                if (mergedCapabilites[key] !== undefined)
+                    return mergedCapabilites[key];
+            }
+        }
+        return undefined;
+    };
+    const capabilities = {};
+    // Normalize all essential capabilities to standard snake_case keys used by the plugin
+    // 1. Video Recording
+    const videoCap = getAnyCap(XENON_CAPABILITIES.VIDEO_RECORDING, XENON_CAPABILITIES.RECORD_VIDEO);
+    capabilities[XENON_CAPABILITIES.VIDEO_RECORDING] =
+        videoCap !== undefined ? String(videoCap) === 'true' : true;
+    // 2. Screenshot on Failure
+    const screenCapOnFail = getAnyCap(XENON_CAPABILITIES.SCREENSHOT_ON_FAILURE, XENON_CAPABILITIES.SCREENSHOT_ON_FAIL);
+    capabilities[XENON_CAPABILITIES.SCREENSHOT_ON_FAILURE] =
+        screenCapOnFail !== undefined ? String(screenCapOnFail) === 'true' : true;
+    // 3. Screenshot on Every Command
+    const screenCapEvery = getAnyCap(XENON_CAPABILITIES.SCREENSHOT_ON_EVERY_COMMAND, XENON_CAPABILITIES.SCREENSHOT_EVERY_COMMAND);
+    capabilities[XENON_CAPABILITIES.SCREENSHOT_ON_EVERY_COMMAND] = String(screenCapEvery) === 'true';
+    // 4. Save Logs
+    const logsCap = getAnyCap(XENON_CAPABILITIES.SAVE_LOGS, XENON_CAPABILITIES.SAVE_DEVICE_LOGS);
+    capabilities[XENON_CAPABILITIES.SAVE_DEVICE_LOGS] = String(logsCap) === 'true';
+    // 5. Build and Session Names
+    capabilities[XENON_CAPABILITIES.BUILD_NAME] = getAnyCap(XENON_CAPABILITIES.BUILD_NAME, 'buildName');
+    capabilities[XENON_CAPABILITIES.SESSION_NAME] = getAnyCap(XENON_CAPABILITIES.SESSION_NAME, 'sessionName');
+    // 6. Network Profile
+    capabilities[XENON_CAPABILITIES.NETWORK_PROFILE] = getAnyCap(XENON_CAPABILITIES.NETWORK_PROFILE, 'networkProfile');
+    // 7. Isolation Profile
+    capabilities[XENON_CAPABILITIES.ISOLATION_PROFILE] = getAnyCap(XENON_CAPABILITIES.ISOLATION_PROFILE, 'isolationProfile');
+    logger_1.default.debug('[CapabilityManager] Resolved Capabilities: ' +
+        `Video=${capabilities[XENON_CAPABILITIES.VIDEO_RECORDING]}, ` +
+        `EveryScreenshot=${capabilities[XENON_CAPABILITIES.SCREENSHOT_ON_EVERY_COMMAND]}, ` +
+        `FailScreenshot=${capabilities[XENON_CAPABILITIES.SCREENSHOT_ON_FAILURE]}, ` +
+        `SaveLogs=${capabilities[XENON_CAPABILITIES.SAVE_DEVICE_LOGS]}`);
+    return capabilities;
+}

package/lib/src/app/index.js

@@ -0,0 +1,167 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 });
+exports.createRouter = createRouter;
+const express_1 = __importDefault(require("express"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const pluginArgs_1 = require("../data-service/pluginArgs");
+const cors_1 = __importDefault(require("cors"));
+const async_lock_1 = __importDefault(require("async-lock"));
+const InternalHttpClient_1 = require("../InternalHttpClient");
+const config_1 = require("../config");
+const logger_1 = __importStar(require("../logger"));
+const dashboard_1 = __importDefault(require("./routers/dashboard"));
+const grid_1 = __importDefault(require("./routers/grid"));
+const control_1 = __importDefault(require("./routers/control"));
+const apps_1 = __importDefault(require("./routers/apps"));
+const webhook_1 = __importDefault(require("./routers/webhook"));
+const reservation_1 = __importDefault(require("./routers/reservation"));
+const config_2 = __importDefault(require("./routers/config"));
+const swagger_1 = require("./swagger");
+const typedi_1 = require("typedi");
+const dashboardPluginUrl = null;
+const ASYNC_LOCK = new async_lock_1.default();
+const router = express_1.default.Router(), apiRouter = express_1.default.Router(), staticFilesRouter = express_1.default.Router();
+router.use((0, cors_1.default)());
+apiRouter.use((0, cors_1.default)());
+staticFilesRouter.use((0, cors_1.default)());
+apiRouter.use((req, res, next) => {
+    // Defensive Body Parsing Logic:
+    // In some Appium versions, the global HTTP logger or other middleware drains the request stream
+    // before it reaches the plugin. Re-calling express.json() on a drained stream throws
+    // 'InternalServerError: stream is not readable'.
+    // 1. If body is already an object (parsed by parent), proceed.
+    if (req.body && typeof req.body === 'object' && Object.keys(req.body).length > 0) {
+        return next();
+    }
+    // 2. If stream is already spent and nothing was parsed, we can't do much, just proceed gracefully.
+    if (!req.readable) {
+        logger_1.default.debug(`[Xenon] Stream drained for ${req.method} ${req.originalUrl}. Skipping local body-parser.`);
+        return next();
+    }
+    // 3. Otherwise, try safe parsing.
+    express_1.default.json()(req, res, (err) => {
+        if (err) {
+            logger_1.default.warn(`[Xenon] Body parsing failed for ${req.originalUrl}: ${err.message}`);
+            // Continue without failing - handlers will validate missing body
+            return next();
+        }
+        next();
+    });
+});
+apiRouter.use((req, res, next) => {
+    res.setHeader('Cache-Control', 'no-store, no-cache, must-revalidate, proxy-revalidate');
+    res.setHeader('Pragma', 'no-cache');
+    res.setHeader('Expires', '0');
+    // Redact secrets from request body to prevent them from leaking into external logs
+    if (req.body && typeof req.body === 'object') {
+        req.body = (0, logger_1.redactSecrets)(req.body);
+    }
+    next();
+});
+// Dashboard state cache - runs once and persists
+let dashboardPluginPromise = null;
+apiRouter.use((req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    if (dashboardPluginPromise === null) {
+        dashboardPluginPromise = (() => __awaiter(void 0, void 0, void 0, function* () {
+            const pingurl = `${req.protocol}://${req.get('host')}/dashboard/api/ping`;
+            try {
+                const response = yield InternalHttpClient_1.InternalHttpClient.get(pingurl, { silent: true });
+                return response['pong'] ? `${req.protocol}://${req.get('host')}/dashboard` : '';
+            }
+            catch (err) {
+                return '';
+            }
+        }))();
+    }
+    req['dashboard-plugin-url'] = yield dashboardPluginPromise;
+    return next();
+}));
+apiRouter.get('/cliArgs', (req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    res.json(yield (0, pluginArgs_1.getCLIArgs)());
+}));
+apiRouter.get('/metrics', (req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const { MetricsService } = yield Promise.resolve().then(() => __importStar(require('../services/MetricsService')));
+    const metrics = yield typedi_1.Container.get(MetricsService).getMetrics();
+    res.set('Content-Type', 'text/plain');
+    res.send(metrics);
+}));
+const publicPath = [path_1.default.join(__dirname, '..', 'public'), path_1.default.join(__dirname, '..', '..', 'public')].find((p) => fs_1.default.existsSync(p)) || path_1.default.join(__dirname, '..', '..', 'public');
+staticFilesRouter.use(express_1.default.static(publicPath));
+router.use('/api', apiRouter);
+router.use('/assets', express_1.default.static(config_1.config.sessionAssetsPath));
+router.use(staticFilesRouter);
+function createRouter(pluginArgs) {
+    dashboard_1.default.register(apiRouter);
+    grid_1.default.register(apiRouter, pluginArgs);
+    control_1.default.register(apiRouter);
+    apps_1.default.register(apiRouter);
+    webhook_1.default.register(apiRouter);
+    config_2.default.register(apiRouter, pluginArgs);
+    apiRouter.use('/reservation', reservation_1.default);
+    // Setup Swagger API documentation at /xenon/api-docs
+    try {
+        (0, swagger_1.setupSwagger)(router, '/xenon');
+    }
+    catch (err) {
+        logger_1.default.warn('Swagger documentation not available. Install swagger-jsdoc and swagger-ui-express to enable.');
+    }
+    // Handle unmatched API routes with a 404 JSON response instead of the UI fallback
+    apiRouter.use('*', (req, res) => {
+        res.status(404).json({
+            error: true,
+            message: `API endpoint ${req.method} ${req.originalUrl} not found`,
+        });
+    });
+    // Fallback route for client-side routing - serve index.html for all non-API routes
+    // MUST be registered after Swagger to avoid interception
+    router.get(/^(?!\/api).*/, (req, res) => {
+        res.sendFile(path_1.default.join(publicPath, 'index.html'));
+    });
+    return router;
+}