nativescript 8.8.0 → 8.8.1

package/lib/common/mobile/device-log-provider.js

@@ -36,6 +36,7 @@ class DeviceLogProvider extends device_log_provider_base_1.DeviceLogProviderBase
         this.colorPoolIndex = 0;
     }
     logData(lineText, platform, deviceIdentifier) {
+        // console.log(lineText)
         const loggingOptions = this.getDeviceLogOptionsForDevice(deviceIdentifier);
         let data = this.$logFilter.filterData(platform, lineText, loggingOptions);
         data = this.$logSourceMapService.replaceWithOriginalFileLocations(platform, data, loggingOptions);
@@ -53,6 +54,7 @@ class DeviceLogProvider extends device_log_provider_base_1.DeviceLogProviderBase
             return this.deviceColorMap.get(deviceIdentifier);
         }
         const color = this.colorPool[this.colorPoolIndex];
+        // wrap around if we have no more colors in the pool
         this.colorPoolIndex =
             this.colorPoolIndex === this.colorPool.length - 1
                 ? 0
@@ -62,10 +64,13 @@ class DeviceLogProvider extends device_log_provider_base_1.DeviceLogProviderBase
     }
     logDataCore(data, deviceIdentifier) {
         var _a, _b, _c;
+        // todo: use config to set logger - --env.classicLogs is temporary!
         if ("classicLogs" in ((_a = this.$options.env) !== null && _a !== void 0 ? _a : {})) {
+            // legacy logging
             this.$logger.info(data, { [constants_2.LoggerConfigData.skipNewLine]: true });
             return;
         }
+        // todo: extract into an injectable printer/logger service
         let shouldPrepend = false;
         let splitIndexes = [];
         const lines = data
@@ -120,7 +125,25 @@ class DeviceLogProvider extends device_log_provider_base_1.DeviceLogProviderBase
     printLine(prefix, ...parts) {
         const fullLine = parts.join(" ");
         console.log(prefix, fullLine);
+        /**
+         * Note: Disabled
+         *
+         * This splits the output into lines that fit within the current
+         * terminal width, however this makes copying json objects that
+         * span across multiple lines difficult, as it introduces
+         * whitespace & line breaks
+         */
+        // const maxWidth = process.stdout.columns - 2;
+        // if (!maxWidth || maxWidth < 10 || fullLine.length < maxWidth) {
+        // 	console.log(prefix, fullLine);
+        // } else {
+        // 	for (let i = 0; i < fullLine.length; i += maxWidth) {
+        // 		const part = fullLine.substring(i, i + maxWidth);
+        // 		console.log(prefix, part);
+        // 	}
+        // }
     }
 }
 exports.DeviceLogProvider = DeviceLogProvider;
 yok_1.injector.register("deviceLogProvider", DeviceLogProvider);
+//# sourceMappingURL=device-log-provider.js.map

package/lib/common/mobile/device-platforms-constants.js

@@ -20,3 +20,4 @@ class DevicePlatformsConstants {
 }
 exports.DevicePlatformsConstants = DevicePlatformsConstants;
 yok_1.injector.register("devicePlatformsConstants", DevicePlatformsConstants);
+//# sourceMappingURL=device-platforms-constants.js.map

package/lib/common/mobile/emulator-helper.js

@@ -6,7 +6,9 @@ const _ = require("lodash");
 const yok_1 = require("../yok");
 class EmulatorHelper {
     constructor() {
+        // https://developer.android.com/guide/topics/manifest/uses-sdk-element
         this.mapAndroidApiLevelToVersion = {
+            "android-35": "15.0.0",
             "android-34": "14.0.0",
             "android-33": "13.0.0",
             "android-32": "12.0.0",
@@ -78,7 +80,9 @@ class EmulatorHelper {
         emulator.identifier = emulatorId;
         emulator.status = constants_1.RUNNING_EMULATOR_STATUS;
         emulator.type = constants_1.DeviceTypes.Device;
+        //emulator.isTablet; // TODO: consider to do this here!!!
     }
 }
 exports.EmulatorHelper = EmulatorHelper;
 yok_1.injector.register("emulatorHelper", EmulatorHelper);
+//# sourceMappingURL=emulator-helper.js.map

package/lib/common/mobile/ios/device/ios-application-manager.js

@@ -144,9 +144,11 @@ class IOSApplicationManager extends application_manager_base_1.ApplicationManage
         });
     }
     getDebuggableApps() {
+        // Implement when we can find debuggable applications for iOS.
         return Promise.resolve([]);
     }
     getDebuggableAppViews(appIdentifiers) {
+        // Implement when we can find debuggable applications for iOS.
         return Promise.resolve(null);
     }
 }
@@ -157,3 +159,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], IOSApplicationManager.prototype, "startDeviceLog", null);
 exports.IOSApplicationManager = IOSApplicationManager;
+//# sourceMappingURL=ios-application-manager.js.map

package/lib/common/mobile/ios/device/ios-device-file-system.js

@@ -131,3 +131,4 @@ class IOSDeviceFileSystem {
 }
 IOSDeviceFileSystem.AFC_DELETE_FILE_NOT_FOUND_ERROR = 8;
 exports.IOSDeviceFileSystem = IOSDeviceFileSystem;
+//# sourceMappingURL=ios-device-file-system.js.map

package/lib/common/mobile/ios/device/ios-device-operations.js

@@ -58,6 +58,7 @@ class IOSDeviceOperations extends events_1.EventEmitter {
                 if (options && options.shouldReturnImmediateResult) {
                     return;
                 }
+                // We need this because we need to make sure that we have devices.
                 yield new Promise((resolve, reject) => {
                     let iterationsCount = 0;
                     const maxIterationsCount = 3;
@@ -154,6 +155,8 @@ class IOSDeviceOperations extends events_1.EventEmitter {
         });
     }
     dispose(signal) {
+        // We need to check if we should dispose the device lib.
+        // For example we do not want to dispose it when we start printing the device logs.
         if (this.shouldDispose && this.deviceLib) {
             this.deviceLib.removeAllListeners();
             this.deviceLib.dispose(signal);
@@ -232,3 +235,4 @@ __decorate([
 ], IOSDeviceOperations.prototype, "attacheDeviceLogDataHandler", null);
 exports.IOSDeviceOperations = IOSDeviceOperations;
 yok_1.injector.register("iosDeviceOperations", IOSDeviceOperations);
+//# sourceMappingURL=ios-device-operations.js.map

package/lib/common/mobile/ios/device/ios-device.js

@@ -122,6 +122,7 @@ class IOSDevice extends ios_device_base_1.IOSDeviceBase {
             const majorVersionAsString = productType.match(/.*?(\d+)\,(\d+)/)[1];
             const majorVersion = parseInt(majorVersionAsString);
             let isArm64Architecture = false;
+            //https://en.wikipedia.org/wiki/List_of_iOS_devices
             if (_.startsWith(productType, "iphone")) {
                 isArm64Architecture = majorVersion >= 6;
             }
@@ -132,6 +133,7 @@ class IOSDevice extends ios_device_base_1.IOSDeviceBase {
                 isArm64Architecture = majorVersion >= 7;
             }
             else if (_.startsWith(productType, "realitydevice")) {
+                // visionos
                 isArm64Architecture = true;
             }
             activeArchitecture = isArm64Architecture ? "arm64" : "armv7";
@@ -141,6 +143,7 @@ class IOSDevice extends ios_device_base_1.IOSDeviceBase {
     getPlatform(productType) {
         productType = productType.toLowerCase().trim();
         if (_.startsWith(productType, "realitydevice")) {
+            // visionos
             return this.$devicePlatformsConstants.visionOS;
         }
         return this.$devicePlatformsConstants.iOS;
@@ -151,3 +154,4 @@ __decorate([
 ], IOSDevice.prototype, "openDeviceLogStream", null);
 exports.IOSDevice = IOSDevice;
 yok_1.injector.register("iOSDevice", IOSDevice);
+//# sourceMappingURL=ios-device.js.map

package/lib/common/mobile/ios/ios-device-base.js

@@ -106,3 +106,4 @@ __decorate([
     (0, decorators_1.performanceLog)()
 ], IOSDeviceBase.prototype, "getDebugSocket", null);
 exports.IOSDeviceBase = IOSDeviceBase;
+//# sourceMappingURL=ios-device-base.js.map

package/lib/common/mobile/ios/ios-device-product-name-mapper.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const yok_1 = require("../../yok");
 class IosDeviceProductNameMapper {
     constructor() {
+        // http://support.hockeyapp.net/kb/client-integration-ios-mac-os-x/ios-device-types
         this.map = {
             "iPhone1,1": "iPhone",
             "iPhone1,2": "iPhone 3G",
@@ -63,3 +64,4 @@ class IosDeviceProductNameMapper {
     }
 }
 yok_1.injector.register("iOSDeviceProductNameMapper", IosDeviceProductNameMapper);
+//# sourceMappingURL=ios-device-product-name-mapper.js.map

package/lib/common/mobile/ios/ios-log-filter.js

@@ -22,3 +22,4 @@ class IOSLogFilter {
 }
 exports.IOSLogFilter = IOSLogFilter;
 yok_1.injector.register("iOSLogFilter", IOSLogFilter);
+//# sourceMappingURL=ios-log-filter.js.map

package/lib/common/mobile/ios/simulator/ios-emulator-services.js

@@ -28,6 +28,7 @@ class IosEmulatorServices {
             try {
                 if (options.platform === this.$devicePlatformsConstants.visionOS &&
                     !options.emulatorIdOrName) {
+                    // find first available visionOS simulator (for now).
                     const { devices } = yield this.tryGetiOSSimDevices();
                     options.emulatorIdOrName = (_a = devices.find((device) => device.platform === this.$devicePlatformsConstants.visionOS)) === null || _a === void 0 ? void 0 : _a.id;
                 }
@@ -73,6 +74,8 @@ class IosEmulatorServices {
     connectToPort(data) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                // node v17+ resolves localhost to ::1 (ipv6) instead of 127.0.0.1 (ipv4)
+                // so we explicitly pass ipv4
                 const socket = net.connect(data.port, "127.0.0.1");
                 return socket;
             }
@@ -137,3 +140,4 @@ class IosEmulatorServices {
     }
 }
 yok_1.injector.register("iOSEmulatorServices", IosEmulatorServices);
+//# sourceMappingURL=ios-emulator-services.js.map

package/lib/common/mobile/ios/simulator/ios-sim-resolver.js

@@ -21,3 +21,4 @@ IOSSimResolver.iOSSimName = "ios-sim-portable";
 IOSSimResolver.iOSStandaloneExecutableName = "ios-sim-standalone.js";
 exports.IOSSimResolver = IOSSimResolver;
 yok_1.injector.register("iOSSimResolver", IOSSimResolver);
+//# sourceMappingURL=ios-sim-resolver.js.map

package/lib/common/mobile/ios/simulator/ios-simulator-application-manager.js

@@ -95,9 +95,14 @@ class IOSSimulatorApplicationManager extends application_manager_base_1.Applicat
     }
     getDebuggableAppViews(appIdentifiers) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Implement when we can find debuggable applications for iOS.
             return Promise.resolve(null);
         });
     }
+    // iOS will kill the app if we freeze it in the NativeScript Runtime and wait for debug-brk.
+    // In order to avoid that, we are attaching lldb and passing it "process continue".
+    // In this way, iOS will not kill the app because it has a native debugger attached
+    // and the users will be able to attach a debug session using the debug-brk flag.
     attachNativeDebugger(appId, pid) {
         this._lldbProcesses[appId] = this.$childProcess.spawn("lldb", ["-p", pid]);
         if (log4js.levels.TRACE.isGreaterThanOrEqualTo(this.$logger.getLevel())) {
@@ -145,3 +150,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], IOSSimulatorApplicationManager.prototype, "startDeviceLog", null);
 exports.IOSSimulatorApplicationManager = IOSSimulatorApplicationManager;
+//# sourceMappingURL=ios-simulator-application-manager.js.map

package/lib/common/mobile/ios/simulator/ios-simulator-device.js

@@ -80,11 +80,15 @@ class IOSSimulator extends ios_device_base_1.IOSDeviceBase {
             let socket;
             const attachRequestMessage = this.$iOSNotification.getAttachRequest(appId, this.deviceInfo.identifier);
             yield this.$iOSEmulatorServices.postDarwinNotification(attachRequestMessage, this.deviceInfo.identifier);
+            // Retry posting the notification every five seconds, in case the AttachRequest
+            // event handler wasn't registered when the first one was sent
             const postNotificationRetryInterval = setInterval(() => {
                 this.$iOSEmulatorServices
                     .postDarwinNotification(attachRequestMessage, this.deviceInfo.identifier)
                     .catch((e) => this.$logger.error(e));
             }, 5e3);
+            // the internal retry-mechanism of getDebuggerPort will ensure the above
+            // interval has a chance to execute multiple times
             const port = yield _super.getDebuggerPort.call(this, appId).finally(() => {
                 clearInterval(postNotificationRetryInterval);
             });
@@ -104,3 +108,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], IOSSimulator.prototype, "openDeviceLogStream", null);
 exports.IOSSimulator = IOSSimulator;
+//# sourceMappingURL=ios-simulator-device.js.map

package/lib/common/mobile/ios/simulator/ios-simulator-file-system.js

@@ -79,3 +79,4 @@ class IOSSimulatorFileSystem {
     }
 }
 exports.IOSSimulatorFileSystem = IOSSimulatorFileSystem;
+//# sourceMappingURL=ios-simulator-file-system.js.map

package/lib/common/mobile/ios/simulator/ios-simulator-log-provider.js

@@ -67,3 +67,4 @@ class IOSSimulatorLogProvider extends events_1.EventEmitter {
 }
 exports.IOSSimulatorLogProvider = IOSSimulatorLogProvider;
 yok_1.injector.register("iOSSimulatorLogProvider", IOSSimulatorLogProvider);
+//# sourceMappingURL=ios-simulator-log-provider.js.map

package/lib/common/mobile/local-to-device-path-data-factory.js

@@ -35,3 +35,4 @@ class LocalToDevicePathDataFactory {
 }
 exports.LocalToDevicePathDataFactory = LocalToDevicePathDataFactory;
 yok_1.injector.register("localToDevicePathDataFactory", LocalToDevicePathDataFactory);
+//# sourceMappingURL=local-to-device-path-data-factory.js.map

package/lib/common/mobile/log-filter.js

@@ -24,6 +24,7 @@ class LogFilter {
         if (deviceLogFilter) {
             return deviceLogFilter.filterData(data, loggingOptions);
         }
+        // In case the platform is not valid, just return the data without filtering.
         return data;
     }
     getDeviceLogFilterInstance(platform) {
@@ -49,3 +50,4 @@ class LogFilter {
 }
 exports.LogFilter = LogFilter;
 yok_1.injector.register("logFilter", LogFilter);
+//# sourceMappingURL=log-filter.js.map

package/lib/common/mobile/logging-levels.js

@@ -10,3 +10,4 @@ class LoggingLevels {
 }
 exports.LoggingLevels = LoggingLevels;
 yok_1.injector.register("loggingLevels", LoggingLevels);
+//# sourceMappingURL=logging-levels.js.map

package/lib/common/mobile/mobile-core/android-device-discovery.js

@@ -54,6 +54,7 @@ class AndroidDeviceDiscovery extends device_discovery_1.DeviceDiscovery {
     checkCurrentData(result) {
         return __awaiter(this, void 0, void 0, function* () {
             const currentDevices = result.map((element) => {
+                // http://developer.android.com/tools/help/adb.html#devicestatus
                 const data = element.split("\t");
                 const identifier = data[0];
                 const status = data[1];
@@ -89,3 +90,4 @@ class AndroidDeviceDiscovery extends device_discovery_1.DeviceDiscovery {
 }
 exports.AndroidDeviceDiscovery = AndroidDeviceDiscovery;
 yok_1.injector.register("androidDeviceDiscovery", AndroidDeviceDiscovery);
+//# sourceMappingURL=android-device-discovery.js.map

package/lib/common/mobile/mobile-core/android-emulator-discovery.js

@@ -31,9 +31,11 @@ class AndroidEmulatorDiscovery extends events_1.EventEmitter {
             const availableEmulatorsOutput = yield this.$androidEmulatorServices.getEmulatorImages();
             const currentEmulators = availableEmulatorsOutput.devices;
             const cachedEmulators = _.values(this._emulators);
+            // Remove old emulators
             const lostEmulators = _(cachedEmulators)
                 .reject((e) => _.some(currentEmulators, (emulator) => emulator && e && emulator.imageIdentifier === e.imageIdentifier))
                 .value();
+            // Add new emulators
             const foundEmulators = _(currentEmulators)
                 .reject((e) => _.some(cachedEmulators, (emulator) => emulator && e && emulator.imageIdentifier === e.imageIdentifier))
                 .value();
@@ -63,3 +65,4 @@ class AndroidEmulatorDiscovery extends events_1.EventEmitter {
 }
 exports.AndroidEmulatorDiscovery = AndroidEmulatorDiscovery;
 yok_1.injector.register("androidEmulatorDiscovery", AndroidEmulatorDiscovery);
+//# sourceMappingURL=android-emulator-discovery.js.map

package/lib/common/mobile/mobile-core/android-process-service.js

@@ -87,6 +87,19 @@ class AndroidProcessService {
         return __awaiter(this, void 0, void 0, function* () {
             const adb = this.getAdb(deviceIdentifier);
             const androidWebViewPortInformation = (yield this.getAbstractPortsInformation(adb)).split(os_1.EOL);
+            // TODO: Add tests and make sure only unique names are returned. Input before groupBy is:
+            // [ { deviceIdentifier: 'SH26BW100473',
+            // 	appIdentifier: 'com.telerik.EmptyNS',
+            // 	framework: 'NativeScript' },
+            // 	{ deviceIdentifier: 'SH26BW100473',
+            // 	appIdentifier: 'com.telerik.EmptyNS',
+            // 	framework: 'Cordova' },
+            // 	{ deviceIdentifier: 'SH26BW100473',
+            // 	appIdentifier: 'chrome',
+            // 	framework: 'Cordova' },
+            // 	{ deviceIdentifier: 'SH26BW100473',
+            // 	appIdentifier: 'chrome',
+            // 	framework: 'Cordova' } ]
             const portInformation = yield Promise.all(_.map(androidWebViewPortInformation, (line) => __awaiter(this, void 0, void 0, function* () {
                 return (yield this.getApplicationInfoFromWebViewPortInformation(adb, deviceIdentifier, line)) ||
                     (yield this.getNativeScriptApplicationInformation(adb, deviceIdentifier, line));
@@ -135,6 +148,7 @@ class AndroidProcessService {
     }
     getApplicationInfoFromWebViewPortInformation(adb, deviceIdentifier, information) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Need to search by processId to check for old Android webviews (@webview_devtools_remote_<processId>).
             const processIdRegExp = /@webview_devtools_remote_(.+)/g;
             const processIdMatches = processIdRegExp.exec(information);
             let cordovaAppIdentifier;
@@ -143,6 +157,7 @@ class AndroidProcessService {
                 cordovaAppIdentifier = yield this.getApplicationIdentifierFromPid(adb, processId);
             }
             else {
+                // Search for appIdentifier (@<appIdentifier>_devtools_remote).
                 const chromeAppIdentifierRegExp = /@(.+)_devtools_remote\s?/g;
                 const chromeAppIdentifierMatches = chromeAppIdentifierRegExp.exec(information);
                 if (chromeAppIdentifierMatches && chromeAppIdentifierMatches.length > 0) {
@@ -161,6 +176,7 @@ class AndroidProcessService {
     }
     getNativeScriptApplicationInformation(adb, deviceIdentifier, information) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Search for appIdentifier (@<appIdentifier-debug>).
             const nativeScriptAppIdentifierRegExp = /@(.+)-(debug|inspectorServer)/g;
             const nativeScriptAppIdentifierMatches = nativeScriptAppIdentifierRegExp.exec(information);
             if (nativeScriptAppIdentifierMatches &&
@@ -177,6 +193,10 @@ class AndroidProcessService {
     }
     getAbstractPortForApplication(adb, processId, appIdentifier, abstractPortsInformation, framework) {
         return __awaiter(this, void 0, void 0, function* () {
+            // The result will look like this (without the columns names):
+            // Num       		 RefCount Protocol Flags    Type St Inode  Path
+            // 0000000000000000: 00000002 00000000 00010000 0001 01 189004 @webview_devtools_remote_25512
+            // The Path column is the abstract port.
             framework = framework || "";
             switch (framework.toLowerCase()) {
                 case constants_1.TARGET_FRAMEWORK_IDENTIFIERS.Cordova.toLowerCase():
@@ -207,6 +227,9 @@ class AndroidProcessService {
     }
     getProcessIds(adb, appIdentifiers) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Process information will look like this (without the columns names):
+            // USER     PID   PPID  VSIZE   RSS   WCHAN    PC         NAME
+            // u0_a63   25512 1334  1519560 96040 ffffffff f76a8f75 S com.telerik.appbuildertabstest
             const result = {};
             const processIdInformation = yield adb.executeShellCommand(["ps"]);
             _.each(appIdentifiers, (appIdentifier) => {
@@ -219,6 +242,11 @@ class AndroidProcessService {
     getAlreadyMappedPort(adb, deviceIdentifier, abstractPort, adbForwardList) {
         return __awaiter(this, void 0, void 0, function* () {
             const allForwardedPorts = adbForwardList || (yield adb.executeCommand(["forward", "--list"])) || "";
+            // Sample output:
+            // 5e2e580b tcp:62503 localabstract:webview_devtools_remote_7985
+            // 5e2e580b tcp:62524 localabstract:webview_devtools_remote_7986
+            // 5e2e580b tcp:63160 localabstract:webview_devtools_remote_7987
+            // 5e2e580b tcp:57577 localabstract:com.telerik.nrel-debug
             const regex = new RegExp(`${deviceIdentifier}\\s+?tcp:(\\d+?)\\s+?.*?${abstractPort}$`);
             return this.getFirstMatchingGroupFromMultilineResult(allForwardedPorts, regex);
         });
@@ -234,6 +262,9 @@ class AndroidProcessService {
     getApplicationIdentifierFromPid(adb, pid, psData) {
         return __awaiter(this, void 0, void 0, function* () {
             psData = psData || (yield adb.executeShellCommand(["ps"]));
+            // Process information will look like this (without the columns names):
+            // USER     PID   PPID  VSIZE   RSS   WCHAN    PC         NAME
+            // u0_a63   25512 1334  1519560 96040 ffffffff f76a8f75 S com.telerik.appbuildertabstest
             return this.getFirstMatchingGroupFromMultilineResult(psData, new RegExp(`\\s+${pid}(?:\\s+\\d+){3}\\s+.*\\s+(.*?)$`));
         });
     }
@@ -257,3 +288,4 @@ __decorate([
 ], AndroidProcessService.prototype, "getAppProcessId", null);
 exports.AndroidProcessService = AndroidProcessService;
 yok_1.injector.register("androidProcessService", AndroidProcessService);
+//# sourceMappingURL=android-process-service.js.map

package/lib/common/mobile/mobile-core/device-discovery.js

@@ -62,3 +62,4 @@ class DeviceDiscovery extends events_1.EventEmitter {
 }
 exports.DeviceDiscovery = DeviceDiscovery;
 yok_1.injector.register("deviceDiscovery", DeviceDiscovery);
+//# sourceMappingURL=device-discovery.js.map

package/lib/common/mobile/mobile-core/devices-service.js

@@ -72,6 +72,7 @@ class DevicesService extends events_1.EventEmitter {
                 const device = yield this.getDevice(options.deviceId);
                 return device;
             }
+            // Now let's take data for each device:
             const availableDevicesAndEmulators = this.getDeviceInstances().filter((d) => d.deviceInfo.status === constants_2.CONNECTED_STATUS &&
                 (!this.platform ||
                     d.deviceInfo.platform.toLowerCase() === this.platform.toLowerCase()));
@@ -94,6 +95,8 @@ class DevicesService extends events_1.EventEmitter {
                     const devices = sortedInstances.filter((d) => !d.isEmulator);
                     let selectedInstance;
                     if (options.onlyEmulators || options.onlyDevices) {
+                        // When --emulator or --forDevice is passed, the instances are already filtered
+                        // So we are sure we have exactly the type we need and we can safely return the last one (highest OS version).
                         selectedInstance = _.last(sortedInstances);
                     }
                     else {
@@ -156,6 +159,7 @@ class DevicesService extends events_1.EventEmitter {
                     ...additionalErrors,
                 ];
             }
+            // emulator is already running
             if (emulator.status === constants.RUNNING_EMULATOR_STATUS) {
                 return null;
             }
@@ -188,9 +192,11 @@ class DevicesService extends events_1.EventEmitter {
         return !!(this.$mobileHelper.isiOSPlatform(device.deviceInfo.platform) &&
             device.isEmulator);
     }
+    /* tslint:disable:no-unused-variable */
     setLogLevel(logLevel, deviceIdentifier) {
         this.$deviceLogProvider.setLogLevel(logLevel, deviceIdentifier);
     }
+    /* tslint:enable:no-unused-variable */
     isAppInstalledOnDevices(deviceIdentifiers, appId, projectName, projectDir) {
         this.$logger.trace(`Called isInstalledOnDevices for identifiers ${deviceIdentifiers}. AppIdentifier is ${appId}.`);
         return _.map(deviceIdentifiers, (deviceIdentifier) => this.isApplicationInstalledOnDevice(deviceIdentifier, {
@@ -264,6 +270,9 @@ class DevicesService extends events_1.EventEmitter {
         delete this._availableEmulators[emulator.imageIdentifier];
         this.emit(constants.EmulatorDiscoveryNames.EMULATOR_IMAGE_LOST, emulator);
     }
+    /**
+     * Starts looking for devices. Any found devices are pushed to "_devices" variable.
+     */
     detectCurrentlyAttachedDevices(deviceInitOpts) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.getDeviceLookingOptions(deviceInitOpts);
@@ -336,6 +345,11 @@ class DevicesService extends events_1.EventEmitter {
             clearInterval(this.emulatorDetectionInterval);
         }
     }
+    /**
+     * Returns device that matches an identifier.
+     * The identifier is expected to be the same as the running device declares it (emulator-5554 for android or GUID for ios).
+     * @param identifier running emulator or device identifier
+     */
     getDeviceByIdentifier(identifier) {
         const searchedDevice = _.find(this.getDeviceInstances(), (device) => {
             if (this.$mobileHelper.isApplePlatform(device.deviceInfo.platform) &&
@@ -351,6 +365,9 @@ class DevicesService extends events_1.EventEmitter {
         }
         return searchedDevice;
     }
+    /**
+     * Starts looking for running devices. All found devices are pushed to _devices variable.
+     */
     startLookingForDevices(deviceInitOpts) {
         return __awaiter(this, void 0, void 0, function* () {
             this.$logger.trace("startLookingForDevices; platform is %s", this._platform);
@@ -362,10 +379,20 @@ class DevicesService extends events_1.EventEmitter {
             yield this.startDeviceDetectionInterval(deviceInitOpts);
         });
     }
+    /**
+     * Returns device depending on the passed index.
+     * The index refers to assigned number to listed devices by tns device command.
+     * @param index assigned device number
+     */
     getDeviceByIndex(index) {
         this.validateIndex(index - 1);
         return this.getDeviceInstances()[index - 1];
     }
+    /**
+     * Returns running device for specified --device <DeviceId>.
+     * Method expects running devices.
+     * @param deviceOption parameter passed by the user to --device flag. Can be name, identifier or imageIdentifier.
+     */
     getDevice(deviceOption) {
         return __awaiter(this, void 0, void 0, function* () {
             let device = null;
@@ -387,6 +414,11 @@ class DevicesService extends events_1.EventEmitter {
             return device;
         });
     }
+    /**
+     * Method runs action for a --device (value), specified by the user.
+     * @param action action to be executed if canExecute returns true
+     * @param canExecute predicate to decide whether the command can be ran
+     */
     executeOnDevice(action, canExecute) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!canExecute || canExecute(this._device)) {
@@ -397,6 +429,11 @@ class DevicesService extends events_1.EventEmitter {
             }
         });
     }
+    /**
+     * Executes passed action for each found device.
+     * @param action action to be executed if canExecute returns true
+     * @param canExecute predicate to decide whether the command can be ran
+     */
     executeOnAllConnectedDevices(action, canExecute) {
         return __awaiter(this, void 0, void 0, function* () {
             const devices = this.filterDevicesByPlatform();
@@ -450,6 +487,12 @@ class DevicesService extends events_1.EventEmitter {
             });
         }));
     }
+    /**
+     * Runs the passed action if the predicate "canExecute" returns true
+     * @param action action to be executed if canExecute returns true.
+     * @param canExecute predicate to decide whether the command can be ran
+     * @param options all possible options that can be passed to the command.
+     */
     execute(action, canExecute, options) {
         return __awaiter(this, void 0, void 0, function* () {
             assert.ok(this._isInitialized, "Devices services not initialized!");
@@ -459,6 +502,7 @@ class DevicesService extends events_1.EventEmitter {
                     this.$mobileHelper.isiOSPlatform(this._platform) &&
                     this.$options.emulator &&
                     !this.isOnlyiOSSimultorRunning()) {
+                    // Executes the command only on iOS simulator
                     const originalCanExecute = canExecute;
                     canExecute = (dev) => this.isiOSSimulator(dev) &&
                         (!originalCanExecute || !!originalCanExecute(dev));
@@ -483,6 +527,11 @@ class DevicesService extends events_1.EventEmitter {
             }
         });
     }
+    /**
+     * Starts emulator or simulator if necessary depending on --device or --emulator flags.
+     * If no options are passed runs default emulator/simulator if no devices are connected.
+     * @param deviceInitOpts mainly contains information about --emulator and --deviceId flags.
+     */
     startEmulatorIfNecessary(deviceInitOpts) {
         return __awaiter(this, void 0, void 0, function* () {
             if (deviceInitOpts && deviceInitOpts.deviceId && deviceInitOpts.emulator) {
@@ -492,6 +541,7 @@ class DevicesService extends events_1.EventEmitter {
             if (deviceInitOpts &&
                 deviceInitOpts.platform &&
                 !deviceInitOpts.skipEmulatorStart) {
+                // are there any running devices
                 this._platform = deviceInitOpts.platform;
                 try {
                     yield this.startLookingForDevices(deviceInitOpts);
@@ -519,9 +569,11 @@ class DevicesService extends events_1.EventEmitter {
     _startEmulatorIfNecessary(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const deviceInstances = this.getDeviceInstances();
+            //if no --device is passed and no devices are found, the default emulator is started
             if (!data.deviceId && _.isEmpty(deviceInstances)) {
                 return this.startEmulatorCore(data);
             }
+            //check if --device(value) is running, if it's not or it's not the same as is specified, start with name from --device(value)
             if (data.deviceId) {
                 if (!helpers.isNumberWithoutExponent(data.deviceId)) {
                     const activeDeviceInstance = _.find(deviceInstances, (device) => device.deviceInfo.identifier === data.deviceId);
@@ -530,6 +582,7 @@ class DevicesService extends events_1.EventEmitter {
                     }
                 }
             }
+            // make sure if the target platform is visionOS we don't try to run it on an already running iOS simulator...
             if (data.platform === this.$devicePlatformsConstants.visionOS &&
                 deviceInstances.length) {
                 const runningDeviceInstance = deviceInstances.find((device) => device.deviceInfo.platform === this.$devicePlatformsConstants.visionOS);
@@ -537,6 +590,7 @@ class DevicesService extends events_1.EventEmitter {
                     return this.startEmulatorCore(data);
                 }
             }
+            // if only emulator flag is passed and no other emulators are running, start default emulator
             if (data.emulator && deviceInstances.length) {
                 const runningDeviceInstance = _.some(deviceInstances, (value) => value.isEmulator);
                 if (!runningDeviceInstance) {
@@ -545,6 +599,12 @@ class DevicesService extends events_1.EventEmitter {
             }
         });
     }
+    /**
+     * Takes care of gathering information about all running devices.
+     * Sets "_isInitialized" to true after infomation is present.
+     * Method expects running devices.
+     * @param data mainly contains information about --emulator and --deviceId flags.
+     */
     initialize(data) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this._deviceInitializePromise) {
@@ -554,6 +614,7 @@ class DevicesService extends events_1.EventEmitter {
                 yield this._deviceInitializePromise;
             }
             catch (err) {
+                // In case the initalization fails, we want to allow calling `initlialize` again with other arguments for example, so remove the cached promise value.
                 this.$logger.trace(`Error while initializing devicesService: ${err}`);
                 this._deviceInitializePromise = null;
                 throw err;
@@ -579,6 +640,7 @@ class DevicesService extends events_1.EventEmitter {
             deviceInitOpts = deviceInitOpts || {};
             this._data = deviceInitOpts;
             if (!deviceInitOpts.skipEmulatorStart) {
+                // TODO: Remove from here as it calls startLookingForDevices, so we double the calls to specific device detection services
                 yield this.startEmulatorIfNecessary(deviceInitOpts);
             }
             const platform = deviceInitOpts.platform;
@@ -609,6 +671,7 @@ class DevicesService extends events_1.EventEmitter {
                 yield this.startLookingForDevices(deviceLookingOptions);
             }
             else {
+                // platform and deviceId are not specified
                 if (deviceInitOpts.skipInferPlatform) {
                     if (deviceInitOpts.skipDeviceDetectionInterval) {
                         yield this.detectCurrentlyAttachedDevices(deviceLookingOptions);
@@ -723,6 +786,11 @@ class DevicesService extends events_1.EventEmitter {
         }
         return null;
     }
+    /**
+     * Starts emulator for platform and makes sure started devices/emulators/simulators are in _devices array before finishing.
+     * @param platform (optional) platform to start emulator/simulator for
+     * @param emulatorIdOrName (optional) emulator/simulator image identifier or name
+     */
     startEmulatorCore(deviceInitOpts = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const { deviceId } = deviceInitOpts;
@@ -852,3 +920,4 @@ __decorate([
 ], DevicesService.prototype, "getDebuggableViews", null);
 exports.DevicesService = DevicesService;
 yok_1.injector.register("devicesService", DevicesService);
+//# sourceMappingURL=devices-service.js.map