refactor(deps): upgrade to aws-sdk-go-v2
#529
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
- `aws-sdk-go` has [a vuln](https://osv.dev/vulnerability/GO-2022-0646) in the v1 EncryptionClient - it's fixed in the v2 client - we don't use this functionality, but still get reported this vuln - instead add an ignore for the vuln, figured I might as well make the upgrade to v2 - confirmed that `go.mod` has latest versions (e.g. `config` [released v1.19.0](https://github.com/aws/aws-sdk-go-v2/releases/tag/release-2023-10-16) this week) - follow the [migration instructions](https://aws.github.io/aws-sdk-go-v2/docs/migrating/) - migrate all `session` usage to `config.LoadDefaultConfig` per [instructions](https://aws.github.io/aws-sdk-go-v2/docs/migrating/#configuration-loading) - this includes shared config handling, so I believe `session.SharedConfigEnable` is no longer necessary per [instructions](https://aws.github.io/aws-sdk-go-v2/docs/migrating/#migrating-from-newsessionwithoptions) - the docs on ["Speciyfing Credentials"](https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials) seem to state this as well, if I'm understanding correctly - see also `config.WithRegion` mention in the [instructions](https://aws.github.io/aws-sdk-go-v2/docs/migrating/#migrating-from-newsession-with-awsconfig-options) - migrate credential usage - [`Config.Credentials`](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws#Config) still exists, but the function is now [`Retrieve(context)`](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws#CredentialsProvider) instead of `Get` - the [`Credentials` struct](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws#Credentials) otherwise looks the same, has the `AccessKeyId`, `SecretAccessKey`, and `SessionToken` that were used in v1 - STS credentials are retrieved a bit differently now [per instructions](https://aws.github.io/aws-sdk-go-v2/docs/migrating/#aws-security-token-service-credentials) - use a `config` instead of a `session` to create a client, then use `NewAssumeRoleProvider` instead of `NewCredentials - NOTE: I used `context.Background()` for all of the contexts that are now required - it may make more sense for context to be passed into these functions, but that would be a breaking change and require downstream changes in Argo projects, so I left that out for now and just went with `Background` as a default Signed-off-by: Anton Gilgur <[email protected]>
- this was just straight up missing from the migration guide's imports - found it myself: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/sts Signed-off-by: Anton Gilgur <[email protected]>
agilgur5
added
dependencies
This was referenced Oct 20, 2023
- more idiomatic Go, less memory use, and makes it easier to replace with an argument later Signed-off-by: Anton Gilgur <[email protected]>
jmeridth
approved these changes
Oct 30, 2023
terrytangyuan
approved these changes
Oct 31, 2023
|
@agilgur5 can you rebase? |
|
Aw dang, another conflict with dependabot. Fixed conflicts now if we could get this in before the next conflict 😅 |
|
There's an |
|
Kudos, SonarCloud Quality Gate passed!
|
|
3rd+ merge conflict fixed now 😕 @terrytangyuan @crenshaw-dev could either of you merge this? it will conflict with dependabot about every other day per above |
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.
Partial fix for argoproj/argo-workflows#12031, Vulnerabilities
aws-sdk-gov1 is only used frompkgfor WorkflowsMotivation
aws-sdk-gohas a vuln in the v1 EncryptionClientModifications
follow the migration instructions
sessionusage toconfig.LoadDefaultConfigper instructionssession.SharedConfigEnableis no longer necessary per instructionsconfig.WithRegionmention in the instructionsConfig.Credentialsstill exists, but the function is nowRetrieve(context)instead ofGetCredentialsstruct otherwise looks the same, has theAccessKeyId,SecretAccessKey, andSessionTokenthat were used in v1configinstead of asessionto create a client, then useNewAssumeRoleProviderinstead of `NewCredentialsNOTE: I used
context.Background()for all of the contexts that are now requiredBackgroundas a defaultVerification
go.modhas latest versions (e.g.configreleased v1.19.0 this week)make buildandmake testpass successfully. Did not test this live however as that needs to be done downstream