Added the ability to have s-maxage cache control headers (alongside existing max-age cache control headers) #80
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
zekth
requested changes
Nov 17, 2021
Readme.md
Outdated
| { | ||
| privacy: 'value', | ||
| expiresIn: 300, | ||
| serverExpiresIn: 2592000, |
Member
There was a problem hiding this comment.
This is an advanced feature and i don't think we should describe it here. Also it's incompatible with privacy: 'value'
plugin.js
Outdated
| value = `${_options.privacy}, max-age=${_options.expiresIn}` | ||
| } | ||
|
|
||
| if (_options.privacy.toLowerCase() === 'public' && _options.serverExpiresIn) { |
Member
There was a problem hiding this comment.
Suggested change
| if (_options.privacy.toLowerCase() === 'public' && _options.serverExpiresIn) { | |
| if (_options.privacy !== undefined && _options.privacy.toLowerCase() === 'public' && _options.serverExpiresIn) { |
Readme.md
Outdated
| resource may be cached. When this is set, and `privacy` is not set to `no-cache`, | ||
| then `', max-age=<value>'` will be appended to the `cache-control` header. | ||
| then `', max-age=<value>'` will be appended to the `cache-control` header. (300 seconds = 5 minutes) | ||
| + `serverExpiresIn` (Default: `undefined`): a value, in seconds, for the *max-age* the resource may be cached on the server. When this is set, and `privacy` is set to `public`, then `', s-maxage=<value>'` will be appended to the `cache-control` header. (2,592,000 seconds = 30 days) |
Member
There was a problem hiding this comment.
I tend to prefer the explanation from MDN:
The s-maxage response directive also indicates how long the response is fresh for (similar to max-age) — but it is specific to shared caches, and they will ignore max-age when it is present.
Shared caches makes more sense as it's mostly used on CDN edges.
Author
There was a problem hiding this comment.
I tried to integrate that without copying their language. Let me know what you think
…xample of the object definition, since it's an advanced feature
Fdawgs
approved these changes
Nov 17, 2021
Author
|
Will someone with sufficient permissions merge this? I can't. It's got four approvals. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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.
Added the ability to have s-maxage cache control headers when caching is public, so the length of time something is stored in a CDN can be longer than the length of time it is stored in a browser. e.g. For things stored in AWS CloudFront, https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html#ExpirationDownloadDist
Checklist
npm run testandnpm run benchmarkand the Code of conduct