Enforce minSdk constraint for Android Flutter #164251

ash2moon · 2025-02-27T00:28:46Z

This commit adds validation for the Android SDK version within the existing dependency version checker. It introduces a warning when the SDK version is below a predefined threshold. The validation checks for the minSdk property in the android block of the app's build.gradle file. It will warn users if their minSdk version is out of Flutter's supported
range and guide them on how to fix it.

Fixes #134570

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

auto-submit · 2025-02-27T01:05:50Z

autosubmit label was removed for flutter/flutter/164251, because - The status or check suite Linux analyze has failed. Please fix the issues identified (or deflake) before re-applying this label.

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

packages/flutter_tools/gradle/src/test/kotlin/DependencyVersionCheckerTest.kt

gmackall

I'd recommend also adding the code path for the error version in this pr, but just setting the actual error version to 1 for now (similar to what is done for Java)

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

gmackall

lgtm w/ tiny nits

packages/flutter_tools/gradle/src/test/kotlin/DependencyVersionCheckerTest.kt

auto-submit · 2025-03-03T18:43:03Z

autosubmit label was removed for flutter/flutter/164251, because This PR has not met approval requirements for merging. Changes were requested by {reidbaker}, please make the needed changes and resubmit this PR.
The PR author is a member of flutter-hackers and needs 1 more review(s) in order to merge this PR.

Merge guidelines: A PR needs at least one approved review if the author is already part of flutter-hackers or two member reviews if the author is not a flutter-hacker before re-applying the autosubmit label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

reidbaker · 2025-03-03T19:01:46Z

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

+        }
+
+        val androidComponents =
+            project.extensions.findByType(AndroidComponentsExtension::class.java)


Do you also need to check for com.android.build.gradle.LibraryExtension to support non apps like aar's?

I'm not sure if this would even be possible to warn via the way we are applying this gradle plugin. Since the gradle plugin is only added for flutter applications and not flutter plugins, this code would never run, therefore making any checks on LibraryExtension to not run.

I feel like adding support for plugins would require deeper integration work and would be out of the scope for this PR. WDYT?

I was more thinking flutter modules that get built from either source like a locally developed plugin or a flutter module assembled as an aar. I am pretty confident that flutter tooling is run in that case (e.g. flutter build aar).

I am ok if you do library work in another pr but I think it is in scope for this issue.

Looks like for modules/plugins, the "dev.flutter.flutter-gradle-plugin" is not applied, so none of our dependency checking code gets ran. Once that plugin is added to the projects, I believe this code should automatically start checking for those dependencies since AndroidComponentsExtension is a supertype of ApplicationAndroidComponentsExtension and LibraryAndroidComponentsExtension

Flutter tooling is run, but we don't apply the flutter gradle plugin to either modules or plugins, so I don't think we will be able to handle those cases in the DependencyVersionChecker.

But also, AndroidComponentsExtension is a supertype of ApplicationAndroidComponentsExtension and LibraryAndroidComponentsExtension, so I think this would work if we did eventually apply to a Library

ok then with grays comment it is not in scope.

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

…avor in min sdk checker

reidbaker

Approved % comments.

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

reidbaker · 2025-03-04T15:01:25Z

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

@@ -105,6 +131,35 @@ object DependencyVersionChecker {
        // KGP is not required, so don't log any warning if we can't find the version.
    }

+    private fun checkMinSdkForAndroidComponents(project: Project) {


Naming nit: I think this should be called something like configureMinSdkCheck since that is what this method does and the actual check is in checkMinSdkVersion which feels appropriately named.

reidbaker · 2025-03-04T15:02:49Z

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

+            val taskName = "${it.name.capitalize()}$MIN_SDK_CHECK_TASK_POSTFIX"
+            val minSdkCheckTask =
+                project.tasks.register(taskName) {
+                    doLast {


Does this need to be in a doLast block? there is no prework and we are creating the task so I would think it could run in the "normal order" part of the task.

In this case, it wouldn't really matter if we call doFirst or doLast since there is no other code being executed, but I think typically I've seen doLast more often than doFirst. If you mean by "normal order" as in without the doLast or doFirst, we would end up adding code in the configuration stage of the action which is not something we would want to do. Alternatively we can also just do actions.add { ... } but I think it would be more idiomatic to just do doLast { ... }. WDYT?

No strong opinion but we should probably have a strong opinion. I am leaning towards having it be part of the regular actions based on this documentation of task outputs.

Then we can save doFirst for setup and doLast for clean up. I think you are right that our current code does use doLast the most.
@gmackall fyi.

reidbaker · 2025-03-04T15:05:16Z

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt

+
+    @VisibleForTesting internal fun checkMinSdkVersion(
+        minSdkVersion: MinSdkVersion,
+        project: Project


Scope nit: consider passing the rootDir path, and the logger then returning if OUT_OF_SUPPORT_RANGE_PROPERTY should be set.

Project as you can see is a big object that has a lot of scope and we can minimize that scope in this method.

reidbaker · 2025-03-04T15:08:30Z

packages/flutter_tools/gradle/src/test/kotlin/DependencyVersionCheckerTest.kt

@@ -209,6 +220,98 @@ class DependencyVersionCheckerTest {
        }
        verify(exactly = 0) { mockExtraPropertiesExtension.set(OUT_OF_SUPPORT_RANGE_PROPERTY, true) }
    }
+
+    @Test
+    fun `min SDK version in warn range results in warning logs`() {


I like the 2 roughly end to end tests you have added here. Consider adding unit tests for some of the extracted logic you made @VisibleForTesting that are smaller in scope and require less expansive mocking (or no mocking).

I added some more tests for checkMinSdkVersion since that's the only other non-private method added.

- refactored checkMinSdkVersion - added more test cases for min sdk check

…r#164251)

flutter/flutter@2578d97...321fbc0 2025-03-06 [email protected] Roll Skia from fefecd49e03a to ccd8cc23aa94 (1 revision) (flutter/flutter#164712) 2025-03-06 [email protected] [web] Detect scrollable semantics nodes more reliably (flutter/flutter#164491) 2025-03-06 [email protected] [windows] wire the focus request and the focus events through the Windows platform (flutter/flutter#164296) 2025-03-06 [email protected] Roll Skia from 02897747c7d5 to fefecd49e03a (1 revision) (flutter/flutter#164701) 2025-03-06 [email protected] Roll Skia from e315b0ab7c84 to 02897747c7d5 (1 revision) (flutter/flutter#164677) 2025-03-06 [email protected] Roll Skia from 0c3880f94970 to e315b0ab7c84 (1 revision) (flutter/flutter#164669) 2025-03-06 [email protected] [Impeller] use device private on non-iOS devices. (flutter/flutter#164601) 2025-03-05 [email protected] Roll Skia from 43294a662fd0 to 0c3880f94970 (1 revision) (flutter/flutter#164661) 2025-03-05 [email protected] Add a workflow (only triggered from rest events) for hasing experiment (flutter/flutter#164657) 2025-03-05 [email protected] Roll Skia from 4cf9f0b77d41 to 43294a662fd0 (4 revisions) (flutter/flutter#164649) 2025-03-05 [email protected] Adds animateToItem to the CarouselController (flutter/flutter#162694) 2025-03-05 [email protected] Cleanup content context (flutter/flutter#164229) 2025-03-05 [email protected] Fix: Update CupertinoSheetRoute transition rounded corner (flutter/flutter#163700) 2025-03-05 [email protected] [Impeller] fix macOS managed memory. (flutter/flutter#164635) 2025-03-05 [email protected] [skwasm] Clear font collection cache when font is loaded manually. (flutter/flutter#164588) 2025-03-05 [email protected] Fix race condition causing crash when interacting with an animating scrollable (flutter/flutter#164392) 2025-03-05 [email protected] Use dwds 24.3.6 and pass uri for the reload scripts path to FrontendServerDdcLibraryBundleProvider (flutter/flutter#164582) 2025-03-05 [email protected] Roll Packages from 9e4684e to abba683 (8 revisions) (flutter/flutter#164630) 2025-03-05 [email protected] Roll Skia from 7e4323f72c9d to 4cf9f0b77d41 (1 revision) (flutter/flutter#164622) 2025-03-05 [email protected] Fix to Linux_pixel_7pro integration_ui_keyboard_resize test flakiness (flutter/flutter#162308) 2025-03-05 [email protected] Roll Skia from 03a3f653d64e to 7e4323f72c9d (1 revision) (flutter/flutter#164599) 2025-03-05 [email protected] Implement `clipPath` Mutator for hcpp (flutter/flutter#164525) 2025-03-05 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] use DeviceLocal textures for gifs on non-iOS devices. (#164573)" (flutter/flutter#164600) 2025-03-05 [email protected] [macos] prefer integrated GPU. (flutter/flutter#164569) 2025-03-05 [email protected] Enforce minSdk constraint for Android Flutter (flutter/flutter#164251) 2025-03-05 [email protected] Add `clipRSuperellipse`, and use them for dialogs (flutter/flutter#161111) 2025-03-05 [email protected] Roll Skia from 46705a22edc3 to 03a3f653d64e (1 revision) (flutter/flutter#164590) 2025-03-05 [email protected] when resetting FlutterPlatformViewsController, clear out some additional internal state to prevent it from carrying over across a Hot Restart (flutter/flutter#164456) 2025-03-05 [email protected] Roll Fuchsia Linux SDK from Rt6pxGFLVAJHduM0V... to fhm5z889sA5T1AQao... (flutter/flutter#164583) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

ash2moon requested review from reidbaker and gmackall February 27, 2025 00:28

github-actions bot added platform-android Android applications specifically tool Affects the "flutter" command-line tool. See also t: labels. labels Feb 27, 2025

add minSdk check to DependencyVersionChecker

3dfb411

ash2moon force-pushed the master2 branch from c32ef8b to 1a1e10a Compare February 27, 2025 00:47

ash2moon changed the title ~~Master2~~ Enforce minSdk constraint for Android Flutter Feb 27, 2025

add tests

06ca738

ash2moon force-pushed the master2 branch from 1a1e10a to 06ca738 Compare February 27, 2025 00:50

ash2moon enabled auto-merge February 27, 2025 00:51

ash2moon disabled auto-merge February 27, 2025 00:51

ash2moon added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 27, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 27, 2025

reidbaker requested changes Feb 27, 2025

View reviewed changes

fix lint

5a53e1c

gmackall mentioned this pull request Feb 27, 2025

Add SDK version validation to the dependency checker. #162713

Closed

9 tasks

gmackall reviewed Feb 27, 2025

View reviewed changes

ash2moon added 2 commits February 27, 2025 22:02

add support for error version for minSdk and flavor-specific versions

10494dd

Merge branch 'master' into master2

7ba0e16

reidbaker reviewed Feb 28, 2025

View reviewed changes

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt Outdated Show resolved Hide resolved

gmackall approved these changes Feb 28, 2025

View reviewed changes

ash2moon added 2 commits February 28, 2025 17:20

add support for error version for minSdk and flavor-specific versions

9c30941

Merge remote-tracking branch 'origin/master2'

882e423

ash2moon added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 3, 2025

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 3, 2025

reidbaker requested changes Mar 3, 2025

View reviewed changes

gmackall reviewed Mar 3, 2025

View reviewed changes

packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt Outdated Show resolved Hide resolved

remove default check since flavor checks already check for default fl…

925d580

…avor in min sdk checker

ash2moon force-pushed the master2 branch from f98be3e to a569f8e Compare March 4, 2025 01:34

remove default check since flavor checks already check for default fl…

1ad32d7

…avor in min sdk checker

reidbaker approved these changes Mar 4, 2025

View reviewed changes

- add support for minSdk versions on AGP < 8.1.0

3d27fe9

- refactored checkMinSdkVersion - added more test cases for min sdk check

ash2moon added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 5, 2025

auto-submit bot added this pull request to the merge queue Mar 5, 2025

Merged via the queue into flutter:master with commit b771b39 Mar 5, 2025
139 of 140 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 5, 2025

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Manual roll Flutter from 04d39343a691 to ccf99229c76a (37 revisions) flutter/packages#8795

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

bd630cc

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Roll Flutter from 04d39343a691 to 296c54f7a001 (42 revisions) flutter/packages#8797

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

c4db03b

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Roll Flutter from 04d39343a691 to 5ca20d8d0e78 (43 revisions) flutter/packages#8798

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

ce875bf

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Roll Flutter from 04d39343a691 to 86e4c12a068a (44 revisions) flutter/packages#8799

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

839adac

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Manual roll Flutter from 04d39343a691 to 57cddce92438 (45 revisions) flutter/packages#8800

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

33e6abb

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Roll Flutter from 04d39343a691 to 57cddce92438 (45 revisions) flutter/packages#8801

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

1b0ca6a

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 5, 2025

Roll Flutter from 04d39343a691 to 1e9676fc9527 (46 revisions) flutter/packages#8802

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

adad8be

…r#164251)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

6089d84

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 6, 2025

Roll Flutter from 2578d97f32c8 to 099e6d39fe38 (27 revisions) flutter/packages#8806

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

20c94b7

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 6, 2025

Roll Flutter from 2578d97f32c8 to d778ed25a485 (28 revisions) flutter/packages#8807

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

b771b39 Enforce minSdk constraint for Android Flutter (flutter/flutte…

51ca67b

…r#164251)

engine-flutter-autoroll mentioned this pull request Mar 6, 2025

Roll Flutter from 2578d97f32c8 to 321fbc0e7e81 (29 revisions) flutter/packages#8808

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enforce minSdk constraint for Android Flutter #164251

Enforce minSdk constraint for Android Flutter #164251

ash2moon commented Feb 27, 2025

auto-submit bot commented Feb 27, 2025

gmackall left a comment

gmackall left a comment

auto-submit bot commented Mar 3, 2025

reidbaker Mar 3, 2025

ash2moon Mar 4, 2025

reidbaker Mar 4, 2025

ash2moon Mar 5, 2025

gmackall Mar 5, 2025

reidbaker Mar 5, 2025

reidbaker left a comment

reidbaker Mar 4, 2025

ash2moon Mar 5, 2025

reidbaker Mar 4, 2025

ash2moon Mar 5, 2025 •

edited

Loading

reidbaker Mar 5, 2025

reidbaker Mar 4, 2025

ash2moon Mar 5, 2025

reidbaker Mar 4, 2025

ash2moon Mar 5, 2025

Enforce minSdk constraint for Android Flutter #164251

Enforce minSdk constraint for Android Flutter #164251

Conversation

ash2moon commented Feb 27, 2025

Pre-launch Checklist

auto-submit bot commented Feb 27, 2025

gmackall left a comment

Choose a reason for hiding this comment

gmackall left a comment

Choose a reason for hiding this comment

auto-submit bot commented Mar 3, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reidbaker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ash2moon Mar 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ash2moon Mar 5, 2025 •

edited

Loading