@xenon-device-management/xenon 1.1.0

package/lib/src/device-managers/ios/IOSDiscoveryService.js

@@ -0,0 +1,268 @@
+"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 __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;
+};
+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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+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.IOSDiscoveryService = void 0;
+const node_simctl_1 = __importDefault(require("node-simctl"));
+const lodash_1 = require("lodash");
+const appium_ios_device_1 = require("appium-ios-device");
+const helpers_1 = require("../../helpers");
+const logger_1 = __importDefault(require("../../logger"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const device_utils_1 = require("../../device-utils");
+const device_store_1 = require("../../data-service/device-store");
+const PluginContext_1 = require("../../PluginContext");
+const typedi_1 = require("typedi");
+const Devices_1 = __importDefault(require("../cloud/Devices"));
+const NodeDevices_1 = __importDefault(require("../NodeDevices"));
+const device_service_1 = require("../../data-service/device-service");
+const iOSTracker_1 = require("../iOSTracker");
+let IOSDiscoveryService = class IOSDiscoveryService {
+    constructor(context) {
+        this.context = context;
+        this.log = logger_1.default.scope('IOSDiscovery');
+        this.trackingInitialized = false;
+    }
+    get pluginArgs() {
+        return this.context.pluginArgs;
+    }
+    get hostPort() {
+        return this.context.port;
+    }
+    get nodeId() {
+        return this.context.nodeId;
+    }
+    getDevices(deviceTypes, existingDeviceDetails) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (deviceTypes.iosDeviceType === 'real') {
+                return (0, lodash_1.flatten)(yield Promise.all([this.getRealDevices(existingDeviceDetails)]));
+            }
+            else if (deviceTypes.iosDeviceType === 'simulated') {
+                return yield this.getSimulators();
+            }
+            else {
+                return (0, lodash_1.flatten)(yield Promise.all([this.getRealDevices(existingDeviceDetails), this.getSimulators()]));
+            }
+        });
+    }
+    getConnectedDevices() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield appium_ios_device_1.utilities.getConnectedDevices();
+            }
+            catch (error) {
+                this.log.error(error);
+                return [];
+            }
+        });
+    }
+    getRealDevices(existingDeviceDetails) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            let deviceState = [];
+            if ((_a = this.pluginArgs.cloud) === null || _a === void 0 ? void 0 : _a.cloudName) {
+                const cloud = new Devices_1.default(this.pluginArgs.cloud, deviceState, 'ios');
+                return yield cloud.getDevices();
+            }
+            else {
+                deviceState = yield this.fetchLocalIOSDevices(existingDeviceDetails);
+            }
+            return deviceState.filter((device) => device.realDevice === true);
+        });
+    }
+    fetchLocalIOSDevices(existingDeviceDetails) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (process.env.NODE_ENV === 'test') {
+                console.log('[POISON PILL] REAL fetchLocalIOSDevices CALLED IN TEST MODE!');
+            }
+            const devices = yield this.getConnectedDevices();
+            const deviceProcessingPromises = devices.map((udid) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const existingDevice = existingDeviceDetails.find((device) => device.udid === udid);
+                    if (existingDevice) {
+                        return Object.assign({}, existingDevice);
+                    }
+                    else {
+                        return yield this.getDeviceInfo(udid);
+                    }
+                }
+                catch (e) {
+                    this.log.error(`Failed to initialize iOS device ${udid}: ${e.message}`);
+                    return null;
+                }
+            }));
+            const deviceState = (yield Promise.all(deviceProcessingPromises)).filter((d) => d !== null);
+            if (!this.trackingInitialized && process.env.NODE_ENV !== 'test') {
+                this.trackIOSDevices();
+            }
+            return deviceState;
+        });
+    }
+    getDeviceInfo(udid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const store = device_store_1.DeviceStoreFactory.getStore();
+            const storeDevice = yield store.findDevice({ udid });
+            const host = this.pluginArgs.remoteMachineProxyIP
+                ? String(this.pluginArgs.remoteMachineProxyIP)
+                : `http://${this.pluginArgs.bindHostOrIp}:${this.hostPort}`;
+            const wdaLocalPort = (storeDevice === null || storeDevice === void 0 ? void 0 : storeDevice.wdaLocalPort) || (yield (0, helpers_1.getFreePort)());
+            const mjpegServerPort = (storeDevice === null || storeDevice === void 0 ? void 0 : storeDevice.mjpegServerPort) || (yield (0, helpers_1.getFreePort)());
+            const totalUtilizationTimeMilliSec = yield (0, device_utils_1.getUtilizationTime)(udid);
+            let sdk = 'Unknown';
+            let name = 'iPhone';
+            let ip = '';
+            try {
+                [sdk, name] = yield Promise.all([appium_ios_device_1.utilities.getOSVersion(udid), appium_ios_device_1.utilities.getDeviceName(udid)]);
+                // Principal Intelligence: Fetch network IP for health resilience
+                const goIOSDir = (0, helpers_1.cachePath)('goIOS');
+                const goIOSPath = path_1.default.join(goIOSDir, 'ios');
+                if (fs_extra_1.default.existsSync(goIOSPath)) {
+                    const { exec } = yield Promise.resolve().then(() => __importStar(require('child_process')));
+                    const { promisify } = yield Promise.resolve().then(() => __importStar(require('util')));
+                    const execPromise = promisify(exec);
+                    try {
+                        const { stdout } = yield execPromise(`"${goIOSPath}" info --udid ${udid}`, {
+                            env: Object.assign(Object.assign({}, process.env), { ENABLE_GO_IOS_AGENT: 'yes' }),
+                        });
+                        const info = JSON.parse(stdout);
+                        ip = info.IPAddress || '';
+                    }
+                    catch (e) {
+                        logger_1.default.debug(`Failed to fetch IP via go-ios for ${udid}: ${e}`);
+                    }
+                }
+            }
+            catch (e) {
+                this.log.error(`Metadata discovery failed for ${udid}: ${e.message}`);
+            }
+            return Object.assign({ wdaLocalPort,
+                mjpegServerPort,
+                udid,
+                sdk,
+                name,
+                ip, busy: false, realDevice: true, deviceType: 'real', platform: (name.toLowerCase().includes('tv') ? 'tvos' : 'ios'), host: host, totalUtilizationTimeMilliSec, sessionStartTime: 0, state: (storeDevice === null || storeDevice === void 0 ? void 0 : storeDevice.state) || 'Unknown', userBlocked: (storeDevice === null || storeDevice === void 0 ? void 0 : storeDevice.userBlocked) || false }, (storeDevice || {}));
+        });
+    }
+    getSimulators() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const simulators = yield this.fetchLocalSimulators();
+            simulators.sort((a, b) => (a.state > b.state ? 1 : -1));
+            if (this.pluginArgs.hub !== undefined) {
+                const nodeDevices = new NodeDevices_1.default(this.pluginArgs.hub, this.pluginArgs.tlsRejectUnauthorized);
+                yield nodeDevices.postDevicesToHub(simulators, 'add');
+            }
+            return simulators;
+        });
+    }
+    fetchLocalSimulators() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (process.env.NODE_ENV === 'test') {
+                console.log('[POISON PILL] REAL fetchLocalSimulators CALLED IN TEST MODE!');
+            }
+            const simctl = new node_simctl_1.default();
+            const list = yield simctl.list();
+            // Log unavailable runtimes
+            list.runtimes
+                .filter((r) => !r.isAvailable)
+                .forEach((r) => this.log.error(`Runtime not available: ${r.name}`));
+            const iosSims = (0, lodash_1.flatten)(Object.values((yield simctl.getDevicesByParsing('iOS'))));
+            const tvosSims = (0, lodash_1.flatten)(Object.values((yield simctl.getDevicesByParsing('tvOS'))));
+            let simulators = [...iosSims, ...tvosSims];
+            if (this.pluginArgs.bootedSimulators) {
+                simulators = simulators.filter((d) => d.state === 'Booted');
+            }
+            const localPluginArgs = this.pluginArgs;
+            if (localPluginArgs.simulators && localPluginArgs.simulators.length > 0) {
+                const allowedSimulators = localPluginArgs.simulators;
+                simulators = simulators.filter((d) => allowedSimulators.some((s) => d.name === s.name && d.sdk === s.sdk));
+            }
+            return yield Promise.all(simulators.map((d) => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                return (Object.assign(Object.assign({}, d), { wdaLocalPort: yield (0, helpers_1.getFreePort)(), mjpegServerPort: yield (0, helpers_1.getFreePort)(), busy: false, realDevice: false, platform: (((_a = d.name) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes('tv')) ? 'tvos' : 'ios'), deviceType: 'simulator', host: `http://${this.pluginArgs.bindHostOrIp}:${this.hostPort}`, totalUtilizationTimeMilliSec: yield (0, device_utils_1.getUtilizationTime)(d.udid), sessionStartTime: 0 }));
+            })));
+        });
+    }
+    trackIOSDevices() {
+        if (this.trackingInitialized)
+            return;
+        this.trackingInitialized = true;
+        const tracker = typedi_1.Container.get(iOSTracker_1.IosTracker).getListener();
+        tracker.on('attached', (udid) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const device = Object.assign(Object.assign({}, (yield this.getDeviceInfo(udid))), { nodeId: this.nodeId });
+                if (this.pluginArgs.hub) {
+                    yield new NodeDevices_1.default(this.pluginArgs.hub, this.pluginArgs.tlsRejectUnauthorized).postDevicesToHub([device], 'add');
+                }
+                yield (0, device_service_1.addNewDevice)([device], this.pluginArgs.bindHostOrIp);
+            }
+            catch (e) {
+                this.log.error(`Attach failed for ${udid}: ${e.message}`);
+            }
+        }));
+        tracker.on('detached', (udid) => __awaiter(this, void 0, void 0, function* () {
+            const deviceRemoved = [{ udid, host: this.pluginArgs.bindHostOrIp }];
+            if (this.pluginArgs.hub) {
+                yield new NodeDevices_1.default(this.pluginArgs.hub, this.pluginArgs.tlsRejectUnauthorized).postDevicesToHub(deviceRemoved, 'remove');
+            }
+            yield (0, device_service_1.removeDevice)(deviceRemoved);
+        }));
+    }
+};
+exports.IOSDiscoveryService = IOSDiscoveryService;
+exports.IOSDiscoveryService = IOSDiscoveryService = __decorate([
+    (0, typedi_1.Service)(),
+    __metadata("design:paramtypes", [PluginContext_1.PluginContext])
+], IOSDiscoveryService);