Add ability to request checksum in an S3 HeadObject request #1083
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
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
dannycjones
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
dannycjones
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
passaro
reviewed
Oct 25, 2024
| @@ -647,7 +682,7 @@ impl fmt::Display for ObjectAttribute { | |||
| /// | |||
| /// See [Checksum](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html) in the *Amazon | |||
| /// S3 API Reference* for more details. | |||
| #[derive(Debug)] | |||
| #[derive(Clone, Debug)] | |||
There was a problem hiding this comment.
Thoughts on having the checksums typed once #1082 goes in?
There was a problem hiding this comment.
I don't have a strong opinion. I'd be inclined to stick close to the REST API but I see we already diverged a bit by creating a Checksum struct in the first place.
There was a problem hiding this comment.
Thinking about this a bit more:
- Probably HeadObject shouldn't be returning this struct, but instead each checksum on the
HeadObjectResult. (This struct is mirroring how GetObjectAttributes returns the values.) - We could have
Option<Crc32>, etc. here. That sounds fine to me.
There was a problem hiding this comment.
If we are talking about whether to wrap the Optional checksums in a Checksum struct, my slight preference is in favour - I don't think its really diverging from the API in meaningful ways. But I don't think it's really too interesting either way.
I care a bit more about the "typed" checksums. As I sees it we should either:
- keep everything as
String, neutral and close to the API. We'll offer separate facilities to parse checksums (and encode as base64). - consistently use our checksum types.
My preference is for (2), which seems much nicer for users.
There was a problem hiding this comment.
None of this is blocking for this PR, just bringing it up because we may want to go through all related API changes in one release cycle.
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
passaro
approved these changes
Oct 28, 2024
I'll merge now, let's converge on an approach with the API changes in new PR if needed. |
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.
Description of change
For a consumer of the S3 client, we need to return the checksum algorithm used with the object. This change adds the request option to retrieve checksum algorithm as part of a HeadObject request. The result now include the field, which will only be populated when requested and supported by the S3 implementation.
Relevant issues: N/A
Does this change impact existing behavior?
We now require a
HeadObjectParamsstruct when invokinghead_objectwith the S3 client. This changes the signature, and so a change log entry will be added for the client crate. There is no behavior change.Does this change need a changelog entry in any of the crates?
Yes, a note is added for
mountpoint-s3-clientcrate.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).