Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Invalidate merged Noncore JS / CSS in case of any plugin update/downgrade/uninstall #4655

Closed
tsteur opened this Issue · 17 comments

3 participants

Thomas Steur Julien Moumné Timo B.
Thomas Steur
Owner

In case we are in production mode (merged assets is enabled) and there is a plugin upgrade/downgrade/uninstall we should regenerate the merged Noncore JS / CSS if needed.

Julien Moumné
Collaborator

This should already work, see first line of [https://github.com/piwik/piwik/blob/master/core/Filesystem.php#L24] :

/**
* Called on Core install, update, plugin enable/disable
* Will clear all cache that could be affected by the change in configuration being made
*/
    public static function deleteAllCacheOnUpdate($pluginName = false)
    {
        AssetManager::getInstance()->removeMergedAssets($pluginName);
        View::clearCompiledTemplates();
        Cache::deleteTrackerCache();
    }
Thomas Steur
Owner

During update/downgrade/... it is not called I think. At least this is what I've experienced. I will try to reproduce it later. We should definitely remove the first line of that comment as a function does not know when it is called :)

Thomas Steur
Owner

To reproduce I installed the CustomAlerts plugin. Afterwards I increased the version number form 0.1.12 to 0.1.13 in plugin.json and added the following CSS to the alerts.less file

body, html {
  background-color: red;
}

In database Piwik recognized the update but did not recompile the CSS. Same for downgrading.

Julien Moumné
Collaborator

If you are manually editing files, you are then in "development mode" right?

disable_merged_assets should then be set to true

Thomas Steur
Owner

That's what I would normally do. But to reproduce this behavior on production I disabled merged assets (=false).

Julien Moumné
Collaborator

Why would you edit files in a production environment?

Thomas Steur
Owner

This is basically what happens when you update a 3rd party plugin in production environment

Julien Moumné
Collaborator

Is there no button for the user to press in order to trigger the update?

Julien Moumné
Collaborator

By 3rd party you mean a plugin not published in the marketplace right?

In that case, maybe the simple solution is to document the fact the tmp directory must be manually emptied when a plugin is manually updated.

Thomas Steur
Owner

We experienced this issue also when updating plugins via Marketplace or when uploading a plugin ZIP in the UI. When you are running multiple PHP nodes you usually want to update manually though. Documenting could be a solution but can be problematic since you maybe do not directly notice that you forgot to clean the tmp directory (which also causes a rebuild of all JS files). In our case we didn't notice it in the beginning since everything still kinda worked but didn't. Maybe we can delete the assets in case any plugin changes? We do already have the installed version in the option table and can compare it with the current plugin version in the plugin.json file before it is actually updated.

Thomas Steur
Owner

In 237d8ef: fixes #4655 assets are not invalidated after a plugin change. To fix this issue (at least for now) we always compare the cache buster. For JavaScript in production this is always fast as the hash is based only on plugin names + version. For css we have to concat the content of all raw css/less files which should be still fast, especially since the css is cached in the browser afterwards. @Julien let me know what you think about this and we can change it otherwise

Thomas Steur
Owner

In 3da7d94: refs #4655 updated description of merged assets setting

Timo B.
Collaborator

The setting disable_merged_assets is mentioned multiple times in the code as well. I'd suggest updating all descriptions. Just do a quick search for disable_merged_assets to see what I mean: at a first glance, StylesheetUIAssetFetcher and AssetManager need updates as well.

Or maybe it would be better to remove the duplicate documentation and refer to the comment in global.ini from the other places.

Thomas Steur
Owner

In 2a00eb6: refs #4655 updated documentation as the merged_assets flag is not really relevant for CSS at the moment

Thomas Steur
Owner

In b150893: refs #4655 updated description of merged assets option

Thomas Steur
Owner

In 5c12352: refs #4655 actually here we can refer to the comment in the config

Thomas Steur
Owner

Thx Timo! I removed it in one place and updated another. Probably we still need the documentation in two places. The inline doc for developers (developer.piwik.org) and the other one for people who want to configure Piwik and just browse through the config.

Thomas Steur tsteur added this to the 2.1 - Piwik 2.1 milestone
Thomas Steur tsteur self-assigned this
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Thomas Steur tsteur fixes #4655 assets are not invalidated after a plugin change. To fix …
…this issue (at least for now) we always compare the cache buster. For JavaScript in production this is always fast as the hash is based only on plugin names + version. For css we have to concat the content of all raw css/less files which should be still fast, especially since the css is cached in the browser afterwards. @Julien let me know what you think about this and we can change it otherwise
237d8ef
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Thomas Steur tsteur refs #4655 updated description of merged assets setting 3da7d94
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Thomas Steur tsteur refs #4655 updated documentation as the merged_assets flag is not rea…
…lly relevant for CSS at the moment
2a00eb6
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Thomas Steur tsteur refs #4655 updated description of merged assets option b150893
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.