Use Surrogate-Key headers for docs.python.org #510
Merged
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
AA-Turner
commented
Oct 9, 2024
Comment on lines
+191
to
+197
| # Add the Surrogate-Key for bulk CDN purging | ||
| # xref https://docs.fastly.com/en/guides/working-with-surrogate-keys | ||
| location ~ ^/((2|3)(\.[0-9]+)?|dev)/ { | ||
| add_header Surrogate-Key en/$1 always; | ||
| } | ||
| location ~ ^/(es|fr|id|it|ja|ko|pl|pt-br|tr|uk|zh-cn|zh-tw)/((2|3)(\.[0-9]+)?|dev)/ { | ||
| add_header Surrogate-Key $1/$2 always; |
There was a problem hiding this comment.
Ideally I had hoped to use some sort of non-binding match construct to add the headers, but it seems that NGINX location directives will always bind. The end goal is simply to add some unique prefix for every second level path (and English) that we can use to purge. I think the approach here is fine given every other rule here is a redirect, but worth pointing out.
Fastly has some text about adding surrogate keys via vcl_fetch, but I don't know where I'd configure that.
A
There was a problem hiding this comment.
This could be configured in our Fastly service for docs.python.org, but is probably more scrutable (and testable, nice!) here.
ewdurbin
approved these changes
Oct 9, 2024
This was referenced Oct 9, 2024
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.
Closes #287.
A