nativescript 9.0.0-alpha.2 → 9.0.0-alpha.3

package/lib/services/android-project-service.js

@@ -18,7 +18,40 @@ const constants_1 = require("../common/constants");
 const helpers_1 = require("../common/helpers");
 const decorators_1 = require(".././common/decorators");
 const yok_1 = require("../common/yok");
-function topologicalSortNativeDependencies(dependencies, start = [], depth = 0, total = 0) {
+//
+// we sort the native dependencies topologically to make sure they are processed in the right order
+// native dependenciess need to be sorted so the deepst dependencies are built before it's parents
+//
+// for example, given this dep structure (assuming these are all native dependencies that need to be built)
+// (note: we list all dependencies at the root level, so the leaf nodes are essentially references to the root nodes)
+//
+//   |- dep1
+//   |- dep2
+//   |- |- dep3
+//   |- |- dep4
+//   |- |- |- dep5
+//   |- dep3
+//   |- dep4
+//   |- |- dep5
+//   |- dep5
+//
+// It is sorted:
+//
+//   |- dep1
+//   |- dep3
+//   |- dep5
+//   |- dep4        # depends on dep5, so dep5 must be built first, ie above ^
+//   |- |- dep5
+//   |- dep2        # depends on dep3, dep4 (and dep5 through dep4) so all of them must be built first before dep2 is built
+//   |- |- dep3
+//   |- |- dep4
+//   |- |- |- dep5
+//
+// for more details see: https://wikiless.org/wiki/Topological_sorting?lang=en
+//
+function topologicalSortNativeDependencies(dependencies, start = [], depth = 0, total = 0 // do not pass in, we calculate it in the initial run!
+) {
+    // we set the total on the initial call - and never increment it, as it's used for esacaping the recursion
     if (total === 0) {
         total = dependencies.length;
     }
@@ -32,6 +65,8 @@ function topologicalSortNativeDependencies(dependencies, start = [], depth = 0,
         return sortedDeps;
     }, start);
     const remainingDeps = dependencies.filter((nativeDep) => !sortedDeps.includes(nativeDep));
+    // recurse if we still have remaining deps
+    // the second condition here prevents infinite recursion
     if (remainingDeps.length && sortedDeps.length < total) {
         return topologicalSortNativeDependencies(remainingDeps, sortedDeps, depth + 1, total);
     }
@@ -85,7 +120,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 constants.APK_DIR,
             ];
             const packageName = this.getProjectNameFromId(projectData);
-            const runtimePackage = this.$projectDataService.getRuntimePackage(projectData.projectDir, "android");
+            const runtimePackage = this.$projectDataService.getRuntimePackage(projectData.projectDir, "android" /* constants.PlatformTypes.android */);
             this._platformData = {
                 frameworkPackageName: runtimePackage.name,
                 normalizedPlatformName: "Android",
@@ -126,7 +161,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 configurationFileName: constants.MANIFEST_FILE_NAME,
                 configurationFilePath: path.join(...configurationsDirectoryArr),
                 relativeToFrameworkConfigurationFilePath: path.join(constants.SRC_DIR, constants.MAIN_DIR, constants.MANIFEST_FILE_NAME),
-                fastLivesyncFileExtensions: [".jpg", ".gif", ".png", ".bmp", ".webp"],
+                fastLivesyncFileExtensions: [".jpg", ".gif", ".png", ".bmp", ".webp"], // http://developer.android.com/guide/appendix/media-formats.html
             };
         }
         return this._platformData;
@@ -176,6 +211,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         const targetSdkVersion = androidToolsInfo && androidToolsInfo.targetSdkVersion;
         this.$logger.trace(`Using Android SDK '${targetSdkVersion}'.`);
         this.copy(this.getPlatformData(projectData).projectRoot, frameworkDir, "*", "-R");
+        // TODO: Check if we actually need this and if it should be targetSdk or compileSdk
         this.cleanResValues(targetSdkVersion, projectData);
     }
     getResDestinationDir(projectData) {
@@ -207,6 +243,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         _.map(directoriesToClean, (dir) => this.$fs.deleteDirectory(dir));
     }
     async interpolateData(projectData) {
+        // Interpolate the apilevel and package
         this.interpolateConfigurationFile(projectData);
         const appResourcesDirectoryPath = projectData.getAppResourcesDirectoryPath();
         let stringsFilePath;
@@ -222,8 +259,10 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         const gradleSettingsFilePath = path.join(this.getPlatformData(projectData).projectRoot, "settings.gradle");
         shell.sed("-i", /__PROJECT_NAME__/, this.getProjectNameFromId(projectData), gradleSettingsFilePath);
         try {
+            // will replace applicationId in app/App_Resources/Android/app.gradle if it has not been edited by the user
             const appGradleContent = this.$fs.readText(projectData.appGradlePath);
             if (appGradleContent.indexOf(constants.PACKAGE_PLACEHOLDER_NAME) !== -1) {
+                //TODO: For compatibility with old templates. Once all templates are updated should delete.
                 shell.sed("-i", new RegExp(constants.PACKAGE_PLACEHOLDER_NAME), projectData.projectIdentifiers.android, projectData.appGradlePath);
             }
         }
@@ -274,6 +313,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         return [".jar", ".dat"];
     }
     async prepareProject() {
+        // Intentionally left empty.
     }
     ensureConfigurationFileInAppResources(projectData) {
         const appResourcesDirectoryPath = projectData.appResourcesDirectoryPath;
@@ -290,6 +330,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
             this.$logger.warn("No manifest found in " + originalAndroidManifestFilePath);
             return;
         }
+        // Overwrite the AndroidManifest from runtime.
         if (!appResourcesDirStructureHasMigrated) {
             this.$fs.copyFile(originalAndroidManifestFilePath, this.getPlatformData(projectData).configurationFilePath);
         }
@@ -306,6 +347,8 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         }
         else {
             this.$fs.copyFile(path.join(projectAppResourcesPath, platformData.normalizedPlatformName, "*"), platformsAppResourcesPath);
+            // https://github.com/NativeScript/android-runtime/issues/899
+            // App_Resources/Android/libs is reserved to user's aars and jars, but they should not be copied as resources
             this.$fs.deleteDirectory(path.join(platformsAppResourcesPath, "libs"));
         }
         const androidToolsInfo = this.$androidToolsInfo.getToolsInfo({
@@ -315,6 +358,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         this.cleanResValues(compileSdkVersion, projectData);
     }
     async preparePluginNativeCode(pluginData, projectData) {
+        // build Android plugins which contain AndroidManifest.xml and/or resources
         const pluginPlatformsFolderPath = this.getPluginPlatformsFolderPath(pluginData, AndroidProjectService.ANDROID_PLATFORM_NAME);
         if (this.$fs.exists(pluginPlatformsFolderPath)) {
             const options = {
@@ -336,6 +380,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         return;
     }
     async removePluginNativeCode(pluginData, projectData) {
+        // not implemented
     }
     async beforePrepareAllPlugins(projectData, dependencies) {
         if (dependencies) {
@@ -349,6 +394,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
     filterUniqueDependencies(dependencies) {
         const depsDictionary = dependencies.reduce((dict, dep) => {
             const collision = dict[dep.name];
+            // in case there are multiple dependencies to the same module, the one declared in the package.json takes precedence
             if (!collision || collision.depth > dep.depth) {
                 dict[dep.name] = dep;
             }
@@ -367,6 +413,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 name,
                 directory: path.relative(platformDir, directory),
                 dependencies: dependencies.filter((dep) => {
+                    // filter out transient dependencies that don't have native dependencies
                     return (nativeDependencyData.findIndex((nativeDep) => nativeDep.name === dep) !== -1);
                 }),
             };
@@ -374,6 +421,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         nativeDependencies = topologicalSortNativeDependencies(nativeDependencies);
         const jsonContent = JSON.stringify(nativeDependencies, null, 4);
         this.$fs.writeFile(dependenciesJsonPath, jsonContent);
+        // we sort all the dependencies to respect the topological sorting of the native dependencies
         return dependencies.sort(function (a, b) {
             return (nativeDependencies.findIndex((n) => n.name === a.name) -
                 nativeDependencies.findIndex((n) => n.name === b.name));
@@ -405,6 +453,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         await adb.executeShellCommand(["rm", "-rf", deviceRootPath]);
     }
     async checkForChanges() {
+        // Nothing android specific to check yet.
     }
     getDeploymentTarget(projectData) {
         return;
@@ -414,9 +463,12 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         shell.cp(cpArg, paths, projectRoot);
     }
     validatePackageName(packageName) {
+        //Make the package conform to Java package types
+        //Enforce underscore limitation
         if (!/^[a-zA-Z]+(\.[a-zA-Z0-9][a-zA-Z0-9_]*)+$/.test(packageName)) {
             this.$errors.fail(`Package name must look like: com.company.Name. Got: ${packageName}`);
         }
+        //Class is a reserved word
         if (/\b[Cc]lass\b/.test(packageName)) {
             this.$errors.fail("class is a reserved word");
         }
@@ -425,6 +477,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         if (projectName === "") {
             this.$errors.fail("Project name cannot be empty");
         }
+        //Classes in Java don't begin with numbers
         if (/^[0-9]/.test(projectName)) {
             this.$errors.fail("Project name must not begin with a number");
         }
@@ -445,6 +498,19 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         ];
         return path.join(this.getPlatformData(projectData).projectRoot, ...resourcePath);
     }
+    /**
+     * The purpose of this method is to delete the previously prepared user resources.
+     * The content of the `<platforms>/android/.../res` directory is based on user's resources and gradle project template from android-runtime.
+     * During preparation of the `<path to user's App_Resources>/Android` we want to clean all the users files from previous preparation,
+     * but keep the ones that were introduced during `platform add` of the android-runtime.
+     * Currently the Gradle project template contains resources only in values and values-v21 directories.
+     * So the current logic of the method is cleaning al resources from `<platforms>/android/.../res` that are not in `values.*` directories
+     * and that exist in the `<path to user's App_Resources>/Android/.../res` directory
+     * This means that if user has a resource file in values-v29 for example, builds the project and then deletes this resource,
+     * it will be kept in platforms directory. Reference issue: `https://github.com/NativeScript/nativescript-cli/issues/5083`
+     * Same is valid for files in `drawable-<resolution>` directories - in case in user's resources there's drawable-hdpi directory,
+     * which is deleted after the first build of app, it will remain in platforms directory.
+     */
     cleanUpPreparedResources(projectData) {
         let resourcesDirPath = path.join(projectData.appResourcesDirectoryPath, this.getPlatformData(projectData).normalizedPlatformName);
         if (this.$androidResourcesMigrationService.hasMigrated(projectData.appResourcesDirectoryPath)) {
@@ -469,7 +535,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 const hasUseKotlinPropertyInAppData = `hasUseKotlinPropertyInApp${analyticsDelimiter}${buildStatistics.kotlinUsage.hasUseKotlinPropertyInApp}`;
                 const hasKotlinRuntimeClassesData = `hasKotlinRuntimeClasses${analyticsDelimiter}${buildStatistics.kotlinUsage.hasKotlinRuntimeClasses}`;
                 await this.$analyticsService.trackEventActionInGoogleAnalytics({
-                    action: "Using Kotlin",
+                    action: "Using Kotlin" /* constants.TrackActionNames.UsingKotlin */,
                     additionalData: `${hasUseKotlinPropertyInAppData}${analyticsDelimiter}${hasKotlinRuntimeClassesData}`,
                 });
             }
@@ -502,3 +568,4 @@ __decorate([
     (0, helpers_1.hook)("buildAndroid")
 ], AndroidProjectService.prototype, "buildProject", null);
 yok_1.injector.register("androidProjectService", AndroidProjectService);
+//# sourceMappingURL=android-project-service.js.map

package/lib/services/android-resources-migration-service.js

@@ -46,6 +46,7 @@ class AndroidResourcesMigrationService {
         const appResourcesMainSourceSetResourcesDestination = path.join(appMainSourceSet, constants.RESOURCES_DIR);
         this.$fs.ensureDirectoryExists(appResourcesDestination);
         this.$fs.ensureDirectoryExists(appMainSourceSet);
+        // create /java, /res and /assets in the App_Resources/Android/src/main directory
         this.$fs.ensureDirectoryExists(appResourcesMainSourceSetResourcesDestination);
         this.$fs.ensureDirectoryExists(path.join(appMainSourceSet, "java"));
         this.$fs.ensureDirectoryExists(path.join(appMainSourceSet, constants.ASSETS_DIR));
@@ -59,20 +60,25 @@ class AndroidResourcesMigrationService {
         const resourceFiles = getFiles(appResourcesFiles);
         resourceDirectories.forEach((dir) => {
             if (path.basename(dir) !== "libs") {
+                // don't copy /App_Resources/Android/libs into the src/main/res/libs directory
                 this.$fs.copyFile(dir, appResourcesMainSourceSetResourcesDestination);
             }
             else {
+                // copy App_Resources/Android/libs to App_ResourcesNew/Android/libs
                 this.$fs.copyFile(dir, path.join(appResourcesDestination));
             }
         });
         resourceFiles.forEach((file) => {
             const fileName = path.basename(file);
             if (fileName !== constants.MANIFEST_FILE_NAME) {
+                // don't copy AndroidManifest into /App_Resources/Android as it needs to be inside src/main/
                 this.$fs.copyFile(file, path.join(appResourcesDestination, fileName));
             }
         });
         this.$fs.copyFile(path.join(originalAppResources, constants.MANIFEST_FILE_NAME), path.join(appMainSourceSet, constants.MANIFEST_FILE_NAME));
+        // rename the legacy app_resources to ANDROID_DIR_OLD
         this.$fs.rename(originalAppResources, appResourcesBackup);
+        // move the new, updated app_resources to App_Resources/Android, as  the de facto resources
         this.$fs.rename(appResourcesDestination, originalAppResources);
     }
     recover(originalAppResources, appResourcesDestination, appResourcesBackup) {
@@ -89,3 +95,4 @@ AndroidResourcesMigrationService.ANDROID_DIR = "Android";
 AndroidResourcesMigrationService.ANDROID_DIR_TEMP = "Android-Updated";
 AndroidResourcesMigrationService.ANDROID_DIR_OLD = "Android-Pre-v4";
 yok_1.injector.register("androidResourcesMigrationService", AndroidResourcesMigrationService);
+//# sourceMappingURL=android-resources-migration-service.js.map

package/lib/services/apple-portal/apple-portal-application-service.js

@@ -63,3 +63,4 @@ class ApplePortalApplicationService {
 }
 exports.ApplePortalApplicationService = ApplePortalApplicationService;
 yok_1.injector.register("applePortalApplicationService", ApplePortalApplicationService);
+//# sourceMappingURL=apple-portal-application-service.js.map

package/lib/services/apple-portal/apple-portal-cookie-service.js

@@ -51,3 +51,4 @@ class ApplePortalCookieService {
 }
 exports.ApplePortalCookieService = ApplePortalCookieService;
 yok_1.injector.register("applePortalCookieService", ApplePortalCookieService);
+//# sourceMappingURL=apple-portal-cookie-service.js.map

package/lib/services/apple-portal/apple-portal-session-service.js

@@ -201,10 +201,10 @@ For more details how to set up your environment, please execute "ns publish ios
         const data = JSON.parse(authResponse.body);
         const isSMS = data.trustedPhoneNumbers &&
             data.trustedPhoneNumbers.length === 1 &&
-            data.noTrustedDevices;
+            data.noTrustedDevices; // 1 device and no trusted devices means sms was automatically sent.
         const multiSMS = data.trustedPhoneNumbers &&
             data.trustedPhoneNumbers.length !== 1 &&
-            data.noTrustedDevices;
+            data.noTrustedDevices; // Not handling more than 1 sms device and no trusted devices.
         let token;
         if (data.trustedPhoneNumbers &&
             data.trustedPhoneNumbers.length &&
@@ -218,6 +218,7 @@ For more details how to set up your environment, please execute "ns publish ios
             };
             let url = `https://idmsa.apple.com/appleauth/auth/verify/trusteddevice/securitycode`;
             if (isSMS) {
+                // No trusted devices means it must be sms.
                 body.mode = "sms";
                 body.phoneNumber = {
                     id: data.trustedPhoneNumbers[0].id,
@@ -280,8 +281,9 @@ function checkBits(bits, digest) {
     return result;
 }
 function checkBit(position, buffer) {
-    const bitOffset = position & 7;
-    const byteIndex = position >> 3;
+    const bitOffset = position & 7; // in byte
+    const byteIndex = position >> 3; // in buffer
     const bit = (buffer[byteIndex] >> bitOffset) & 1;
     return bit === 0;
 }
+//# sourceMappingURL=apple-portal-session-service.js.map

package/lib/services/apple-portal/srp/srp-wrapper.js

@@ -28,7 +28,9 @@ class GSASRPAuthenticator {
     async getInit() {
         if (this.srpClient)
             throw new Error("Already initialized");
-        this.srpClient = await srp.newClient(stringToU8Array(this.username), new Uint8Array());
+        this.srpClient = await srp.newClient(stringToU8Array(this.username), 
+        // provide fake passsword because we need to get data from server
+        new Uint8Array());
         let a = Buffer.from(js_srp_1.util.bytesFromBigint(this.srpClient.A)).toString("base64");
         return {
             a,
@@ -59,3 +61,4 @@ class GSASRPAuthenticator {
     }
 }
 exports.GSASRPAuthenticator = GSASRPAuthenticator;
+//# sourceMappingURL=srp-wrapper.js.map

package/lib/services/assets-generation/assets-generation-service.js

@@ -82,7 +82,7 @@ class AssetsGenerationService {
                 }
                 continue;
             }
-            const operation = assetItem.resizeOperation || "resize";
+            const operation = assetItem.resizeOperation || "resize" /* Operations.Resize */;
             let tempScale = null;
             if (assetItem.scale) {
                 if (_.isNumber(assetItem.scale)) {
@@ -107,27 +107,31 @@ class AssetsGenerationService {
             }
             let image;
             switch (operation) {
-                case "overlayWith":
+                case "overlayWith" /* Operations.OverlayWith */:
                     const overlayImageScale = assetItem.overlayImageScale ||
                         constants_1.AssetConstants.defaultOverlayImageScale;
                     const imageResize = Math.round(Math.min(width, height) * overlayImageScale);
                     image = await this.resize(generationData.imagePath, imageResize, imageResize);
                     image = this.generateImage(background, width, height, image);
                     break;
-                case "blank":
+                case "blank" /* Operations.Blank */:
                     image = this.generateImage(background, width, height);
                     break;
-                case "resize":
+                case "resize" /* Operations.Resize */:
                     image = await this.resize(generationData.imagePath, width, height);
                     break;
-                case "outerScale":
+                case "outerScale" /* Operations.OuterScale */:
+                    // Resize image without applying scale
                     image = await this.resize(generationData.imagePath, assetItem.width, assetItem.height);
+                    // The scale will apply to the underlying layer of the generated image
                     image = this.generateImage("#00000000", width, height, image);
                     break;
                 default:
                     throw new Error(`Invalid image generation operation: ${operation}`);
             }
+            // This code disables the alpha chanel, as some images for the Apple App Store must not have transparency.
             if (assetItem.rgba === false) {
+                // Add an underlying white layer
                 image = this.generateImage("#FFFFFF", image.width, image.height, image);
             }
             if (this.isAssetFilePath(outputPath)) {
@@ -181,3 +185,4 @@ __decorate([
     (0, decorators_1.exported)("assetsGenerationService")
 ], AssetsGenerationService.prototype, "generateSplashScreens", null);
 yok_1.injector.register("assetsGenerationService", AssetsGenerationService);
+//# sourceMappingURL=assets-generation-service.js.map

package/lib/services/build-artifacts-service.js

@@ -64,7 +64,7 @@ class BuildArtifactsService {
         if (packages.length > 1) {
             this.$logger.warn(`More than one ${packageExtName} found in ${buildOutputPath} directory. Using the last one produced from build.`);
         }
-        packages = _.sortBy(packages, (pkg) => pkg.time).reverse();
+        packages = _.sortBy(packages, (pkg) => pkg.time).reverse(); // We need to reverse because sortBy always sorts in ascending order
         return packages[0];
     }
     getApplicationPackagesCore(candidates, validPackageNames) {
@@ -85,3 +85,4 @@ class BuildArtifactsService {
 }
 exports.BuildArtifactsService = BuildArtifactsService;
 yok_1.injector.register("buildArtifactsService", BuildArtifactsService);
+//# sourceMappingURL=build-artifacts-service.js.map

package/lib/services/build-data-service.js

@@ -18,3 +18,4 @@ class BuildDataService {
 }
 exports.BuildDataService = BuildDataService;
 yok_1.injector.register("buildDataService", BuildDataService);
+//# sourceMappingURL=build-data-service.js.map

package/lib/services/build-info-file-service.js

@@ -62,3 +62,4 @@ class BuildInfoFileService {
 }
 exports.BuildInfoFileService = BuildInfoFileService;
 yok_1.injector.register("buildInfoFileService", BuildInfoFileService);
+//# sourceMappingURL=build-info-file-service.js.map

package/lib/services/bundler/bundler-compiler-service.js

@@ -16,7 +16,8 @@ const constants_1 = require("../../constants");
 const yok_1 = require("../../common/yok");
 const package_path_helper_1 = require("../../helpers/package-path-helper");
 class BundlerCompilerService extends events_1.EventEmitter {
-    constructor($options, $errors, $childProcess, $fs, $hooksService, $hostInfo, $logger, $mobileHelper, $cleanupService, $packageManager, $packageInstallationManager, $projectConfigService) {
+    constructor($options, $errors, $childProcess, $fs, $hooksService, $hostInfo, $logger, $mobileHelper, $cleanupService, $packageManager, $packageInstallationManager, // private $sharedEventBus: ISharedEventBus
+    $projectConfigService) {
         super();
         this.$options = $options;
         this.$errors = $errors;
@@ -51,14 +52,23 @@ class BundlerCompilerService extends events_1.EventEmitter {
                 });
                 childProcess.on("message", (message) => {
                     this.$logger.trace(`Message from ${projectData.bundler}`, message);
+                    // if we are on webpack5 - we handle HMR in a  slightly different way
                     if (typeof message === "object" &&
                         "version" in message &&
                         "type" in message) {
+                        // first compilation can be ignored because it will be synced regardless
+                        // handling it here would trigger 2 syncs
                         if (isFirstBundlerWatchCompilation) {
                             isFirstBundlerWatchCompilation = false;
                             resolve(childProcess);
                             return;
                         }
+                        // if ((message as IWebpackMessage).type === "hmr-status") {
+                        // 	// we pass message through our event-bus to be handled wherever needed
+                        // 	// in this case webpack-hmr-status-service listens for this event
+                        // 	this.$sharedEventBus.emit("webpack:hmr-status", message);
+                        // 	return;
+                        // }
                         return this.handleHMRMessage(message, platformData, projectData, prepareData);
                     }
                     if (message ===
@@ -74,6 +84,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
                                 prepareData.hmr ? message.hash : "";
                             return;
                         }
+                        // Persist the previousHash value before calling `this.getUpdatedEmittedFiles` as it will modify the expectedHashes object with the current hash
                         const previousHash = this.expectedHashes[platformData.platformNameLowerCase];
                         let result;
                         if (prepareData.hmr) {
@@ -98,6 +109,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
                             platform: platformData.platformNameLowerCase,
                         };
                         this.$logger.trace(`Generated data from ${projectData.bundler} message:`, data);
+                        // the hash of the compilation is the same as the previous one and there are only hot updates produced
                         if (data.hasOnlyHotUpdateFiles && previousHash === message.hash) {
                             return;
                         }
@@ -115,6 +127,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
                     const exitCode = typeof arg === "number" ? arg : arg && arg.code;
                     this.$logger.trace(`${capitalizeFirstLetter(projectData.bundler)} process exited with code ${exitCode} when we expected it to be long living with watch.`);
                     if (this.getBundler() === "vite" && exitCode === 0) {
+                        // note experimental: investigate watch mode
                         const bundlePath = path.join(projectData.projectDir, "dist/bundle.js");
                         console.log("bundlePath:", bundlePath);
                         const data = {
@@ -183,6 +196,9 @@ class BundlerCompilerService extends events_1.EventEmitter {
         }
     }
     async shouldUsePreserveSymlinksOption() {
+        // pnpm does not require symlink (https://github.com/nodejs/node-eps/issues/46#issuecomment-277373566)
+        // and it also does not work in some cases.
+        // Check https://github.com/NativeScript/nativescript-cli/issues/5259 for more information
         const currentPackageManager = await this.$packageManager.getPackageManagerName();
         const res = currentPackageManager !== constants_1.PackageManagers.pnpm;
         return res;
@@ -201,6 +217,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
         const envData = this.buildEnvData(platformData.platformNameLowerCase, projectData, prepareData);
         const isVite = this.getBundler() === "vite";
         const cliArgs = await this.buildEnvCommandLineParams(envData, platformData, projectData, prepareData);
+        // Note: With Vite, we need `--` to prevent vite cli from erroring on unknown options.
         const envParams = isVite
             ? [`--mode=${platformData.platformNameLowerCase}`, "--", ...cliArgs]
             : cliArgs;
@@ -261,16 +278,28 @@ class BundlerCompilerService extends events_1.EventEmitter {
         });
         envData.verbose = envData.verbose || this.$logger.isVerbose();
         envData.production = envData.production || prepareData.release;
+        // add the config file name to the env data so the webpack process can read the
+        // correct config file when resolving the CLI lib and the config service
+        // we are explicitly setting it to false to force using the defaults
         envData.config =
             (_b = (_a = process.env.NATIVESCRIPT_CONFIG_NAME) !== null && _a !== void 0 ? _a : this.$options.config) !== null && _b !== void 0 ? _b : "false";
+        // explicitly set the env variable
         process.env.NATIVESCRIPT_CONFIG_NAME = envData.config;
+        // The snapshot generation is wrongly located in the Webpack plugin.
+        // It should be moved in the Native Prepare of the CLI or a Gradle task in the Runtime.
+        // As a workaround, we skip the mksnapshot, xxd and android-ndk calls based on skipNativePrepare.
+        // In this way the plugin will prepare only the snapshot JS entry without any native prepare and
+        // we will able to execute cloud builds with snapshot without having any local snapshot or Docker setup.
+        // TODO: Remove this flag when we remove the native part from the plugin.
         envData.skipSnapshotTools =
             prepareData.nativePrepare && prepareData.nativePrepare.skipNativePrepare;
+        // only set sourceMap if not explicitly set through a flag
         if (typeof ((_c = prepareData === null || prepareData === void 0 ? void 0 : prepareData.env) === null || _c === void 0 ? void 0 : _c.sourceMap) === "undefined") {
             if (!prepareData.release) {
                 envData.sourceMap = true;
             }
         }
+        // convert string to boolean
         if (envData.sourceMap === "true" || envData.sourceMap === "false") {
             envData.sourceMap = envData.sourceMap === "true";
         }
@@ -291,6 +320,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
             }
             else if (this.$hostInfo.isWindows) {
                 if (projectData.bundler === "webpack") {
+                    //TODO: check this use case for webpack5 WEBPACK_PLUGIN_NAME
                     const minWebpackPluginWithWinSnapshotsVersion = "1.3.0";
                     const installedWebpackPluginVersion = await this.$packageInstallationManager.getInstalledDependencyVersion(constants_1.WEBPACK_PLUGIN_NAME, projectData.projectDir);
                     const hasWebpackPluginWithWinSnapshotsSupport = !!installedWebpackPluginVersion
@@ -324,6 +354,15 @@ class BundlerCompilerService extends events_1.EventEmitter {
     }
     getUpdatedEmittedFiles(allEmittedFiles, chunkFiles, nextHash, platform) {
         const currentHash = this.getCurrentHotUpdateHash(allEmittedFiles);
+        // This logic is needed as there are already cases when webpack doesn't emit any files physically.
+        // We've set noEmitOnErrors in webpack.config.js based on noEmitOnError from tsconfig.json,
+        // so webpack doesn't emit any files when noEmitOnErrors: true is set in webpack.config.js and
+        // there is a compilation error in the source code. On the other side, hmr generates new hot-update files
+        // on every change and the hash of the next hmr update is written inside hot-update.json file.
+        // Although webpack doesn't emit any files, hmr hash is still generated. The hash is generated per compilation no matter
+        // if files will be emitted or not. This way, the first successful compilation after fixing the compilation error generates
+        // a hash that is not the same as the one expected in the latest emitted hot-update.json file.
+        // As a result, the hmr chain is broken and the changes are not applied.
         const isHashValid = nextHash
             ? this.expectedHashes[platform] === currentHash
             : true;
@@ -342,6 +381,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
         let hotHash;
         const hotUpdateScripts = emittedFiles.filter((x) => x.endsWith(".hot-update.js"));
         if (hotUpdateScripts && hotUpdateScripts.length) {
+            // the hash is the same for each hot update in the current compilation
             const hotUpdateName = hotUpdateScripts[0];
             const matcher = /^(.+)\.(.+)\.hot-update/gm;
             const matches = matcher.exec(hotUpdateName);
@@ -359,6 +399,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
         }
     }
     handleHMRMessage(message, platformData, projectData, prepareData) {
+        // handle new bundler hmr packets
         this.$logger.trace(`Received message from ${projectData.bundler} process:`, message);
         if (message.type !== "compilation") {
             return;
@@ -366,6 +407,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
         this.$logger.trace(`${capitalizeFirstLetter(projectData.bundler)} build done!`);
         const files = message.data.emittedAssets.map((asset) => path.join(platformData.appDestinationDirectoryPath, this.$options.hostProjectModuleName, asset));
         const staleFiles = message.data.staleAssets.map((asset) => path.join(platformData.appDestinationDirectoryPath, this.$options.hostProjectModuleName, asset));
+        // extract last hash from emitted filenames
         const lastHash = (() => {
             const absoluteFileNameWithLastHash = files.find((fileName) => fileName.endsWith("hot-update.js"));
             if (!absoluteFileNameWithLastHash) {
@@ -378,6 +420,7 @@ class BundlerCompilerService extends events_1.EventEmitter {
             }
         })();
         if (!files.length) {
+            // ignore compilations if no new files are emitted
             return;
         }
         this.emit(constants_1.BUNDLER_COMPILATION_COMPLETE, {
@@ -449,3 +492,4 @@ function capitalizeFirstLetter(val) {
     return String(val).charAt(0).toUpperCase() + String(val).slice(1);
 }
 yok_1.injector.register("bundlerCompilerService", BundlerCompilerService);
+//# sourceMappingURL=bundler-compiler-service.js.map

package/lib/services/bundler/bundler.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=bundler.js.map