Disable keyring by default, add setting to enable (#83)

Co-authored-by: Vince Salvino <[email protected]>

Author: jonatron

ci/compare-codecov.ps1

@@ -39,10 +39,12 @@ $ApiBase = "https://dev.azure.com/$org/$project"
 
 # ---- GET CODE COVERAGE FROM RECENT BUILD -------------------------------------
 
+$mainBuildUrl = "$ApiBase/_apis/build/builds?branchName=refs/heads/main&api-version=5.1"
+Write-Host "mainBuildUrl: $mainBuildUrl"
 
 # Get list of all recent builds.
 $mainBuildJson = (
-    Invoke-WebRequest "$ApiBase/_apis/build/builds?branchName=refs/heads/main&api-version=5.1"
+    Invoke-WebRequest "$mainBuildUrl"
 ).Content | ConvertFrom-Json
 
 # Get the latest matching build ID from the list of builds.
@@ -53,9 +55,17 @@ foreach ($build in $mainBuildJson.value) {
     }
 }
 
+$mainCoverageUrl = "$ApiBase/_apis/test/codecoverage?buildId=$mainLatestId&flags=7&api-version=7.1"
+Write-Host "mainCoverageUrl: $mainCoverageUrl"
+
+if($mainLatestId -eq $null) {
+    Write-Host "No main coverage, build may have been cleaned up"
+    exit 0
+}
+
 # Retrieve code coverage for this build ID.
 $mainCoverageJson = (
-    Invoke-WebRequest "$ApiBase/_apis/test/codecoverage?buildId=$mainLatestId&flags=7&api-version=7.1-preview.1"
+    Invoke-WebRequest $mainCoverageUrl
 ).Content | ConvertFrom-Json
 foreach ($cov in $mainCoverageJson.coverageData.coverageStats) {
     if ($cov.label -eq "Lines") {

docs/getting_started/django_settings.rst

@@ -100,3 +100,14 @@ own unique page in the cache, set this value to ``None`` or ``[]``.
 If you feel as though the spammers have won, and want the nuclear option, you
 can set this to ``[r".*"]`` which will ignore all querystrings. This is surely
 a terrible idea, but it can be done.
+
+WAGTAIL_CACHE_KEYRING
+---------------------
+
+.. versionadded:: 3.0
+
+Set to ``True`` to enable the keyring, which allows you to purge specific URLs. Defaults to ``False``.
+
+.. note::
+
+   Enabling the keyring will reduce the performance of the cache. Only enable this if you need to purge specific URLs before they are set to expire.

docs/getting_started/usage.rst

@@ -52,6 +52,8 @@ publishing a page. To accomplish this, use a Wagtail hook as so
 Purge specific URLs
 -------------------
 
+Requires ``WAGTAIL_CACHE_KEYRING=True``
+
 Sometimes you only want to delete specific pages in the cache automatically
 after publishing a page. To achieve this, use a Wagtail hook as follows
 

testproject/home/tests.py

@@ -538,6 +538,7 @@ def test_admin_clearcache(self):
 
     # ---- PURGE SPECIFIC URLS & CLEAR ALL--------------------------------------
 
+    @override_settings(WAGTAIL_CACHE_KEYRING=True)
     def test_cache_keyring(self):
         # Check if keyring is not present
         self.assertEqual(self.cache.get("keyring"), None)
@@ -549,7 +550,9 @@ def test_cache_keyring(self):
         # Compare Keys
         self.assertEqual(key, url)
 
-    @override_settings(WAGTAIL_CACHE_BACKEND="one_second")
+    @override_settings(
+        WAGTAIL_CACHE_BACKEND="one_second", WAGTAIL_CACHE_KEYRING=True
+    )
     def test_cache_keyring_no_uri_key_duplication(self):
         # First get to populate keyring
         self.get_miss(self.page_cachedpage.get_url())
@@ -576,6 +579,7 @@ def test_clear_cache(self):
         # Now the page should miss cache.
         self.get_miss(self.page_cachedpage.get_url())
 
+    @override_settings(WAGTAIL_CACHE_KEYRING=True)
     def test_clear_cache_url(self):
         u1 = self.page_cachedpage.get_url()
         u2 = self.page_cachedpage.get_url() + "?action=pytest"

wagtailcache/cache.py

@@ -343,15 +343,18 @@ def process_response(
                 # (of the chopped request, not the real one).
                 cr = _chop_querystring(request)
                 uri = unquote(cr.build_absolute_uri())
-                keyring = self._wagcache.get("keyring", {})
-                # Get current cache keys belonging to this URI.
-                # This should be a list of keys.
-                uri_keys: List[str] = keyring.get(uri, [])
-                # Append the key to this list if not already present and save.
-                if cache_key not in uri_keys:
-                    uri_keys.append(cache_key)
-                    keyring[uri] = uri_keys
-                    self._wagcache.set("keyring", keyring)
+
+                if wagtailcache_settings.WAGTAIL_CACHE_KEYRING:
+                    keyring = self._wagcache.get("keyring", {})
+                    # Get current cache keys belonging to this URI.
+                    # This should be a list of keys.
+                    uri_keys: List[str] = keyring.get(uri, [])
+                    # Append the key to this list if not already present and save.
+                    if cache_key not in uri_keys:
+                        uri_keys.append(cache_key)
+                        keyring[uri] = uri_keys
+                        self._wagcache.set("keyring", keyring)
+
                 if isinstance(response, SimpleTemplateResponse):
 
                     def callback(r):
@@ -382,7 +385,11 @@ def clear_cache(urls: List[str] = []) -> None:
         return
 
     _wagcache = caches[wagtailcache_settings.WAGTAIL_CACHE_BACKEND]
-    if urls and "keyring" in _wagcache:
+    if (
+        urls
+        and wagtailcache_settings.WAGTAIL_CACHE_KEYRING
+        and "keyring" in _wagcache
+    ):
         keyring = _wagcache.get("keyring")
         # Check the provided URL matches a key in our keyring.
         matched_urls = []

wagtailcache/settings.py

@@ -34,6 +34,7 @@ class _DefaultSettings:
         r"^trk_.*$",  # Listrak
         r"^utm_.*$",  # Google Analytics
     ]
+    WAGTAIL_CACHE_KEYRING = False
 
     def __getattribute__(self, attr: Text):
         # First load from Django settings.

wagtailcache/templates/wagtailcache/index.html

@@ -33,25 +33,27 @@ <h2>{% trans "Status" %}</h2>
       {% trans "Clear cache" %}
     </a>
   </p>
-  <br>
-  <h2>{% trans "Contents" %}</h2>
-  <p>{% trans "Number of URLs in the cache:" %} <b>{{ keyring|length }}</b></p>
-  <p>
-    {% trans "Below is each URL and the cache key for each response of that URL that is currently in the cache." %}
-    {% trans "Note that 301/302 redirects and 404s may also be cached." %}
-  </p>
-  <ul class="wagcache-pagelist">
-    {% for url, entries in keyring.items %}
-    <li>
-      {{ url }}
-      <ul>
-        {% for entry in entries %}
-        <li>{{ entry }}</li>
-        {% endfor %}
-      </ul>
-    </li>
-    {% endfor %}
-  </ul>
+  {% if 'WAGTAIL_CACHE_KEYRING'|get_wagtailcache_setting %}
+    <br>
+    <h2>{% trans "Contents" %}</h2>
+    <p>{% trans "Number of URLs in the cache:" %} <b>{{ keyring|length }}</b></p>
+    <p>
+      {% trans "Below is each URL and the cache key for each response of that URL that is currently in the cache." %}
+      {% trans "Note that 301/302 redirects and 404s may also be cached." %}
+    </p>
+    <ul class="wagcache-pagelist">
+      {% for url, entries in keyring.items %}
+      <li>
+        {{ url }}
+        <ul>
+          {% for entry in entries %}
+          <li>{{ entry }}</li>
+          {% endfor %}
+        </ul>
+      </li>
+      {% endfor %}
+    </ul>
+  {% endif %}
   {% else %}
   <p>
     <b>{% trans "DISABLED" %}</b>