Remove three redundant error-related dependencies #34794
Merged
Conversation
This file contains 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
This functionality is now provided by the "errors" package in the standard library, so the HashiCorp-specific library is obsolete. This also removed our one direct use of github.com/pkg/errors, which we were using in a way that was totally redundant with the stdlib package errors. However, it lives on as an indirect dependency through the Consul backend's dependency on the Consul SDK, which uses that library.
HashiCorp needed support for wrapping multiple errors into a single error and for wrapping one error inside another long before that was in the standard library, and so built its own libraries for those needs. However, the standard library now has its own answers for both and so the HashiCorp libraries are redundant. We've already eliminated all use of both elsewhere in Terraform (except for some legacy packages that predate tfdiags anyway), so we no longer need to support them in package tfdiags.
SarahFrench
approved these changes
Mar 8, 2024
jbardin
approved these changes
Mar 8, 2024
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In the early days the Go standard library lacked various useful helpers for wrapping and combining errors and so various parties, including HashiCorp itself, wrote separate libraries to fill those gaps.
However, recent improvements to the standard library have made those all redundant. There's now sufficient functionality in the standard library to support all of Terraform's error wrapping and combining needs.
This therefore removes all of the uses of the following three modules from our non-legacy packages:
github.com/pkg/errorsgit.luolix.top/hashicorp/go-multierrorgit.luolix.top/hashicorp/errwrapThe latter two still have callers in the packages under our
legacydirectory, but we'll hopefully eventually take care of those with a combination of #34793 and #34772.The first has no remaining callers in this repository, but unfortunately it's still used by the Consul SDK that we depend on for the
consulremote state backend. Hopefully a future version of that will switch to using the standard library functions instead too, if that hasn't already happened.This is motivated just by minimizing the number of external dependencies Terraform has. We prefer to use standard library functionality instead of third-party libraries whenever possible.
As a bonus, this also fills two prior gaps in the unit testing in
package tfdiags.