[CP-stable]Check for devicectl launch logs from std and file #178675
Conversation
For some reason in different editors, `devicectl` does not appear to stream its logs to `stdout`. Usually after calling `xcrun devicectl device process launch --console ...`, the `stdout` stream will receive a log of `'Waiting for the application to terminate'`. To workaround this, we use the `--log-ouput` flag with the `devicectl` command, which tells `devicectl` to write its logs to a file. We then periodically read the file looking for the `'Waiting for the application to terminate'` log. Fixes b/454953393. ## 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
|
@vashworth 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. |
github-actions
bot
added
platform-ios
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a workaround for an issue where devicectl launch logs may not be streamed to stdout. It adds a polling mechanism that checks a log file for a specific message to determine if the app launch is complete. The changes also include renaming outputFile to jsonOutputFile for clarity and adding a new logOutputFile parameter. Tests are updated to cover the new logic. My review identified a resource leak where a temporary directory is created but not deleted. I have provided a suggestion to fix this.
| } finally { | ||
| timer?.cancel(); | ||
| } |
There was a problem hiding this comment.
The temporary directory created for the log file is not being cleaned up. This will lead to files being left on the user's system. You should delete it in this finally block to ensure it's cleaned up even if errors occur.
} finally {
timer?.cancel();
ErrorHandlingFileSystem.deleteIfExists(tempDirectory, recursive: true);
}
…8f77a10e6a790905d045f62ddf
reidbaker
added
the
autosubmit
auto-submit
bot
merged commit a7cb63e
into
flutter:flutter-3.38-candidate.0
|
@vashworth "A good approach for hotfix messages is to describe the problem in terms of the current state prior to the fix." If it is ok with you I will use the impact description instead of the changelog as written in the pr for the changelog entry.
|
4 participants
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:
What is the link to the issue this cherry-pick is addressing?
#178421
Changelog Description:
Explain this cherry pick in one line that is accessible to most Flutter developers. See best practices for examples
Fixes an issue where debugging from an IDE hangs when using a physical iOS 26 device.
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)
When debugging from an IDE with a physical iOS 26 device, it installs and app but hangs on a white screen during launching.
Workaround:
Is there a workaround for this issue?
Use a simulator or use release mode
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 an app
Use an IDE (like VS Code) to debug the app on an iOS 26 physical device