Handle theme assets cache burst (fix #761)

CHANGELOG.md

@@ -8,6 +8,8 @@
 - Raise a `400 Bad Request` when a bad `class` attribute is provided to the API
   (for entry point not using forms). [#772](https://github.com/opendatateam/udata/issues/772)
 - Fix datasets with spatial coverage not being indexed [#778](https://github.com/opendatateam/udata/issues/778)
+- Ensure theme assets cache is versionned (and flushed when necessary)
+  [#781](https://github.com/opendatateam/udata/pull/781)
 
 ## 1.0.1 (2017-02-16)
 

udata/theme.py

@@ -3,15 +3,19 @@
 
 import imp
 import logging
+import pkg_resources
 
 from importlib import import_module
 from os.path import join, dirname, isdir, exists
+from time import time
 
 from flask import current_app, g
+from jinja2 import contextfunction
 from werkzeug.local import LocalProxy
 
 from flask_themes2 import (
-    Themes, Theme, render_theme_template, get_theme, packaged_themes_loader
+    Themes, Theme, render_theme_template, get_theme, packaged_themes_loader,
+    global_theme_static
 )
 
 from udata.app import nav
@@ -41,6 +45,22 @@ def get_current_theme():
 ])
 
 
+@contextfunction
+def theme_static_with_version(ctx, filename, external=False):
+    '''Override the default theme static to add cache burst'''
+    url = global_theme_static(ctx, filename, external=external)
+    if url.endswith('/'):  # this is a directory, no need for cache burst
+        return url
+    if current_app.config['DEBUG'] or current_app.config['TESTING']:
+        burst = time()
+    elif current.pkg_version:
+        # If a package name is provided for versionning, use it
+        burst = pkg_resources.get_distribution(current.pkg_version).version
+    else:
+        burst = current.version
+    return '?'.join((url, '_={0}'.format(burst)))
+
+
 class ConfigurableTheme(Theme):
     context_processors = None
     defaults = None
@@ -56,6 +76,8 @@ def __init__(self, path):
             self.variants.insert(0, 'default')
         self.context_processors = {}
 
+        self.pkg_version = self.info.get('pkg_version')
+
     @property
     def site(self):
         from udata.core.site.models import current_site
@@ -151,6 +173,9 @@ def init_app(app):
     prefix = '/'.join(('_themes', theme.identifier))
     app.config['STATIC_DIRS'].append((prefix, theme.static_path))
 
+    # Override the default theme_static
+    app.jinja_env.globals['theme_static'] = theme_static_with_version
+
     # Hook into flask security to user themed auth pages
     app.config.setdefault('SECURITY_RENDER', 'udata.theme:render')
 

udata/themes/default/info.json

@@ -7,5 +7,6 @@
     "website": "http://data.gouv.fr",
     "license": "WTF",
     "version": "0.1.0",
+    "pkg_version": "udata",
     "doctype": "html5"
 }