Refactor ETag to use GZIP CRC32 trailer #245
Draft
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
Refactor ETag generation to read CRC32 checksum from GZIP file trailer - Changed _getEtag() signature to accept File handle instead of byte array - Function now seeks to GZIP trailer and extracts CRC32 checksum - Added error handling for file operations (seek/read failures) - Returns boolean to indicate success/failure of ETag generation - Maintains same hex conversion logic for consistent ETag format - Simplifies code following DRY principle by eliminating duplicate read file This refactoring maintains full backward compatibility
mathieucarbou
approved these changes
Jul 29, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR refactors ETag generation for GZIP files to read the CRC32 checksum directly from the GZIP file trailer instead of requiring a separate byte array parameter. The refactor centralizes file operations within the _getEtag function and adds proper error handling while maintaining the same ETag format.
Key changes:
- Modified
_getEtag()function signature to accept a File handle and return boolean success status - Consolidated GZIP trailer reading logic into the
_getEtagfunction with error handling - Updated calling code to use the new function signature and handle return status
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/ESPAsyncWebServer.h | Updated _getEtag function signature to accept File parameter and return boolean |
| src/AsyncWebServerRequest.cpp | Refactored _getEtag implementation to handle file operations internally with error handling |
| src/WebResponses.cpp | Updated to use new _getEtag function and handle boolean return value |
Comments suppressed due to low confidence (1)
|
@JosePineiro could you please rebase and fix the conflicts in this PR ? I will merge it after, thanks! |
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.
Refactor ETag generation to read CRC32 checksum from GZIP file trailer
This refactoring maintains full backward compatibility