Report an error if the git ls-tree command fails in the content_aware_hash script#185170
Conversation
…_hash script Without this, the script will output an incorrect hash and return a successful exit code if "git ls-tree" fails. See flutter#184376
|
It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging. If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group. |
There was a problem hiding this comment.
Code Review
This pull request modifies bin/internal/content_aware_hash.sh to capture the output of the git pipeline into a variable and implement error checking. A review comment suggests improving the robustness of the error handling by using 'set -o pipefail' to catch failures in the second part of the pipeline and quoting the hash variable to prevent word splitting.
| GIT_OPTS=(-c core.multiPackIndex=false) | ||
| fi | ||
| git "${GIT_OPTS[@]}" -C "$FLUTTER_ROOT" ls-tree "$BASEREF" -- "${TRACKEDFILES[@]}" | git hash-object --stdin | ||
| if ! HASH=$(set -o pipefail; git "${GIT_OPTS[@]}" -C "$FLUTTER_ROOT" ls-tree "$BASEREF" -- "${TRACKEDFILES[@]}" | git hash-object --stdin); then |
There was a problem hiding this comment.
What do you think about grouping the commands and capture the outputs for better error messages:
if ! HASH=$( { set -o pipefail; git "${GIT_OPTS[@]}" -C "$FLUTTER_ROOT" ls-tree "$BASEREF" -- "${TRACKEDFILES[@]}" | git hash-object --stdin; } 2>&1 ); then
>&2 echo "${0}: git error when generating Flutter content-aware hash: $HASH"
exit 1
fiThere was a problem hiding this comment.
SGTM.
Note that if an error happens, then this approach will print the inaccurate hash to stderr. The script could try to filter it out, but that might risk removing useful output.
(The original PR will not show the hash. But with the original PR, the git command's error message will be printed on a separate line from the script's error message.)
There was a problem hiding this comment.
Oh, I was trying to catch the error either from the first ls-tree OR the second hash-object. I'm OK with leaving this alone for now.
flutter/flutter@2844af6...3d0e822 2026-04-21 [email protected] Reland "Unpin google_mobile_ads" (flutter/flutter#180838) 2026-04-21 [email protected] fix: correct LicenseRegistry docs to reference NOTICES instead of LICENSE (flutter/flutter#184572) 2026-04-21 [email protected] Roll Skia from f8637ade3d92 to a234f0ed7245 (2 revisions) (flutter/flutter#185334) 2026-04-21 [email protected] Roll Skia from 3b338913f623 to f8637ade3d92 (9 revisions) (flutter/flutter#185331) 2026-04-21 [email protected] Fix non-minimal relative imports in flutter_tools (flutter/flutter#183971) 2026-04-21 [email protected] Reapply "Unpin sdk package dependencies" (flutter/flutter#185268) 2026-04-21 [email protected] Remove unused private header (flutter/flutter#185260) 2026-04-20 [email protected] [iOS] Improve LaunchEngine implementation/API/docs (flutter/flutter#185200) 2026-04-20 [email protected] [ios][pv] Reland platform view hitTest approach (again) (flutter/flutter#185126) 2026-04-20 [email protected] Roll Skia from 75c2791c6274 to 3b338913f623 (3 revisions) (flutter/flutter#185304) 2026-04-20 [email protected] ignore avoid_type_to_string lint rule (flutter/flutter#184765) 2026-04-20 [email protected] Fix race condition in modifying release manifest. (flutter/flutter#185185) 2026-04-20 [email protected] In the dev/bots/analyze.dart script, obtain the relevant set of paths from Git instead of crawling the filesystem (flutter/flutter#185058) 2026-04-20 [email protected] [wimp] Implement images for wimp. (flutter/flutter#183913) 2026-04-20 [email protected] add the next batch for VPAT assessment (flutter/flutter#185053) 2026-04-20 [email protected] Roll Packages from c2e3d1f to 01c505f (21 revisions) (flutter/flutter#185287) 2026-04-20 [email protected] Avoid use of direct string injection in GitHub Workflow "run" steps. (flutter/flutter#185301) 2026-04-20 [email protected] Regenerate pubspec.lock (flutter/flutter#185290) 2026-04-20 [email protected] Report an error if the git ls-tree command fails in the content_aware_hash script (flutter/flutter#185170) 2026-04-20 [email protected] Roll Skia from d8415c5d7b91 to 75c2791c6274 (40 revisions) (flutter/flutter#185284) 2026-04-20 [email protected] Move widget_preview_scaffold into pub workspace (flutter/flutter#185176) 2026-04-20 [email protected] [record_use] Run build hooks and link hooks in separate targets (flutter/flutter#184880) 2026-04-20 [email protected] feat: add reloadIsRestart to handle hot reload as a restart for web #179448 (flutter/flutter#183233) 2026-04-20 [email protected] Roll Fuchsia Linux SDK from aDbXQm6WA0wFCAUp-... to LPa7NLiXEZP2A7IwZ... (flutter/flutter#185269) 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 [email protected] 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
…r#11548) flutter/flutter@2844af6...3d0e822 2026-04-21 [email protected] Reland "Unpin google_mobile_ads" (flutter/flutter#180838) 2026-04-21 [email protected] fix: correct LicenseRegistry docs to reference NOTICES instead of LICENSE (flutter/flutter#184572) 2026-04-21 [email protected] Roll Skia from f8637ade3d92 to a234f0ed7245 (2 revisions) (flutter/flutter#185334) 2026-04-21 [email protected] Roll Skia from 3b338913f623 to f8637ade3d92 (9 revisions) (flutter/flutter#185331) 2026-04-21 [email protected] Fix non-minimal relative imports in flutter_tools (flutter/flutter#183971) 2026-04-21 [email protected] Reapply "Unpin sdk package dependencies" (flutter/flutter#185268) 2026-04-21 [email protected] Remove unused private header (flutter/flutter#185260) 2026-04-20 [email protected] [iOS] Improve LaunchEngine implementation/API/docs (flutter/flutter#185200) 2026-04-20 [email protected] [ios][pv] Reland platform view hitTest approach (again) (flutter/flutter#185126) 2026-04-20 [email protected] Roll Skia from 75c2791c6274 to 3b338913f623 (3 revisions) (flutter/flutter#185304) 2026-04-20 [email protected] ignore avoid_type_to_string lint rule (flutter/flutter#184765) 2026-04-20 [email protected] Fix race condition in modifying release manifest. (flutter/flutter#185185) 2026-04-20 [email protected] In the dev/bots/analyze.dart script, obtain the relevant set of paths from Git instead of crawling the filesystem (flutter/flutter#185058) 2026-04-20 [email protected] [wimp] Implement images for wimp. (flutter/flutter#183913) 2026-04-20 [email protected] add the next batch for VPAT assessment (flutter/flutter#185053) 2026-04-20 [email protected] Roll Packages from c2e3d1f to 01c505f (21 revisions) (flutter/flutter#185287) 2026-04-20 [email protected] Avoid use of direct string injection in GitHub Workflow "run" steps. (flutter/flutter#185301) 2026-04-20 [email protected] Regenerate pubspec.lock (flutter/flutter#185290) 2026-04-20 [email protected] Report an error if the git ls-tree command fails in the content_aware_hash script (flutter/flutter#185170) 2026-04-20 [email protected] Roll Skia from d8415c5d7b91 to 75c2791c6274 (40 revisions) (flutter/flutter#185284) 2026-04-20 [email protected] Move widget_preview_scaffold into pub workspace (flutter/flutter#185176) 2026-04-20 [email protected] [record_use] Run build hooks and link hooks in separate targets (flutter/flutter#184880) 2026-04-20 [email protected] feat: add reloadIsRestart to handle hot reload as a restart for web #179448 (flutter/flutter#183233) 2026-04-20 [email protected] Roll Fuchsia Linux SDK from aDbXQm6WA0wFCAUp-... to LPa7NLiXEZP2A7IwZ... (flutter/flutter#185269) 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 [email protected] 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
Without this, the script will output an incorrect hash and return a successful exit code if "git ls-tree" fails.
See #184376