-
Notifications
You must be signed in to change notification settings - Fork 29.7k
[CP-beta]Add structured warning event for slow wireless debugging on iOS 26+ d… #176976
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]Add structured warning event for slow wireless debugging on iOS 26+ d… #176976
Conversation
…r#175254) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? flutter#173474 ### Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples `PlatformDispatchers.instance.engineId` returns `null` after hot restart ### 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) It affects anyone who uses engineId while in development (since it happens after hot-restart). ### Workaround: Is there a workaround for this issue? Not doing any hot-restarting while development which is not ideal. ### 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? Running this app and hot restarting no longer prints null: ```dart class MyApp extends StatefulWidget { const MyApp({super.key}); @OverRide _MyAppState createState() => _MyAppState(); } class _MyAppState extends State<MyApp> { @OverRide void initState() { super.initState(); print('engineId: ${PlatformDispatcher.instance.engineId}'); } // ... } ```
…5299) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? flutter#174513 ### Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples Fix a bug where platform view's gesture blocking fails to work on iOS 26 ### 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) All platform views (e.g. web view, map, etc) on iOS 26 ### Workaround: Is there a workaround for this issue? No ### 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? As explained in the linked issue above, interact with the flutter UI on top of the platform view. Notice that the platform view still receives the touches, despite that the platform view is under flutter UI and it shouldn't receive the touches. This only happens on iOS 26.
…#175391) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? flutter#173106 ### Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples [flutter/173106](flutter#173106) - Fixes an issue where multiple cursors were shown incorrectly ### 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) App is usable but shows multiple cursors incorrectly ### Workaround: Is there a workaround for this issue? No. ### 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 list with many text fields. Tap on one text field to focus it. Swipe on another text field. Only at most one cursor should be visible at a time.
flutter#176673) This PR improves the developer experience when running or debugging Flutter apps on iOS 26+ devices connected via WiFi. The tool now emits a structured `app.warning` event (in addition to a console warning) when it detects wireless debugging on iOS 26 or later. This allows IDEs and other tools using `--machine` mode to display a prominent warning to users, encouraging them to use a wired (USB) connection for better performance. ## Details - Detects when an iOS device is: - Running iOS 26 or later, - Connected wirelessly, - Debugging is enabled. - Emits a human-readable warning to the console. - Emits a structured `app.warning` event with relevant metadata (category, deviceId, iosVersion, suggestion, etc.) for IDEs and tools using `--machine` mode. - No changes to existing workflows for users not matching these conditions. *List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.* Fixes flutter#176206 *If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].* ## 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. - [] 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. - [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
|
@jmagman please fill out the PR description above, afterwards the release team will review this request. |
|
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 adds a helpful structured warning for developers when debugging on iOS 26+ over a wireless connection, which can be slow. The implementation is clear and includes relevant tests. My review includes a suggestion to align the data type of a field in the new app.warning event with its documentation and a minor code organization improvement.
| @visibleForTesting | ||
| void warnIfSlowWirelessDebugging(DebuggingOptions debuggingOptions) { | ||
| // The minimum iOS version where wireless debugging is known to be slow. | ||
| const minSlowWirelessDebugIOSVersion = 26; |
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.
| 'warning': warningMessage, | ||
| 'category': 'ios-wireless-performance', | ||
| 'deviceId': id, | ||
| 'deviceOsVersion': sdkVersion.major, |
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 deviceOsVersion field is being sent as an integer, but the documentation for the app.warning event in packages/flutter_tools/doc/daemon.md specifies this field should be a string. To maintain consistency with the API contract, please convert this value to a string.
'deviceOsVersion': sdkVersion.major.toString(),| 'warning': warningMessage, | ||
| 'category': 'ios-wireless-performance', | ||
| 'deviceId': '123', | ||
| 'deviceOsVersion': 26, |
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.
|
#176997 is a related cherry-pick required to forward this event to DAP clients like VS Code. |
|
An existing Git SHA, To re-trigger presubmits after closing or re-opeing a PR, or pushing a HEAD commit (i.e. with |
…f9b32fe43d59d4e46ece8278
2522834
into
flutter:flutter-3.38-candidate.0
…ient (#176997) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? #176206 / Dart-Code/Dart-Code#5730 This is related to another cherry-pick at #176976. That cherry-pick adds a warning to `flutter run` and this cherry-pick ensures the warning is forwarded correctly to DAP clients (like VS Code). ### Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples Warns the developer that wireless debugging may be slow on iOS 26 in VS Code. ### 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) Debugging wirelessly on iOS 26 may be slow. This change forwards the warning (which is being cherry-picked by #176976) to DAP clients so that it can be shown more prominently in VS Code. ### Workaround: Is there a workaround for this issue? This change is to show a workaround for the slow debugging to the user. ### 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? Testing requires using a DAP client. The automated test verifies the event is forwarded, and I tested manually with the Dart-Code changes when I added this change (screenshots at Dart-Code/Dart-Code#5730 (comment)).
…ugging on iOS 26+ d… (flutter/flutter#176976)
This pull request is created by automatic cherry pick workflow
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
Issue Link:
#176206
Changelog Description:
Explain this cherry pick in one line that is accessible to most Flutter developers. See best practices for examples
Warns the developer that wireless debugging may be slow on iOS 26
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)
Debugging wirelessly on iOS 26 may be slow. This warning suggests that the developer use a wired connection.
Additionally, this will be surfaced in IDEs: Dart-Code/Dart-Code#5730
Workaround:
Is there a workaround for this issue?
The tool is proposing the workaround.
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?
Connect an iPhone running iOS 26 wirelessly,
flutter run.