Repository navigation
Implement Cache Busting for Static Assets (JS/CSS) - #206
Merged
Merged
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
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.
Problem:
When upgrading beanstalk-console, browsers or intermediate caches (like CDNs) might continue serving outdated JavaScript (JS) and Cascading Style Sheets (CSS) files. This mismatch between the backend PHP code and the frontend assets can lead to a broken or malfunctioning user interface (UI).
Solution:
This change implements a standard cache-busting technique by appending the application's version number as a query parameter to all static asset URLs (
for CSS,for JS) within the main HTML template (lib/tpl/main.php).How it Works:
config.phpwithin$GLOBALS['config']['version'].lib/tpl/main.phptemplate now accesses this version usingand appends it as a query string (e.g.,?1.8.0) to thehreforsrcattribute of static asset includes.config.phpis updated, the URLs for all static assets change automatically.Files Changed:
lib/tpl/main.php: Modified to append the version query parameter to CSS and JS includes.config.php: (Implicitly relevant) Contains the$GLOBALS['config']['version']definition used for cache busting.This resolves UI inconsistencies caused by stale asset caches during version upgrades.
Fixes: #202