fix(hooks): wrap errors to preserve sentinel values#760
Open
victoriacheng15 wants to merge 1 commit into
Open
Conversation
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
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.
🤔 What's changed?
This PR fixes hook error wrapping to preserve the types of all merged errors.
Specifically:
joinedErrortype andmergeErrorshelper at the end of suite.go.runBeforeStepHooks,runAfterStepHooks,runBeforeScenarioHooks, andrunAfterScenarioHooksin suite.go to usemergeErrorsinstead offmt.Errorf("%v, %w").errors.Isanderrors.As.Backward Compatibility:
IsandAsmethods onjoinedError, which have been natively supported by the standarderrorspackage since Go 1.13.Unwrap() []errormethod, allowing modern Go runtimes and static analysis tools to natively unwrap the error slice.%v, %vstring formatting, ensuring no breaking changes to logs or output formatting.⚡️ What's your motivation?
Fixes #732
Currently, when a step fails and a hook also returns an error (such as a skip), they are merged using
fmt.Errorf("%v, %w"). This preventserrors.Isanderrors.Asfrom detecting the hook error type because it is formatted with%vinstead of%w. As a result, the runner fails to recognize sentinel errors likeErrSkipreturned from hooks when a step fails.🏷️ What kind of change is this?
♻️ Anything particular you want feedback on?
Feedback on the
joinedErrorimplementation for Go versions < 1.20 (which do not support multiple%wverbs).📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.