Resolve resolve native Flutter dependencies in Android Studio #167332

rekire · 2025-04-17T07:54:23Z

With this fix you can edit Flutter and native code in one Android Studio instance. This fixes #19830

The only downside is that you need to copy the files settings.gradle, build.gradle and local.properteis from the android folder to the project root folder. The last one should be added to the .gitignore file.

The second step is that you need to correct the path in the settings.gradle at the end is:

include ':app'

That needs to be replaced with:

include ':app'
project(':app').projectDir = new File(rootDir, 'android/app/')

The cool thing is if you have two flutter projects or another gradle module you can include them there too and you get the autocompletion too.

include ':app', ':app2', ':native-lib'
project(':app').projectDir = new File(rootDir, 'android/app/')
project(':app2').projectDir = new File(rootDir, 'app2/android/app/')
project(':native-lib').projectDir = new File(rootDir, 'example/native-lib/')

My assumption is that there will be some change requests and some questions. Feel free to ask

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.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…modules

flutter-dashboard · 2025-04-17T07:54:26Z

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.

reidbaker · 2025-04-25T15:52:36Z

It looks like this change caused test failures.

execution failed for task ':app:preReleaseBuild'.
            > The following Android dependencies are set to compileOnly which is not supported:
              -> io.flutter:arm64_v8a_debug:1.0.0-eee1cffceea3b53287c8097679a9c868c4831330
              -> io.flutter:armeabi_v7a_debug:1.0.0-eee1cffceea3b53287c8097679a9c868c4831330
              -> io.flutter:flutter_embedding_debug:1.0.0-eee1cffceea3b53287c8097679a9c868c4831330
              -> io.flutter:x86_64_debug:1.0.0-eee1cffceea3b53287c8097679a9c868c4831330
              -> io.flutter:x86_debug:1.0.0-eee1cffceea3b53287c8097679a9c868c4831330

rekire · 2025-04-28T08:31:40Z

I am not sure, how I can fix the test yet.

reidbaker

Tests need to pass.
Blocking this so I can review it when it is ready.

flutter-dashboard · 2025-04-28T14:34:45Z

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.

rekire · 2025-05-03T12:32:38Z

@reidbaker I am not sure why some tests are red it changes on each master merge. Are the tests currently flaky or is it somehow my fault?

rekire · 2025-05-04T19:56:29Z

JFYI: I'm also working on migrating the default template to put the files at the right place. This also includes some fixes. I am not sure if I should make multiple PRs for that since I guess that will fix most likely two other bugs: rekire#1

Like that the .cxx is not on the ignore list or that you get the nasty "Missing ExternalProject for :" error.

That diff will also give you an idea what is required to make use of my change.

reidbaker · 2025-05-05T13:59:16Z

The tests I saw when I made #167332 (comment) looked like it was caused by your change. That said if a test fails then passes and your code unrelated then consider it flakey.

rekire · 2025-05-05T14:37:43Z

I merge the master one time more. That test you mentioned failed because of my change. I fixed my code so that test is green. Let's wait for the CI if I get all tests passed. (Actually I would prefer just to rerun the failed test to verify my flakiness assumption, but I don't have the permission)

What do you think should I change the project creation template within this PR?

What is the right way to make sure that the result of the current template won't break, when my changes become the default? My aimed "big" change is that the settings.gradle.kts and the local.properties file should move from the android to the project root directory.

reidbaker · 2025-05-05T14:48:52Z

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

                    }
                }
            }
+        } catch (e: TaskInstantiationException) {
+            // ignored


Why is this safe to ignore? We use lockfiles in our own ci and having the generation fail without creating lockfiles would break our process.

That just happens when the task is registered twice which, can just happen when you have two flutter modules in your project (like a plugin). I tried to check if that task is already registered, but that caused some strange class cast exceptions in gradle, so I choose (without knowing a better solution) to ignore that special exception.

OK that seems safe to ignore. If I have time I can see if we can check if we ahve already applied the plugin which would catch the issue before the exception but you dont need to do that.

reidbaker · 2025-05-05T14:50:54Z

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

@@ -97,6 +98,13 @@ class FlutterPlugin : Plugin<Project> {
            repositories.maven {
                url = uri(repository!!)
            }
+            if (plugins.hasPlugin("com.android.application") && hasProperty("android.injected.invoked.from.ide")) {


Where did you find "android.injected.invoked.from.ide"? I would like to read the source/documentation.

In general we dont do ide specific code in our plugin but from the string I cant tell if this is part of the api or something that is android studio specific.

I found it on StackOverflow: https://stackoverflow.com/q/18824890 I just want to inject the dependencies for Android Studio in normal builds like the CLI or CI those dependencies are not relevant.

@jwren Is there something equivalent for visual studio or something ide neutral you want this pr to include?
For now it is ok to leave this because I want @gmackall's opinion but I think we may ask that the check for android studio be removed to align with our philosophy of of shipping tools that are portable.

It also helps protect against bugs that only happen for users when they run from android studio. This is extra important because we do not have integration tests that require launch android studio and verifying the tooling works.

Source appears to be here https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:build-system/builder-model/src/main/java/com/android/builder/model/InjectedProperties.kt?q=%20PROPERTY_INVOKED_FROM_IDE

If this change has been tested and seems to work then I am okay with it. Any other IDE neutral changes can be added as a follow on.

@rekire -- Thanks for this change. Did you check that this doesn't have any negative effects for Ultimate or Community?

Not yet, I can try it tomorrow on the CE, but I've no license for the ultimate edition.

CE is sufficient

I tested it with my new template and it worked as expected. I just had to click once on import gradle project or something similar which popped up on the right. I guess that is the default behavior. Visual Studio code seems not to break ether, however there I had no Kotlin support (most likely because I never installed those plugins)

flutter-dashboard · 2025-05-05T15:19:46Z

Golden file changes have been found for this pull request. Click here to view and triage (e.g. because this is an intentional change).

If you are still iterating on this change and are not ready to resolve the images on the Flutter Gold dashboard, consider marking this PR as a draft pull request above. You will still be able to view image results on the dashboard, commenting will be silenced, and the check will not try to resolve itself until marked ready for review.

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.

Changes reported for pull request #167332 at sha 645a016

reidbaker · 2025-05-05T15:27:37Z

Golden file changes have been found for this pull request. Click here to view and triage (e.g. because this is an intentional change).

If you are still iterating on this change and are not ready to resolve the images on the Flutter Gold dashboard, consider marking this PR as a draft pull request above. You will still be able to view image results on the dashboard, commenting will be silenced, and the check will not try to resolve itself until marked ready for review.

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.

Changes reported for pull request #167332 at sha 645a016

These changes appear to be failures to render anything. Not sure how this pr caused them (or if it did)

rekire · 2025-05-05T15:30:51Z

Okay, I was already shocked how I broke that test :-D

reidbaker · 2025-05-05T15:59:42Z

Ignoring the golden part of the test and just verifying if the app can run with your changes

from dev/integration_tests/android_engine_test run flutter run lib/external_texture/surface_producer_smiley_face_main.dart

I see

../../../packages/flutter/lib/src/semantics/semantics.dart:117:80: Error: The type 'SemanticsRole' is not exhaustively matched by the switch cases since it doesn't match 'SemanticsRole.searchBox'.
 - 'SemanticsRole' is from 'dart:ui'.
Try adding a wildcard pattern or cases that match 'SemanticsRole.searchBox'.
  static FlutterError? _checkSemanticsData(SemanticsNode node) => switch (node.role) {

I think this is a real failure that is unrelated to your pr.

rekire · 2025-05-07T16:57:13Z

I want to change the default template (from flutter create) to have the advantages also in fresh new projects. I am right now not sure if this should be part of the PR or if you prefer this as a second PR. My draft as diff to this PR is here: rekire#1, should I merge it into this PR? (of cause I need to make the tests pass before, this can be merged)

reidbaker · 2025-05-19T18:04:48Z

@gmackall to review today.

gmackall · 2025-05-19T19:33:21Z

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

@@ -97,6 +98,13 @@ class FlutterPlugin : Plugin<Project> {
            repositories.maven {
                url = uri(repository!!)
            }
+            if (plugins.hasPlugin("com.android.application") && hasProperty("android.injected.invoked.from.ide")) {


Can you move this configuration to its own method (configureForTopLevelAndroidStudioSupport, or something similar), with docs explaining clearly the case that this configuration is done for?

The configuration is currently small anyways, but I want to make sure that if we add more in the future it doesn't end up leaking out across the FGP in a way that makes it hard to tell what is AS configuration only, and what is core logic of the FGP.

@gmackall Where should I move it exactly? Just to the same level as the methods addFlutterDependencies() and addTaskForLockfileGeneration() with a couple of lines which explains the propose of adding those dependencies?

Yes, just into its own class-level method, with a descriptive kdoc (and then you can leave the call site the same here. I just want the configuration encapsulated)

gmackall

LGTM outside of the request to move to its own method.

I think we should hold off on adding the additional necessary build.gradle files to the templates until the feature gets some use - template changes are risky, so I'd like to only make that change that we have high confidence it is safe.

rekire added 2 commits April 17, 2025 09:39

Add compileOnly dependencies to resolve the flutter engine imports

1883cf1

Check if generateLockfiles exists for projects with multiple flutter …

3874f13

…modules

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

camsim99 requested review from reidbaker and gmackall and removed request for reidbaker April 22, 2025 18:14

reidbaker requested changes Apr 28, 2025

View reviewed changes

rekire marked this pull request as draft April 28, 2025 14:34

rekire added 6 commits April 29, 2025 21:46

Only add compileOnly dependencies when Android Studio is detected

84090fc

Merge branch 'master' into resolve-resolve-flutter-dependencies

73a5826

Merge branch 'master' into resolve-resolve-flutter-dependencies

65be9f2

Merge branch 'master' into resolve-resolve-flutter-dependencies

6dd2df4

Catch the exception when the task is already registered

b8b4590

Merge branch 'master' into resolve-resolve-flutter-dependencies

0208307

rekire marked this pull request as ready for review May 3, 2025 12:29

Merge branch 'master' into resolve-resolve-flutter-dependencies

645a016

reidbaker reviewed May 5, 2025

View reviewed changes

reidbaker requested changes May 5, 2025

View reviewed changes

flutter-dashboard bot added the will affect goldens Changes to golden files label May 5, 2025

rekire mentioned this pull request May 7, 2025

Draft: Extend template to resolve dart and kotlin #168490

Draft

9 tasks

gmackall reviewed May 19, 2025

View reviewed changes

gmackall approved these changes May 19, 2025

View reviewed changes

Resolve resolve native Flutter dependencies in Android Studio #167332

Are you sure you want to change the base?

Resolve resolve native Flutter dependencies in Android Studio #167332

Conversation

rekire commented Apr 17, 2025

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Apr 17, 2025

Uh oh!

reidbaker commented Apr 25, 2025

Uh oh!

rekire commented Apr 28, 2025

Uh oh!

reidbaker left a comment

Choose a reason for hiding this comment

Uh oh!

flutter-dashboard bot commented Apr 28, 2025

Uh oh!

rekire commented May 3, 2025

Uh oh!

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

Uh oh!

Uh oh!

reidbaker commented May 5, 2025

Uh oh!

rekire commented May 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flutter-dashboard bot commented May 5, 2025

Uh oh!

reidbaker commented May 5, 2025

Uh oh!

rekire commented May 5, 2025

Uh oh!

reidbaker commented May 5, 2025

Uh oh!

rekire commented May 7, 2025

Uh oh!

reidbaker commented May 19, 2025

Uh oh!

gmackall May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmackall May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmackall left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

rekire commented May 4, 2025 •

edited

Loading

gmackall May 19, 2025 •

edited

Loading

gmackall May 19, 2025 •

edited

Loading