Remove VERSION from libraries.yml

Open on Drupal.org →

Created on 23 December 2024, 5 months ago

Problem/Motivation

The version: VERSION lines in libraries.yml are creating a version query string using the Drupal Core version number for the asset files, making these files cached in the browser dependent on the Core version.

Steps to reproduce

This can produce various problems after an update, as the old versions of assets might be loaded for users who have those cached. The only way to currently fix those to clear the browser cache.

Proposed resolution

Remove the version: VERSION lines from libraries.yml. By doing this, Drupal will use an automatically generated query string added to filenames. From the code documentation:

The string changes on every update or full cache flush, forcing browsers to load a new copy of the files as the URL changed.

See: web/core/lib/Drupal/Core/Asset/JsCollectionRenderer.php:62

The other option is to explicitly set the module's version on these lines and keep track of it when the version number changes/the asset is updated.

🐛 Bug report

Status

Active

Version

3.0

Component

Code

Created by

🇧🇪Belgium dieterholvoet Brussels

Live updates comments and jobs are added and updated live.

Sign in to follow issues

Merge Requests

!36Remove VERSION from libraries.yml
Merged
🇧🇪Belgium dieterholvoet
updated 5 months ago

Comments & Activities

Issue created by @dieterholvoet
Merge request !36Remove VERSION from libraries.yml → (Merged) created by dieterholvoet
Comment 5 months ago →
🇧🇪Belgium dieterholvoet Brussels
Pipeline finished with Failed
5 months ago
Total: 1754s
#377092
Pipeline finished with Skipped
5 months ago
#377132
First commit to issue fork.
Comment 5 months ago →
System Message

amateescu → committed 6b0bcab3 on 3.x authored by dieterholvoet →
Issue #3495657: Remove VERSION from libraries.yml
Comment 5 months ago →
🇷🇴Romania amateescu
I've read a bit about the change from https://www.drupal.org/node/3301716 → and the asset-surrounding code, and there's a @todo in \Drupal\Core\Asset\LibraryDiscoveryParser::buildByExtension() that will make core get the version information from the extension (module in this case), so let's not bother with maintaining that version string ourselves.

In other words, makes sense to me! Merged into 3.x, thanks!
Comment 4 months ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024