[CP-stable][ Widget Preview ] Handle changes to unexpected pubspec.yaml files gracefully #179198
Conversation
…acefully (flutter#179157) This change fixes an issue where the preview command would crash if a `pubspec.yaml` was added / deleted somewhere under the previewed directory. It also improves testing for `PreviewManifest` in the context of pub workspaces and ensures that `FlutterProject` instances are refreshed based on the latest `pubspec.yaml` contents. Fixes flutter#179155 --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@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 improves the robustness of the widget preview feature by gracefully handling changes to pubspec.yaml files, particularly within workspace projects. The changes ensure that non-existent or deleted projects referenced in a workspace do not cause crashes. This is achieved by refining how pubspec.yaml hashes are calculated and updated in the preview manifest. The PR also includes significant test refactoring and adds new tests to cover these workspace-related edge cases, improving the overall quality and maintainability of the test suite.
eyebrowsoffire
added
the
autosubmit
auto-submit
bot
merged commit 79e60d7
into
flutter:flutter-3.38-candidate.0
…pubspec.yaml files gracefully (flutter/flutter#179198)
…pubspec.yaml files gracefully (flutter/flutter#179198)
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?
#179155
Changelog Description:
Explain this cherry pick in one line that is accessible to most Flutter developers. See best practices for examples
flutter widget-preview startcrashes if a file namedpubspec.yamlis modified outside the root of the previewed project.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)
The widget previewer can silently crash in the context of an IDE if a developer makes a change to a
pubspec.yamlthat's not the one for the previewed project (i.e., underexample/).Workaround:
Is there a workaround for this issue?
N/A
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 startpubspec.yamlin a newexample/folder and verify the tool doesn't crash