[Theme] Fix Liquid asset hot reload #4669
Merged
+41
−5
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
Coverage report
Test suite run success1904 tests passing in 865 suites. Report generated by 🧪jest coverage report action from 1ceb3ee |
jamesmengo
reviewed
Oct 17, 2024
| // The `href` property prepends the host to the pathname. Use attributes instead. | ||
| // Note: when a .liquid asset is requested but not found in SFR, it will be rendered as | ||
| // `.../assets/file.css?1234` instead of `.../assets/file.css?v=1234`. Ensure we target both. | ||
| element.setAttribute('href', element.getAttribute('href')!.replace(/(\?|&)(?:v=)?\d+$/, `$1v=${Date.now()}`)) |
frandiox
added
the
#gsd:40767
|
/snapit |
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.
WHY are these changes introduced?
Fixes #2614
WHAT is this pull request doing?
When a missing .liquid asset that is referenced in the app is created anew, the server will try to hot reload it and fail.
Pairing with @jamesmengo , we found out during the first rendering, SFR renders
?1234for the file querystring, which returns a 404.The problem is that even after creating the file and uploading it, SFR still renders the wrong
?1234instead of?v=timestamp. This makes the request fail again with 404 even though the file already exists. This might be related to caching at the SFR level, I'm not sure about it.This PR makes 3 changes:
?1234with a new?v=timestamp.?1234queries to?v=timestamp queries. This fix would probably also work for CSS assets, but I'm keeping the previous one since it's cleaner for CSS.How to test your changes?
.liquid.cssfile from your theme.Post-release steps
Measuring impact
How do we know this change was effective? Please choose one:
Checklist