@xenon-device-management/xenon 2.0.0 → 2.1.0

package/lib/src/proxy/wd-command-proxy.js

@@ -1,221 +0,0 @@
-"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.addProxyHandler = addProxyHandler;
-exports.removeProxyHandler = removeProxyHandler;
-exports.registerProxyMiddlware = registerProxyMiddlware;
-const https_proxy_agent_1 = require("https-proxy-agent");
-const http_proxy_agent_1 = require("http-proxy-agent");
-const http_proxy_middleware_1 = require("http-proxy-middleware");
-const device_service_1 = require("../data-service/device-service");
-const axios_1 = __importDefault(require("axios"));
-const logger_1 = __importDefault(require("../logger"));
-const helpers_1 = require("../helpers");
-const SessionManager_1 = require("../sessions/SessionManager");
-const event_manager_1 = require("../dashboard/event-manager");
-const base_driver_1 = require("@appium/base-driver");
-const typedi_1 = require("typedi");
-const remoteProxyMap = new Map();
-const remoteHostMap = new Map();
-function getProxyServer() {
-    return process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
-}
-function addProxyHandler(sessionId, remoteHost) {
-    const proxyServer = getProxyServer();
-    const targetBasePath = new URL(remoteHost).pathname;
-    const config = {
-        target: new URL(remoteHost).origin,
-        changeOrigin: true,
-        pathRewrite: (path, _req) => {
-            const newPath = `${targetBasePath}/${path}`;
-            return newPath;
-        },
-        on: {
-            proxyReq: http_proxy_middleware_1.fixRequestBody,
-            proxyRes: (_proxyRes, _req, _res) => {
-                // log.debug(`proxyRes host: ${req.headers.host} method: ${req.method}  path: ${req.url}`);
-            },
-            error: (err, _req, _res) => {
-                var _a;
-                logger_1.default.error('proxy handler error: ', err.message, ' data: ', (_a = err.response) === null || _a === void 0 ? void 0 : _a.data);
-            },
-        },
-    };
-    if (proxyServer) {
-        //log.info(`Added proxy to createProxyMiddleware: ${JSON.stringify(proxyServer)}`);
-        config.agent = new https_proxy_agent_1.HttpsProxyAgent(proxyServer);
-    }
-    logger_1.default.info(`Creating remote proxy for session ${sessionId} to ${remoteHost}`);
-    remoteProxyMap.set(sessionId, (0, http_proxy_middleware_1.createProxyMiddleware)(config));
-    remoteHostMap.set(sessionId, remoteHost);
-}
-function removeProxyHandler(sessionId) {
-    remoteProxyMap.delete(sessionId);
-}
-function getSessionIdFromUrl(url) {
-    const SESSION_ID_PATTERN = /\/session\/([^/]+)/;
-    const match = SESSION_ID_PATTERN.exec(url);
-    if (match) {
-        return match[1];
-    }
-    return null;
-}
-function handler(cliArgs) {
-    const WEBDRIVER_BASE_PATH = (cliArgs['basePath'] || '').replace(/\/$/, '') + '/session';
-    const isHub = !(0, helpers_1.hasHubArgument)(cliArgs); //if hub cliArg is provided, then current appium process serves as a NODE
-    return (req, res, next) => __awaiter(this, void 0, void 0, function* () {
-        if (new RegExp(/wd-internal\//).test(req.url)) {
-            req.url = req.originalUrl = req.url.replace('wd-internal/', '');
-            return next();
-        }
-        if (isHub && !req.path.startsWith(WEBDRIVER_BASE_PATH)) {
-            logger_1.default.debug(`Received non-webdriver request with url ${req.path}. So, not proxying it to downstream.`);
-            return next();
-        }
-        const sessionId = getSessionIdFromUrl(req.url);
-        const proxyServer = getProxyServer();
-        if (!sessionId) {
-            return next();
-        }
-        yield (0, device_service_1.updateCmdExecutedTime)(sessionId);
-        req.headers['accept-encoding'] = 'deflate';
-        const shouldInterceptRequest = isHub && !!SessionManager_1.SESSION_MANAGER.isValidSession(sessionId);
-        const commandName = (0, base_driver_1.routeToCommandName)(req.path, req.method, cliArgs['basePath']);
-        // Always intercept DELETE requests to ensure onSessionStoped is called
-        if (req.method === 'DELETE' || shouldInterceptRequest) {
-            logger_1.default.info(`Intercepting ${req.method} request for session ${sessionId}, shouldInterceptRequest: ${shouldInterceptRequest}`);
-            if (shouldInterceptRequest) {
-                const shouldProceed = yield event_manager_1.DASHBORD_EVENT_MANAGER.beforeSessionCommand(sessionId, commandName, req, res);
-                if (!shouldProceed) {
-                    return;
-                }
-            }
-            interceptResponse(sessionId, commandName, req, res);
-        }
-        // Principal Intelligence: Virtualized Network Conditioning (Latency Injection)
-        try {
-            const { NetworkConditioningService } = yield Promise.resolve().then(() => __importStar(require('../services/NetworkConditioningService')));
-            const latency = typedi_1.Container.get(NetworkConditioningService).getLatency(sessionId);
-            if (latency > 0) {
-                logger_1.default.debug(`⏳ Network Conditioning: Delaying command by ${latency}ms for session ${sessionId}`);
-                yield new Promise((resolve) => setTimeout(resolve, latency));
-            }
-        }
-        catch (e) {
-            /* ignore */
-        }
-        if (remoteProxyMap.has(sessionId)) {
-            if (proxyServer) {
-                const response = yield (0, axios_1.default)({
-                    method: req.method,
-                    url: new URL(req.path, new URL(remoteHostMap.get(sessionId)).origin).toString(),
-                    data: req.body,
-                    params: req.query,
-                    validateStatus: () => true,
-                    httpsAgent: new https_proxy_agent_1.HttpsProxyAgent(proxyServer),
-                    httpAgent: new http_proxy_agent_1.HttpProxyAgent(proxyServer),
-                    proxy: false,
-                });
-                res.status(response.status).json(response.data);
-            }
-            else {
-                remoteProxyMap.get(sessionId)(req, res, next);
-            }
-            if (req.method === 'DELETE') {
-                logger_1.default.info(`📱 Unblocking the device that is blocked for session ${sessionId} in remote machine`);
-                (0, device_service_1.unblockDeviceMatchingFilter)({ session_id: sessionId });
-                removeProxyHandler(sessionId);
-            }
-        }
-        else {
-            next();
-        }
-    });
-}
-function interceptResponse(sessionId, commandName, req, res) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const [originalWrite, originalEnd] = [res.write, res.end];
-        const chunks = [];
-        res.write = function (...args) {
-            chunks.push(typeof args[0] === 'string' ? Buffer.from(args[0]) : args[0]);
-            originalWrite.apply(res, args);
-        };
-        res.end = function (...args) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (args[0]) {
-                    chunks.push(typeof args[0] === 'string' ? Buffer.from(args[0]) : args[0]);
-                }
-                const body = Buffer.concat(chunks).toString('utf8');
-                if (req.method === 'DELETE') {
-                    logger_1.default.info(`🔴 DELETE request intercepted for ${sessionId}`);
-                }
-                else {
-                    yield event_manager_1.DASHBORD_EVENT_MANAGER.afterSessionCommand(sessionId, commandName, null, req, res, body);
-                }
-                originalEnd.apply(res, args);
-            });
-        };
-    });
-}
-function registerProxyMiddlware(expressApp, cliArgs) {
-    logger_1.default.info('Registering proxy middleware');
-    // Ensure the router and stack exist; plugin code may be loaded before routes are added
-    if (!expressApp || !expressApp._router || !Array.isArray(expressApp._router.stack)) {
-        logger_1.default.info('Express app router not initialized yet; attaching proxy as a normal middleware');
-        expressApp.use('/', handler(cliArgs));
-        return;
-    }
-    const index = expressApp._router.stack.findIndex((s) => s.route);
-    expressApp.use('/', handler(cliArgs));
-    // If index is not found, just push to the stack
-    if (index === -1) {
-        expressApp._router.stack.push(expressApp._router.stack.pop());
-    }
-    else {
-        expressApp._router.stack.splice(index, 0, expressApp._router.stack.pop());
-    }
-}