-
Notifications
You must be signed in to change notification settings - Fork 749
refactor(sdkv3): migrate S3 Client #6721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
Contributor
Author
|
/runIntegrationTests |
Contributor
Author
|
Integ test failing on master: 99a555a Duplicate code unrelated to these changes. Refactoring explorer nodes lead to it seeing duplication in the explorer node boilerplate. |
justinmk3
approved these changes
Mar 6, 2025
Contributor
justinmk3
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait until after today's release?
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.
Problem
This client is tightly coupled to some implementations, making this migration more difficult than usual. Additionally, v3 handles streams differently than v2. Also, some v2 features in the SDK are completely redone. For example, pre-signing a url: https://aws.amazon.com/blogs/developer/generate-presigned-url-modular-aws-sdk-javascript/.
Solution
listFilesrefactor).Buckettype exported by the SDK, our ownBucket, andDefaultBucket.Bucketwas derived fromDefaultBucket, but this made reading type signatures ambiguous at first glance. These are all now under S3Bucket.Verification
To verify this migration didn't break anything I manually tested the following through the toolkit:
Future Work
GetObjectresponse body is now aStreamingBlobPayloadOutputTypesfrom@smithy/types. This is a general type for web/node streams, therefore we must cast to Node'sReadabletype. Ideally we would support working with the abstract stream directly and avoiding the cast. The approach is outlined here: https://docs.aws.amazon.com/code-library/latest/ug/s3_example_s3_Scenario_UsingLargeFiles_section.html.listBucketsand it should return anAsyncCollectionfor proper pagination support.feature/xbranches will not be squash-merged at release time.