feat(android): per-plugin build options reaching the plugin gradle build

docs/man_pages/project/testing/debug-android.md

@@ -38,6 +38,8 @@ Attach the debug tools to a running app in the native emulator | `$ ns debug and
     *   `--env.sourceMap` - creates inline source maps.
     *   `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
 * `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
+* `--no-filter-devices-arch` - If set, builds every ABI instead of only the ones the connected devices report. The narrowing only applies when the app's gradle configuration acts on the `abiFilters` property, and `ns build` never narrows.
+* `--filter-plugins-devices-arch` - If set, the ABIs of the connected devices are also passed to the gradle build of every plugin built from source. Nothing in the gradle files the CLI generates for a plugin acts on them - this is for a plugin whose own `include.gradle` reads the `abiFilters` property to shorten a long native build.
 * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
 
 <% if(isHtml) { %>

docs/man_pages/project/testing/run-android.md

@@ -43,6 +43,8 @@ Start a default emulator if none are running, or run application on all connecte
     *   `--env.sourceMap` - creates inline source maps.
     *   `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
 * `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
+* `--no-filter-devices-arch` - If set, builds every ABI instead of only the ones the connected devices report. The narrowing only applies when the app's gradle configuration acts on the `abiFilters` property, and `ns build` never narrows.
+* `--filter-plugins-devices-arch` - If set, the ABIs of the connected devices are also passed to the gradle build of every plugin built from source. Nothing in the gradle files the CLI generates for a plugin acts on them - this is for a plugin whose own `include.gradle` reads the `abiFilters` property to shorten a long native build.
 * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
 
 <% if(isHtml) { %>

lib/commands/build.ts

@@ -53,7 +53,12 @@ export abstract class BuildCommandBase extends ValidatePlatformCommandBase {
 		const buildData = this.$buildDataService.getBuildData(
 			this.$projectData.projectDir,
 			platform,
-			this.$options,
+			{
+				...this.$options.argv,
+				// `ns build` produces an artifact meant to be shipped, so it must
+				// not be narrowed down to the ABIs of whatever is plugged in
+				filterDevicesArch: false,
+			},
 		);
 		const outputPath = await this.$buildController.prepareAndBuild(buildData);
 

lib/common/definitions/mobile.d.ts

@@ -100,6 +100,11 @@ declare global {
 			 * For iOS simulators - same as the identifier.
 			 */
 			imageIdentifier?: string;
+			/**
+			 * Optional property listing the ABIs the device supports, most
+			 * preferred first. Available for Android only.
+			 */
+			abis?: string[];
 		}
 
 		interface IDeviceError extends Error, IDeviceIdentifier {}

lib/common/mobile/android/android-device.ts

@@ -13,6 +13,9 @@ interface IAndroidDeviceDetails {
 	name: string;
 	release: string;
 	brand: string;
+	"cpu.abi"?: string;
+	"cpu.abilist32"?: string;
+	"cpu.abilist64"?: string;
 }
 
 interface IAdbDeviceStatusInfo {
@@ -96,6 +99,7 @@ export class AndroidDevice implements Mobile.IAndroidDevice {
 			identifier: this.identifier,
 			displayName: details.name,
 			model: details.model,
+			abis: this.getAbis(details),
 			version,
 			vendor: details.brand,
 			platform: this.$devicePlatformsConstants.Android,
@@ -179,6 +183,25 @@ export class AndroidDevice implements Mobile.IAndroidDevice {
 		return parsedDetails;
 	}
 
+	// `ro.product.cpu.abilist64`/`abilist32` list every ABI the device supports,
+	// most preferred first. Old devices report neither and only have the single
+	// `ro.product.cpu.abi`.
+	private getAbis(details: IAndroidDeviceDetails): string[] {
+		const abis = [
+			...(details["cpu.abilist64"] || "").split(","),
+			...(details["cpu.abilist32"] || "").split(",")
+		]
+			.map((abi) => abi.trim())
+			.filter((abi) => !!abi);
+
+		if (abis.length) {
+			return abis;
+		}
+
+		const abi = (details["cpu.abi"] || "").trim();
+		return abi ? [abi] : [];
+	}
+
 	private getIsTablet(details: any): boolean {
 		//version 3.x.x (also known as Honeycomb) is a tablet only version
 		return (

lib/controllers/build-controller.ts

@@ -116,7 +116,7 @@ export class BuildController extends EventEmitter implements IBuildController {
 		);
 
 		if (buildData.copyTo) {
-			this.$buildArtifactsService.copyLatestAppPackage(
+			this.$buildArtifactsService.copyAppPackages(
 				buildData.copyTo,
 				platformData,
 				buildData

lib/data/build-data.ts

@@ -51,6 +51,7 @@ export class AndroidBuildData extends BuildData {
 	public keyStoreAliasPassword: string;
 	public keyStorePassword: string;
 	public androidBundle: boolean;
+	public buildFilterDevicesArch: boolean;
 	public gradlePath: string;
 	public gradleArgs: string;
 	public hostProjectPath: string;
@@ -63,6 +64,9 @@ export class AndroidBuildData extends BuildData {
 		this.keyStoreAliasPassword = data.keyStoreAliasPassword;
 		this.keyStorePassword = data.keyStorePassword;
 		this.androidBundle = data.androidBundle || data.aab;
+		// an app bundle already carries every ABI, so there is nothing to filter
+		this.buildFilterDevicesArch =
+			!this.androidBundle && data.filterDevicesArch !== false;
 		this.gradlePath = data.gradlePath;
 		this.gradleArgs = data.gradleArgs;
 		this.hostProjectPath = data.hostProjectPath;

lib/declarations.d.ts

@@ -571,6 +571,20 @@ interface IEmbedOptions {
 }
 
 interface IAndroidOptions extends IEmbedOptions {
+	/**
+	 * When true (the default) `ns run`/`ns debug` restrict the native build to
+	 * the ABIs of the devices it is about to deploy to. Pass
+	 * `--no-filter-devices-arch` to always build every ABI.
+	 */
+	filterDevicesArch: boolean;
+
+	/**
+	 * When true, the same ABIs are passed to the gradle build of every plugin
+	 * that is built from source. Off by default - the CLI's own plugin gradle
+	 * files ignore the property, only a plugin acting on it in its
+	 * `include.gradle` gains anything from it.
+	 */
+	filterPluginsDevicesArch: boolean;
 	gradlePath: string;
 	gradleArgs: string;
 }

lib/definitions/android-plugin-migrator.d.ts

@@ -12,6 +12,15 @@ interface IAndroidBuildOptions {
 	tempPluginDirPath: string;
 	gradlePath?: string;
 	gradleArgs?: string;
+	abiFilters?: string[];
+
+	/**
+	 * Appended to the plugin name before it is shortened into the name of the
+	 * produced `.aar`. The npm scope is dropped when shortening, so two plugins
+	 * from different scopes can end up with the same `.aar` - a suffix tells
+	 * them apart.
+	 */
+	aarSuffix?: string;
 }
 
 interface IAndroidPluginBuildService {
@@ -49,4 +58,13 @@ interface IBuildAndroidPluginData extends Partial<IProjectDir> {
 	 * Optional custom Gradle arguments.
 	 */
 	gradleArgs?: string;
+
+	/**
+	 * The ABIs the build this plugin is prepared for is about to deploy to,
+	 * passed to the plugin build as `-PabiFilters`. Nothing in the gradle files
+	 * the CLI generates for a plugin acts on it - it is there for a plugin whose
+	 * own `include.gradle` reads the property to skip the ABIs the build does
+	 * not need.
+	 */
+	abiFilters?: string[];
 }

lib/definitions/build.d.ts

@@ -31,6 +31,7 @@ interface IAndroidBuildData
 	extends IBuildData,
 		IAndroidSigningData,
 		IHasAndroidBundle {
+	buildFilterDevicesArch?: boolean;
 	gradlePath?: string;
 	gradleArgs?: string;
 }
@@ -62,7 +63,7 @@ interface IBuildArtifactsService {
 		platformData: IPlatformData,
 		buildOutputOptions: IBuildOutputOptions
 	): Promise<string>;
-	copyLatestAppPackage(
+	copyAppPackages(
 		targetPath: string,
 		platformData: IPlatformData,
 		buildOutputOptions: IBuildOutputOptions

lib/definitions/project.d.ts

@@ -8,6 +8,7 @@ import {
 import { ICheckEnvironmentRequirementsOutput, IPlatformData } from "./platform";
 import { IPluginData, IBasePluginData } from "./plugins";
 import {
+	IDictionary,
 	IStringDictionary,
 	IProjectDir,
 	IDeviceIdentifier,
@@ -179,6 +180,30 @@ interface INsConfigAndroid extends INsConfigPlaform {
 	 * Custom runtime package name
 	 */
 	runtimePackageName?: string;
+
+	/**
+	 * Per plugin build options, keyed by the plugin's npm package name.
+	 */
+	plugins?: IDictionary<INsConfigAndroidPlugin>;
+}
+
+interface INsConfigAndroidPlugin {
+	/**
+	 * Appended to the plugin name before it is shortened into the name of the
+	 * produced `.aar`. The npm scope is dropped when shortening, so
+	 * `@foo/plugin` and `@bar/plugin` both build a `plugin.aar` and overwrite
+	 * each other - a suffix tells them apart.
+	 */
+	aarSuffix?: string;
+
+	/**
+	 * The ABIs passed to this plugin's gradle build as `-PabiFilters`, which a
+	 * plugin acts on in its own `include.gradle`. Wins over the ABIs
+	 * `--filter-plugins-devices-arch` derives from the connected devices, and
+	 * applies whether or not that flag is set. An empty array passes nothing,
+	 * which opts this plugin out of the narrowing.
+	 */
+	abiFilters?: string[];
 }
 
 interface INsConfigHooks {

lib/options.ts

@@ -219,6 +219,16 @@ export class Options {
 				default: false,
 				hasSensitiveValue: false,
 			},
+			filterDevicesArch: {
+				type: OptionType.Boolean,
+				default: true,
+				hasSensitiveValue: false,
+			},
+			filterPluginsDevicesArch: {
+				type: OptionType.Boolean,
+				default: false,
+				hasSensitiveValue: false,
+			},
 			gradlePath: { type: OptionType.String, hasSensitiveValue: false },
 			gradleArgs: { type: OptionType.String, hasSensitiveValue: false },
 			hostProjectPath: { type: OptionType.String, hasSensitiveValue: false },

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

@@ -61,6 +61,14 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		private $watchIgnoreListService: IWatchIgnoreListService,
 	) {}
 
+	/**
+	 * The plugin build data entry recording the build options gradle was last
+	 * asked for. The plugin sources do not change when an option does, so every
+	 * per-plugin option that changes what gradle produces belongs in here -
+	 * otherwise the aar built with the old one is kept.
+	 */
+	private static BUILD_OPTIONS_DATA_KEY = "__buildOptions";
+
 	private static MANIFEST_ROOT = {
 		$: {
 			"xmlns:android": "http://schemas.android.com/apk/res/android",
@@ -226,13 +234,24 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		const androidSourceDirectories = this.getAndroidSourceDirectories(
 			options.platformsAndroidDirPath,
 		);
-		const shortPluginName = getShortPluginName(options.pluginName);
+		// the npm scope is dropped when shortening, so an optional suffix is what
+		// keeps two same-named plugins from overwriting each other's `.aar`
+		const shortPluginName = getShortPluginName(
+			`${options.pluginName}${options.aarSuffix || ""}`,
+		);
 		const pluginTempDir = path.join(options.tempPluginDirPath, shortPluginName);
 		const pluginSourceFileHashesInfo = await this.getSourceFilesHashes(
 			options.platformsAndroidDirPath,
 			shortPluginName,
 		);
 
+		const buildOptions = this.getArtifactAffectingOptions(options);
+		if (buildOptions) {
+			pluginSourceFileHashesInfo[
+				AndroidPluginBuildService.BUILD_OPTIONS_DATA_KEY
+			] = buildOptions;
+		}
+
 		const shouldBuildAar = await this.shouldBuildAar({
 			manifestFilePath,
 			androidSourceDirectories,
@@ -260,10 +279,12 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 				options.platformsAndroidDirPath,
 				options.projectDir,
 				options.pluginName,
+				shortPluginName,
 			);
 			await this.buildPlugin({
 				gradlePath: options.gradlePath,
 				gradleArgs: options.gradleArgs,
+				abiFilters: options.abiFilters,
 				pluginDir: pluginTempDir,
 				pluginName: options.pluginName,
 				projectDir: options.projectDir,
@@ -278,6 +299,28 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		return shouldBuildAar;
 	}
 
+	/**
+	 * The build options that change what gradle produces for this plugin, in
+	 * the form they are recorded in the plugin build data. `null` when none of
+	 * them is set, so a project that uses none of them keeps the build data it
+	 * already has.
+	 *
+	 * `abiFilters` is the only one today: the aar of a plugin built for a
+	 * subset of the ABIs is not the aar of the same sources built for another
+	 * subset. Options that only change the *name* of the artifact - `aarSuffix`
+	 * - do not belong here, they produce a different file rather than a stale
+	 * one.
+	 */
+	private getArtifactAffectingOptions(options: IPluginBuildOptions): string {
+		const affectingOptions: { [key: string]: any } = {};
+
+		if (options.abiFilters && options.abiFilters.length) {
+			affectingOptions.abiFilters = options.abiFilters;
+		}
+
+		return _.isEmpty(affectingOptions) ? null : JSON.stringify(affectingOptions);
+	}
+
 	private cleanPluginDir(pluginTempDir: string): void {
 		// 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);
@@ -401,6 +444,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		platformsAndroidDirPath: string,
 		projectDir: string,
 		pluginName: string,
+		shortPluginName: string,
 	): Promise<void> {
 		const gradleTemplatePath = path.resolve(
 			path.join(__dirname, "../../vendor/gradle-plugin"),
@@ -425,8 +469,6 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		this.replaceFileContent(settingsGradlePath, "{{pluginName}}", pluginName);
 
 		// gets the package from the AndroidManifest to use as the namespace or fallback to the `org.nativescript.${shortPluginName}`
-		const shortPluginName = getShortPluginName(pluginName);
-
 		const manifestPath = path.join(
 			pluginTempDir,
 			"src",
@@ -821,6 +863,19 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 			localArgs.push(pluginBuildSettings.gradleArgs);
 		}
 
+		// nothing in the gradle files generated here acts on `abiFilters` - it is
+		// passed for a plugin whose own include.gradle reads it to narrow a long
+		// native build down. An explicit `-PabiFilters` in the gradle args wins.
+		if (
+			pluginBuildSettings.abiFilters &&
+			pluginBuildSettings.abiFilters.length &&
+			(pluginBuildSettings.gradleArgs || "").indexOf("-PabiFilters") === -1
+		) {
+			localArgs.push(
+				`-PabiFilters=${pluginBuildSettings.abiFilters.join(",")}`
+			);
+		}
+
 		if (this.$logger.getLevel() === "INFO") {
 			localArgs.push("--quiet");
 		}