refactor: the CLI builds aar files if necessary even with no --syncAllFiles flag

* removed invalid test

* move gradlew plugin to vendor folder and add licese file
* add unit test for android build plugin service

Author: Plamen5kov

lib/services/android-plugin-build-service.ts

@@ -1,7 +1,6 @@
 import * as path from "path";
 import * as shell from "shelljs";
-
-const xml2js = require("xml2js");
+import { Builder, parseString } from "xml2js";
 
 export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 
@@ -17,11 +16,12 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			"xmlns:android": "http://schemas.android.com/apk/res/android"
 		}
 	};
-	private static ANDROID_PLUGIN_GRADLE_TEMPLATE = "gradle-plugin";
+	private static ANDROID_PLUGIN_GRADLE_TEMPLATE = "../../vendor/gradle-plugin";
 
 	private getAndroidSourceDirectories(source: string): Array<string> {
 		const directories = ["res", "java", "assets", "jniLibs"];
 		const resultArr: Array<string> = [];
+
 		this.$fs.enumerateFilesInDirectorySync(source, (file, stat) => {
 			if (stat.isDirectory() && _.some(directories, (element) => file.endsWith(element))) {
 				resultArr.push(file);
@@ -32,11 +32,9 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		return resultArr;
 	}
 
-	private getManifest(platformsDir: string) {
-		const manifests = this.$fs
-			.readDirectory(platformsDir)
-			.filter(fileName => fileName === AndroidPluginBuildService.ANDROID_MANIFEST_XML);
-		return manifests.length > 0 ? path.join(platformsDir, manifests[0]) : null;
+	private getManifest(platformsDir: string): string {
+		const manifest = path.join(platformsDir, AndroidPluginBuildService.ANDROID_MANIFEST_XML);
+		return this.$fs.exists(manifest) ? manifest : null;
 	}
 
 	private getShortPluginName(pluginName: string): string {
@@ -68,26 +66,24 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 
 		newManifest.manifest["$"]["package"] = packageName;
 
-		const xmlBuilder = new xml2js.Builder();
+		const xmlBuilder = new Builder();
 		newManifestContent = xmlBuilder.buildObject(newManifest);
 
 		return newManifestContent;
 	}
 
-	private createManifestContent(packageName: string) {
+	private createManifestContent(packageName: string): string {
 		let newManifestContent;
 		const newManifest: any = { manifest: AndroidPluginBuildService.MANIFEST_ROOT };
 		newManifest.manifest["$"]["package"] = packageName;
-		const xmlBuilder: any = new xml2js.Builder();
+		const xmlBuilder: any = new Builder();
 		newManifestContent = xmlBuilder.buildObject(newManifest);
 
 		return newManifestContent;
 	}
 
-	private async getXml(stringContent: string) {
-		const parseString = xml2js.parseString;
-
-		const promise = new Promise((resolve, reject) =>
+	private async getXml(stringContent: string): Promise<any> {
+		const promise = new Promise<any>((resolve, reject) =>
 			parseString(stringContent, (err: any, result: any) => {
 				if (err) {
 					reject(err);
@@ -100,11 +96,11 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		return promise;
 	}
 
-	private copyRecursive(source: string, destination: string) {
+	private copyRecursive(source: string, destination: string): void {
 		shell.cp("-R", source, destination);
 	}
 
-	private getIncludeGradleCompileDependenciesScope(includeGradleFileContent: string) {
+	private getIncludeGradleCompileDependenciesScope(includeGradleFileContent: string): Array<string> {
 		const indexOfDependenciesScope = includeGradleFileContent.indexOf("dependencies");
 		const result: Array<string> = [];
 
@@ -126,7 +122,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		return result;
 	}
 
-	private getScope(scopeName: string, content: string) {
+	private getScope(scopeName: string, content: string): string {
 		const indexOfScopeName = content.indexOf(scopeName);
 		let result = "";
 		const OPENING_BRACKET = "{";
@@ -206,9 +202,9 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			if (manifestFilePath) {
 				let androidManifestContent;
 				try {
-					androidManifestContent = this.$fs.readFile(manifestFilePath).toString();
+					androidManifestContent = this.$fs.readText(manifestFilePath);
 				} catch (err) {
-					throw Error(
+					throw new Error(
 						`Failed to fs.readFileSync the manifest file located at ${manifestFilePath}`
 					);
 				}
@@ -223,7 +219,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			try {
 				this.$fs.writeFile(pathToNewAndroidManifest, updatedManifestContent);
 			} catch (e) {
-				throw Error(`Failed to write the updated AndroidManifest in the new location - ${pathToNewAndroidManifest}`);
+				throw new Error(`Failed to write the updated AndroidManifest in the new location - ${pathToNewAndroidManifest}`);
 			}
 
 			// copy all android sourceset directories to the new temporary plugin dir
@@ -241,18 +237,16 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			// copy the preconfigured gradle android library project template to the temporary android library
 			this.copyRecursive(path.join(path.resolve(path.join(__dirname, AndroidPluginBuildService.ANDROID_PLUGIN_GRADLE_TEMPLATE), "*")), newPluginDir);
 
-			// sometimes the AndroidManifest.xml or certain resources in /res may have a compile dependency to a lbirary referenced in include.gradle. Make sure to compile the plugin with a compile dependency to those libraries
+			// sometimes the AndroidManifest.xml or certain resources in /res may have a compile dependency to a library referenced in include.gradle. Make sure to compile the plugin with a compile dependency to those libraries
 			const includeGradlePath = path.join(options.platformsAndroidDirPath, "include.gradle");
 			if (this.$fs.exists(includeGradlePath)) {
-				const includeGradleContent = this.$fs.readFile(includeGradlePath)
-					.toString();
+				const includeGradleContent = this.$fs.readText(includeGradlePath);
 				const repositoriesAndDependenciesScopes = this.getIncludeGradleCompileDependenciesScope(includeGradleContent);
 
 				// dependencies { } object was found - append dependencies scope
 				if (repositoriesAndDependenciesScopes.length > 0) {
 					const buildGradlePath = path.join(newPluginDir, "build.gradle");
-					this.$fs.appendFile(buildGradlePath, "\n" + repositoriesAndDependenciesScopes.join("\n")
-					);
+					this.$fs.appendFile(buildGradlePath, "\n" + repositoriesAndDependenciesScopes.join("\n"));
 				}
 			}
 
@@ -277,7 +271,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			try {
 				await this.$childProcess.exec(localArgs.join(" "), { cwd: newPluginDir });
 			} catch (err) {
-				throw Error(`Failed to build plugin ${options.pluginName} : \n${err}`);
+				throw new Error(`Failed to build plugin ${options.pluginName} : \n${err}`);
 			}
 
 			const finalAarName = `${shortPluginName}-release.aar`;
@@ -289,12 +283,12 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 						this.copyRecursive(pathToBuiltAar, path.join(options.aarOutputDir, `${shortPluginName}.aar`));
 					}
 				} catch (e) {
-					throw Error(`Failed to copy built aar to destination. ${e.message}`);
+					throw new Error(`Failed to copy built aar to destination. ${e.message}`);
 				}
 
 				return true;
 			} else {
-				throw Error(`No built aar found at ${pathToBuiltAar}`);
+				throw new Error(`No built aar found at ${pathToBuiltAar}`);
 			}
 		}
 
@@ -315,7 +309,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			try {
 				includeGradleFileContent = this.$fs.readFile(includeGradleFilePath).toString();
 			} catch (err) {
-				throw Error(`Failed to fs.readFileSync the include.gradle file located at ${includeGradleFilePath}`);
+				throw new Error(`Failed to fs.readFileSync the include.gradle file located at ${includeGradleFilePath}`);
 			}
 
 			const productFlavorsScope = this.getScope("productFlavors", includeGradleFileContent);
@@ -325,14 +319,14 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 				this.$fs.writeFile(includeGradleFilePath, newIncludeGradleFileContent);
 
 			} catch (e) {
-				throw Error(`Failed to write the updated include.gradle in - ${includeGradleFilePath}`);
+				throw new Error(`Failed to write the updated include.gradle in - ${includeGradleFilePath}`);
 			}
 		}
 	}
 
-	private validateOptions(options: IBuildOptions) {
+	private validateOptions(options: IBuildOptions): void {
 		if (!options) {
-			throw Error("Android plugin cannot be built without passing an 'options' object.");
+			throw new Error("Android plugin cannot be built without passing an 'options' object.");
 		}
 
 		if (!options.pluginName) {
@@ -344,19 +338,19 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		}
 
 		if (!options.tempPluginDirPath) {
-			throw Error("Android plugin cannot be built without passing the path to a directory where the temporary project should be built.");
+			throw new Error("Android plugin cannot be built without passing the path to a directory where the temporary project should be built.");
 		}
 
 		this.validatePlatformsAndroidDirPathOption(options);
 	}
 
-	private validatePlatformsAndroidDirPathOption(options: IBuildOptions) {
+	private validatePlatformsAndroidDirPathOption(options: IBuildOptions): void {
 		if (!options) {
-			throw Error("Android plugin cannot be built without passing an 'options' object.");
+			throw new Error("Android plugin cannot be built without passing an 'options' object.");
 		}
 
 		if (!options.platformsAndroidDirPath) {
-			throw Error("Android plugin cannot be built without passing the path to the platforms/android dir.");
+			throw new Error("Android plugin cannot be built without passing the path to the platforms/android dir.");
 		}
 	}
 

lib/services/android-project-service.ts

@@ -436,15 +436,15 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 					tempPluginDirPath: path.join(projectData.platformsDir, "tempPlugin")
 				};
 
-				this.prebuildNativePlugin(options);
+				await this.prebuildNativePlugin(options);
 			}
 		}
 
 		// Do nothing, the Android Gradle script will configure itself based on the input dependencies.json
 	}
 
-	public async checkIfPluginsNeedBuild(projectData: IProjectData): Promise<Array<any>> {
-		const detectedPlugins: Array<any> = [];
+	public async checkIfPluginsNeedBuild(projectData: IProjectData): Promise<Array<{ platformsAndroidDirPath: string, pluginName: string }>> {
+		const detectedPlugins: Array<{ platformsAndroidDirPath: string, pluginName: string }> = [];
 
 		const platformsAndroid = path.join(constants.PLATFORMS_DIR_NAME, "android");
 		const pathToPlatformsAndroid = path.join(projectData.projectDir, platformsAndroid);
@@ -477,15 +477,15 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 							const currentItemStat = this.$fs.getFsStats(item);
 							if (currentItemStat.mtime > aarStat.mtime) {
 								detectedPlugins.push({
-									platformsAndroidDirPath: platformsAndroidDirPath,
-									pluginName: pluginName
+									platformsAndroidDirPath,
+									pluginName
 								});
 							}
 						});
 					} else if (nativeFiles.length > 0) {
 						detectedPlugins.push({
-							platformsAndroidDirPath: platformsAndroidDirPath,
-							pluginName: pluginName
+							platformsAndroidDirPath,
+							pluginName
 						});
 					}
 				}
@@ -494,7 +494,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		return detectedPlugins;
 	}
 
-	private isAllowedFile(item: string) {
+	private isAllowedFile(item: string): boolean {
 		return item.endsWith(constants.MANIFEST_FILE_NAME) || item.endsWith(constants.RESOURCES_DIR);
 	}
 

lib/services/livesync/livesync-service.ts

@@ -2,9 +2,9 @@ import * as path from "path";
 import * as choki from "chokidar";
 import { EOL } from "os";
 import { EventEmitter } from "events";
-import { hook, executeActionByChunks, isBuildFromCLI } from "../../common/helpers";
+import { hook, isBuildFromCLI } from "../../common/helpers";
 import { PACKAGE_JSON_FILE_NAME, LiveSyncTrackActionNames, USER_INTERACTION_NEEDED_EVENT_NAME, DEBUGGER_ATTACHED_EVENT_NAME, DEBUGGER_DETACHED_EVENT_NAME, TrackActionNames } from "../../constants";
-import { DEFAULT_CHUNK_SIZE, DeviceTypes, DeviceDiscoveryEventNames } from "../../common/constants";
+import { DeviceTypes, DeviceDiscoveryEventNames } from "../../common/constants";
 import { cache } from "../../common/decorators";
 
 const deviceDescriptorPrimaryKey = "identifier";
@@ -37,8 +37,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		private $debugDataService: IDebugDataService,
 		private $analyticsService: IAnalyticsService,
 		private $usbLiveSyncService: DeprecatedUsbLiveSyncService,
-		private $injector: IInjector,
-		private $platformsData: IPlatformsData) {
+		private $injector: IInjector) {
 		super();
 	}
 
@@ -463,26 +462,6 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 				const platform = device.deviceInfo.platform;
 				const deviceBuildInfoDescriptor = _.find(deviceDescriptors, dd => dd.identifier === device.deviceInfo.identifier);
 
-				if (liveSyncData.watchAllFiles) {
-					const platformData: IPlatformData = this.$platformsData.getPlatformData("android", projectData);
-					const pluginsNeedingRebuild: Array<any> = await platformData.platformProjectService.checkIfPluginsNeedBuild(projectData);
-					const action = async (buildAarOptions: IBuildOptions) => {
-						this.$logger.warn(`Building ${buildAarOptions.pluginName}...`);
-						await platformData.platformProjectService.prebuildNativePlugin(buildAarOptions);
-					};
-					const pluginInfo: any = [];
-					pluginsNeedingRebuild.forEach((item) => {
-						const options: IBuildOptions = {
-							pluginName: item.pluginName,
-							platformsAndroidDirPath: item.platformsAndroidDirPath,
-							aarOutputDir: item.platformsAndroidDirPath,
-							tempPluginDirPath: path.join(projectData.platformsDir, 'tempPlugin')
-						};
-						pluginInfo.push(options);
-					});
-					await executeActionByChunks<IBuildOptions>(pluginInfo, DEFAULT_CHUNK_SIZE, action);
-				}
-
 				await this.ensureLatestAppPackageIsInstalledOnDevice({
 					device,
 					preparedPlatforms,
@@ -582,37 +561,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 								filesToRemove = [];
 
 								const allModifiedFiles = [].concat(currentFilesToSync).concat(currentFilesToRemove);
-								if (liveSyncData.watchAllFiles) {
-
-									const platformData: IPlatformData = this.$platformsData.getPlatformData("android", projectData);
-									const pluginInfo: any = [];
-									allModifiedFiles.forEach(async (item) => {
-										const matchedItem = item.match(/(.*\/node_modules\/[\w-]+)\/platforms\/android\//);
-										if (matchedItem) {
-											const matchLength = matchedItem[0].length;
-											const matchIndex = item.indexOf(matchedItem[0]);
-											const pluginInputOutputPath = item.substr(0, matchIndex + matchLength);
-											const pluginPackageJason = require(path.resolve(matchedItem[1], PACKAGE_JSON_FILE_NAME));
-
-											if (pluginPackageJason && pluginPackageJason.name) {
-												const options: IBuildOptions = {
-													pluginName: pluginPackageJason.name,
-													platformsAndroidDirPath: pluginInputOutputPath,
-													aarOutputDir: pluginInputOutputPath,
-													tempPluginDirPath: path.join(projectData.platformsDir, "tempPlugin")
-												};
-												pluginInfo.push(options);
-											}
-										}
-									});
-
-									const action = async (buildAarOptions: IBuildOptions) => {
-										this.$logger.warn(`Building ${buildAarOptions.pluginName}...`);
-										await platformData.platformProjectService.prebuildNativePlugin(buildAarOptions);
-									};
 
-									await executeActionByChunks<IBuildOptions>(pluginInfo, DEFAULT_CHUNK_SIZE, action);
-								}
 								const preparedPlatforms: string[] = [];
 								const rebuiltInformation: ILiveSyncBuildInfo[] = [];
 

lib/services/platform-service.ts

@@ -203,7 +203,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 
 	public async preparePlatform(platformInfo: IPreparePlatformInfo): Promise<boolean> {
 		const changesInfo = await this.getChangesInfo(platformInfo);
-		const shouldPrepare = await this.shouldPrepare({ platformInfo, changesInfo });
+		const shouldPrepare = changesInfo.nativeChanged || await this.shouldPrepare({ platformInfo, changesInfo });
 
 		if (shouldPrepare) {
 			// Always clear up the app directory in platforms if `--bundle` value has changed in between builds or is passed in general
@@ -309,6 +309,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 				platformSpecificData,
 				changesInfo,
 				filesToSync,
+				filesToRemove,
 				projectFilesConfig,
 				env
 			});

lib/services/project-changes-service.ts

@@ -64,7 +64,7 @@ export class ProjectChangesService implements IProjectChangesService {
 			this._changesInfo.packageChanged = this.isProjectFileChanged(projectData, platform);
 			this._changesInfo.appResourcesChanged = this.containsNewerFiles(projectData.appResourcesDirectoryPath, null, projectData);
 			/*done because currently all node_modules are traversed, a possible improvement could be traversing only the production dependencies*/
-			this._changesInfo.nativeChanged = projectChangesOptions.skipModulesNativeCheck ? false : this.containsNewerFiles(
+			this._changesInfo.nativeChanged = this.containsNewerFiles(
 				path.join(projectData.projectDir, NODE_MODULES_FOLDER_NAME),
 				path.join(projectData.projectDir, NODE_MODULES_FOLDER_NAME, "tns-ios-inspector"),
 				projectData,

lib/tools/node-modules/node-modules-dest-copy.ts

@@ -140,7 +140,7 @@ export class NpmPluginPrepare {
 	}
 
 	public async preparePlugins(dependencies: IDependencyData[], platform: string, projectData: IProjectData, projectFilesConfig: IProjectFilesConfig): Promise<void> {
-		if (_.isEmpty(dependencies) || this.allPrepared(dependencies, platform, projectData)) {
+		if (_.isEmpty(dependencies)) {
 			return;
 		}