docs: Update HTTP cache references to RFC 9111 compliant implementation #3608
+9
−6
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3608 +/- ##
=======================================
Coverage 91.34% 91.34%
=======================================
Files 184 184
Lines 16180 16180
=======================================
Hits 14779 14779
Misses 1227 1227
Partials 174 174 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
gmlewis
approved these changes
Jun 27, 2025
There was a problem hiding this comment.
Thank you for sharing this, @bartventer, and nice work! It is greatly appreciated.
LGTM.
Merging.
Glad to contribute, thanks for merging @gmlewis ! |
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.
This PR updates the documentation and example code to recommend
bartventer/httpcacheinstead ofgregjones/httpcache.bartventer/httpcacheis actively maintained and complies with RFC 9111 HTTP Caching.Motivation
bartventer/httpcacheimplements RFC 9111 §4.1, including proper normalization of Vary headers and URIs when generating cache keys. This covers recommended normalization steps from RFC 7230 §2.7.3 and RFC 3986 §6. In contrast,gregjones/httpcacheuses(*url.URL).String()as the cache key, which means it cannot support Vary-based caching and may produce unpredictable caching behaviour for requests that differ by query parameters, fragments, or other URI components.Additionally,
bartventer/httpcachealso:stale-while-revalidateand theimmutablecache-control extension.200,203,301,304,308,404,405,410,414, and501.X-Httpcache-Status) for easier debugging and monitoring (HIT,MISS,STALE,REVALIDATED,BYPASS).X-From-Cacheheader for drop-in replacement.