nativescript 9.0.0-alpha.2 → 9.0.0-alpha.4

package/lib/common/host-info.js

@@ -65,6 +65,9 @@ class HostInfo {
         catch (err) {
             this.$logger.trace(`Unable to get macOS version from ${systemProfileCommand}. Error is: ${err}`);
         }
+        // https://en.wikipedia.org/wiki/Darwin_(operating_system)#Release_history
+        // Each macOS version is labeled 10.<version>, where it looks like <versions> is taken from the major version returned by os.release() (16.x.x for example) and subtracting 4 from it.
+        // So the version becomes "10.12" in this case.
         const osRelease = this.$osInfo.release();
         const majorVersion = osRelease && _.first(osRelease.split("."));
         macOSVersion = majorVersion && `10.${+majorVersion - 4}`;
@@ -118,3 +121,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], HostInfo.prototype, "getMacOSVersion", null);
 yok_1.injector.register("hostInfo", HostInfo);
+//# sourceMappingURL=host-info.js.map

package/lib/common/http-client.js

@@ -26,6 +26,9 @@ class HttpClient {
         catch (err) {
             if (err.message === HttpClient.STUCK_REQUEST_ERROR_MESSAGE ||
                 err.message === HttpClient.STUCK_RESPONSE_ERROR_MESSAGE) {
+                // Retry the request immediately because there are at least 10 seconds between the two requests.
+                // We have to retry only once the sporadically stuck requests/responses.
+                // We can add exponential backoff retry here if we decide that we need to workaround bigger network issues on the client side.
                 this.$logger.warn("%s Retrying request to %s...", err.message, options.url || options);
                 const retryResult = await this.httpRequestCore(options, proxySettings);
                 return {
@@ -51,6 +54,7 @@ class HttpClient {
         await this.useProxySettings(proxySettings, cliProxySettings, options, headers, requestProto);
         if (!headers["User-Agent"]) {
             if (!this.defaultUserAgent) {
+                //TODO: the user agent client name is also passed explicitly during login and should be kept in sync
                 this.defaultUserAgent = `${this.$staticConfig.USER_AGENT_NAME}/${this.$staticConfig.version} (Node.js ${process.versions.node}; ${process.platform}; ${process.arch})`;
                 this.$logger.trace("User-Agent: %s", this.defaultUserAgent);
             }
@@ -79,14 +83,19 @@ class HttpClient {
         }).catch((err) => {
             this.$logger.trace("An error occurred while sending the request:", err);
             if (err.response) {
+                // The request was made and the server responded with a status code
+                // that falls out of the range of 2xx
                 const errorMessage = this.getErrorMessage(err.response.status, null);
                 err.proxyAuthenticationRequired =
                     err.response.status === constants_1.HttpStatusCodes.PROXY_AUTHENTICATION_REQUIRED;
                 err.message = errorMessage || err.message;
             }
             else if (err.request) {
+                // The request was made but no response was received
+                // `err.request` is an instance of XMLHttpRequest in the browser and an instance of
             }
             else {
+                // Something happened in setting up the request that triggered an Error
             }
             throw err;
         });
@@ -132,8 +141,17 @@ class HttpClient {
             return body;
         }
     }
+    /**
+     * This method respects the proxySettings (or proxyCache) by modifying headers and options passed to http(s) module.
+     * @param {IProxySettings} proxySettings The settings passed for this specific call.
+     * @param {IProxySettings} cliProxySettings The globally set proxy for this CLI.
+     * @param {any}options The object that will be passed to http(s) module.
+     * @param {any} headers Headers of the current request.
+     * @param {string} requestProto The protocol used for the current request - http or https.
+     */
     async useProxySettings(proxySettings, cliProxySettings, options, headers, requestProto) {
         const isLocalRequest = options.host === "localhost" || options.host === "127.0.0.1";
+        // don't use the proxy for requests to localhost
         if (!isLocalRequest && (proxySettings || cliProxySettings)) {
             const proto = (proxySettings && proxySettings.protocol) ||
                 cliProxySettings.protocol ||
@@ -144,6 +162,7 @@ class HttpClient {
             if (cliProxySettings.username && cliProxySettings.password) {
                 credentialsPart = `${cliProxySettings.username}:${cliProxySettings.password}@`;
             }
+            // Note that proto ends with :
             options.proxy = `${proto}//${credentialsPart}${host}:${port}`;
             options.rejectUnauthorized = proxySettings
                 ? proxySettings.rejectUnauthorized
@@ -156,3 +175,4 @@ exports.HttpClient = HttpClient;
 HttpClient.STUCK_REQUEST_ERROR_MESSAGE = "The request can't receive any response.";
 HttpClient.STUCK_RESPONSE_ERROR_MESSAGE = "Can't receive all parts of the response.";
 yok_1.injector.register("httpClient", HttpClient);
+//# sourceMappingURL=http-client.js.map

package/lib/common/logger/appenders/cli-appender.js

@@ -15,9 +15,13 @@ function cliAppender(layout) {
     return appender;
 }
 function configure(config, layouts) {
+    // the default layout for the appender
     let layout = layouts.messagePassThroughLayout;
+    // check if there is another layout specified
     if (config.layout) {
         layout = layouts.layout(config.layout.type, config.layout);
     }
+    // create a new appender instance
     return cliAppender(layout);
 }
+//# sourceMappingURL=cli-appender.js.map

package/lib/common/logger/appenders/emit-appender.js

@@ -21,9 +21,13 @@ function configure(config, layouts) {
     if (!config.emitter.emit || typeof config.emitter.emit !== "function") {
         throw new Error("The passed emitter must be instance of EventEmitter");
     }
+    // the default layout for the appender
     let layout = layouts.messagePassThroughLayout;
+    // check if there is another layout specified
     if (config.layout) {
         layout = layouts.layout(config.layout.type, config.layout);
     }
+    // create a new appender instance
     return emitAppender(layout, config.emitter);
 }
+//# sourceMappingURL=emit-appender.js.map

package/lib/common/logger/layouts/cli-layout.js

@@ -30,3 +30,4 @@ function layout(config) {
         return msg;
     };
 }
+//# sourceMappingURL=cli-layout.js.map

package/lib/common/logger/logger.js

@@ -98,9 +98,11 @@ class Logger {
         if (typeof item === "string") {
             return item;
         }
+        // do not try to read streams, because they may not be rewindable
         if (item instanceof stream.Readable) {
             return "[ReadableStream]";
         }
+        // There's no point in printing buffers
         if (item instanceof Buffer) {
             return "[Buffer]";
         }
@@ -153,12 +155,14 @@ class Logger {
     getLogOptionsForMessage(data) {
         const loggerOptionKeys = _.keys(constants_1.LoggerConfigData);
         const dataToCheck = data.filter((el) => {
+            // objects created with Object.create(null) do not have `hasOwnProperty` function
             if (!!el &&
                 typeof el === "object" &&
                 el.hasOwnProperty &&
                 typeof el.hasOwnProperty === "function") {
                 for (const key of loggerOptionKeys) {
                     if (el.hasOwnProperty(key)) {
+                        // include only the elements which have one of the keys we've specified as logger options
                         return true;
                     }
                 }
@@ -197,3 +201,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], Logger.prototype, "initialize", null);
 yok_1.injector.register("logger", Logger);
+//# sourceMappingURL=logger.js.map

package/lib/common/messages/messages.js

@@ -1,7 +1,11 @@
 "use strict";
+//
+// automatically generated code; do not edit manually!
+//
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Messages = void 0;
 const yok_1 = require("../yok");
+/* tslint:disable:all */
 class Messages {
     constructor() {
         this.Devices = {
@@ -13,3 +17,5 @@ class Messages {
 }
 exports.Messages = Messages;
 yok_1.injector.register("messages", Messages);
+/* tslint:enable */
+//# sourceMappingURL=messages.js.map

package/lib/common/mobile/android/android-application-manager.js

@@ -29,7 +29,7 @@ class AndroidApplicationManager extends application_manager_base_1.ApplicationMa
         this.$deviceLogProvider = $deviceLogProvider;
         this.$errors = $errors;
         this.PID_CHECK_INTERVAL = 100;
-        this.PID_CHECK_TIMEOUT = 10000;
+        this.PID_CHECK_TIMEOUT = 10000; // 10 secs
     }
     async getInstalledApplications() {
         const result = (await this.adb.executeShellCommand(["pm", "list", "packages"])) || "";
@@ -67,6 +67,7 @@ class AndroidApplicationManager extends application_manager_base_1.ApplicationMa
         }
     }
     uninstallApplication(appIdentifier) {
+        // Need to set the treatErrorsAsWarnings to true because when using tns run command if the application is not installed on the device it will throw error
         return this.adb.executeShellCommand(["pm", "uninstall", `${appIdentifier}`], { treatErrorsAsWarnings: true });
     }
     async startApplication(appData) {
@@ -75,9 +76,24 @@ class AndroidApplicationManager extends application_manager_base_1.ApplicationMa
                 `cat /dev/null > ${constants_1.LiveSyncPaths.ANDROID_TMP_DIR_NAME}/${appData.appId}-debugbreak`,
             ]);
         }
+        // If the app is debuggable, the Runtime will update the file when its ready for debugging
+        // and we will be able to take decisions and synchronize the debug experience based on the content
         await this.adb.executeShellCommand([
             `cat /dev/null > ${constants_1.LiveSyncPaths.ANDROID_TMP_DIR_NAME}/${appData.appId}-debugger-started`,
         ]);
+        /*
+        Example "pm dump <app_identifier> | grep -A 1 MAIN" output"
+            android.intent.action.MAIN:
+            3b2df03 org.nativescript.cliapp/com.tns.NativeScriptActivity filter 50dd82e
+            Action: "android.intent.action.MAIN"
+            Category: "android.intent.category.LAUNCHER"
+            --
+            intent={act=android.intent.action.MAIN cat=[android.intent.category.LAUNCHER] flg=0x10200000 cmp=org.nativescript.cliapp/com.tns.NativeScriptActivity}
+            realActivity=org.nativescript.cliapp/com.tns.NativeScriptActivity
+            --
+            Intent { act=android.intent.action.MAIN cat=[android.intent.category.LAUNCHER] flg=0x10200000 cmp=org.nativescript.cliapp/com.tns.NativeScriptActivity }
+            frontOfTask=true task=TaskRecord{fe592ac #449 A=org.nativescript.cliapp U=0 StackId=1 sz=1}
+        */
         const appIdentifier = appData.appId;
         const pmDumpOutput = await this.adb.executeShellCommand([
             "pm",
@@ -127,6 +143,8 @@ class AndroidApplicationManager extends application_manager_base_1.ApplicationMa
                     pid: processIdentifier,
                     appId: appIdentifier,
                     onAppRestarted: () => {
+                        // If the app restarts, we update the PID and
+                        // restart log helper.
                         this.onAppLaunch(appData);
                     },
                 });
@@ -205,3 +223,4 @@ __decorate([
 __decorate([
     (0, decorators_1.cache)()
 ], AndroidApplicationManager.prototype, "getFullyQualifiedActivityRegex", null);
+//# sourceMappingURL=android-application-manager.js.map

package/lib/common/mobile/android/android-debug-bridge-result-handler.js

@@ -330,3 +330,4 @@ AndroidDebugBridgeResultHandler.ANDROID_DEBUG_BRIDGE_ERRORS = [
     },
 ];
 yok_1.injector.register("androidDebugBridgeResultHandler", AndroidDebugBridgeResultHandler);
+//# sourceMappingURL=android-debug-bridge-result-handler.js.map

package/lib/common/mobile/android/android-debug-bridge.js

@@ -38,11 +38,15 @@ class AndroidDebugBridge {
                 return this.$childProcess.spawn(command.command, command.args);
             }
         }
+        // If adb -s <invalid device id> install <smth> is executed the childProcess won't get any response
+        // because the adb will be waiting for valid device and will not send close or exit event.
+        // For example `adb -s <invalid device id> install <smth>` throws error 'error: device \'030939f508e6c773\' not found\r\n' exitCode 4294967295
         const result = await this.$childProcess.spawnFromEvent(command.command, command.args, event, childProcessOptions, { throwError: false });
         const errors = this.$androidDebugBridgeResultHandler.checkForErrors(result);
         if (errors && errors.length > 0) {
             this.$androidDebugBridgeResultHandler.handleErrors(errors, treatErrorsAsWarnings);
         }
+        // Some adb commands returns array of strings instead of object with stdout and stderr. (adb start-server)
         return result.stdout === undefined || result.stdout === null
             ? result
             : result.stdout;
@@ -121,6 +125,7 @@ class AndroidDebugBridge {
     }
     async pushFile(localFilePath, deviceFilePath) {
         const fileDirectory = (0, helpers_1.fromWindowsRelativePathToUnix)(path.dirname(deviceFilePath));
+        // starting from API level 28, the push command is returning an error if the directory does not exist
         await this.executeShellCommand(["mkdir", "-p", fileDirectory]);
         await this.executeCommand(["push", localFilePath, deviceFilePath]);
         await this.executeShellCommand(["chmod", "0777", fileDirectory]);
@@ -140,3 +145,4 @@ __decorate([
     (0, decorators_1.invokeInit)()
 ], AndroidDebugBridge.prototype, "getDevices", null);
 yok_1.injector.register("adb", AndroidDebugBridge);
+//# sourceMappingURL=android-debug-bridge.js.map

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

@@ -74,6 +74,8 @@ class AndroidDeviceFileSystem {
         return transferredFiles;
     }
     async transferDirectory(deviceAppData, localToDevicePaths, projectFilesPath) {
+        // starting from Android 9, adb push is throwing an exception when there are subfolders
+        // the check could be removed when we start supporting only runtime versions with sockets
         const minAndroidWithoutAdbPushDir = "9.0.0";
         const isAdbPushDirSupported = semver.lt(semver.coerce(deviceAppData.device.deviceInfo.version), minAndroidWithoutAdbPushDir);
         const deviceProjectDir = await deviceAppData.getDeviceProjectRootPath();
@@ -120,6 +122,7 @@ class AndroidDeviceFileSystem {
         const hostTmpDir = await this.$tempService.mkdirSync("application-");
         const commandsFileHostPath = path.join(hostTmpDir, "temp.commands.file");
         this.$fs.writeFile(commandsFileHostPath, fileContent);
+        // copy it to the device
         await this.transferFile(commandsFileHostPath, deviceFilePath);
         await this.adb.executeShellCommand(["chmod", "0777", deviceFilePath]);
     }
@@ -141,3 +144,4 @@ class AndroidDeviceFileSystem {
     }
 }
 exports.AndroidDeviceFileSystem = AndroidDeviceFileSystem;
+//# sourceMappingURL=android-device-file-system.js.map

package/lib/common/mobile/android/android-device-hash-service.js

@@ -51,6 +51,8 @@ class AndroidDeviceHashService {
         const action = async (localToDevicePathData) => {
             const localPath = localToDevicePathData.getLocalPath();
             if (this.$fs.getFsStats(localPath).isFile()) {
+                // TODO: Use relative to project path for key
+                // This will speed up livesync on the same device for the same project on different PCs.
                 initialShasums[localPath] = await this.$fs.getFileShasum(localPath);
             }
         };
@@ -106,3 +108,4 @@ __decorate([
 __decorate([
     (0, decorators_1.cache)()
 ], AndroidDeviceHashService.prototype, "getTempDir", null);
+//# sourceMappingURL=android-device-hash-service.js.map

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

@@ -32,6 +32,8 @@ class AndroidDevice {
         this.fileSystem = this.$injector.resolve(fileSystemPath.AndroidDeviceFileSystem, { adb: this.adb });
         let details = await this.getDeviceDetails(["getprop"]);
         if (!details || !details.name) {
+            // In older CLI versions we are calling cat /system/build.prop to get details.
+            // Keep this logic for compatibility and possibly for devices for which getprop is not working
             details = await this.getDeviceDetails(["cat", "/system/build.prop"]);
         }
         this.$logger.trace(details);
@@ -88,6 +90,9 @@ class AndroidDevice {
         try {
             const details = await this.adb.executeShellCommand(shellCommandArgs);
             details.split(/\r?\n|\r/).forEach((value) => {
+                // sample line is "ro.build.version.release=4.4" in /system/build.prop
+                // sample line from getprop is:  [ro.build.version.release]: [6.0]
+                // NOTE: some props do not have value: [ro.build.version.base_os]: []
                 const match = /(?:\[?ro\.build\.version|ro\.product|ro\.build)\.(.+?)]?(?:\:|=)(?:\s*?\[)?(.*?)]?$/.exec(value);
                 if (match) {
                     parsedDetails[match[1]] = match[2];
@@ -101,6 +106,7 @@ class AndroidDevice {
         return parsedDetails;
     }
     getIsTablet(details) {
+        //version 3.x.x (also known as Honeycomb) is a tablet only version
         return (details &&
             (_.startsWith(details.release, "3.") ||
                 _.includes((details.characteristics || "").toLowerCase(), "tablet")));
@@ -114,6 +120,7 @@ class AndroidDevice {
     }
 }
 exports.AndroidDevice = AndroidDevice;
+// http://stackoverflow.com/questions/31178195/what-does-adb-device-status-mean
 AndroidDevice.ADB_DEVICE_STATUS_INFO = {
     device: {
         errorHelp: null,
@@ -139,3 +146,4 @@ AndroidDevice.ADB_DEVICE_STATUS_INFO = {
 __decorate([
     (0, decorators_1.cache)()
 ], AndroidDevice.prototype, "init", null);
+//# sourceMappingURL=android-device.js.map

package/lib/common/mobile/android/android-emulator-services.js

@@ -37,14 +37,16 @@ class AndroidEmulatorServices {
     async getRunningEmulatorName(emulatorId) {
         let result = await this.$androidVirtualDeviceService.getRunningEmulatorName(emulatorId);
         if (!result) {
-            result = await this.$androidGenymotionService.getRunningEmulatorName(emulatorId);
+            result =
+                await this.$androidGenymotionService.getRunningEmulatorName(emulatorId);
         }
         return result;
     }
     async getRunningEmulatorImageIdentifier(emulatorId) {
         let result = await this.$androidVirtualDeviceService.getRunningEmulatorImageIdentifier(emulatorId);
         if (!result) {
-            result = await this.$androidGenymotionService.getRunningEmulatorImageIdentifier(emulatorId);
+            result =
+                await this.$androidGenymotionService.getRunningEmulatorImageIdentifier(emulatorId);
         }
         return result;
     }
@@ -101,7 +103,7 @@ class AndroidEmulatorServices {
                     endTimeEpoch,
                 };
             }
-            await (0, helpers_1.sleep)(10000);
+            await (0, helpers_1.sleep)(10000); // the emulator definitely takes its time to wake up
             hasTimeLeft = (0, helpers_1.getCurrentEpochTime)() < endTimeEpoch;
         }
         if (!hasTimeLeft && !isInfiniteWait) {
@@ -116,13 +118,13 @@ class AndroidEmulatorServices {
         let pathToEmulatorExecutable = null;
         let startEmulatorArgs = null;
         if (emulator.vendor === constants_1.AndroidVirtualDevice.AVD_VENDOR_NAME) {
-            pathToEmulatorExecutable = this.$androidVirtualDeviceService
-                .pathToEmulatorExecutable;
+            pathToEmulatorExecutable =
+                this.$androidVirtualDeviceService.pathToEmulatorExecutable;
             startEmulatorArgs = this.$androidVirtualDeviceService.startEmulatorArgs(emulator.imageIdentifier);
         }
         else if (emulator.vendor === constants_1.AndroidVirtualDevice.GENYMOTION_VENDOR_NAME) {
-            pathToEmulatorExecutable = this.$androidGenymotionService
-                .pathToEmulatorExecutable;
+            pathToEmulatorExecutable =
+                this.$androidGenymotionService.pathToEmulatorExecutable;
             startEmulatorArgs = this.$androidGenymotionService.startEmulatorArgs(emulator.imageIdentifier);
         }
         this.$logger.info(`Starting Android emulator with image ${emulator.imageIdentifier}`);
@@ -146,7 +148,7 @@ class AndroidEmulatorServices {
         }
         const minVersion = semver.coerce(constants_1.AndroidVirtualDevice.MIN_ANDROID_VERSION);
         const bestVersion = best && best.version && semver.coerce(best.version);
-        return bestVersion && semver.gte(bestVersion, minVersion) ? best : null;
+        return !bestVersion || semver.gte(bestVersion, minVersion) ? best : null;
     }
     async waitForEmulatorBootToComplete(emulator, endTimeEpoch, timeout) {
         this.$logger.info("Waiting for emulator device initialization...", {
@@ -178,3 +180,4 @@ class AndroidEmulatorServices {
 }
 exports.AndroidEmulatorServices = AndroidEmulatorServices;
 yok_1.injector.register("androidEmulatorServices", AndroidEmulatorServices);
+//# sourceMappingURL=android-emulator-services.js.map

package/lib/common/mobile/android/android-ini-file-parser.js

@@ -12,6 +12,8 @@ class AndroidIniFileParser {
         if (!this.$fs.exists(iniFilePath)) {
             return null;
         }
+        // avd files can have different encoding, defined on the first line.
+        // find which one it is (if any) and use it to correctly read the file contents
         const encoding = this.getAvdEncoding(iniFilePath);
         const contents = this.$fs.readText(iniFilePath, encoding).split("\n");
         return _.reduce(contents, (result, line) => {
@@ -44,6 +46,8 @@ class AndroidIniFileParser {
         }, Object.create(null));
     }
     getAvdEncoding(avdName) {
+        // avd files can have different encoding, defined on the first line.
+        // find which one it is (if any) and use it to correctly read the file contents
         let encoding = "utf8";
         let contents = this.$fs.readText(avdName, "ascii");
         if (contents.length > 0) {
@@ -57,18 +61,22 @@ class AndroidIniFileParser {
         }
         return encoding;
     }
+    // Android L is not written as a number in the .ini files, and we need to convert it
     readTargetNum(target) {
         const platform = target.replace("android-", "");
         let platformNumber = +platform;
         if (isNaN(platformNumber)) {
+            // this may be a google image
             const googlePlatform = target.split(":")[2];
             if (googlePlatform) {
                 platformNumber = +googlePlatform;
             }
             else if (platform === "L") {
+                // Android SDK 20 preview
                 platformNumber = 20;
             }
             else if (platform === "MNC") {
+                // Android M preview
                 platformNumber = 22;
             }
         }
@@ -77,3 +85,4 @@ class AndroidIniFileParser {
 }
 exports.AndroidIniFileParser = AndroidIniFileParser;
 yok_1.injector.register("androidIniFileParser", AndroidIniFileParser);
+//# sourceMappingURL=android-ini-file-parser.js.map

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

@@ -37,6 +37,10 @@ class AndroidLogFilter {
     }
 }
 exports.AndroidLogFilter = AndroidLogFilter;
+//sample line is "I/Web Console(    4438): Received Event: deviceready at file:///storage/emulated/0/Icenium/com.telerik.TestApp/js/index.js:48"
 AndroidLogFilter.LINE_REGEX = /.\/(.+?)\s*\(\s*\d+?\): (.*)/;
+// sample line is "11-23 12:39:07.310  1584  1597 I art     : Background sticky concurrent mark sweep GC freed 21966(1780KB) AllocSpace objects, 4(80KB) LOS objects, 77% free, 840KB/3MB, paused 4.018ms total 158.629ms"
+// or '12-28 10:45:08.020  3329  3329 W chromium: [WARNING:data_reduction_proxy_settings.cc(328)] SPDY proxy OFF at startup'
 AndroidLogFilter.API_LEVEL_23_LINE_REGEX = /.+?\s+?(?:[A-Z]\s+?)([A-Za-z \.]+?)\s*?\: (.*)/;
 yok_1.injector.register("androidLogFilter", AndroidLogFilter);
+//# sourceMappingURL=android-log-filter.js.map

package/lib/common/mobile/android/android-virtual-device-service.js

@@ -69,6 +69,9 @@ class AndroidVirtualDeviceService {
     get pathToEmulatorExecutable() {
         const emulatorExecutableName = "emulator";
         if (this.androidHome) {
+            // Check https://developer.android.com/studio/releases/sdk-tools.html (25.3.0)
+            // Since this version of SDK tools, the emulator is a separate package.
+            // However the emulator executable still exists in the "tools" dir.
             const pathToEmulatorFromAndroidStudio = path.join(this.androidHome, emulatorExecutableName, emulatorExecutableName);
             const realFilePath = this.$hostInfo.isWindows
                 ? `${pathToEmulatorFromAndroidStudio}.exe`
@@ -108,6 +111,17 @@ class AndroidVirtualDeviceService {
             client.on("data", (data) => {
                 output += data.toString();
                 const imageIdentifier = this.getImageIdentifierFromClientOutput(output);
+                // old output should look like:
+                // Android Console: type 'help' for a list of commands
+                // OK
+                // <Name of image>
+                // OK
+                // new output should look like:
+                // Android Console: type 'help' for a list of commands
+                // OK
+                // a\u001b[K\u001b[Dav\u001b[K\u001b[D\u001b[Davd\u001b...
+                // <Name of image>
+                // OK
                 if (imageIdentifier && !isResolved) {
                     this.mapEmulatorIdToImageIdentifier[emulatorId] = imageIdentifier;
                     this.clearNetConnection(client, timer);
@@ -159,6 +173,8 @@ class AndroidVirtualDeviceService {
         if (this.pathToAvdManagerExecutable &&
             this.$fs.exists(this.pathToAvdManagerExecutable)) {
             if (process.env.JAVA_HOME) {
+                // In case JAVA_HOME is set, but it points to incorrect directory (i.e. there's no java in $JAVA_HOME/bin/java), avdmanager will fail
+                // no matter if you have correct java in PATH.
                 canExecute = !!(await this.$sysInfo.getJavaVersionFromJavaHome());
             }
             else {
@@ -230,6 +246,13 @@ class AndroidVirtualDeviceService {
         const avdOutput = output.split(constants_1.AndroidVirtualDevice.AVAILABLE_AVDS_MESSAGE);
         const availableDevices = avdOutput && avdOutput[1] && avdOutput[1].trim();
         if (availableDevices) {
+            // In some cases `avdmanager list avds` command prints:
+            //	`The following Android Virtual Devices could not be loaded:
+            //	Name: Pixel_2_XL_API_28
+            //	Path: /Users/<username>/.android/avd/Pixel_2_XL_API_28.avd
+            //	Error: Google pixel_2_xl no longer exists as a device`
+            // These devices sometimes are valid so try to parse them.
+            // Also these devices are printed at the end of the output and are separated with 2 new lines from the valid devices output.
             const parts = availableDevices.split(/(?:\r?\n){2}/);
             const items = [parts[0], parts[1]].filter((item) => !!item);
             for (const item of items) {
@@ -246,6 +269,7 @@ class AndroidVirtualDeviceService {
     }
     getAvdManagerDeviceInfo(output) {
         const avdManagerDeviceInfo = Object.create(null);
+        // Split by `\n`, not EOL as the avdmanager and android executables print results with `\n` only even on Windows
         _.reduce(output.split("\n"), (result, row) => {
             const [key, value] = row.split(": ").map((part) => part.trim());
             switch (key) {
@@ -292,6 +316,7 @@ class AndroidVirtualDeviceService {
         };
     }
     getImageIdentifierFromClientOutput(output) {
+        // The lines should be trimmed after the split because the output has \r\n and when using split(EOL) on mac each line ends with \r.
         const lines = _.map(output.split(os_1.EOL), (line) => line.trim());
         const firstIndexOfOk = _.indexOf(lines, "OK");
         if (firstIndexOfOk < 0) {
@@ -340,3 +365,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], AndroidVirtualDeviceService.prototype, "getConfigurationError", null);
 yok_1.injector.register("androidVirtualDeviceService", AndroidVirtualDeviceService);
+//# sourceMappingURL=android-virtual-device-service.js.map

package/lib/common/mobile/android/device-android-debug-bridge.js

@@ -30,3 +30,4 @@ class DeviceAndroidDebugBridge extends android_debug_bridge_1.AndroidDebugBridge
     }
 }
 exports.DeviceAndroidDebugBridge = DeviceAndroidDebugBridge;
+//# sourceMappingURL=device-android-debug-bridge.js.map

package/lib/common/mobile/android/genymotion/genymotion-service.js

@@ -42,6 +42,7 @@ class AndroidGenymotionService {
             .map(async (row) => {
             const match = row.match(/^(.+?)\s+device$/);
             if (match && match[1]) {
+                // possible genymotion emulator
                 const emulatorId = match[1];
                 const result = (await this.isGenymotionEmulator(emulatorId))
                     ? emulatorId
@@ -92,6 +93,7 @@ class AndroidGenymotionService {
         this.$emulatorHelper.setRunningAndroidEmulatorProperties(runningEmulatorId, runningEmulator);
         return runningEmulator;
     }
+    // https://wiki.appcelerator.org/display/guides2/Installing+Genymotion
     get playerSearchPaths() {
         return {
             darwin: [
@@ -133,13 +135,14 @@ class AndroidGenymotionService {
             vendor: constants_1.AndroidVirtualDevice.GENYMOTION_VENDOR_NAME,
             status: constants_1.NOT_RUNNING_EMULATOR_STATUS,
             errorHelp: [configurationError, error].filter((item) => !!item).join(os_1.EOL) || null,
-            isTablet: false,
+            isTablet: false, //TODO: Consider how to populate this correctly when the device is not running
             type: constants_1.DeviceTypes.Emulator,
             connectionTypes: [constants_2.DeviceConnectionType.Local],
             platform: this.$devicePlatformsConstants.Android,
         };
     }
     getSdkVersion(output) {
+        // Example -> Name: android_version, value: 6.0.0, timestamp: 1530090506102029000, flags:
         const androidApiLevelRow = output
             .split("\n")
             .filter((row) => !!row)
@@ -165,6 +168,7 @@ In case you have installed Genymotion in a different location, please add the pa
     }
     async getConfigurationError() {
         const result = await this.$childProcess.trySpawnFromCloseEvent(this.pathToEmulatorExecutable, [], {}, { throwError: false });
+        // When player is spawned, it always prints message on stderr.
         if (result &&
             result.stderr &&
             result.stderr.indexOf(constants_1.AndroidVirtualDevice.GENYMOTION_DEFAULT_STDERR_STRING) === -1) {
@@ -182,3 +186,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], AndroidGenymotionService.prototype, "getConfigurationError", null);
 yok_1.injector.register("androidGenymotionService", AndroidGenymotionService);
+//# sourceMappingURL=genymotion-service.js.map

package/lib/common/mobile/android/genymotion/virtualbox-service.js

@@ -34,6 +34,7 @@ class VirtualBoxService {
                     .split(os_1.EOL)
                     .filter((row) => !!row)
                     .map((row) => {
+                    // Example row: "Google Nexus 4 - 5.0.0 - API 21 - 768x1280" {9d9beef2-cc60-4a54-bcc0-cc1dbf89811f}
                     const [rawName, rawId] = row.split('" ');
                     const id = rawId.substr(1, rawId.length - 2);
                     const name = rawName.substr(1, rawName.length - 1);
@@ -70,6 +71,15 @@ class VirtualBoxService {
         if (this.$hostInfo.isWindows) {
             let searchPath = null;
             try {
+                /* This can be used as interface!!!!
+                    arch:null
+                    hive:"HKLM"
+                    host:""
+                    key:"\Software\Oracle\VirtualBox"
+                    name:"InstallDir"
+                    type:"REG_SZ"
+                    value:"C:\Program Files\Oracle\VirtualBox\"
+                */
                 const result = await (0, helpers_1.getWinRegPropertyValue)("\\Software\\Oracle\\VirtualBox", "InstallDir");
                 searchPath = result && result.value ? result.value : null;
             }
@@ -102,3 +112,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], VirtualBoxService.prototype, "getvBoxManagePath", null);
 yok_1.injector.register("virtualBoxService", VirtualBoxService);
+//# sourceMappingURL=virtualbox-service.js.map