Cache Django.js views and introduce settings.JS_CACHE_DURATION

noirbizarre · noirbizarre · commit 757ccd70b626 · 2013-07-29T10:28:26.000+02:00
diff --git a/djangojs/conf.py b/djangojs/conf.py
@@ -26,6 +26,7 @@
     'JS_I18N_APPS': None,
     'JS_I18N_APPS_EXCLUDE': None,
     'JS_I18N_PATTERNS': tuple(),
+    'JS_CACHE_DURATION': 24 * 60,
     'JQUERY_VERSION': JQUERY_DEFAULT_VERSION,
 }
 
diff --git a/djangojs/tests/test_urls.py b/djangojs/tests/test_urls.py
@@ -1,5 +1,6 @@
 import json
 
+from django.core.cache import cache
 from django.core.urlresolvers import reverse
 from django.test import TestCase
 from django.test.utils import override_settings
@@ -11,6 +12,7 @@ class UrlsTestMixin(object):
 
     def setUp(self):
         self.result = self.get_result()
+        cache.clear()
 
     def test_simple_url(self):
         '''It should serialize a simple URL without parameters'''
diff --git a/djangojs/views.py b/djangojs/views.py
@@ -9,12 +9,15 @@
 import re
 
 from django.http import HttpResponse
+from django.utils.cache import patch_vary_headers
+from django.views.decorators.cache import cache_page
 from django.views.generic import View, TemplateView
 
 from djangojs.conf import settings
 from djangojs.urls_serializer import urls_as_dict, urls_as_json
 from djangojs.utils import StorageGlobber, LazyJsonEncoder, class_from_string
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -37,7 +40,21 @@
 JAVASCRIPT_MIMETYPE = 'application/javascript'
 
 
-class JsInitView(TemplateView):
+class CacheMixin(object):
+    '''Apply a JS_CACHE_DURATION to the view'''
+    def dispatch(self, *args, **kwargs):
+        cache = cache_page(60 * settings.JS_CACHE_DURATION)
+        return cache(super(CacheMixin, self).dispatch)(*args, **kwargs)
+
+
+class UserCacheMixin(CacheMixin):
+    def dispatch(self, *args, **kwargs):
+        response = super(UserCacheMixin, self).dispatch(*args, **kwargs)
+        patch_vary_headers(response, ('Cookie',))
+        return response
+
+
+class JsInitView(UserCacheMixin, TemplateView):
     '''
     Render a javascript file containing the URLs mapping and the context as JSON.
     '''
@@ -67,15 +84,15 @@ def get(self, request, **kwargs):
         )
 
 
-class UrlsJsonView(JsonView):
+class UrlsJsonView(CacheMixin, JsonView):
     '''
     Render the URLs as a JSON object.
     '''
     def get_context_data(self, **kwargs):
         return urls_as_dict()
 
 
-class ContextJsonView(JsonView):
+class ContextJsonView(UserCacheMixin, JsonView):
     '''
     Render the context as a JSON object.
     '''
diff --git a/doc/settings.rst b/doc/settings.rst
@@ -190,6 +190,17 @@ pattern
     )
 
 
+Cache management
+~~~~~~~~~~~~~~~~
+
+``JS_CACHE_DURATION``
+---------------------
+
+**Default**: ``24 * 60`` (24 hours)
+
+Django.js urls and context cache duration in minutes.
+
+
 Usage exemple
 -------------
 

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`'JS_I18N_APPS': None,`
`27`	`27`	`'JS_I18N_APPS_EXCLUDE': None,`
`28`	`28`	`'JS_I18N_PATTERNS': tuple(),`
	`29`	`+ 'JS_CACHE_DURATION': 24 * 60,`
`29`	`30`	`'JQUERY_VERSION': JQUERY_DEFAULT_VERSION,`
`30`	`31`	`}`
`31`	`32`