Repository navigation
iOS: Document and tidy the embedder API flag - #190828
Merged
Merged
Conversation
github-actions
Bot
added
platform-ios
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation comment for the iOS embedder API flag in FlutterDartProject.mm, replaces an NSLog statement with a FlutterLogger call in FlutterEngine.mm, and removes software rendering settings from tests in FlutterEngineTest.mm. A review comment identifies a double-space typo in the newly added comment.
| settings.resource_cache_max_bytes_threshold = screenWidth * screenHeight * 12 * 4; | ||
|
|
||
| // Whether to enable ios embedder api. | ||
| // Whether to run the iOS embedder on top of the embedder API rather than `Shell` directly. |
Contributor
There was a problem hiding this comment.
There is a double space typo between API and rather in this comment.
Member
Author
There was a problem hiding this comment.
Good bot but that doesn't mean I'm not annoyed. Done.
`FLTEnableIOSEmbedderAPI` is an existing (unused) switch for the iOS embedder API migration, but we didn't document its expected behaviour where we used it. This documents its semantics in `FlutterDartProject`: it's opt-in while the migration is in progress, a YES value currently only has the effect of populating `FlutterEngine`'s `FlutterEngineProcTable`. Once the embedder fully supports the embedder API and we've tested for a sufficient period, this will become opt-out and eventually be removed. This also replaces the `NSLog` banner we emitted when the flag is on with `FlutterLogger`, so the message goes through the same logging path as the rest of the embedder and respects the configured log level. Also drops two `settings.enable_software_rendering = true` assignments from `testCanEnableDisableEmbedderAPIThroughInfoPlist`. Those were the last references to that setting anywhere in the iOS embedder; nothing has read it on iOS since the software renderer fallback was removed in flutter#190590. Issue: flutter#112232
cbracken
force-pushed
the
embedder-api-flag
branch
from
August 10, 2026 07:10
73655cb to
2900a4d
Compare
hellohuanlin
approved these changes
Aug 10, 2026
| // | ||
| // See: https://github.com/flutter/flutter/issues/112232 | ||
| NSNumber* enable_embedder_api = | ||
| [mainBundle objectForInfoDictionaryKey:@"FLTEnableIOSEmbedderAPI"]; |
Contributor
There was a problem hiding this comment.
it's odd that this field is part of "FlutterDartProject.mm" - it shouldn't be related to dart at all. But since it's already there, feel free to leave it.
This was referenced Aug 11, 2026
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
2 participants
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.
FLTEnableIOSEmbedderAPIis an existing (unused) switch for the iOS embedder API migration, but we didn't document its expected behaviour where we used it.This documents its semantics in
FlutterDartProject: it's opt-in while the migration is in progress, a YES value currently only has the effect of populatingFlutterEngine'sFlutterEngineProcTable. Once the embedder fully supports the embedder API and we've tested for a sufficient period, this will become opt-out and eventually be removed.This also replaces the
NSLogbanner we emitted when the flag is on withFlutterLogger, so the message goes through the same logging path as the rest of the embedder and respects the configured log level.Also drops two
settings.enable_software_rendering = trueassignments fromtestCanEnableDisableEmbedderAPIThroughInfoPlist. Those were the last references to that setting anywhere in the iOS embedder; nothing has read it on iOS since the software renderer fallback was removed in #190590.Issue: #112232
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance.
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.