Wrap underlying errors with %w instead of %v#896
Open
arpitjain099 wants to merge 1 commit into
Open
Conversation
Go 1.20 allows wrapping multiple errors in one fmt.Errorf. Convert the "%w: %v" sites whose second argument is an error to "%w: %w" so errors.Is/As match the underlying cause, not just the sentinel; accumulated []error cases are combined with errors.Join. Sites whose second argument is a plain string keep %v. Signed-off-by: Arpit Jain <arpitjain099@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #692.
Go 1.20 added support for wrapping multiple errors in a single
fmt.Errorf, which the issue (following the discussion on #691) suggested adopting across the code.This converts the
fmt.Errorf("%w: %v", sentinel, err)sites whose second argument is actually an error, so the underlying cause is wrapped too anderrors.Is/errors.Ascan match it rather than only the sentinel:gcb/provenance.go(invalid DSSE payload, mismatched tag and versioned-tag) andgha/builder.go(untrusted reusable workflow) now wrap theirerrwith%w. The two signature-verification paths ingcb/provenance.goandutils/dsse.gothat accumulate a[]errornow join them witherrors.Join(errs...), so every collected failure stays inspectable instead of being flattened into a string.err.Error()arguments became plainerrso the chain is preserved.Sites whose second argument is a plain string (package name, build type, builder ID, config URI) are left as
%v, since there is no error to wrap there.go build,go vet, and the gcb/utils package tests pass locally.