-
Notifications
You must be signed in to change notification settings - Fork 29.5k
Stream logs from devicectl and lldb
#173724
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
Stream logs from devicectl and lldb
#173724
Conversation
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 introduces a new logging mechanism for iOS devices on Xcode 26+ by streaming logs directly from devicectl and lldb, replacing the older idevicesyslog method. The changes are well-structured, introducing log forwarder classes and updating the device launching logic accordingly. My review includes a few suggestions to fix a typo in an enum value and to add missing documentation for new public classes and members to align with the Flutter style guide.
| class IOSCoreDeviceInstallResult { | ||
| IOSCoreDeviceInstallResult._({ | ||
| required this.outcome, | ||
| required this.bundleID, | ||
| required this.databaseUUID, | ||
| required this.installationURL, | ||
| required this.launchServicesIdentifier, | ||
| }); | ||
|
|
||
| /// Parse JSON from `devicectl device install app --device <uuid|ecid|udid|name> <path> --json-output`. | ||
| /// | ||
| /// Example: | ||
| /// { | ||
| /// "info" : { | ||
| /// ... | ||
| /// "outcome" : "success", | ||
| /// ... | ||
| /// }, | ||
| /// "result" : { | ||
| /// ... | ||
| /// "installedApplications" : [ | ||
| /// { | ||
| /// "bundleID" : "com.example.app", | ||
| /// "databaseSequenceNumber" : 1324, | ||
| /// "databaseUUID" : "DF123456-1234-4C46-B3F2-EF7D18596C3D", | ||
| /// "installationURL" : "file:////private/var/containers/Bundle/Application/D12EFD3B-4567-890E-B1F2-23456DAA789A/Runner.app/", | ||
| /// "launchServicesIdentifier" : "unknown", | ||
| /// "options" : { | ||
| /// } | ||
| /// } | ||
| /// ] | ||
| /// } | ||
| /// } | ||
| factory IOSCoreDeviceInstallResult.fromJson(Map<String, Object?> data) { | ||
| String? outcome; | ||
| final Object? info = data['info']; | ||
| if (info is Map<String, Object?>) { | ||
| outcome = info['outcome'] as String?; | ||
| } | ||
|
|
||
| final Map<String, Object?>? installedApp = switch (data['result']) { | ||
| {'installedApplications': [final Map<String, Object?> app, ...]} => app, | ||
| _ => null, | ||
| }; | ||
|
|
||
| return IOSCoreDeviceInstallResult._( | ||
| outcome: outcome, | ||
| bundleID: installedApp?['bundleID'] as String?, | ||
| databaseUUID: installedApp?['databaseUUID'] as String?, | ||
| installationURL: installedApp?['installationURL'] as String?, | ||
| launchServicesIdentifier: installedApp?['launchServicesIdentifier'] as String?, | ||
| ); | ||
| } | ||
|
|
||
| final String? outcome; | ||
| final String? bundleID; | ||
| final String? databaseUUID; | ||
| final String? installationURL; | ||
| final String? launchServicesIdentifier; | ||
| } |
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.
According to the Flutter Style Guide, all public members should have documentation.1
The IOSCoreDeviceInstallResult class and its public fields are missing doc comments. Please add them to explain what each field represents.
Style Guide References
Footnotes
| /// The `devicectl` process that launched the app and is streaming the logs. | ||
| Process? launchProcess; | ||
|
|
||
| final _streamController = StreamController<String>.broadcast(); |
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.
Just verifying, but is there any chance that logLines.listen(...) would be invoked after addLog(...) is called? I just want to make sure we're not going to accidentally drop important logs before a listener is registered.
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.
The listener is set up before the process that streams the logs is started
flutter/packages/flutter_tools/lib/src/ios/devices.dart
Lines 1006 to 1015 in 358a5a7
| if (deviceLogReader is IOSDeviceLogReader) { | |
| await deviceLogReader.listenToCoreDeviceLauncher(_coreDeviceLauncher); | |
| } | |
| final bool launchSuccess = await _coreDeviceLauncher.launchAppWithLLDBDebugger( | |
| deviceId: id, | |
| bundlePath: package.deviceBundlePath, | |
| bundleId: package.id, | |
| launchArguments: launchArguments, | |
| ); |
I also tweaked a test to validate this, though
flutter/flutter@a4cb00a...c65f01d 2025-08-26 engine-flutter-autoroll@skia.org Roll Packages from fe66130 to 1ef712e (4 revisions) (flutter/flutter#174442) 2025-08-26 15619084+vashworth@users.noreply.github.com Revert "Directly generate a Mach-O dynamic library using gen_snapshot (#171626) (flutter/flutter#174392) 2025-08-26 49699333+dependabot[bot]@users.noreply.github.com Bump codecov/codecov-action from 5.4.0 to 5.5.0 in the all-github-actions group (flutter/flutter#174436) 2025-08-26 engine-flutter-autoroll@skia.org Roll Skia from 9daab16abbf9 to 21214d63fc40 (1 revision) (flutter/flutter#174431) 2025-08-26 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from UiY8gj468PZUj6QTm... to L5zGzsIWIS8N36AFQ... (flutter/flutter#174430) 2025-08-26 engine-flutter-autoroll@skia.org Roll Dart SDK from f1f90d413dd3 to 9054cd8af73c (2 revisions) (flutter/flutter#174428) 2025-08-26 engine-flutter-autoroll@skia.org Roll Skia from afb5c22d9ba0 to 9daab16abbf9 (2 revisions) (flutter/flutter#174429) 2025-08-26 engine-flutter-autoroll@skia.org Roll Skia from 2227187dbdcf to afb5c22d9ba0 (1 revision) (flutter/flutter#174425) 2025-08-26 87506348+jingshao-code@users.noreply.github.com [iOS][Secure Paste] Custom edit menu actions (flutter/flutter#171825) 2025-08-26 huy@nevercode.io Make SystemUiOverlayStyle to be diagnosticable (flutter/flutter#174018) 2025-08-26 34465683+rkishan516@users.noreply.github.com Fix: Active step fully colored in vertical mode (flutter/flutter#173152) 2025-08-26 32538273+ValentinVignal@users.noreply.github.com Migrate to use `WidgetStateProperty` (flutter/flutter#174323) 2025-08-26 engine-flutter-autoroll@skia.org Roll Skia from ed42a94ee066 to 2227187dbdcf (3 revisions) (flutter/flutter#174417) 2025-08-26 engine-flutter-autoroll@skia.org Roll Dart SDK from a0e39d9b4a58 to f1f90d413dd3 (1 revision) (flutter/flutter#174409) 2025-08-26 jason-simmons@users.noreply.github.com [Impeller] Flush the data written to the device buffer by RoundSuperellipseGeometry (flutter/flutter#174316) 2025-08-26 flar@google.com Remove obsolete vulkan_window source files (flutter/flutter#174087) 2025-08-25 1961493+harryterkelsen@users.noreply.github.com [web] Migrate non-CanvasKit-specific tests to ui/ (flutter/flutter#174396) 2025-08-25 jessy.yameogo@gmail.com Create Hot Restart over websocket test (flutter/flutter#173852) 2025-08-25 engine-flutter-autoroll@skia.org Roll Dart SDK from e283a9e88242 to a0e39d9b4a58 (1 revision) (flutter/flutter#174383) 2025-08-25 matanlurey@users.noreply.github.com Update `master` CHANGELOG for 3.35.2 (flutter/flutter#174399) 2025-08-25 engine-flutter-autoroll@skia.org Roll Skia from da724d312e65 to ed42a94ee066 (4 revisions) (flutter/flutter#174394) 2025-08-25 58529443+srujzs@users.noreply.github.com Update dwds to 25.0.3 (flutter/flutter#174379) 2025-08-25 38427679+xVemu@users.noreply.github.com Fix logic statements in year2023 documentation (flutter/flutter#174120) 2025-08-25 jason-simmons@users.noreply.github.com Release thread-local resources when submitting a Flutter GPU command buffer (flutter/flutter#173663) 2025-08-25 1961493+harryterkelsen@users.noreply.github.com [web] Refactor LayerScene out of CanvasKit (flutter/flutter#174375) 2025-08-25 15619084+vashworth@users.noreply.github.com Stream logs from `devicectl` and `lldb` (flutter/flutter#173724) 2025-08-25 jmccandless@google.com NavigatorPopScope examples no longer use deprecated onPop. (flutter/flutter#174291) 2025-08-25 mohellebiabdessalem@gmail.com fix typo in test documentation function name (flutter/flutter#174297) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
When debugging with `devicectl` and `lldb` (exclusive to Xcode 26+), stream logs from both processes instead of using `idevicesyslog`, which does not work with Xcode 26. Fixes flutter#173365. ## 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
When debugging with `devicectl` and `lldb` (exclusive to Xcode 26+), stream logs from both processes instead of using `idevicesyslog`, which does not work with Xcode 26. Fixes flutter#173365. ## 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
When debugging with `devicectl` and `lldb` (exclusive to Xcode 26+), stream logs from both processes instead of using `idevicesyslog`, which does not work with Xcode 26. Fixes flutter#173365. ## 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
When debugging with
devicectlandlldb(exclusive to Xcode 26+), stream logs from both processes instead of usingidevicesyslog, which does not work with Xcode 26.Fixes #173365.
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.