[Android] Add integration test for setting engine flags via the manifest#182241
Draft
camsim99 wants to merge 8 commits intoflutter:masterfrom
Draft
[Android] Add integration test for setting engine flags via the manifest#182241camsim99 wants to merge 8 commits intoflutter:masterfrom
camsim99 wants to merge 8 commits intoflutter:masterfrom
Conversation
9 tasks
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces integration tests for setting Android engine flags via the AndroidManifest.xml. It adds new devicelab tests for debug and release modes, along with a shared utility function to modify the manifest file. The changes also include refactoring an existing performance test to use this new utility. The overall approach is sound, but there are a few issues in the implementation, including a logic error in one of the new tests, a potential bug in the manifest modification utility, and a leftover debug print statement.
13 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 18, 2026
…Android manifest (take 2)" (#182522) ### Overview Re-lands #181632 which TLDR does the following: **Same old same old changes from original PR** - Refactors all engine flags recognized by the Flutter Android embedding (specifically those previously recognized by [`FlutterShellArgs`](https://github.com/flutter/flutter/blob/4f5478cce38d837e14b7a032a12500d3fc0f1310/engine/src/flutter/shell/platform/android/io/flutter/embedding/engine/FlutterShellArgs.java) and all of those used to initialize the engine in `FlutterLoader`) into a new class `FlutterEngineFlags` (`FlutterShellArgs` is kept for now to maintain backwards compatibility; see #182153 for details) - Adds the ability to set engine flags (that are recognized by `FlutterEngineFlags`) via the manifest - Adds warnings for developers that set engine flags via `Intent`s as this will be disabled as part of #180686. - Disallows debug/test only flags in release mode **New changes/fixes** > [!NOTE] > This re-land was required because when previously submitted, it caused b/483299339. I have confirmed that this bug has been fixed in this PR; see go/flutter-android-setting-flags-in-manifest-perf-comparison for A/B test results with the previous version of this PR (#181632) and commit d6d4a07 of this PR. - [Critical change] To fix the bug caught by b/483299339, `--merged-platform-ui-thread` flag is added to `FlutterEngineFlag`s - [Behavior change, not critical] To avoid more bugs like b/483299339, `FlutterLoader` allows unrecognized flags specified by the command line or `Intent` extras to be used to initialize the engine for now (same behavior as before my original change but I plan to secure this in the future; see #182557) - [Small refactor] To speed up manifest argument processing time, `FlutterLoader` loops through all recognized `FlutterEngineFlag`s to check if they are present in an application's manifest versus looping through all metadata in an application's manifest and looking for recognized `FlutterEngineFlag`s (small improvement for apps with large manifests) - [Small refactor] To speed up command line argument processing time, `FlutterLoader` processes the `--aot-shared-library-name` flag in the same loop as the other flags, reducing the number of loops `ensureInitializationComplete` has to do (minimal improvement perf-wise but kept it in because it's more readable to me) ### Full description (Mostly copied from #181632) > [!NOTE] > This PR is based on conversation & feedback on go/flutter-android-harden-engine-shell-arguments. Adds a mechanism for setting Android engine flags via the manifest. If a flag is specified on the command line and in manifest metadata, the value specified on the command line will take precedence. Documentation is added on this mechanism Additionally, this PR removes the exposure of`--cache-sksl` command line flag as per [https://github.com/flutter/flutter/issues/140310#issuecomment-2708459007](https://www.google.com/url?q=https://github.com/flutter/flutter/issues/140310%23issuecomment-2708459007&sa=D&source=docs&ust=1761156167162464&usg=AOvVaw3a8ubXTtv3apknY2-P9dKe). Additionally, this PR adds documentation for the only two supported ways of setting engine flags moving forward -- via the command line or manifest. The `Intent` mechanism will be removed when #180686 is completed (intended to be a follow up to this PR). As the unit tests in this PR only cover setting flags via manifest in debug mode, I will follow up this PR with an integration test to test that flags are appropriately respected/ignored in release mode. See #178383 for my currently working but WIP draft. Part of #172553. # Follow up work: - [ ] **Migrate flags all un-migrated flags `FlutterEngineFlags`** #182852 - [ ] **Add integration test for this new added mechanism.** This will land as an immediate follow-up to this PR. WIP in #182241. - [ ] **Remove support for setting shell arguments via `Intent`.** This task will be a follow up to this work + the integration test landing, and will complete work for #172553. See #180686 for details. - [ ] **Only allow known engine flags to be passed to the engine.** This is more of a P2 but would be a nice additional security feature; see #182557. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [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 documentation (doc comments with `///`). - [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. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [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 [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 --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds integration test for setting engine flags via the manifest for Flutter Android apps. Continuation of #178383.
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.