Fix handling of generate lock files #172124

rekire · 2025-07-14T18:27:33Z

While preparing a migration guide for supporting Dart and Kotlin files in one Android Studio instance I noticed that within #167332 a wrong exception was caught. This results in the exception mentioned in #172093 and this PR also fixes #172093. This is the "master" version of #172101

For the review the exception within gradle is thrown here:

private static void failOnDuplicateTask(String task) {
    throw new DuplicateTaskException(String.format("Cannot add task '%s' as a task with that name already exists.", task));
}

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.

flutter-dashboard · 2025-07-14T18:27:37Z

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

…error

rekire · 2025-07-18T20:14:54Z

I'm working on a test.

flutter-dashboard · 2025-07-18T20:16:11Z

This pull request has been changed to a draft. The currently pending flutter-gold status will not be able to resolve until a new commit is pushed or the change is marked ready for review again.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

…root too

In context of adding a test of [Fix handling of generate lock files](flutter/flutter#172124) I noticed that the migration guide had a bug. When you keep the "build" sub directory the android artifacts will land in `build/build/outputs` instead of `build/outputs` and will break the rest of the build pipeline. _Issues fixed by this PR:_ Part of [#172124](flutter/flutter#172124) verified via [test](https://github.com/flutter/flutter/pull/172124/files#diff-69f1017db6d0164855e2cc56f273edcca2cc4bff1d5b14b716b0259252568d52R49-R51) ## Presubmit checklist - [x] If this PR is not meant to land until a future stable release, mark it as draft with an explanation. - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style)—for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person pronouns). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer.

gmackall · 2025-07-23T16:23:10Z

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

@@ -332,7 +332,7 @@ class FlutterPlugin : Plugin<Project> {
    }

    private fun addTaskForLockfileGeneration(rootProject: Project) {
-        try {
+        if ((rootProject.tasks as? DefaultTaskContainer)?.findByName("generateLockfiles") == null) {


Is there a reason you are casting here? I believe you could do

rootProject.tasks.findByName("generateLockfiles")

You are right, that cast is useless will remove it now

is removed now

gmackall · 2025-07-23T16:37:52Z

packages/flutter_tools/lib/src/project.dart

  /// The Gradle root directory of the Android host app. This is the directory
  /// containing the `app/` subdirectory and the `settings.gradle` file that
  /// includes it in the overall Gradle project.
  Directory get hostAppGradleRoot {
+    if (hasGradleSettingsInProjectRoot) {


Can I ask why these changes to the gradle file getters are required? I would expect that the goal of the pr (the missed exception) would be fixed by just checking if the task exists before registering (i.e., what we are doing in FlutterPlugin.kt).

I'd like to avoid this configuration (that is specific to this specific IDE use case) creeping in scope across the flutter tool if possible, so I'm hesitant about these changes.

I already expected questions like that. I should have made notes about it. Anyway there are many checks for the build.gradle[.kts] or settings.gradle[.kts] since my original change aims to move those files there are lots of tests which break in those cases. Like the detection of the embedding since it starts looking in the wrong directory since it is currently relative to the settings.gradle[.kts].

This just becomes visible when you use the new file location in a test. This is also the reason why my draft PR, which moves the gradle files in the template, has lots of failing tests.

rekire · 2025-08-04T10:42:07Z

I tough all the time that the failing tests here were just flaky (the tree was quite often broken when I checked it)

Task :test
FlutterPluginTest > FlutterPlugin apply() adds expected tasks(Path) FAILED
java.lang.ClassCastException at FlutterPluginTest.kt:81
FlutterPluginTest > copyFlutterAssets task sets filePermissions correctly(Path) FAILED
java.lang.ClassCastException at FlutterPluginTest.kt:226

I see not really how I broke them. I just removed a not required cast in my change set. Can someone tell me what I do not see?

reidbaker · 2025-08-05T14:59:40Z

test/integration.shard/android_run_flutter_gradle_plugin_tests_test.dart appears to be file test failing and that does seem related.

FlutterPluginTest > FlutterPlugin apply() adds expected tasks(Path) FAILED
              java.lang.ClassCastException at FlutterPluginTest.kt:81
          
          FlutterPluginTest > copyFlutterAssets task sets filePermissions correctly(Path) FAILED
              java.lang.ClassCastException at FlutterPluginTest.kt:226

What do you get when you run FlutterPluginTest locally?

rekire · 2025-08-06T17:15:38Z

Converting back to draft since I have no time the next two weeks to get this resolved.

Fix handling of generate lock files

0cea9a6

rekire requested a review from a team as a code owner July 14, 2025 18:27

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

rekire mentioned this pull request Jul 14, 2025

Fix handling of generate lock files #172101

Closed

9 tasks

Add missing check if the task already exists instead of catching the …

a259dcb

…error

rekire force-pushed the fix-handling-of-generate-lockfiles-on-main branch from 8975a5d to a259dcb Compare July 18, 2025 06:47

rekire marked this pull request as draft July 18, 2025 20:14

rekire added 3 commits July 18, 2025 22:17

Detect gradle projects when the build.gradle[.kts] is in the project …

1e0162f

…root too

Reveal how the v1 embedding was detected

abf7547

Add test to ensure that the gradle plugin can handle two flutter modules

a529409

rekire changed the title ~~Fix handling of generate lock files (on master)~~ Fix handling of generate lock files Jul 19, 2025

rekire added 5 commits July 19, 2025 11:49

Merge branch 'master' into fix-handling-of-generate-lockfiles-on-main

3bdcd74

Undo debug change

a536f6a

Fix import

7f4bcbb

Reformat test

596fbc2

Reformat code

806f125

rekire marked this pull request as ready for review July 19, 2025 12:14

Add header

93ab134

rekire mentioned this pull request Jul 19, 2025

Fix path to build directory in migration guide flutter/website#12223

Merged

3 tasks

Merge branch 'master' into fix-handling-of-generate-lockfiles-on-main

2e51134

reidbaker requested a review from gmackall July 22, 2025 19:44

gmackall reviewed Jul 23, 2025

View reviewed changes

Simplify check

d283372

gmackall reviewed Jul 23, 2025

View reviewed changes

Merge branch 'master' into fix-handling-of-generate-lockfiles-on-main

513bb9a

Merge branch 'master' into fix-handling-of-generate-lockfiles-on-main

bf49ead

jesswrd requested a review from reidbaker July 29, 2025 20:49

Merge branch 'master' into fix-handling-of-generate-lockfiles-on-main

a3bf086

rekire marked this pull request as draft August 6, 2025 17:15

Merge branch 'master' into fix-handling-of-generate-lockfiles-on-main

4ab7611

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix handling of generate lock files #172124

Fix handling of generate lock files #172124

rekire commented Jul 14, 2025 •

edited

Loading

Uh oh!

flutter-dashboard bot commented Jul 14, 2025

Uh oh!

rekire commented Jul 18, 2025

Uh oh!

flutter-dashboard bot commented Jul 18, 2025

Uh oh!

gmackall Jul 23, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

rekire Jul 23, 2025

Uh oh!

rekire Jul 23, 2025

Uh oh!

gmackall Jul 23, 2025

Uh oh!

rekire Jul 23, 2025

Uh oh!

rekire commented Aug 4, 2025

Uh oh!

reidbaker commented Aug 5, 2025

Uh oh!

rekire commented Aug 6, 2025

Uh oh!

Uh oh!

Fix handling of generate lock files #172124

Are you sure you want to change the base?

Fix handling of generate lock files #172124

Conversation

rekire commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Jul 14, 2025

Uh oh!

rekire commented Jul 18, 2025

Uh oh!

flutter-dashboard bot commented Jul 18, 2025

Uh oh!

gmackall Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

rekire Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

rekire Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

gmackall Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

rekire Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

rekire commented Aug 4, 2025

Uh oh!

reidbaker commented Aug 5, 2025

Uh oh!

rekire commented Aug 6, 2025

Uh oh!

Uh oh!

rekire commented Jul 14, 2025 •

edited

Loading