Skip to content

Commit 1bdad40

Browse files
[AGP 9.1.0 Migration flutter#9] Move aar_init_script to public AGP APIs (flutter#193962)
PR 7 (flutter#193693) merged to master as `ecd1ab06865` and PR 8 (flutter#193717) as `4249ccbc18a`. This branch merges master at `4521d8d6634`, so the Files tab shows only PR 9's changes. PR 9 commits: - `86523c549fc` Move aar_init_script to public AGP APIs - `3edc95d1fa0` Check requested AAR variants in the module and each plugin - `da9646aad53` Address review: derive requested variants from components, register AAR tasks lazily - `94a29907065` Clarify aar_init_script comments from the adversarial review - `ea08280d886` Merge commit '23ddd6b74e6' into agp-aar-init-script (PR 8's head with master at `ecd1ab06865`; no conflicts, no change to PR 9's files) - `a17fafcc35e` Merge commit '5ba8961b517' into agp-aar-init-script (master with PR 8 at `4249ccbc18a`; no conflicts, no change to PR 9's files) - `77ba449ea4a` Filter requested AAR components before adding tasks - `adbfb9cd640` Drop the AGP version list from the duplicate-variant comment - `f2b7111c51e` Docs: state the AAR variant requirement in plain words - `cd10f766b5b` Register an AAR task for every variant, publish only requested ones - `b9493299916` Merge commit '4521d8d6634' into agp-aar-init-script (master, including flutter#193649; no conflicts, no change to PR 9's files) ## Description This is PR 9 of 11 in the AGP 9.1.0 / public `gradle-api` migration stack ([flutter#180137](flutter#180137), [flutter#166550](flutter#166550)). `flutter build aar` passes `packages/flutter_tools/gradle/aar_init_script.gradle` to Gradle with `-I`. The script read `android.libraryVariants` and AGP's internal `publishing.singleVariants`. With AGP 9's `android.newDsl=true`, `flutter build aar` on a module fails on `5ba8961b517` with `Can't generate AAR on a non Android library project.` (script line 13), and then at line 178 (`Could not get unknown property 'libraryVariants'`). With this PR the script uses only `pluginManager.hasPlugin`, `Publishing.singleVariant`, software `components` and `tasks.register`, and the build succeeds with `newDsl` on and off, on AGP 9.3.1 and on master's minimum AGP 9.1.1, and on AGP 8.11.1 when FGP's version check is skipped. **Breaking:** no. Builds that succeed on `5ba8961b517` succeed with the same artifacts. Two failing cases change: a module or plugin build file that declares `singleVariant` for only some variants builds, and a variant mismatch between the module and a plugin fails with a Flutter error instead of `Task with name … not found`. **Base:** `master` at `4521d8d6634`. `aar_init_script.gradle`, `build_aar_module_test.dart` and both docs are the same at `4521d8d6634` and `5ba8961b517`, so the comparisons below against `5ba8961b517` hold for `4521d8d6634`. <details> <summary>Agent authored details</summary> ### Changes All in `aar_init_script.gradle` unless noted. Line numbers are at `b9493299916`. 1. **Library check** (`:13`): `project.pluginManager.hasPlugin("com.android.library")` replaces `android.hasProperty("libraryVariants")`. The error text is unchanged. 2. **Publishing declarations** (`afterProject`, `:185-219`): Flutter calls `android.publishing.singleVariant(<variant>) { withSourcesJar(); withJavadocJar() }` for each variant, one variant at a time. If the project's build file already declared that variant, AGP throws, and `isDuplicateSingleVariantError` (`:125-134`) matches AGP's exact message, so the build file's declaration is kept. Its comment links the AGP source of the message ([`AbstractPublishing.kt` at `studio-2025.3.2`, AGP 9.1.0](https://android.googlesource.com/platform/tools/base/+/refs/tags/studio-2025.3.2/build-system/gradle-core/src/main/java/com/android/build/gradle/internal/dsl/AbstractPublishing.kt#38)). Any other exception is rethrown (`:201-203`). The guard that read `publishing.singleVariants` and skipped every Flutter declaration once the build file declared any variant is deleted. 3. **No module-to-plugin `dependsOn`** (`projectsEvaluated`): the loop over `moduleProject.android.libraryVariants` that made each module `assembleAar<Variant>` depend on the plugin's task (with eager `tasks.named(...).get()`) is deleted. The tool requests `assembleAar<Variant>` without a project path (`gradle.dart` `buildGradleAar`, `command.add(aarTask)`), and Gradle runs a task selector that is only a task name in every project that has the task ([Gradle docs](https://docs.gradle.org/current/userguide/command_line_interface.html#executing_tasks_in_multi_project_builds): "You can also run a task for all subprojects using a task selector that consists of only the task name."). Each plugin publishes from its own task. The comment at `:247-248` says this. 4. **Tasks, publications and task name** (`configureProject` `:27-37`; `aarTaskName` `:93-97`; `requestedAarComponents` `:99-103`): AGP adds one software component for each `singleVariant` declaration, with the variant's name. `registerAarTask` (`:105-110`) registers `assembleAar<Variant>` for every component, so a misspelled `--flavor` gets Gradle's candidate list (`Some candidates are: 'assembleAarDebug', ...`). `requestedAarComponents` returns the components whose `assembleAar<Variant>` name is in `startParameter.taskNames`; only those get a publication (`addAarPublication`, `:112-123`), because `publish` publishes every publication in the project. The check uses the same function. `aarTaskName` is the only place that builds `assembleAar<Variant>`; its comment points to the tool's `getAarTaskFor` (`gradle.dart`). Nothing parses a task name back into a variant. The `component.name != "all"` filter from `5ba8961b517` is deleted (see "Why removing the deleted code is safe"). 5. **Lazy task registration** (`registerAarTask`): `project.tasks.register` replaces `project.tasks.create(name:)`. The configuration action only adds `finalizedBy "publish"`. `publications.create` runs in `addAarPublication`, not in the action, because maven-publish registers tasks for each publication and Gradle rejects that while it realizes a task (`DefaultTaskContainer#register(String, Class, Action) on task set cannot be executed in the current context.`, seen when `publications.create` was inside the action). 6. **Requested-variant check** (`checkProjectsHaveRequestedVariants`, `:136-175`, called at `:252`): Gradle skips projects that lack the requested task, so the script checks the module and each Android plugin. The requested variants are the names of the components that `requestedAarComponents` returns for those projects. A project without a requested variant fails the build with a `GradleException` that names the variant and the project: - module: `Flutter can't build the AAR for variant 'debug' because module project ':flutter' has no variant with that name. Its variants are: demoDebug, demoProfile, demoRelease, fullDebug, fullProfile, fullRelease. Pass the module's product flavor with --flavor, or omit --flavor if the module has no product flavors.` - plugin: `Flutter can't build the AAR for variant 'demoDebug' because plugin project ':plugin_a' has no variant with that name, so the plugin AAR that the module depends on can't be published. `flutter build aar` requires the module and each of its Android plugins to declare the same product flavors.` - A requested task that matches no project's variant (for example `--flavor foo`) is left to Gradle: `Task 'assembleAarFooDebug' not found in root project 'android_generated' and its subprojects. Some candidates are: 'assembleAarDebug', 'assembleAarDemoDebug', 'assembleAarFullDebug'.` That is the same error as on `5ba8961b517`. The check's doc says so. (`3edc95d1fa0` parsed the task-name prefix and reported a Flutter module error in this case; `da9646aad53` drops the parsing per review.) 7. **Docs.** Both docs describe behavior only. - `Migrating-Flutter-Gradle-Plugin-to-AGP-public-API.md`: the P8 row of the phase table and "Features that must break" item 8 are rewritten. The "Why" starting-state list (L38-39) is unchanged, as in other PRs of the stack. - [`website-page-draft.md`](https://github.com/flutter/flutter/blob/master/docs/platforms/android/website-page-draft.md) (publishing tracked in [flutter#193713](flutter#193713)): the `flutter build aar` section is rewritten. It said Flutter "detects the overlap and reports it with an actionable error". The code keeps the build file's declaration instead, so the docs were changed to match the code. It says (L234-237) that when a build file declares `singleVariant` for a variant, Flutter keeps that declaration and declares the other variants, and (L238-241) that the module and each Android plugin need a variant with the built name. 8. **Tests.** devicelab `build_aar_module_test` gets two final sections: - With `android.newDsl=true` and `android.builtInKotlin=true` in `.android/gradle.properties`, and `android.publishing.singleVariant("release") { withSourcesJar() }` in `.android/Flutter/build.gradle`, it runs `flutter build aar --no-profile`. It checks that the edits survive, that release has the AAR and sources jar and no javadoc jar, that debug has the javadoc jar, and that the plugin AARs exist for release and debug. - It replaces that declaration with a `demo` product flavor and checks both errors: `flutter build aar --no-profile --no-release` fails with the module error, and the same with `--flavor demo` fails with the plugin error. `da9646aad53`'s commit message says the check's doc "says when it returns and when it throws". That doc sentence was added in `94a29907065`. ### Bug history (moved out of the docs) The docs describe behavior only, so the history that `3edc95d1fa0` put in them is here: - On `5ba8961b517`, the `afterProject` guard skipped all of Flutter's `singleVariant` declarations for a project whose build file declared any variant. For a module with at least one Android plugin that declared only `release`, every `flutter build aar` failed with `Task with name 'assembleAarDebug' not found in project ':flutter'`. With this PR that build succeeds (table 1 below). - On `5ba8961b517`, the `dependsOn` loop failed with `Task with name 'assembleAar<Variant>' not found in project ':<plugin>'` whenever a plugin lacked any module variant, requested or not, and nothing checked that the module had the requested variant. With this PR only requested variants are checked, in the module and in each plugin (table 2 below). ### Audit resolution [PR 9 draft audit](reidbaker-agent#9 (comment)), and stack audit items M4 and L8: | Item | Resolution | | --- | --- | | 1. Eager `.get()` and cross-project task lookup by name | The wiring is deleted, not made lazy: it was redundant (Changes 3). No `.get()` or `tasks.named` in the script. The check reads software components, and `registerAarTask` uses `tasks.register`. | | 2. Broad `catch (Exception)`; overstated `multipleVariants` warning | Only AGP's exact duplicate message is ignored (`:130-134`); everything else is rethrown (`:201-203`). No warning is logged, so there is no `multipleVariants` claim. | | 3. Ext property without `flutter.internal.` | No ext property. `afterProject` fires once per project (instrumented: count 1 for `:`, `:app`, `:flutter`, `:plugin_a` and the included FGP build), and a second call would only hit ignored duplicates. The "fires more than once in composite settings" claim is dropped. | Why the message match and not the type: AGP reports the duplicate from `AbstractPublishing.checkSingleVariantUniqueness` through `SyncIssueReporterImpl`, which throws `com.android.builder.errors.EvalIssueException` in STANDARD mode. That class is in `com.android.tools.build:builder`, not in `gradle-api`, and is not on the init script's classpath. `javap -v` on `AbstractPublishing` shows the same text in AGP 8.11.1, 9.1.0 and 9.3.1. AGP checks before it adds the component (8.11.1 `AbstractPublishing.kt:27-35`), so the build file's declaration stays. If AGP changes the text, the exception is rethrown and the build fails loudly; devicelab `build_aar_module_test` exercises the path on the template AGP. Why not declare first or query: the public `Publishing` DSL in `gradle-api-9.1.0.jar` has only `singleVariant(String)` and `singleVariant(String, Function1)`, and `LibraryPublishing` adds only `multipleVariants(...)` (`javap`), so there is no public way to list declared variants. Declaring Flutter's variants in `beforeProject` + `pluginManager.withPlugin("com.android.library")` makes the build file fail at its own `singleVariant("release")` line with the duplicate error (probe). Why not AGP types in the init script: `import com.android.build.api.dsl.LibraryExtension` fails with `unable to resolve class`. With `gradle-api:9.3.1` on the `initscript` classpath, the init script gets its own copy of the class from a different classloader, so `instanceof` is `false` and `extensions.getByType(LibraryExtension)` throws `Extension of type 'LibraryExtension' does not exist. Currently registered extension types: [..., LibraryExtension, ...]` (probes). `multipleVariants`: `PublishingUtil.ensureComponentNameUniqueness` errors only when a `multipleVariants` component name equals a `singleVariant` name. Flutter declares the same `singleVariant`s on `5ba8961b517` when the build file declares none, so that behavior is unchanged. It is not tested here. ### Why removing the deleted code is safe - `android.libraryVariants` does not exist with `newDsl=true` (reproduced above). AGP 9.1.0 marks its class, `com.android.build.gradle.LibraryExtension`, `@Deprecated` ("This class is not used for the public extensions in AGP when android.newDsl=true, which is the default in AGP 9.0, and will be removed in AGP 10.0."), and the class is not in `gradle-api-9.1.0.jar`. `singleVariants` is an internal property (`getSingleVariants()` on `com.android.build.gradle.internal.dsl.AbstractPublishing`, `javap`). It resolves from Groovy with `newDsl=true`, so it was not a failure, only internal API. - The `dependsOn`: with it removed, the task graph for `assembleAarRelease` on case (a) has `:plugin_a:assembleAarRelease`, `:plugin_a:bundleReleaseAar`, `:plugin_a:publishReleasePublicationToMavenRepository` and `:plugin_a:publish`. `:flutter:generatePomFileForReleasePublication` depends on no `:plugin_a` task, and `:flutter:publishReleasePublicationToMavenRepository` depends only on the plugin's compile-classpath tasks, so the order between the module's and the plugin's publishing doesn't matter. The module POM refers to the plugin by coordinates (`plugin_a_release`). devicelab `build_aar_module_test`, `build_android_host_app_with_module_aar` and `android_java17_build_android_host_app_with_module_aar` pass (they check the plugin AAR/POM and that the module POM depends on `plugin_with_android_release`). - The `all` filter (`component.name != "all"`, added in flutter#101891 `606e91ad63d`): AGP 7.x created an automatic multi-variant component named `all` when a project used no publishing DSL ([`PublishingUtil.kt` at `studio-2021.3.1`](https://android.googlesource.com/platform/tools/base/+/refs/tags/studio-2021.3.1/build-system/gradle-core/src/main/java/com/android/build/gradle/internal/utils/PublishingUtil.kt), `createPublishingInfoForLibrary` and `publishingFeatureOptIn`; same in the AGP 7.3.1 jar). flutter#101891 published it separately with classifiers and skipped it for the `_<variant>` publications; flutter#112149 (`8e30cc9c56b`) removed that publication and kept the skip. AGP 8.0 disabled automatic components by default ([AGP 8.0.0 release notes](https://developer.android.com/build/releases/past-releases/agp-8-0-0-release-notes)), and the AGP 8.11.1, 9.1.1 and 9.3.1 jars list `android.disableAutomaticComponentCreation` as removed, with no `all` component code. This script declares `singleVariant` for every variant, which also turns automatic components off on AGP 7.x. A probe that prints `project.components` after `projectsEvaluated` on all four matrix configurations shows only per-variant names (`[debug, profile, release]` for `:flutter`, `:app` and each plugin, `[demoDebug, …, fullRelease]` for the flavored module, `[freeDebug, freeProfile, freeRelease]` for `plugin_flavored`, `[debug, release]` for the root), never `all`. - `tasks.register`: the publication is created at configuration time only for a requested task name, as with `tasks.create`, whose configuration closure ran immediately. Only the task object is created lazily. Table rows below and the devicelab runs show the same artifacts. ### Removed comments, assertions and code | Removed | Reason | | --- | --- | | `afterProject` comment item 2, "The project has already defined which variants to publish…", and the `singleVariants.size()` guard it described | The guard read internal API and skipped all of Flutter's declarations once a build file declared any. Item 1 of that comment became "Exit early if the project doesn't have the Android Gradle plugin applied." | | The `projectsEvaluated` comment "Configure the `assembleAar<variantName>` task for each plugin's projects and make the module's equivalent task depend on the plugin's task.", with the `libraryVariants.all` loop, both `tasks.named(...).get()` calls, both `assert(... != null)` and the `dependsOn` | The dependency is redundant (see above). `tasks.named(...).get()` throws before the asserts could fail, so they never checked anything. | | `addAarTask` and its `variantName` local | Split into `registerAarTask` (every component) and `addAarPublication` (requested components). The task name comes from `aarTaskName`, which the check also uses. | | `addAarTask` comment "This check is required to be able to configure the archives before `publish` runs.", with the check | The check is `requestedAarComponents`, applied by the caller before `addAarPublication`. Its reason is the comment on `addAarPublication`: "`publish` publishes every publication in the project, so only requested components get one." | | The `component.name != "all"` filter in `configureProject`, and the fragment "(except "all" since that is used to publish artifacts in the new way)" from "Create a default MavenPublication for the variant" | Nothing creates an `all` component where this script runs (see "Why removing the deleted code is safe"). | | From the migration doc item 8 and the website page draft: the sentences about the deleted guard, the `Task with name … not found` failures, and what the deleted code did and did not check | The docs describe behavior only. The history is in "Bug history" above. | ### Behavioral and compatibility notes Matrix projects (local scratch): (a) module + Android plugin `plugin_a`; (b) module with flavors `demo`/`full` + `plugin_a`; (c) module + `plugin_a` + `plugin_flavored` (flavor `free`); (d) module declaring `singleVariant("release") { withSourcesJar() }` + `plugin_a`. 1. **A build file that declares `singleVariant` for some variants builds.** Case (d), `flutter build aar`: | Script | Result | | --- | --- | | `5ba8961b517` (AGP 9.3.1 `newDsl=false`) | exit 1: `Task with name 'assembleAarDebug' not found in project ':flutter'.` | | This PR (all four configurations below) | exit 0. Release has the AAR, POM and sources jar, and no javadoc jar (the build file's declaration). Debug and profile have sources and javadoc jars. Plugin AAR/POM for all three. | 2. **Variant mismatches fail with a Flutter error that names the project.** Only requested variants are checked. The `5ba8961b517` column is AGP 9.3.1 with `newDsl=false`. | Case | `5ba8961b517` | This PR (all four configurations) | | --- | --- | --- | | (b) `--flavor demo` | `Task with name 'assembleAarDemoDebug' not found in project ':plugin_a'.` | plugin error for `demoDebug` and `:plugin_a` | | (c) default | `Task with name 'assembleAarDebug' not found in project ':plugin_flavored'.` | plugin error for `debug` and `:plugin_flavored` | | (b) no `--flavor`, `--no-profile --no-release` | `Task with name 'assembleAarDemoDebug' not found in project ':plugin_a'.` | module error for `debug`, listing the module's variants | | (c) `--flavor free`, `--no-profile --no-release` | `Task with name 'assembleAarDebug' not found in project ':plugin_flavored'.` | module error for `freeDebug` | | (b) `--flavor foo` | Gradle `Task 'assembleAarFooDebug' not found in root project …` | same Gradle error | Without the module check (`86523c549fc`), the module-error cases exit 0 with "✓ Built" and a repo that has only the plugin AAR. 3. **Path-qualified requests.** `./gradlew -I aar_init_script.gradle … :flutter:assembleAarRelease` exits 0 and publishes nothing, on `5ba8961b517` and on this PR: a publication is created only when `startParameter.taskNames` contains the bare name. The tool sends only the bare name (`gradle.dart` `command.add(aarTask)`). Not changed here. 4. **No warnings.** `flutter build aar` hides Gradle output on success unless `-v` (`ProcessUtils.run` buffers it; `gradle.dart` prints it only on failure, and verified with a `logger.error` probe). Keeping a build file's declaration needs no action, so nothing is logged. Errors are shown. 5. **Configuration cache:** with `org.gradle.configuration-cache=true` in case (a)'s `.android/gradle.properties` (AGP 9.3.1 / Gradle 9.5.0), `flutter build aar` reports the same single problem with the `5ba8961b517` script and with this PR: ``Task `:flutter:compileFlutterBuildDebug` of type `com.flutter.gradle.tasks.FlutterTask`: invocation of 'Task.project' at execution time is unsupported with the configuration cache.`` None comes from the init script. 6. `newDsl=true` with `builtInKotlin=false` fails before the script with any Kotlin plugin (`The 'org.jetbrains.kotlin.android' plugin is not compatible with AGP's 9.0 new DSL`). The devicelab section and matrix set `builtInKotlin=true`. 7. Related open work: no overlap with [flutter#191681](flutter#191681) (`gradle.dart`, `gradle_errors.dart` and tests). No open PR touches `aar_init_script.gradle`. ### Follow-up candidates (pre-existing, not changed here) - `allprojects { apply plugin: "maven-publish" }` applies maven-publish to every project, including ones that never publish. - The `afterProject` and `projectsEvaluated` hooks reach across projects, which Gradle Isolated Projects does not allow. - The `-SNAPSHOT` rewrite of `project.version` in `configureProject`. - The `engine.realm` and `engine.stamp` file reads at configuration time in `configureProject`. - The `is-plugin` branch of `projectsEvaluated` looks unreachable from the tool. - The configuration cache problem in FGP `FlutterTask` (note 5). - `newDsl=true` with KGP (`builtInKotlin=false`), for PR 10. - Mapping between flavored module variants and plugin variants (for example, plugin `release` for module `demoRelease`). - `singleVariant` is declared on the root project and `:app`, which never publish. - Gradle output is hidden on success, so nothing the script logs at info or warn level reaches the user without `-v`. ### Integration test coverage of the changed paths Searched `dev/devicelab/bin/tasks` and `packages/flutter_tools/test/integration.shard` for `build aar` and `assembleAar`. | Path | Tests | | --- | --- | | Library check, publishing declarations, lazy task registration, plugin publishing without `dependsOn` (`newDsl=false`) | devicelab `build_aar_module_test`, `build_android_host_app_with_module_aar`, `android_java17_build_android_host_app_with_module_aar`; `android_obfuscate_test` | | `newDsl=true`, a build file's `singleVariant` declaration kept | devicelab `build_aar_module_test`, `newDsl=true` section | | Module and plugin variant mismatch errors | devicelab `build_aar_module_test`, product flavor section | | AGP 9.1.1 and 8.11.1; a variant that no project has | Manual matrix only | `Linux build_aar_module_test` runs in presubmit for this PR: in `.ci.yaml` its `runIf` includes `dev/**` and `packages/flutter_tools/**`, and it sets neither `presubmit: false` nor `bringup`. It also ran locally on the head (below) with `cd dev/devicelab && ../../bin/dart bin/test_runner.dart test -t build_aar_module_test --exit`. ### Tests run locally (macOS, JDK 17) On the head (`b9493299916`; master merged at `4521d8d6634`): - `gradle test --rerun-tasks` in `packages/flutter_tools/gradle`, with the engine's `third_party/gradle` binary that the README names: 33 suites, 277 tests, 0 failures. - `dart format` and `dart analyze --fatal-infos` on `build_aar_module_test.dart`: clean (unchanged since `3edc95d1fa0`). - Tool tests: `test/commands.shard/hermetic/build_aar_test.dart`, `test/commands.shard/permeable/build_aar_test.dart` and `test/general.shard/android/android_gradle_builder_test.dart`: 56 tests, all pass. - `test/integration.shard/android_obfuscate_test.dart`: 2 tests pass. - devicelab via `bin/test_runner.dart test --exit`, one at a time: `build_aar_module_test` (including both added sections), `build_android_host_app_with_module_aar`, `android_java17_build_android_host_app_with_module_aar`, `build_android_host_app_with_module_source`, `module_host_with_custom_build_test`, all `success`. - The configuration cache comparison (note 5). Manual matrix on `b9493299916`, four configurations: - **9.3.1 off:** AGP 9.3.1 / Gradle 9.5.0, `newDsl=false`, `builtInKotlin=false`. - **9.3.1 on:** AGP 9.3.1 / Gradle 9.5.0, `newDsl=true`, `builtInKotlin=true`. - **9.1.1 on:** AGP 9.1.1 / Gradle 9.3.1 (FGP's minimums on master since flutter#193813), `newDsl=true`, `builtInKotlin=true`. - **8.11.1:** AGP 8.11.1 / Gradle 8.14.3, `newDsl=false`, with `skipDependencyChecks=true` in `.android/gradle.properties`. Without it, FGP stops before the init script runs: `Your project's Gradle version (8.14.3) is lower than Flutter's minimum supported version of 9.3.1.` | Case | 9.3.1 off | 9.3.1 on | 9.1.1 on | 8.11.1 | | --- | --- | --- | --- | --- | | (a) | exit 0, AAR, POM, sources and javadoc jars for `flutter_{debug,profile,release}` and `plugin_a_{debug,profile,release}` | same | same | same | | (b) `--flavor demo` | exit 1, plugin error | same | same | same | | (b) no `--flavor` | exit 1, module error | same | same | same | | (b) `--flavor foo` | exit 1, Gradle `Task 'assembleAarFooDebug' not found in root project` | same | same | same | | (c) | exit 1, plugin error | same | same | same | | (c) `--flavor free` | exit 1, module error | same | same | same | | (d) | exit 0, as (a), except module release has the sources jar and no javadoc jar | same | same | same | Case (a)'s `flutter_release-1.0.pom` depends on `dev.pr9.plugin_a:plugin_a_release:1.0` (checked on `b9493299916`, AGP 9.1.1). Negative control, the master script (same at `5ba8961b517` and `4521d8d6634`), on `b9493299916`: with `newDsl=true` (AGP 9.3.1 and AGP 9.1.1), (a)-(d) all fail with `Can't generate AAR on a non Android library project.`; with `newDsl=false` on AGP 9.3.1, (a) passes and (b)-(d) fail with Gradle's `Task with name 'assembleAar<V>' not found in project ':<p>'.` On `a17fafcc35e`, with only line 13 changed to `hasPlugin`, `newDsl=true` fails at line 178 with `Could not get unknown property 'libraryVariants' for object of type com.android.build.gradle.internal.dsl.LibraryExtensionImpl$AgpDecorated.` devicelab `build_aar_module_test` with that script fails at the `newDsl=true` section with the same error. </details> --- ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant in-code documentation (doc comments with `///`). - [x] If this PR introduces a new feature or capability, I created and linked a website documentation issue or PR in [flutter/website] (or verified none is needed). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [flutter/website]: https://github.com/flutter/website [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
1 parent ad52f8e commit 1bdad40

4 files changed

Lines changed: 229 additions & 56 deletions

File tree

‎dev/devicelab/bin/tasks/build_aar_module_test.dart‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,85 @@ Future<void> main() async {
262262

263263
checkCollectionContains<String>(<String>[...flutterAssets, ...debugAssets], debugAar);
264264

265+
section('Build AARs with android.newDsl=true and a module singleVariant declaration');
266+
267+
final androidDir = Directory(path.join(projectDir.path, '.android'));
268+
final gradleProperties = File(path.join(androidDir.path, 'gradle.properties'));
269+
_setGradleProperty(gradleProperties, 'android.newDsl', 'true');
270+
// The plugin template uses Kotlin, which needs built-in Kotlin with newDsl=true.
271+
_setGradleProperty(gradleProperties, 'android.builtInKotlin', 'true');
272+
final moduleBuildFile = File(path.join(androidDir.path, 'Flutter', 'build.gradle'));
273+
const userDeclaration = 'android.publishing.singleVariant("release") { withSourcesJar() }';
274+
moduleBuildFile.writeAsStringSync(
275+
'${Platform.lineTerminator}$userDeclaration${Platform.lineTerminator}',
276+
mode: FileMode.append,
277+
flush: true,
278+
);
279+
rmTree(Directory(repoPath));
280+
281+
await inDirectory(projectDir, () async {
282+
await flutter('build', options: <String>['aar', '--no-profile']);
283+
});
284+
285+
// The tool regenerates `.android` when it is stale; the edits must still be there.
286+
checkFileContains(<String>['android.newDsl=true'], gradleProperties.path);
287+
checkFileContains(<String>[userDeclaration], moduleBuildFile.path);
288+
289+
section('Check that the module declaration is used for release only');
290+
291+
final String helloDir = path.join(repoPath, 'io', 'flutter', 'devicelab', 'hello');
292+
checkFileExists(path.join(helloDir, 'flutter_release', '1.0', 'flutter_release-1.0.aar'));
293+
checkFileExists(
294+
path.join(helloDir, 'flutter_release', '1.0', 'flutter_release-1.0-sources.jar'),
295+
);
296+
checkFileNotExists(
297+
path.join(helloDir, 'flutter_release', '1.0', 'flutter_release-1.0-javadoc.jar'),
298+
);
299+
checkFileExists(path.join(helloDir, 'flutter_debug', '1.0', 'flutter_debug-1.0-javadoc.jar'));
300+
for (final mode in <String>['release', 'debug']) {
301+
checkFileExists(
302+
path.join(
303+
repoPath,
304+
'io',
305+
'flutter',
306+
'devicelab',
307+
'plugin_with_android',
308+
'plugin_with_android_$mode',
309+
'1.0',
310+
'plugin_with_android_$mode-1.0.aar',
311+
),
312+
);
313+
}
314+
315+
section('Check variant mismatch errors for a module with a product flavor');
316+
317+
// The `release` declaration is replaced because the flavor renames the variant to `demoRelease`.
318+
moduleBuildFile.writeAsStringSync(
319+
moduleBuildFile.readAsStringSync().replaceFirst(
320+
userDeclaration,
321+
'android {${Platform.lineTerminator}'
322+
' flavorDimensions = ["env"]${Platform.lineTerminator}'
323+
' productFlavors { demo { dimension = "env" } }${Platform.lineTerminator}'
324+
'}',
325+
),
326+
flush: true,
327+
);
328+
329+
// Without --flavor, only the plugin has the requested `debug` variant.
330+
await _checkBuildAarFails(projectDir, <String>[
331+
'aar',
332+
'--no-profile',
333+
'--no-release',
334+
], "module project ':flutter' has no variant with that name");
335+
// With --flavor demo, only the module has the requested `demoDebug` variant.
336+
await _checkBuildAarFails(projectDir, <String>[
337+
'aar',
338+
'--no-profile',
339+
'--no-release',
340+
'--flavor',
341+
'demo',
342+
], "plugin project ':plugin_with_android' has no variant with that name");
343+
265344
return TaskResult.success(null);
266345
} on TaskResult catch (taskResult) {
267346
return taskResult;
@@ -273,3 +352,29 @@ Future<void> main() async {
273352
}
274353
});
275354
}
355+
356+
/// Sets [name] to [value] in [gradleProperties], adding the line if it is missing.
357+
void _setGradleProperty(File gradleProperties, String name, String value) {
358+
final String content = gradleProperties.readAsStringSync();
359+
final pattern = RegExp('^${RegExp.escape(name)}=.*\$', multiLine: true);
360+
gradleProperties.writeAsStringSync(
361+
content.contains(pattern)
362+
? content.replaceFirst(pattern, '$name=$value')
363+
: '$content${Platform.lineTerminator}$name=$value${Platform.lineTerminator}',
364+
flush: true,
365+
);
366+
}
367+
368+
/// Runs `flutter build` with [options] in [projectDir] and checks that it fails with [message].
369+
Future<void> _checkBuildAarFails(Directory projectDir, List<String> options, String message) async {
370+
final ProcessResult result = await inDirectory(projectDir, () {
371+
return executeFlutter('build', options: options, canFail: true);
372+
});
373+
final output = '${result.stdout}${result.stderr}';
374+
if (result.exitCode == 0 || !output.contains(message)) {
375+
throw TaskResult.failure(
376+
'Expected `flutter build ${options.join(' ')}` to fail with "$message". '
377+
'Exit code: ${result.exitCode}. Output:\n$output',
378+
);
379+
}
380+
}

‎docs/platforms/android/Migrating-Flutter-Gradle-Plugin-to-AGP-public-API.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ projects. That opt-out dies with AGP 10.
126126
| eager `applicationVariants.configureEach` task creation; mergeAssets/processResources hooks | `FlutterPlugin.kt`, `FlutterPluginUtils.kt` | consolidated `onVariants` block; `CopyFlutterAssetsTask` + `variant.sources.assets.addGeneratedSourceDirectory` | P5 |
127127
| `variant.outputs` + `packageApplicationProvider` + `doLast` APK copy; `versionCodeOverride` | `FlutterPluginUtils.kt` | `CopyFlutterApksTask` (`SingleArtifact.APK` + `BuiltArtifactsLoader`); `VariantOutput.versionCode` set from a `finalizeDsl` snapshot (`DslVersionCodes`) | P6 |
128128
| `libraryVariants.all` × host `applicationVariants.all` cross-wiring | `FlutterPlugin.kt` (add-to-app) | library-side `onVariants` with `Component.debuggable`; no host-project lookup | P7 |
129-
| dynamic Groovy legacy API in `aar_init_script.gradle` | `aar_init_script.gradle` | `components`-based enumeration; ext-property guard | P8 |
129+
| `android.libraryVariants`; internal `publishing.singleVariants`; module-to-plugin `assembleAar<V>.dependsOn` | `aar_init_script.gradle` | `com.android.library` plugin check; per-variant `singleVariant` that keeps the build file's declaration; the tool requests `assembleAar<V>` without a project path, so it runs in the module and in every plugin that has it (no `dependsOn`) | P8 |
130130
| `android.newDsl=false` template/migrator | templates, `disable_new_dsl_migration.dart` | drop from templates; `RemoveNewDslOptOutMigration` | P9 |
131131
| FULL `gradle` artifact dependency | `build.gradle.kts` | `gradle-api` artifact (compile-time proof of zero internal usage) | P10 |
132132

@@ -258,10 +258,11 @@ else serializes through `FlutterPlugin.kt` / `FlutterPluginUtils.kt`.
258258
7. **Task realization/type**: flutter tasks become lazy `TaskProvider`s, and
259259
`copyFlutterAssets<V>` changes type from `org.gradle.api.tasks.Copy` to a
260260
custom task class — `tasks.named(..., Copy::class)` casts fail.
261-
8. **`flutter build aar`**: the singleVariant dedup guard becomes an
262-
ext-property/try-catch with a specified error message; variant enumeration
263-
moves from `libraryVariants` to `components` — partial user `singleVariant`
264-
declarations surface differently.
261+
8. **`flutter build aar`**: Flutter declares `singleVariant` publishing (with sources and
262+
javadoc jars) for each variant of the module and of each Android plugin. For a variant that
263+
the project's build file declares, the build file's declaration wins. The requested variant
264+
must exist in the module and in each Android plugin; otherwise the build fails, and the fix
265+
is to build a variant that all of them declare (`--flavor`, matching product flavors).
265266
9. **newDsl flip**: new projects lose the opt-out; the removal migrator deletes
266267
only marker-tagged `android.newDsl` lines (template marker "This newDsl flag
267268
was added by the Flutter template"; migrator marker "This newDsl flag was

‎docs/platforms/android/website-page-draft.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -231,10 +231,14 @@ aliases:
231231

232232
### `flutter build aar`
233233

234-
Variant enumeration for AAR builds now uses the public `components` API. If
235-
your module's build script declares `singleVariant(...)` publishing itself,
236-
Flutter detects the overlap and reports it with an actionable error instead of
237-
failing inside AGP.
234+
- If your module's or a plugin's build file declares
235+
`android.publishing.singleVariant(...)` for a variant, Flutter uses that
236+
declaration for that variant and declares publishing (with sources and javadoc
237+
jars) for the other variants.
238+
- `flutter build aar` builds one variant for each build mode, named from
239+
`--flavor` and the build mode (for example, `demoRelease`). The module and
240+
each Android plugin that it uses must have a variant with that name, or the
241+
build fails. Pass `--flavor` for a module with product flavors.
238242

239243
## Escape hatch (temporary)
240244

‎packages/flutter_tools/gradle/aar_init_script.gradle‎

Lines changed: 110 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ void configureProject(Project project, String outputDir) {
1010
if (!project.hasProperty("android")) {
1111
throw new GradleException("Android property not found.")
1212
}
13-
if (!project.android.hasProperty("libraryVariants")) {
13+
if (!project.pluginManager.hasPlugin("com.android.library")) {
1414
throw new GradleException("Can't generate AAR on a non Android library project.")
1515
}
1616

@@ -24,10 +24,16 @@ void configureProject(Project project, String outputDir) {
2424
project.version = project.property("buildNumber")
2525
}
2626

27-
project.components.forEach { component ->
28-
if (component.name != "all") {
29-
addAarTask(project, component)
30-
}
27+
// AGP adds one software component for each `singleVariant` declaration and gives it the
28+
// variant's name, and `afterProject` below declares one for every variant. Every variant gets a
29+
// task, so when the requested task doesn't exist (for example, a misspelled `--flavor`), Gradle
30+
// lists the `assembleAar<Variant>` tasks as candidates. Only requested variants get a
31+
// publication.
32+
project.components.each { component ->
33+
registerAarTask(project, component.name)
34+
}
35+
requestedAarComponents(project).each { component ->
36+
addAarPublication(project, component)
3137
}
3238

3339
project.publishing {
@@ -84,28 +90,90 @@ static String getFlutterRoot(Project project) {
8490
return project.property("flutter-root")
8591
}
8692

87-
void addAarTask(Project project, component) {
88-
String variantName = component.name.capitalize()
89-
String taskName = "assembleAar$variantName"
90-
project.tasks.create(name: taskName) {
91-
// This check is required to be able to configure the archives before `publish` runs.
92-
if (!project.gradle.startParameter.taskNames.contains(taskName)) {
93-
return
94-
}
93+
// Builds the task name that the tool requests (`getAarTaskFor` in
94+
// packages/flutter_tools/lib/src/android/gradle.dart).
95+
static String aarTaskName(String variantName) {
96+
return "assembleAar${variantName.capitalize()}"
97+
}
9598

96-
// Create a default MavenPublication for the variant (except "all" since that is used to publish artifacts in the new way)
97-
project.publishing.publications.create(component.name, MavenPublication) { pub ->
98-
groupId = "${pub.groupId}"
99-
artifactId = "${pub.artifactId}_${pub.name}"
100-
version = "${pub.version}"
101-
from component
102-
}
99+
// Returns the components whose `assembleAar<Variant>` task the tool requested.
100+
static Collection<SoftwareComponent> requestedAarComponents(Project project) {
101+
List<String> requestedTasks = project.gradle.startParameter.taskNames
102+
return project.components.findAll { requestedTasks.contains(aarTaskName(it.name)) }
103+
}
103104

105+
void registerAarTask(Project project, String variantName) {
106+
project.tasks.register(aarTaskName(variantName)) {
104107
// Generate the Maven artifacts.
105108
finalizedBy "publish"
106109
}
107110
}
108111

112+
// `publish` publishes every publication in the project, so only requested components get one.
113+
void addAarPublication(Project project, SoftwareComponent component) {
114+
// Create a default MavenPublication for the variant.
115+
// This doesn't run in the task's configuration action because maven-publish registers tasks
116+
// for each publication, and Gradle doesn't allow registering tasks while it realizes a task.
117+
project.publishing.publications.create(component.name, MavenPublication) { pub ->
118+
groupId = "${pub.groupId}"
119+
artifactId = "${pub.artifactId}_${pub.name}"
120+
version = "${pub.version}"
121+
from component
122+
}
123+
}
124+
125+
// AGP reports this error when `singleVariant` is declared twice for one variant
126+
// (`checkSingleVariantUniqueness`:
127+
// https://android.googlesource.com/platform/tools/base/+/refs/tags/studio-2025.3.2/build-system/gradle-core/src/main/java/com/android/build/gradle/internal/dsl/AbstractPublishing.kt#38).
128+
// Its class, com.android.builder.errors.EvalIssueException, is not public AGP API and is not on
129+
// this script's classpath, so the error is matched by its message.
130+
static boolean isDuplicateSingleVariantError(Exception e, String variantName) {
131+
String duplicateMessage = "Using singleVariant publishing DSL multiple times to publish " +
132+
"variant \"$variantName\" to component \"$variantName\" is not allowed."
133+
return e.message == duplicateMessage
134+
}
135+
136+
// Checks that the module and each Android plugin have every variant whose `assembleAar<Variant>`
137+
// task the tool requested. Returns normally if they do. Otherwise throws a GradleException that
138+
// names the variant and the first project without it. A requested task that matches no project's
139+
// variant (for example a misspelled `--flavor`) is left to Gradle, which fails with
140+
// `Task '<name>' not found in root project`.
141+
//
142+
// A project without the requested variant publishes no AAR, and the module's POM depends on each
143+
// plugin's AAR for the same variant name.
144+
void checkProjectsHaveRequestedVariants(Project moduleProject, Collection<Project> pluginProjects) {
145+
Collection<Project> androidPlugins = pluginProjects.findAll { it.hasProperty("android") }
146+
Collection<Project> aarProjects = [moduleProject] + androidPlugins
147+
Map<Project, Set<String>> variantsByProject = aarProjects.collectEntries {
148+
[(it): it.components*.name as Set]
149+
}
150+
Set<String> requestedVariants = aarProjects.collectMany {
151+
requestedAarComponents(it)*.name
152+
} as Set
153+
requestedVariants.each { variantName ->
154+
if (!variantsByProject[moduleProject].contains(variantName)) {
155+
String moduleVariants = variantsByProject[moduleProject].sort().join(", ")
156+
throw new GradleException(
157+
"Flutter can't build the AAR for variant '$variantName' because module " +
158+
"project '${moduleProject.path}' has no variant with that name. Its variants " +
159+
"are: $moduleVariants. Pass the module's product flavor with --flavor, or " +
160+
"omit --flavor if the module has no product flavors."
161+
)
162+
}
163+
androidPlugins.each { pluginProject ->
164+
if (!variantsByProject[pluginProject].contains(variantName)) {
165+
throw new GradleException(
166+
"Flutter can't build the AAR for variant '$variantName' because plugin " +
167+
"project '${pluginProject.path}' has no variant with that name, so the " +
168+
"plugin AAR that the module depends on can't be published. " +
169+
"`flutter build aar` requires the module and each of its Android " +
170+
"plugins to declare the same product flavors."
171+
)
172+
}
173+
}
174+
}
175+
}
176+
109177
// maven-publish has to be applied _before_ the project gets evaluated, but some of the code in
110178
// `configureProject` requires the project to be evaluated. Apply the maven plugin to all projects, but
111179
// only configure it if it matches the conditions in `projectsEvaluated`
@@ -115,32 +183,35 @@ allprojects {
115183
}
116184

117185
afterProject { project ->
118-
// Exit early if either:
119-
// 1. The project doesn't have the Android Gradle plugin applied.
120-
// 2. The project has already defined which variants to publish (trying to re-define which
121-
// variants to publish will result in an error).
186+
// Exit early if the project doesn't have the Android Gradle plugin applied.
122187
if (!project.hasProperty("android")) {
123188
return
124189
}
125-
if (project.android.publishing.singleVariants.size() != 0) {
126-
return
190+
191+
// afterProject runs after the project's build file, so AGP rejects a variant that the build
192+
// file already declared. The public `Publishing` DSL can declare variants but not list them,
193+
// so ignoring only that error is how the build file's declaration is kept. Any other error
194+
// fails the build.
195+
Closure addSingleVariant = { String variantName ->
196+
try {
197+
project.android.publishing.singleVariant(variantName) {
198+
withSourcesJar()
199+
withJavadocJar()
200+
}
201+
} catch (Exception e) {
202+
if (!isDuplicateSingleVariantError(e, variantName)) {
203+
throw e
204+
}
205+
}
127206
}
128207

129208
Closure addSingleVariants = {buildType ->
130209
if (!project.android.productFlavors.isEmpty()) {
131210
project.android.productFlavors.all{productFlavor ->
132-
project.android.publishing.singleVariant(
133-
productFlavor.name + buildType.name.capitalize()
134-
) {
135-
withSourcesJar()
136-
withJavadocJar()
137-
}
211+
addSingleVariant(productFlavor.name + buildType.name.capitalize())
138212
}
139213
} else {
140-
project.android.publishing.singleVariant(buildType.name) {
141-
withSourcesJar()
142-
withJavadocJar()
143-
}
214+
addSingleVariant(buildType.name)
144215
}
145216
}
146217

@@ -173,18 +244,10 @@ projectsEvaluated {
173244
// because the module POM's file will include a dependency on the plugin Maven artifact.
174245
// This is due to the Android Gradle Plugin expecting all library subprojects to be published
175246
// as Maven artifacts.
247+
// The tool requests `assembleAar<Variant>` by name, without a project path, so Gradle runs it
248+
// in every project that has it, and each plugin publishes its own AAR.
176249
modulePlugins.each { pluginProject ->
177250
configurePlugin(pluginProject, moduleProject.property("output-dir"))
178-
moduleProject.android.libraryVariants.all { variant ->
179-
// Configure the `assembleAar<variantName>` task for each plugin's projects and make
180-
// the module's equivalent task depend on the plugin's task.
181-
String variantName = variant.name.capitalize()
182-
183-
Task moduleProjectTask = moduleProject.tasks.named("assembleAar$variantName").get()
184-
assert(moduleProjectTask != null)
185-
Task pluginProjectTask = pluginProject.tasks.named("assembleAar$variantName").get()
186-
assert(pluginProjectTask != null)
187-
moduleProjectTask.dependsOn(pluginProjectTask)
188-
}
189251
}
252+
checkProjectsHaveRequestedVariants(moduleProject, modulePlugins)
190253
}

0 commit comments

Comments
 (0)