feat(storage): Add full object checksum validation at finalization for json path
This PR modifies the client library to send the x-goog-hash header, containing crc32c= and/or md5= values, if available, when sending the final chunk of a resumable upload.
Implementation Details The core of the change involves coordinating hash calculation between the ObjectWriteStreambuf and the RestStub. The hash_function within ObjectWriteStreambuf maintains the running checksum state for the entire upload.
RestStub::UploadChunk: For intermediate chunks (when last_chunk() is false), UploadChunk receives a valid hash_function_ptr from ObjectWriteStreambuf. It calls hash_function->Update() to incorporate the chunk's payload into the running checksum. For the final chunk (when last_chunk() is true), UploadChunk receives a nullptr for hash_function_ptr but receives the final, computed object hashes via request.known_object_hashes(). It then adds the x-goog-hash header(s) to the HTTP request using these final hashes.
ObjectWriteStreambuf::FlushFinal: This method is called when Close() is invoked on the stream. It first calls hash_function->Update() with any data still pending in its internal buffer.
Summary of Changes
Hello @v-pratap, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the Google Cloud Storage client library by implementing full object checksum validation for resumable uploads. It introduces mechanisms to calculate and transmit crc32c and md5 checksums in the x-goog-hash HTTP header during the finalization step of an upload, thereby bolstering data integrity and reliability for large object transfers.
Highlights
-
Checksum Header Integration: The client library now sends
x-goog-hashheaders containingcrc32cand/ormd5values with the final chunk of resumable uploads, enhancing data integrity. -
Hash Calculation Coordination: Hash calculation logic is coordinated between
ObjectWriteStreambufandRestStub, ensuring that the final, computed object hashes are correctly passed and included in the HTTP request. -
Enhanced Test Coverage: Comprehensive unit tests have been added to verify the correct behavior of hash computation, passing, and header inclusion for various scenarios, including intermediate and final chunks, and different combinations of
crc32candmd5.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.