feat: validation for runtime version for --aab, linting, tests fix

Author: KristianDD

lib/commands/build.ts

@@ -119,24 +119,25 @@ export class BuildAndroidCommand extends BuildCommandBase implements ICommand {
 		$devicePlatformsConstants: Mobile.IDevicePlatformsConstants,
 		$platformService: IPlatformService,
 		$bundleValidatorHelper: IBundleValidatorHelper,
+		protected $androidBundleValidatorHelper: IAndroidBundleValidatorHelper,
 		protected $logger: ILogger) {
 			super($options, $errors, $projectData, $platformsData, $devicePlatformsConstants, $platformService, $bundleValidatorHelper);
 	}
 
 	public async execute(args: string[]): Promise<void> {
 		const buildResult = await this.executeCore([this.$platformsData.availablePlatforms.Android]);
 
-		if(this.$options.aab) {
+		if (this.$options.aab) {
 			this.$logger.info("Link to documentation article");
 		}
 
-		return buildResult
+		return buildResult;
 	}
 
 	public async canExecute(args: string[]): Promise<boolean | ICanExecuteCommandOutput> {
 		const platform = this.$devicePlatformsConstants.Android;
 		super.validatePlatform(platform);
-
+		this.$androidBundleValidatorHelper.validateRuntimeVersion(this.$projectData);
 		let result = await super.canExecuteCommandBase(platform, { notConfiguredEnvOptions: { hideSyncToPreviewAppOption: true }});
 		if (result.canExecute) {
 			if (this.$options.release && (!this.$options.keyStorePath || !this.$options.keyStorePassword || !this.$options.keyStoreAlias || !this.$options.keyStoreAliasPassword)) {

lib/constants.ts

@@ -40,7 +40,7 @@ export const CONFIG_NS_APP_RESOURCES_ENTRY = "appResourcesPath";
 export const CONFIG_NS_APP_ENTRY = "appPath";
 export const DEPENDENCIES_JSON_NAME = "dependencies.json";
 export const APK_EXTENSION_NAME = ".apk";
-export const AAB_EXTENSION_NAME = ".aab"
+export const AAB_EXTENSION_NAME = ".aab";
 export const HASHES_FILE_NAME = ".nshashes";
 
 export class PackageVersion {
@@ -244,4 +244,7 @@ export class BundleValidatorMessages {
 	public static NotSupportedVersion = `The NativeScript CLI requires nativescript-dev-webpack %s or later to work properly. After updating nativescript-dev-webpack you need to ensure "webpack.config.js" file is up to date with the one in the new version of nativescript-dev-webpack. You can automatically update it using "./node_modules/.bin/update-ns-webpack --configs" command.`;
 }
 
-export const AAB_NOT_SUPPORTED_BY_COMMNAND_MESSAGE = "This command does not support --aab (Android Application Bundle) parameter.";
+export class AndroidBundleValidatorMessages {
+	public static AAB_NOT_SUPPORTED_BY_COMMNAND_MESSAGE = "This command does not support --aab (Android Application Bundle) parameter.";
+	public static RUNTIME_VERSION_TOO_LOW = "Android Application Bundle (--aab) option requires NativeScript Android Runtime (tns-android) version %s and above.";
+}

lib/declarations.d.ts

@@ -872,6 +872,13 @@ interface IAndroidBundleValidatorHelper {
 	 * @return {void}
 	 */
 	validateNoAab(): void;
+
+	/**
+	 * Validates android runtime version is sufficient to support bundling option --aab.
+	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @return {void}
+	 */
+	validateRuntimeVersion(projectData: IProjectData): void
 }
 
 interface INativeScriptCloudExtensionService {

lib/helpers/android-bundle-validator-helper.ts

@@ -1,14 +1,36 @@
-import { AAB_NOT_SUPPORTED_BY_COMMNAND_MESSAGE } from "../constants";
+import * as semver from "semver";
+import * as util from "util";
+import { AndroidBundleValidatorMessages, TNS_ANDROID_RUNTIME_NAME } from "../constants";
 
 export class AndroidBundleValidatorHelper implements IAndroidBundleValidatorHelper {
+	public static MIN_RUNTIME_VERSION = "5.0.0";
+
 	constructor(protected $projectData: IProjectData,
 		protected $errors: IErrors,
-		protected $options: IOptions) {
+		protected $options: IOptions,
+		protected $projectDataService: IProjectDataService) {
 	}
 
-	public validateNoAab(minSupportedVersion?: string): void {
-		if(this.$options.aab) {
-			this.$errors.fail(AAB_NOT_SUPPORTED_BY_COMMNAND_MESSAGE);
+	public validateNoAab(): void {
+		if (this.$options.aab) {
+			this.$errors.fail(AndroidBundleValidatorMessages.AAB_NOT_SUPPORTED_BY_COMMNAND_MESSAGE);
+		}
+	}
+
+	public validateRuntimeVersion(projectData: IProjectData): void {
+		if (this.$options.aab) {
+			const androidRuntimeInfo = this.$projectDataService.getNSValue(projectData.projectDir, TNS_ANDROID_RUNTIME_NAME);
+			const androidRuntimeVersion = androidRuntimeInfo ? androidRuntimeInfo.version : "";
+
+			if (androidRuntimeVersion) {
+				const shouldSkipCheck = !semver.valid(androidRuntimeVersion) && !semver.validRange(androidRuntimeVersion);
+				if (!shouldSkipCheck) {
+					const isAndroidBundleSupported = semver.gte(semver.coerce(androidRuntimeVersion), semver.coerce(AndroidBundleValidatorHelper.MIN_RUNTIME_VERSION));
+					if (!isAndroidBundleSupported) {
+						this.$errors.failWithoutHelp(util.format(AndroidBundleValidatorMessages.RUNTIME_VERSION_TOO_LOW, AndroidBundleValidatorHelper.MIN_RUNTIME_VERSION));
+					}
+				}
+			}
 		}
 	}
 }

lib/services/android-project-service.ts

@@ -78,12 +78,12 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 				getValidBuildOutputData: (buildOptions: IBuildOutputOptions): IValidBuildOutputData => {
 					const buildMode = buildOptions.release ? Configurations.Release.toLowerCase() : Configurations.Debug.toLowerCase();
 
-					if(buildOptions.androidBundle) {
+					if (buildOptions.androidBundle) {
 						return {
 							packageNames: [
 								`${constants.APP_FOLDER_NAME}${constants.AAB_EXTENSION_NAME}`
 							]
-						}
+						};
 					}
 
 					return {

lib/services/platform-service.ts

@@ -616,10 +616,10 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 	}
 
 	private getBuildOutputPath(platform: string, platformData: IPlatformData, options: IBuildOutputOptions): string {
-		if(options.androidBundle) {
+		if (options.androidBundle) {
 			return platformData.bundleBuildOutputPath;
 		}
-		
+
 		if (platform.toLowerCase() === this.$devicePlatformsConstants.iOS.toLowerCase()) {
 			return options.buildForDevice ? platformData.deviceBuildOutputPath : platformData.emulatorBuildOutputPath;
 		}

test/debug.ts

@@ -29,6 +29,7 @@ function createTestInjector(): IInjector {
 	testInjector.register('fs', FileSystem);
 	testInjector.register('errors', stubs.ErrorsStub);
 	testInjector.register('hostInfo', {});
+	testInjector.register("androidBundleValidatorHelper", stubs.AndroidBundleValidatorHelper);
 	testInjector.register("analyticsService", {
 		trackException: async (): Promise<void> => undefined,
 		checkConsent: async (): Promise<void> => undefined,

test/platform-service.ts

@@ -937,6 +937,7 @@ describe('Platform Service Tests', () => {
 			platformsData.getPlatformData = (platform: string) => {
 				return {
 					deviceBuildOutputPath: "",
+					normalizedPlatformName: "",
 					platformProjectService: {
 						buildProject: () => Promise.resolve(),
 						on: () => ({}),

test/stubs.ts

@@ -849,6 +849,16 @@ export class AndroidResourcesMigrationServiceStub implements IAndroidResourcesMi
 	}
 }
 
+export class AndroidBundleValidatorHelper implements IAndroidBundleValidatorHelper {
+	validateNoAab() {
+		return true;
+	}
+
+	validateRuntimeVersion() {
+
+	}
+}
+
 export class InjectorStub extends Yok implements IInjector {
 	constructor() {
 		super();