Improve experience after Frontend is rebuilt #496
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
The error message should account for the possibility that Frontend was rebuilt.
matthew-white
commented
Sep 17, 2021
ktuite
approved these changes
Sep 17, 2021
matthew-white
added a commit
to getodk/central
that referenced
this pull request
Sep 27, 2021
This commit aims to prevent excessive caching of /version.txt and
/index.html. Browsers will still be able to cache these files, but they
must revalidate them with each request.
Prior to this commit, I noticed the following behavior:
- Open Frontend in a browser (I used Firefox).
- Change the source, then rebuild. This will change /version.txt.
- However, if you click on the Version link in the help dropdown, the
old /version.txt is shown in a new tab.
- Only if you refresh the new tab is the new /version.txt is shown.
getodk/central-frontend#496 only works if requesting /version.txt
returns the current version, reflecting any change.
Adding the Cache-Control header for /version.txt seems to resolve this
issue. I also added it for /index.html, which should make it unnecessary
to ever force-refresh /index.html in a browser.
I think Cache-Control is useful for these two files, but I don't think
that it is useful for other files:
- CSS and JS files from Vue will have a hash in their filenames that
will change as the associated source changes.
- We use a query string for cache-busting when requesting icon files.
matthew-white
added a commit
to getodk/central
that referenced
this pull request
Sep 28, 2021
This commit aims to prevent excessive caching of /version.txt and
/index.html. Browsers will still be able to cache these files, but they
must revalidate them with each request.
Prior to this commit, I noticed the following behavior:
- Open Frontend in a browser (I used Firefox).
- Change the source, then rebuild. This will change /version.txt.
- However, if you click on the Version link in the help dropdown, the
old /version.txt is shown in a new tab.
- Only if you refresh the new tab is the new /version.txt is shown.
getodk/central-frontend#496 only works if requesting /version.txt
returns the current version, reflecting any change.
Adding the Cache-Control header for /version.txt seems to resolve this
issue. I also added it for /index.html, which should make it unnecessary
to ever force-refresh /index.html in a browser.
I think Cache-Control is useful for these two files, but I don't think
that it is useful for other files:
- CSS and JS files from Vue will have a hash in their filenames that
will change as the associated source changes.
- We use a query string for cache-busting when requesting icon files.
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.
No description provided.