fix(gateway): Cache-Control header for UnixFS directories #639
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
This comment was marked as resolved.
This comment was marked as resolved.
lidel
requested changes
Jul 26, 2024
There was a problem hiding this comment.
Thank you for raising this.
This is bit more tricky, because HTML listing is quality-of-life improvement for web browsers, and not the actual immutable data.
Generated HTML listing of UnixFS directory is NOT immutable and should not be cached forever.
- Proper fix for
/ipns/is to implement TTL handling. - Proper fix for
/ipfs/may not exist. A fair compromise may be to cache for a week, and also allow for serving stale cache while check for update happens asynchronously. This ensures CDNs serve content fast, but we dont cache generated HTML forever. See proposed value inline.
Would you have time to submit related PRs to
- https://github.com/ipfs/specs/blob/main/src/http-gateways/path-gateway.md#cache-control-response-header
- https://github.com/ipfs/gateway-conformance
?
We need to update conformance tests before this can be shipped. (CI is currently failing).
lidel
changed the title
|
@lidel |
This was referenced Jul 29, 2024
|
Thanks! Had to push some test fixes but your fork does not allow it, so continuing in #643 |
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.
Cache-Control headers are currently not being returned when viewing the directory index page of a UnixFS directory. This is because
rq.ttlreturns0.For example, the following request path is missing a
Cache-Controlheader:/ipfs/<cid>/According to the Path Gateway Specification:
https://specs.ipfs.tech/http-gateways/path-gateway/#cache-control-response-header
This PR sets the appropriate header.