feat: Rebuild plugins for Android only when necessary

In case CLI builds `.aar` file for the Android part of a plugin during project preparation, consecutive prepares should not build the `.aar` file. Add logic to keep the hashes of the files that have been used for building the plugin and persist them in the `<project dir>/platforms/tempPlugin/<plugin-name>/plugin-data.json`.
Before building a new `.aar` file, CLI will check if the mentioned file exists and compare its content with the shasums of the current source files of the plugin. This way we ensure the `.aar` will be built only when the sources are changed.

Author: rosen-vladimirov

lib/common

@@ -217,3 +217,5 @@ export const PACKAGE_PLACEHOLDER_NAME = "__PACKAGE__";
 export class AddPlaformErrors {
 	public static InvalidFrameworkPathStringFormat = "Invalid frameworkPath: %s. Please ensure the specified frameworkPath exists.";
 }
+
+export const PLUGIN_BUILD_DATA_FILENAME = "plugin-data.json";

lib/constants.ts

@@ -1,4 +1,5 @@
 interface IFilesHashService {
 	generateHashes(files: string[]): Promise<IStringDictionary>;
 	getChanges(files: string[], oldHashes: IStringDictionary): Promise<IStringDictionary>;
-}
+	hasChangesInShasums(oldHashes: IStringDictionary, newHashes: IStringDictionary): boolean;
+}

lib/definitions/files-hash-service.d.ts

@@ -1,5 +1,5 @@
 import * as path from "path";
-import { MANIFEST_FILE_NAME, INCLUDE_GRADLE_NAME, ASSETS_DIR, RESOURCES_DIR, TNS_ANDROID_RUNTIME_NAME, AndroidBuildDefaults } from "../constants";
+import { MANIFEST_FILE_NAME, INCLUDE_GRADLE_NAME, ASSETS_DIR, RESOURCES_DIR, TNS_ANDROID_RUNTIME_NAME, AndroidBuildDefaults, PLUGIN_BUILD_DATA_FILENAME } from "../constants";
 import { getShortPluginName, hook } from "../common/helpers";
 import { Builder, parseString } from "xml2js";
 import { ILogger } from "log4js";
@@ -25,7 +25,8 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		private $npm: INodePackageManager,
 		private $projectDataService: IProjectDataService,
 		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
-		private $errors: IErrors) { }
+		private $errors: IErrors,
+		private $filesHashService: IFilesHashService) { }
 
 	private static MANIFEST_ROOT = {
 		$: {
@@ -172,23 +173,79 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		this.validateOptions(options);
 		const manifestFilePath = this.getManifest(options.platformsAndroidDirPath);
 		const androidSourceDirectories = this.getAndroidSourceDirectories(options.platformsAndroidDirPath);
-		const shouldBuildAar = !!manifestFilePath || androidSourceDirectories.length > 0;
+		const shortPluginName = getShortPluginName(options.pluginName);
+		const pluginTempDir = path.join(options.tempPluginDirPath, shortPluginName);
+		const pluginSourceFileHashesInfo = await this.getSourceFilesHashes(options.platformsAndroidDirPath, shortPluginName);
+
+		const shouldBuildAar = await this.shouldBuildAar({
+			manifestFilePath,
+			androidSourceDirectories,
+			pluginTempDir,
+			pluginSourceDir: options.platformsAndroidDirPath,
+			shortPluginName,
+			fileHashesInfo: pluginSourceFileHashesInfo
+		});
 
 		if (shouldBuildAar) {
-			const shortPluginName = getShortPluginName(options.pluginName);
-			const pluginTempDir = path.join(options.tempPluginDirPath, shortPluginName);
-			const pluginTempMainSrcDir = path.join(pluginTempDir, "src", "main");
+			// In case plugin was already built in the current process, we need to clean the old sources as they may break the new build.
+			this.$fs.deleteDirectory(pluginTempDir);
+			this.$fs.ensureDirectoryExists(pluginTempDir);
 
+			const pluginTempMainSrcDir = path.join(pluginTempDir, "src", "main");
 			await this.updateManifest(manifestFilePath, pluginTempMainSrcDir, shortPluginName);
 			this.copySourceSetDirectories(androidSourceDirectories, pluginTempMainSrcDir);
 			await this.setupGradle(pluginTempDir, options.platformsAndroidDirPath, options.projectDir);
 			await this.buildPlugin({ pluginDir: pluginTempDir, pluginName: options.pluginName });
 			this.copyAar(shortPluginName, pluginTempDir, options.aarOutputDir);
+			this.writePluginHashInfo(pluginSourceFileHashesInfo, pluginTempDir);
 		}
 
 		return shouldBuildAar;
 	}
 
+	private getSourceFilesHashes(pluginTempPlatformsAndroidDir: string, shortPluginName: string): Promise<IStringDictionary> {
+		const pathToAar = path.join(pluginTempPlatformsAndroidDir, `${shortPluginName}.aar`);
+		const pluginNativeDataFiles = this.$fs.enumerateFilesInDirectorySync(pluginTempPlatformsAndroidDir, (file: string, stat: IFsStats) => {
+			return file !== pathToAar;
+		});
+
+		return this.$filesHashService.generateHashes(pluginNativeDataFiles);
+	}
+
+	private async writePluginHashInfo(fileHashesInfo: IStringDictionary, pluginTempDir: string): Promise<void> {
+		const buildDataFile = this.getPathToPluginBuildDataFile(pluginTempDir);
+		this.$fs.writeJson(buildDataFile, fileHashesInfo);
+	}
+
+	private async shouldBuildAar(opts: {
+		manifestFilePath: string,
+		androidSourceDirectories: string[],
+		pluginTempDir: string,
+		pluginSourceDir: string,
+		shortPluginName: string,
+		fileHashesInfo: IStringDictionary
+	}): Promise<boolean> {
+
+		let shouldBuildAar = !!opts.manifestFilePath || opts.androidSourceDirectories.length > 0;
+
+		if (shouldBuildAar &&
+			this.$fs.exists(opts.pluginTempDir) &&
+			this.$fs.exists(path.join(opts.pluginSourceDir, `${opts.shortPluginName}.aar`))) {
+
+			const buildDataFile = this.getPathToPluginBuildDataFile(opts.pluginTempDir);
+			if (this.$fs.exists(buildDataFile)) {
+				const oldHashes = this.$fs.readJson(buildDataFile);
+				shouldBuildAar = this.$filesHashService.hasChangesInShasums(oldHashes, opts.fileHashesInfo);
+			}
+		}
+
+		return shouldBuildAar;
+	}
+
+	private getPathToPluginBuildDataFile(pluginDir: string): string {
+		return path.join(pluginDir, PLUGIN_BUILD_DATA_FILENAME);
+	}
+
 	private async updateManifest(manifestFilePath: string, pluginTempMainSrcDir: string, shortPluginName: string): Promise<void> {
 		let updatedManifestContent;
 		this.$fs.ensureDirectoryExists(pluginTempMainSrcDir);
@@ -256,7 +313,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		return runtimeGradleVersions || {};
 	}
 
-	private getGradleVersions(packageData: { gradle: { version: string, android: string }}): IRuntimeGradleVersions {
+	private getGradleVersions(packageData: { gradle: { version: string, android: string } }): IRuntimeGradleVersions {
 		const packageJsonGradle = packageData && packageData.gradle;
 		let runtimeVersions: IRuntimeGradleVersions = null;
 		if (packageJsonGradle && (packageJsonGradle.version || packageJsonGradle.android)) {

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

@@ -26,6 +26,14 @@ export class FilesHashService implements IFilesHashService {
 
 	public async getChanges(files: string[], oldHashes: IStringDictionary): Promise<IStringDictionary> {
 		const newHashes = await this.generateHashes(files);
+		return this.getChangesInShasums(oldHashes, newHashes);
+	}
+
+	public hasChangesInShasums(oldHashes: IStringDictionary, newHashes: IStringDictionary): boolean {
+		return !!_.keys(this.getChangesInShasums(oldHashes, newHashes)).length;
+	}
+
+	private getChangesInShasums(oldHashes: IStringDictionary, newHashes: IStringDictionary): IStringDictionary {
 		return _.omitBy(newHashes, (hash: string, pathToFile: string) => !!_.find(oldHashes, (oldHash: string, oldPath: string) => pathToFile === oldPath && hash === oldHash));
 	}
 }

lib/services/files-hash-service.ts

@@ -1,6 +1,6 @@
 import { AndroidPluginBuildService } from "../../lib/services/android-plugin-build-service";
 import { assert } from "chai";
-import { INCLUDE_GRADLE_NAME, AndroidBuildDefaults } from "../../lib/constants";
+import { INCLUDE_GRADLE_NAME, AndroidBuildDefaults, PLUGIN_BUILD_DATA_FILENAME } from "../../lib/constants";
 import { getShortPluginName } from "../../lib/common/helpers";
 import * as FsLib from "../../lib/common/file-system";
 import * as path from "path";
@@ -30,6 +30,8 @@ describe('androidPluginBuildService', () => {
 		latestRuntimeGradleAndroidVersion?: string,
 		projectRuntimeGradleVersion?: string,
 		projectRuntimeGradleAndroidVersion?: string,
+		addPreviousBuildInfo?: boolean,
+		hasChangesInShasums?: boolean,
 	}): IBuildOptions {
 		options = options || {};
 		spawnFromEventCalled = false;
@@ -53,6 +55,7 @@ describe('androidPluginBuildService', () => {
 		latestRuntimeGradleAndroidVersion?: string,
 		projectRuntimeGradleVersion?: string,
 		projectRuntimeGradleAndroidVersion?: string,
+		hasChangesInShasums?: boolean
 	}): void {
 		const testInjector: IInjector = new stubs.InjectorStub();
 		testInjector.register("fs", FsLib.FileSystem);
@@ -71,6 +74,11 @@ describe('androidPluginBuildService', () => {
 			}
 		});
 		testInjector.register('npm', setupNpm(options));
+		testInjector.register('filesHashService', <IFilesHashService>{
+			generateHashes: async (files: string[]): Promise<IStringDictionary> => ({}),
+			getChanges: async (files: string[], oldHashes: IStringDictionary): Promise<IStringDictionary> => ({}),
+			hasChangesInShasums: (oldHashes: IStringDictionary, newHashes: IStringDictionary): boolean => !!options.hasChangesInShasums
+		});
 
 		fs = testInjector.resolve("fs");
 		androidBuildPluginService = testInjector.resolve<AndroidPluginBuildService>(AndroidPluginBuildService);
@@ -113,7 +121,8 @@ describe('androidPluginBuildService', () => {
 		addResFolder?: boolean,
 		addAssetsFolder?: boolean,
 		addIncludeGradle?: boolean,
-		addLegacyIncludeGradle?: boolean
+		addLegacyIncludeGradle?: boolean,
+		addPreviousBuildInfo?: boolean,
 	}) {
 		const validAndroidManifestContent = `<?xml version="1.0" encoding="UTF-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
@@ -125,8 +134,8 @@ describe('androidPluginBuildService', () => {
 		>text_string</string>
 </resources>`;
 		const validIncludeGradleContent =
-`android {` +
-	(options.addLegacyIncludeGradle ? `
+			`android {` +
+			(options.addLegacyIncludeGradle ? `
 	productFlavors {
 		"nativescript-pro-ui" {
 			dimension "nativescript-pro-ui"
@@ -161,6 +170,13 @@ dependencies {
 		if (options.addLegacyIncludeGradle || options.addIncludeGradle) {
 			fs.writeFile(path.join(pluginFolder, INCLUDE_GRADLE_NAME), validIncludeGradleContent);
 		}
+
+		if (options.addPreviousBuildInfo) {
+			const pluginBuildDir = path.join(tempFolder, "my_plugin");
+			fs.ensureDirectoryExists(pluginBuildDir);
+			fs.writeFile(path.join(pluginBuildDir, PLUGIN_BUILD_DATA_FILENAME), "{}");
+			fs.writeFile(path.join(pluginFolder, "my_plugin.aar"), "{}");
+		}
 	}
 
 	describe('buildAar', () => {
@@ -206,6 +222,29 @@ dependencies {
 			assert.isTrue(spawnFromEventCalled);
 		});
 
+		it('builds aar when plugin is already build and source files have changed since last buid', async () => {
+			const config: IBuildOptions = setup({
+				addManifest: true,
+				addPreviousBuildInfo: true,
+				hasChangesInShasums: true
+			});
+
+			await androidBuildPluginService.buildAar(config);
+
+			assert.isTrue(spawnFromEventCalled);
+		});
+
+		it('does not build aar when plugin is already build and source files have not changed', async () => {
+			const config: IBuildOptions = setup({
+				addManifest: true,
+				addPreviousBuildInfo: true
+			});
+
+			await androidBuildPluginService.buildAar(config);
+
+			assert.isFalse(spawnFromEventCalled);
+		});
+
 		it('builds aar with the latest runtime gradle versions when no project dir is specified', async () => {
 			const expectedGradleVersion = "1.2.3";
 			const expectedAndroidVersion = "4.5.6";
@@ -316,15 +355,15 @@ dependencies {
 
 	function getGradleAndroidPluginVersion() {
 		const gradleWrappersContent = fs.readText(path.join(tempFolder, shortPluginName, "build.gradle"));
-		const androidVersionRegex = /com\.android\.tools\.build\:gradle\:(.*)\'\n/g;
+		const androidVersionRegex = /com\.android\.tools\.build\:gradle\:(.*)\'\r?\n/g;
 		const androidVersion = androidVersionRegex.exec(gradleWrappersContent)[1];
 
 		return androidVersion;
 	}
 
 	function getGradleVersion() {
 		const buildGradleContent = fs.readText(path.join(tempFolder, shortPluginName, "gradle", "wrapper", "gradle-wrapper.properties"));
-		const gradleVersionRegex = /gradle\-(.*)\-bin\.zip\n/g;
+		const gradleVersionRegex = /gradle\-(.*)\-bin\.zip\r?\n/g;
 		const gradleVersion = gradleVersionRegex.exec(buildGradleContent)[1];
 
 		return gradleVersion;