Add cache-busting and server headers with a wrapper. #5
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
In order to support custom headers for various response types, this commit adds a wrapper type, ResponseWrapper, which can service all types of response in `bin`. For paste objects, the preferred `Last-Modified` is used, so that caches can compare their exact timings with the HEAD response when revalidating. For static objects, an `ETag` is used instead, based on the Cargo version and git hash of the codebase at compilation time; a `build.rs` is used for this.
wantguns
reviewed
Feb 5, 2022
Comment on lines
+26
to
+27
| static BINARY_ETAG: Lazy<String> = | ||
| Lazy::new(|| sha256::digest(BINARY_VERSION)); |
Owner
There was a problem hiding this comment.
I went on searching for a library which provides a constant function to generate sha256 digests.
The closest I got was https://github.com/saleemrashid/sha2-const, but it brings in more weight than we would have after replacing it with both once-cell and sha256.
wantguns
reviewed
Feb 5, 2022
Comment on lines
+39
to
+78
| impl<'r, 'o: 'r, R: Responder<'r, 'o>> Responder<'r, 'o> | ||
| for ResponseWrapper<R> | ||
| { | ||
| fn respond_to(self, request: &'r Request<'_>) -> Result<'o> { | ||
| use ResponseWrapper::*; | ||
|
|
||
| // Add global headers. | ||
| let mut response = Response::build(); | ||
| response.raw_header("Server", crate::SERVER_VERSION); | ||
|
|
||
| // Handle individual request types. | ||
| match self { | ||
| MetaInterfaceResponse(sup) => response | ||
| .join(sup.respond_to(request)?) | ||
| .raw_header("ETag", &*crate::BINARY_ETAG) | ||
| .ok(), | ||
| PasteContentResponse(sup, modified) => response | ||
| .join(sup.respond_to(request)?) | ||
| .raw_header("Last-Modified", http_strftime(modified)) | ||
| .ok(), | ||
| Redirect(sup) => response.join(sup.respond_to(request)?).ok(), | ||
| NotFound(s) => { | ||
| let body = format!("Unable to find entity '{}'", s); | ||
|
|
||
| response | ||
| .sized_body(body.len(), Cursor::new(body)) | ||
| .status(Status::NotFound) | ||
| .ok() | ||
| } | ||
|
|
||
| ServerError(s) => { | ||
| let body = format!("Server error: '{}'", s); | ||
| response | ||
| .sized_body(body.len(), Cursor::new(body)) | ||
| .status(Status::InternalServerError) | ||
| .ok() | ||
| } | ||
| } | ||
| } | ||
| } |
Owner
There was a problem hiding this comment.
This is neat. It would prove useful in being versatile to future changes.
Owner
|
Thanks for the PR ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In order to support custom headers for various response types, this commit adds a wrapper type, ResponseWrapper, which can service all types of response in
bin.For paste objects, the preferred
Last-Modifiedis used, so that caches can compare their exact timings with the HEAD response when revalidating.For static objects, an
ETagis used instead, based on the Cargo version and git hash of the codebase at compilation time; abuild.rsis used for this.Cargo Format
cargo fmton the project.Clippy lints
cargo clippy -- -Dwarningson the project to check for suggestionscargo clippy --fixto let clippy apply the suggestions itself, if any.