[CP-stable][ Widget Preview ] Gracefully handle unexpected analysis context disposal #178646
Conversation
…osal (flutter#178550) It's possible that the preview detector is in the middle of processing sources after a source file was changed while the widget previewer is shutting down if we're not holding the mutex. This can result in the analysis context being disposed of when we don't expect it, causing requests to the analyzer to return errors. This change guards against this scenario by ensuring that all calls to `findPreviewFunctions` are guarded by the mutex. This change also removes assumptions related to the return type from analyzer APIs to account for the possibility that an error response was returned. Fixes flutter#178472
|
@bkonyi 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
the
tool
![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 several improvements to gracefully handle scenarios where the analysis context might be disposed, particularly during shutdown or unexpected events. The changes primarily focus on preventing runtime errors by adding checks for valid analysis results and ensuring critical sections are guarded by a mutex. Additionally, the PreviewDetectorMutex is now exposed for testing purposes, and new tests have been added to validate the robustness of the PreviewDetector when the analysis context is disposed. The changes enhance the stability and testability of the widget preview feature.
reidbaker
added
the
autosubmit
auto-submit
bot
merged commit 5c04145
into
flutter:flutter-3.38-candidate.0
…analysis context disposal (flutter/flutter#178646)
…analysis context disposal (flutter/flutter#178646)
…analysis context disposal (flutter/flutter#178646)
3 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?
#178472
Changelog Description:
Explain this cherry pick in one line that is accessible to most Flutter developers. See best practices for examples
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)
Unnecessary noise in our crash reporting. Shouldn't have a noticeable impact on development experience.
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?
flutter widget-preview startin a Flutter projectflutterprocess