-
Notifications
You must be signed in to change notification settings - Fork 29.7k
[CP beta] Use LLDB as the default debugging method for iOS 17+ and Xcode 26+ (#173443) #173659
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CP beta] Use LLDB as the default debugging method for iOS 17+ and Xcode 26+ (#173443) #173659
Conversation
…lutter#173443) This PR introduces a new feature flag called `lldb-debugging`, which is turned on by default. When this feature is turned on, if deploying to a physical iOS 17+ device with Xcode 26+, it will use a mixture of `devicectl` and `lldb` to install, launch, and debug the app. If LLDB fails, it will fallback to use Xcode automation. If LLDB times out, it will warn the user they may want to disable it. If LLDB is disabled, it will use Xcode automation. This PR also adds analytics to track what deployment method is used and if it's successful. Part 2 and 3 of flutter#173416. Fixes flutter#144218. Fixes flutter#133465. ## 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
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request enables LLDB as the default debugging method for physical iOS devices on iOS 17+ with Xcode 26+. This is a significant change to address issues with repeated flutter run commands.
The changes include:
- A new feature flag
lldbDebugging, enabled by default. - Updated iOS device launching logic to use
devicectland LLDB, with a fallback to the existing Xcode automation method if LLDB fails or is not available. - Addition of analytics to track the usage and success rates of different iOS deployment methods.
- A new devicelab test to validate that the old Xcode debugging method still works when the new LLDB feature is disabled.
The implementation is well-structured and includes extensive test updates. My only suggestion is to make the new test fail explicitly if its setup step (disabling LLDB) fails, to ensure test reliability.
| if (configResult != 0) { | ||
| print('Failed to disable configuration, tasks may not run.'); | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If disabling LLDB debugging fails, the test will run with an incorrect configuration, which could lead to misleading results. It would be better to throw an exception here to fail the test explicitly if the setup cannot be completed successfully.
if (configResult != 0) {
throw Exception('Failed to disable LLDB debugging configuration; tasks may not run as expected.');
}
|
Gonna go ahead and land this. Basically re-stamping the CP to 3.35: #173472 :) |
7433873
into
flutter:flutter-3.36-candidate.0
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
Issue Link:
Part 2 of #144218
Changelog Description:
Explain this cherry pick in one line that is accessible to most Flutter developers. See best practices for examples
Use LLDB and devicectl for deploying to physical iOS devices when using Xcode 26. This will allow Xcode 26 to
flutter runtwice in a row.Impact Description:
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)? Does it impact development (ex. flutter doctor crashes when Android Studio is installed), or the shipping production app (the app crashes on launch)
Flutter developers running Xcode 26 can
flutter runto a tethered iOS device once. However subsequentflutter runattempts are likely to fail.Workaround:
Is there a workaround for this issue?
Quitting and reopening Xcode.
Risk:
What is the risk level of this cherry-pick?
Test Coverage:
Are you confident that your fix is well-tested by automated tests?
Validation Steps:
What are the steps to validate that this fix works?
Create a flutter project and run
flutter runtwice in a row with a physical iOS 17+ device and Xcode 26.