Skip to content

feat: add support for Android SDK 29 for compilation #4895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 13, 2019
+94 −190
Merged

feat: add support for Android SDK 29 for compilation #4895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
79edd94
refactor: extract android tools info logic to doctor
KristianDD Jul 23, 2019
a95caa5
fix: build projects with SDK28 if runtime below 6.1.0
KristianDD Aug 6, 2019
6d4d5cc
chore: update nativescript-doctor to official version
rosen-vladimirov Aug 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 42 additions & 164 deletions lib/android-tools-info.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,99 +1,62 @@
import * as path from "path";
import * as semver from "semver";
import { cache } from "./common/decorators";
import { androidToolsInfo } from "nativescript-doctor";

export class AndroidToolsInfo implements IAndroidToolsInfo {
private static ANDROID_TARGET_PREFIX = "android";
private static SUPPORTED_TARGETS = [
"android-17",
"android-18",
"android-19",
"android-21",
"android-22",
"android-23",
"android-24",
"android-25",
"android-26",
"android-27",
"android-28",
];
private static MIN_REQUIRED_COMPILE_TARGET = 28;
private static REQUIRED_BUILD_TOOLS_RANGE_PREFIX = ">=23";
private static VERSION_REGEX = /((\d+\.){2}\d+)/;

private showWarningsAsErrors: boolean;
private toolsInfo: IAndroidToolsInfoData;
private selectedCompileSdk: number;
private get androidHome(): string {
return process.env["ANDROID_HOME"];
}

constructor(private $errors: IErrors,
private $fs: IFileSystem,
private $logger: ILogger,
private $options: IOptions,
protected $staticConfig: Config.IStaticConfig) {
}

@cache()
public getToolsInfo(): IAndroidToolsInfoData {
if (!this.toolsInfo) {
const infoData: IAndroidToolsInfoData = Object.create(null);
infoData.androidHomeEnvVar = this.androidHome;
infoData.compileSdkVersion = this.getCompileSdkVersion();
infoData.buildToolsVersion = this.getBuildToolsVersion();
infoData.targetSdkVersion = this.getTargetSdk();
infoData.generateTypings = this.shouldGenerateTypings();

this.toolsInfo = infoData;
}
public getToolsInfo(config: IProjectDir): IAndroidToolsInfoData {
const infoData: IAndroidToolsInfoData = <IAndroidToolsInfoData>(androidToolsInfo.getToolsInfo({projectDir: config.projectDir}));

infoData.androidHomeEnvVar = androidToolsInfo.androidHome;
infoData.compileSdkVersion = this.getCompileSdkVersion(infoData.installedTargets, infoData.compileSdkVersion);
infoData.targetSdkVersion = this.getTargetSdk(infoData.compileSdkVersion);
infoData.generateTypings = this.shouldGenerateTypings();

this.$logger.trace("Installed Android Targets are: ", infoData.installedTargets);
this.$logger.trace("Selected buildToolsVersion is:", infoData.buildToolsVersion);

return this.toolsInfo;
return infoData;
}

public validateInfo(options?: IAndroidToolsInfoValidateInput): boolean {
let detectedErrors = false;
this.showWarningsAsErrors = options && options.showWarningsAsErrors;
const isAndroidHomeValid = this.validateAndroidHomeEnvVariable();
const showWarningsAsErrors = options && options.showWarningsAsErrors;
const isAndroidHomeValid = this.validateAndroidHomeEnvVariable(options);

detectedErrors = androidToolsInfo.validateInfo().map(warning => this.printMessage(warning.warning)).length > 0;
detectedErrors = androidToolsInfo.validateInfo({projectDir: options.projectDir}).map(warning => this.printMessage(warning.warning, showWarningsAsErrors)).length > 0;

if (options && options.validateTargetSdk) {
detectedErrors = this.validateTargetSdk();
detectedErrors = this.validateTargetSdk(options);
}

return detectedErrors || !isAndroidHomeValid;
}

public validateTargetSdk(options?: IAndroidToolsInfoOptions): boolean {
this.showWarningsAsErrors = options && options.showWarningsAsErrors;
public validateTargetSdk(options: IAndroidToolsInfoOptions): boolean {
let detectedErrors = false;

const toolsInfoData = this.getToolsInfo();
const toolsInfoData = this.getToolsInfo({ projectDir: options.projectDir});
const targetSdk = toolsInfoData.targetSdkVersion;
const newTarget = `${AndroidToolsInfo.ANDROID_TARGET_PREFIX}-${targetSdk}`;

if (!_.includes(AndroidToolsInfo.SUPPORTED_TARGETS, newTarget)) {
const supportedVersions = AndroidToolsInfo.SUPPORTED_TARGETS.sort();
const minSupportedVersion = this.parseAndroidSdkString(_.first(supportedVersions));
detectedErrors = androidToolsInfo.validateMinSupportedTargetSdk({targetSdk, projectDir: options.projectDir}).map(warning => this.printMessage(warning.warning, options.showWarningsAsErrors)).length > 0;

if (targetSdk && (targetSdk < minSupportedVersion)) {
this.printMessage(`The selected Android target SDK ${newTarget} is not supported. You must target ${minSupportedVersion} or later.`);
return true;
} else if (!targetSdk || targetSdk > this.getMaxSupportedVersion()) {
this.$logger.warn(`Support for the selected Android target SDK ${newTarget} is not verified. Your Android app might not work as expected.`);
}
if (!detectedErrors) {
androidToolsInfo.validataMaxSupportedTargetSdk({targetSdk, projectDir: options.projectDir}).map(warning => this.$logger.warn(warning.warning));
}

return false;
return detectedErrors;
}

public validateJavacVersion(installedJavacVersion: string, options?: IAndroidToolsInfoOptions): boolean {
if (options) {
this.showWarningsAsErrors = options.showWarningsAsErrors;
}
const showWarningsAsErrors = options && options.showWarningsAsErrors;

return androidToolsInfo.validateJavacVersion(installedJavacVersion).map(warning => this.printMessage(warning.warning)).length > 0;
return androidToolsInfo.validateJavacVersion(installedJavacVersion).map(warning => this.printMessage(warning.warning, showWarningsAsErrors)).length > 0;
}

public async getPathToAdbFromAndroidHome(): Promise<string> {
Expand All @@ -102,19 +65,17 @@ export class AndroidToolsInfo implements IAndroidToolsInfo {
} catch (err) {
// adb does not exist, so ANDROID_HOME is not set correctly
// try getting default adb path (included in CLI package)
this.$logger.trace(`Error while executing '${path.join(this.androidHome, "platform-tools", "adb")} help'. Error is: ${err.message}`);
this.$logger.trace(`Error while executing '${path.join(androidToolsInfo.androidHome, "platform-tools", "adb")} help'. Error is: ${err.message}`);
}

return null;
}

@cache()
public validateAndroidHomeEnvVariable(options?: IAndroidToolsInfoOptions): boolean {
if (options) {
this.showWarningsAsErrors = options.showWarningsAsErrors;
}
const showWarningsAsErrors = options && options.showWarningsAsErrors;

return androidToolsInfo.validateAndroidHomeEnvVariable().map(warning => this.printMessage(warning.warning)).length > 0;
return androidToolsInfo.validateAndroidHomeEnvVariable().map(warning => this.printMessage(warning.warning, showWarningsAsErrors)).length > 0;
}

private shouldGenerateTypings(): boolean {
Expand All @@ -127,119 +88,36 @@ export class AndroidToolsInfo implements IAndroidToolsInfo {
* In case additional details must be shown as info message, use the second parameter.
* NOTE: The additional information will not be printed when showWarningsAsErrors flag is set.
* @param {string} msg The message that will be shown as warning or error.
* @param {string} additionalMsg The additional message that will be shown as info message.
* @return {void}
*/
private printMessage(msg: string, additionalMsg?: string): void {
if (this.showWarningsAsErrors) {
private printMessage(msg: string, showWarningsAsErrors: boolean): void {
if (showWarningsAsErrors) {
this.$errors.failWithoutHelp(msg);
} else {
this.$logger.warn(msg);
}

if (additionalMsg) {
this.$logger.printMarkdown(additionalMsg);
}
}

private getCompileSdkVersion(): number {
if (!this.selectedCompileSdk) {
const userSpecifiedCompileSdk = this.$options.compileSdk;
if (userSpecifiedCompileSdk) {
const installedTargets = this.getInstalledTargets();
const androidCompileSdk = `${AndroidToolsInfo.ANDROID_TARGET_PREFIX}-${userSpecifiedCompileSdk}`;
if (!_.includes(installedTargets, androidCompileSdk)) {
this.$errors.failWithoutHelp(`You have specified '${userSpecifiedCompileSdk}' for compile sdk, but it is not installed on your system.`);
}

this.selectedCompileSdk = userSpecifiedCompileSdk;
} else {
const latestValidAndroidTarget = this.getLatestValidAndroidTarget();
if (latestValidAndroidTarget) {
const integerVersion = this.parseAndroidSdkString(latestValidAndroidTarget);

if (integerVersion && integerVersion >= AndroidToolsInfo.MIN_REQUIRED_COMPILE_TARGET) {
this.selectedCompileSdk = integerVersion;
}
}
}
}
private getCompileSdkVersion(installedTargets: string[], latestCompileSdk: number): number {
const userSpecifiedCompileSdk = this.$options.compileSdk;

return this.selectedCompileSdk;
}

private getTargetSdk(): number {
const targetSdk = this.$options.sdk ? parseInt(this.$options.sdk) : this.getCompileSdkVersion();
this.$logger.trace(`Selected targetSdk is: ${targetSdk}`);
return targetSdk;
}

private getMatchingDir(pathToDir: string, versionRange: string): string {
let selectedVersion: string;
if (this.$fs.exists(pathToDir)) {
const subDirs = this.$fs.readDirectory(pathToDir);
this.$logger.trace(`Directories found in ${pathToDir} are ${subDirs.join(", ")}`);

const subDirsVersions = subDirs
.map(dirName => {
const dirNameGroups = dirName.match(AndroidToolsInfo.VERSION_REGEX);
if (dirNameGroups) {
return dirNameGroups[1];
}

return null;
})
.filter(dirName => !!dirName);
this.$logger.trace(`Versions found in ${pathToDir} are ${subDirsVersions.join(", ")}`);
const version = semver.maxSatisfying(subDirsVersions, versionRange);
if (version) {
selectedVersion = _.find(subDirs, dir => dir.indexOf(version) !== -1);
if (userSpecifiedCompileSdk) {
const androidCompileSdk = `${androidToolsInfo.ANDROID_TARGET_PREFIX}-${userSpecifiedCompileSdk}`;
if (!_.includes(installedTargets, androidCompileSdk)) {
this.$errors.failWithoutHelp(`You have specified '${userSpecifiedCompileSdk}' for compile sdk, but it is not installed on your system.`);
}
}
this.$logger.trace("Selected version is: ", selectedVersion);
return selectedVersion;
}

private getBuildToolsRange(): string {
return `${AndroidToolsInfo.REQUIRED_BUILD_TOOLS_RANGE_PREFIX} <=${this.getMaxSupportedVersion()}`;
}

private getBuildToolsVersion(): string {
let buildToolsVersion: string;
if (this.androidHome) {
const pathToBuildTools = path.join(this.androidHome, "build-tools");
const buildToolsRange = this.getBuildToolsRange();
buildToolsVersion = this.getMatchingDir(pathToBuildTools, buildToolsRange);
return userSpecifiedCompileSdk;
}

return buildToolsVersion;
}

private getLatestValidAndroidTarget(): string {
const installedTargets = this.getInstalledTargets();
return _.findLast(AndroidToolsInfo.SUPPORTED_TARGETS.sort(), supportedTarget => _.includes(installedTargets, supportedTarget));
}

private parseAndroidSdkString(androidSdkString: string): number {
return parseInt(androidSdkString.replace(`${AndroidToolsInfo.ANDROID_TARGET_PREFIX}-`, ""));
return latestCompileSdk;
}

@cache()
private getInstalledTargets(): string[] {
let installedTargets: string[] = [];
if (this.androidHome) {
const pathToInstalledTargets = path.join(this.androidHome, "platforms");
if (this.$fs.exists(pathToInstalledTargets)) {
installedTargets = this.$fs.readDirectory(pathToInstalledTargets);
}
}
this.$logger.trace("Installed Android Targets are: ", installedTargets);

return installedTargets;
}

private getMaxSupportedVersion(): number {
return this.parseAndroidSdkString(_.last(AndroidToolsInfo.SUPPORTED_TARGETS.sort()));
// TODO check if still needed
private getTargetSdk(compileSdk: number): number {
const targetSdk = this.$options.sdk ? parseInt(this.$options.sdk) : compileSdk;
this.$logger.trace(`Selected targetSdk is: ${targetSdk}`);
return targetSdk;
}
}
$injector.register("androidToolsInfo", AndroidToolsInfo);
9 changes: 5 additions & 4 deletions lib/declarations.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,9 +646,10 @@ interface IAndroidToolsInfo {
/**
* Provides information about installed Android SDKs, Build Tools, Support Library
* and ANDROID_HOME environement variable.
* @param {IProjectDir} config Object with a single property - projectDir. This is the root directory where NativeScript project is located.
* @return {IAndroidToolsInfoData} Information about installed Android Tools and SDKs.
*/
getToolsInfo(): IAndroidToolsInfoData;
getToolsInfo(config?: IProjectDir): IAndroidToolsInfoData;

/**
* Validates the information about required Android tools and SDK versions.
Expand Down Expand Up @@ -689,7 +690,7 @@ interface IAndroidToolsInfo {
/**
* Describes information about installed Android tools and SDKs.
*/
interface IAndroidToolsInfoData {
interface IAndroidToolsInfoData extends NativeScriptDoctor.IAndroidToolsInfoData {
/**
* The value of ANDROID_HOME environment variable.
*/
Expand Down Expand Up @@ -720,11 +721,11 @@ interface IAndroidToolsInfoData {
/**
* Describes options that can be passed to methods from IAndroidToolsInfo interface
*/
interface IAndroidToolsInfoOptions {
interface IAndroidToolsInfoOptions extends Partial<IProjectDir> {
/**
* Defines if the warning messages should treated as error.
*/
showWarningsAsErrors: boolean;
showWarningsAsErrors?: boolean;
}

interface IAndroidToolsInfoValidateInput extends IAndroidToolsInfoOptions {
Expand Down
2 changes: 1 addition & 1 deletion lib/definitions/android-plugin-migrator.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface IAndroidPluginBuildService {
* Describes data required for building plugin for Android.
* The data can be consumed in the buildAndroidPlugin hook.
*/
interface IBuildAndroidPluginData {
interface IBuildAndroidPluginData extends Partial<IProjectDir> {
/**
* Directory where the plugin will be build.
* Usually this is the `<project dir>/platforms/tempPlugin/<plugin name>` dir.
Expand Down
6 changes: 3 additions & 3 deletions lib/services/android-plugin-build-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
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 });
await this.buildPlugin({ pluginDir: pluginTempDir, pluginName: options.pluginName, projectDir: options.projectDir });
this.$watchIgnoreListService.addFileToIgnoreList(path.join(options.aarOutputDir, `${shortPluginName}.aar`));
this.copyAar(shortPluginName, pluginTempDir, options.aarOutputDir);
this.writePluginHashInfo(pluginSourceFileHashesInfo, pluginTempDir);
Expand Down Expand Up @@ -440,8 +440,8 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
@hook("buildAndroidPlugin")
private async buildPlugin(pluginBuildSettings: IBuildAndroidPluginData): Promise<void> {
if (!pluginBuildSettings.androidToolsInfo) {
this.$androidToolsInfo.validateInfo({ showWarningsAsErrors: true, validateTargetSdk: true });
pluginBuildSettings.androidToolsInfo = this.$androidToolsInfo.getToolsInfo();
this.$androidToolsInfo.validateInfo({ showWarningsAsErrors: true, validateTargetSdk: true, projectDir: pluginBuildSettings.projectDir });
pluginBuildSettings.androidToolsInfo = this.$androidToolsInfo.getToolsInfo({ projectDir: pluginBuildSettings.projectDir });
}

const gradlew = this.$hostInfo.isWindows ? "gradlew.bat" : "./gradlew";
Expand Down
4 changes: 2 additions & 2 deletions lib/services/android-project-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
notConfiguredEnvOptions
});

this.$androidToolsInfo.validateTargetSdk({ showWarningsAsErrors: true });
this.$androidToolsInfo.validateTargetSdk({ showWarningsAsErrors: true, projectDir: projectData.projectDir });

return {
checkEnvironmentRequirementsOutput
Expand All @@ -135,7 +135,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
}

this.$fs.ensureDirectoryExists(this.getPlatformData(projectData).projectRoot);
const androidToolsInfo = this.$androidToolsInfo.getToolsInfo();
const androidToolsInfo = this.$androidToolsInfo.getToolsInfo({ projectDir: projectData.projectDir});
const targetSdkVersion = androidToolsInfo && androidToolsInfo.targetSdkVersion;
this.$logger.trace(`Using Android SDK '${targetSdkVersion}'.`);

Expand Down
2 changes: 1 addition & 1 deletion lib/services/android/gradle-build-args-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export class GradleBuildArgsService implements IGradleBuildArgsService {
private getBaseTaskArgs(buildData: IAndroidBuildData): string[] {
const args = this.getBuildLoggingArgs();

const toolsInfo = this.$androidToolsInfo.getToolsInfo();
const toolsInfo = this.$androidToolsInfo.getToolsInfo({projectDir: buildData.projectDir});
args.push(
`-PcompileSdk=android-${toolsInfo.compileSdkVersion}`,
`-PtargetSdk=${toolsInfo.targetSdkVersion}`,
Expand Down
Loading