feat: use the Gradle and Android plugin versions specified in the package.json of the runtime instead of hardcoded ones

Dimitar Tachev · Dimitar Tachev · commit 543ded62332f · 2018-07-05T16:31:35.000+03:00
diff --git a/lib/declarations.d.ts b/lib/declarations.d.ts
@@ -850,3 +850,11 @@ interface IAssetsGenerationService {
 	 */
 	generateSplashScreens(splashesGenerationData: ISplashesGenerationData): Promise<void>;
 }
+
+/**
+ * Describes the Gradle versions specified in the package.json of the Android runtime
+ */
+interface IRuntimeGradleVersions {
+	gradleVersion?: string;
+	gradleAndroidPluginVersion?: string;
+}
diff --git a/lib/definitions/android-plugin-migrator.d.ts b/lib/definitions/android-plugin-migrator.d.ts
@@ -1,5 +1,6 @@
 
 interface IBuildOptions extends IAndroidBuildOptions{
+	projectDir?: string
 }
 
 interface IAndroidBuildOptions {
diff --git a/lib/node-package-manager.ts b/lib/node-package-manager.ts
@@ -123,7 +123,7 @@ export class NodePackageManager implements INodePackageManager {
 		const url = `https://registry.npmjs.org/${packageName}`;
 		this.$logger.trace(`Trying to get data from npm registry for package ${packageName}, url is: ${url}`);
 		const responseData = (await this.$httpClient.httpRequest(url)).body;
-		this.$logger.trace(`Successfully received data from npm registry for package ${packageName}. Response data is: ${responseData}`);
+		this.$logger.trace(`Successfully received data from npm registry for package ${packageName}.`);
 		const jsonData = JSON.parse(responseData);
 		this.$logger.trace(`Successfully parsed data from npm registry for package ${packageName}.`);
 		return jsonData;
diff --git a/lib/services/android-plugin-build-service.ts b/lib/services/android-plugin-build-service.ts
@@ -1,5 +1,5 @@
 import * as path from "path";
-import { MANIFEST_FILE_NAME, INCLUDE_GRADLE_NAME, ASSETS_DIR, RESOURCES_DIR } from "../constants";
+import { MANIFEST_FILE_NAME, INCLUDE_GRADLE_NAME, ASSETS_DIR, RESOURCES_DIR, TNS_ANDROID_RUNTIME_NAME } from "../constants";
 import { getShortPluginName, hook } from "../common/helpers";
 import { Builder, parseString } from "xml2js";
 import { ILogger } from "log4js";
@@ -12,19 +12,25 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		return this.$injector.resolve("hooksService");
 	}
 
+	private get $platformService(): IPlatformService {
+		return this.$injector.resolve("platformService");
+	}
+
 	constructor(private $injector: IInjector,
 		private $fs: IFileSystem,
 		private $childProcess: IChildProcess,
 		private $hostInfo: IHostInfo,
 		private $androidToolsInfo: IAndroidToolsInfo,
-		private $logger: ILogger) { }
+		private $logger: ILogger,
+		private $npm: INodePackageManager,
+		private $projectDataService: IProjectDataService,
+		private $devicePlatformsConstants: Mobile.IDevicePlatformsConstants) { }
 
 	private static MANIFEST_ROOT = {
 		$: {
 			"xmlns:android": "http://schemas.android.com/apk/res/android"
 		}
 	};
-	private static ANDROID_PLUGIN_GRADLE_TEMPLATE = "../../vendor/gradle-plugin";
 
 	private getAndroidSourceDirectories(source: string): Array<string> {
 		const directories = [RESOURCES_DIR, "java", ASSETS_DIR, "jniLibs"];
@@ -174,7 +180,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 
 			await this.updateManifest(manifestFilePath, pluginTempMainSrcDir, shortPluginName);
 			this.copySourceSetDirectories(androidSourceSetDirectories, pluginTempMainSrcDir);
-			this.setupGradle(pluginTempDir, options.platformsAndroidDirPath);
+			await this.setupGradle(pluginTempDir, options.platformsAndroidDirPath, options.projectDir);
 			await this.buildPlugin({ pluginDir: pluginTempDir, pluginName: options.pluginName });
 			this.copyAar(shortPluginName, pluginTempDir, options.aarOutputDir);
 		}
@@ -221,23 +227,67 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		}
 	}
 
-	private setupGradle(pluginTempDir: string, platformsAndroidDirPath: string): void {
-		const gradleTemplatePath = path.resolve(path.join(__dirname, AndroidPluginBuildService.ANDROID_PLUGIN_GRADLE_TEMPLATE));
+	private async setupGradle(pluginTempDir: string, platformsAndroidDirPath: string, projectDir: string): Promise<void> {
+		const gradleTemplatePath = path.resolve(path.join(__dirname, "../../vendor/gradle-plugin"));
 		const allGradleTemplateFiles = path.join(gradleTemplatePath, "*");
+		const buildGradlePath = path.join(pluginTempDir, "build.gradle");
 
 		this.$fs.copyFile(allGradleTemplateFiles, pluginTempDir);
-		this.addCompileDependencies(platformsAndroidDirPath, pluginTempDir);
-		// TODO: replace placeholders in target destination
+		this.addCompileDependencies(platformsAndroidDirPath, buildGradlePath);
+		const runtimeGradleVersions = await this.getRuntimeGradleVersions(projectDir);
+		this.replaceGradleVersion(pluginTempDir, runtimeGradleVersions.gradleVersion);
+		this.replaceGradleAndroidPluginVersion(buildGradlePath, runtimeGradleVersions.gradleAndroidPluginVersion);
+	}
+
+	private async getRuntimeGradleVersions(projectDir: string): Promise<IRuntimeGradleVersions> {
+		const runtimeVersions: IRuntimeGradleVersions = {};
+		const registryData = await this.$npm.getRegistryPackageData(TNS_ANDROID_RUNTIME_NAME);
+		let runtimeVersion: string = registryData["dist-tags"].latest;
+		if (projectDir) {
+			runtimeVersion = this.$platformService.getCurrentPlatformVersion(
+				this.$devicePlatformsConstants.Android,
+				this.$projectDataService.getProjectData(projectDir));
+		}
+
+		const latestPackageData = registryData.versions[runtimeVersion];
+		const packageJsonGradle = latestPackageData && latestPackageData.gradle;
+		if (packageJsonGradle) {
+			runtimeVersions.gradleVersion = packageJsonGradle.version;
+			runtimeVersions.gradleAndroidPluginVersion = packageJsonGradle.android;
+		}
+
+		return runtimeVersions;
+	}
+
+	private replaceGradleVersion(pluginTempDir: string, version: string): void {
+		const gradleVersion = version || "4.4";
+		const gradleVersionPlaceholder = "{{runtimeGradleVersion}}";
+		const gradleWrapperPropertiesPath = path.join(pluginTempDir, "gradle", "wrapper", "gradle-wrapper.properties");
+
+		this.replaceFileContent(gradleWrapperPropertiesPath, gradleVersionPlaceholder, gradleVersion);
+	}
+
+	private replaceGradleAndroidPluginVersion(buildGradlePath: string, version: string): void {
+		const gradleAndroidPluginVersionPlaceholder = "{{runtimeAndroidPluginVersion}}";
+		const gradleAndroidPluginVersion = version || "3.1.2";
+
+		this.replaceFileContent(buildGradlePath, gradleAndroidPluginVersionPlaceholder,gradleAndroidPluginVersion);
+	}
+
+	private replaceFileContent(filePath: string, content: string, replacement: string) {
+		const fileContent = this.$fs.readText(filePath);
+		const contentRegex = new RegExp(content, "g");
+		const replacedFileContent = fileContent.replace(contentRegex, replacement);
+		this.$fs.writeFile(filePath, replacedFileContent);
 	}
 
-	private addCompileDependencies(platformsAndroidDirPath: string, pluginTempDir: string): void {
+	private addCompileDependencies(platformsAndroidDirPath: string, buildGradlePath: string): void {
 		const includeGradlePath = path.join(platformsAndroidDirPath, INCLUDE_GRADLE_NAME);
 		if (this.$fs.exists(includeGradlePath)) {
 			const includeGradleContent = this.$fs.readText(includeGradlePath);
 			const repositoriesAndDependenciesScopes = this.getIncludeGradleCompileDependenciesScope(includeGradleContent);
 
 			if (repositoriesAndDependenciesScopes.length > 0) {
-				const buildGradlePath = path.join(pluginTempDir, "build.gradle");
 				this.$fs.appendFile(buildGradlePath, "\n" + repositoriesAndDependenciesScopes.join("\n"));
 			}
 		}
diff --git a/lib/services/android-project-service.ts b/lib/services/android-project-service.ts
@@ -100,9 +100,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		return this._platformData;
 	}
 
-	// TODO: Remove prior to the 4.0 CLI release @Pip3r4o @PanayotCankov
-	// Similar to the private method of the same name in platform-service.
-	private getCurrentPlatformVersion(platformData: IPlatformData, projectData: IProjectData): string {
+	public getCurrentPlatformVersion(platformData: IPlatformData, projectData: IProjectData): string {
 		const currentPlatformData: IDictionary<any> = this.$projectDataService.getNSValue(projectData.projectDir, platformData.frameworkPackageName);
 
 		return currentPlatformData && currentPlatformData[constants.VERSION_STRING];
@@ -422,6 +420,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 			const pluginPlatformsFolderPath = this.getPluginPlatformsFolderPath(pluginData, AndroidProjectService.ANDROID_PLATFORM_NAME);
 			if (this.$fs.exists(pluginPlatformsFolderPath)) {
 				const options: IBuildOptions = {
+					projectDir: projectData.projectDir,
 					pluginName: pluginData.name,
 					platformsAndroidDirPath: pluginPlatformsFolderPath,
 					aarOutputDir: pluginPlatformsFolderPath,
@@ -533,9 +532,6 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 
 	public async removePluginNativeCode(pluginData: IPluginData, projectData: IProjectData): Promise<void> {
 		try {
-			// check whether the dependency that's being removed has native code
-			// TODO: Remove prior to the 4.1 CLI release @Pip3r4o @PanayotCankov
-			// the updated gradle script will take care of cleaning the prepared android plugins
 			if (!this.runtimeVersionIsGreaterThanOrEquals(projectData, "3.3.0")) {
 				const pluginConfigDir = path.join(this.getPlatformData(projectData).projectRoot, "configurations", pluginData.name);
 				if (this.$fs.exists(pluginConfigDir)) {
@@ -563,8 +559,6 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 			if (shouldUseNewRoutine) {
 				this.provideDependenciesJson(projectData, dependencies);
 			} else {
-				// TODO: Remove prior to the 4.1 CLI release @Pip3r4o @PanayotCankov
-
 				const platformDir = path.join(projectData.platformsDir, AndroidProjectService.ANDROID_PLATFORM_NAME);
 				const buildDir = path.join(platformDir, "build-tools");
 				const checkV8dependants = path.join(buildDir, "check-v8-dependants.js");
@@ -580,7 +574,6 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		}
 
 		if (!shouldUseNewRoutine) {
-			// TODO: Remove prior to the 4.0 CLI release @Pip3r4o @PanayotCankov
 			const projectRoot = this.getPlatformData(projectData).projectRoot;
 			await this.cleanProject(projectRoot, projectData);
 		}
diff --git a/vendor/gradle-plugin/build.gradle b/vendor/gradle-plugin/build.gradle
@@ -5,7 +5,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.1.2'
+        classpath 'com.android.tools.build:gradle:{{runtimeAndroidPluginVersion}}'
 
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
diff --git a/vendor/gradle-plugin/gradle/wrapper/gradle-wrapper.properties b/vendor/gradle-plugin/gradle/wrapper/gradle-wrapper.properties
@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-{{runtimeGradleVersion}}-bin.zip

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`
`2`	`2`	`interface IBuildOptions extends IAndroidBuildOptions{`
	`3`	`+ projectDir?: string`
`3`	`4`	`}`
`4`	`5`
`5`	`6`	`interface IAndroidBuildOptions {`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ buildscript {`
`5`	`5`	`jcenter()`
`6`	`6`	`}`
`7`	`7`	`dependencies {`
`8`		`- classpath 'com.android.tools.build:gradle:3.1.2'`
	`8`	`+ classpath 'com.android.tools.build:gradle:{{runtimeAndroidPluginVersion}}'`
`9`	`9`
`10`	`10`	`// NOTE: Do not place your application dependencies here; they belong`
`11`	`11`	`// in the individual module build.gradle files`