Skip to content
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

Update ChecksumAlgorithm field of client's ObjectInfo struct to be Vec over single element #1093

Merged

Conversation

dannycjones
Copy link
Contributor

Description of change

On reviewing the S3 API documentation, the checksum algorithm field is a list of algorithms. Additionally, when reviewing other SDKs such as the Rust SDK, we see that they are presenting this field as Option<Vec<String>> rather than a single optional element. (Note, we do drop the Option still.

We'd prefer to align with the SDK interface. Our tenet here is to ensure our S3 client is consistent with the official SDKs where there's no significant effort required. This is making a breaking change while we're already planning to make a number of breaking changes to the client.

Relevant issues:

Does this change impact existing behavior?

Yes, it changes the S3 client behavior to return a different type. We are however merging this before a new crate release, so this will not be an additional breaking change.

There's no behavior change to Mountpoint file system.

Does this change need a changelog entry in any of the crates?

There is already an existing entry in mountpoint-s3-client's changelog. This PR has been added to the list of PRs for that entry.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).

…ctor over single element

Signed-off-by: Daniel Carl Jones <[email protected]>
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests October 31, 2024 17:26 — with GitHub Actions Inactive
Signed-off-by: Daniel Carl Jones <[email protected]>
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones temporarily deployed to PR integration tests November 1, 2024 11:29 — with GitHub Actions Inactive
@dannycjones dannycjones marked this pull request as ready for review November 1, 2024 11:30
@dannycjones dannycjones requested a review from passaro November 1, 2024 11:30
@dannycjones dannycjones enabled auto-merge November 1, 2024 11:30
Copy link
Contributor

@passaro passaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dannycjones dannycjones added this pull request to the merge queue Nov 1, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 1, 2024
@dannycjones dannycjones added this pull request to the merge queue Nov 1, 2024
Merged via the queue into awslabs:main with commit fb3832b Nov 1, 2024
23 checks passed
@dannycjones dannycjones deleted the fix-listobjects-checksum-field branch November 1, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants