(maybe) add purge action

Author: JacobCoffee

.github/workflows/purge-cache.yml

@@ -0,0 +1,28 @@
+name: Purge Fastly Cache
+
+on:
+  push:
+    branches: [main]
+    paths: ['static/**', 'templates/**', '**/templates/**']
+  workflow_dispatch:
+    inputs:
+      target:
+        description: 'Surrogate key to purge'
+        required: true
+        default: 'pydotorg-app'
+        type: choice
+        options: [pydotorg-app, downloads, events, sponsors, jobs]
+
+permissions: {}
+
+jobs:
+  purge:
+    runs-on: ubuntu-latest
+    env:
+      KEY: ${{ inputs.target || 'pydotorg-app' }}
+    steps:
+      - name: Purge ${{ env.KEY }}
+        run: |
+          curl -fsS -X POST \
+            "https://api.fastly.com/service/${{ secrets.FASTLY_SERVICE_ID }}/purge/${{ env.KEY }}" \
+            -H "Fastly-Key: ${{ secrets.FASTLY_API_KEY }}"

apps/downloads/models.py

@@ -290,9 +290,10 @@ def promote_latest_release(sender, instance, **kwargs):
 def purge_fastly_download_pages(sender, instance, **kwargs):
     """Purge Fastly caches so new Downloads show up more quickly.
 
-    Uses surrogate key purging to clear ALL pages under /downloads/ in one request,
-    including dynamically added pages like /downloads/android/, /downloads/ios/, etc.
-    Falls back to individual URL purges if surrogate key purging is not configured.
+    Uses surrogate key purging to attempt to clear ALL pages under /downloads/
+    in one request, including dynamically added pages like /downloads/android/,
+    /downloads/ios/, etc. Independently purges a set of specific non-/downloads/
+    URLs via individual URL purges.
     """
     # Don't purge on fixture loads
     if kwargs.get("raw", False):

fastly/utils.py

@@ -22,8 +22,7 @@ def purge_url(path):
 
 
 def purge_surrogate_key(key):
-    """
-    Purge all Fastly cached content tagged with a surrogate key.
+    """Purge all Fastly cached content tagged with a surrogate key.
 
     Common keys (set by GlobalSurrogateKey middleware):
         - 'pydotorg-app': Purges entire site
@@ -37,13 +36,13 @@ def purge_surrogate_key(key):
     if settings.DEBUG:
         return None
 
-    api_key = getattr(settings, 'FASTLY_API_KEY', None)
-    service_id = getattr(settings, 'FASTLY_SERVICE_ID', None)
+    api_key = getattr(settings, "FASTLY_API_KEY", None)
+    service_id = getattr(settings, "FASTLY_SERVICE_ID", None)
     if not api_key or not service_id:
         return None
 
-    response = requests.post(
-        f'https://api.fastly.com/service/{service_id}/purge/{key}',
-        headers={'Fastly-Key': api_key},
+    return requests.post(
+        f"https://api.fastly.com/service/{service_id}/purge/{key}",
+        headers={"Fastly-Key": api_key},
+        timeout=30,
     )
-    return response

pydotorg/middleware.py

@@ -29,14 +29,15 @@ def __init__(self, get_response):
         """Store the get_response callable."""
         self.get_response = get_response
 
-    def _get_section_key(self, path):
+    def get_section_key(self, path):
         """Extract section surrogate key from URL path.
 
         Examples:
             /downloads/ -> downloads
             /downloads/release/python-3141/ -> downloads
             /events/python-events/ -> events
             / -> None
+
         """
         parts = path.strip("/").split("/")
         if parts and parts[0]:
@@ -50,7 +51,7 @@ def __call__(self, request):
         if hasattr(settings, "GLOBAL_SURROGATE_KEY"):
             keys.append(settings.GLOBAL_SURROGATE_KEY)
 
-        section_key = self._get_section_key(request.path)
+        section_key = self.get_section_key(request.path)
         if section_key:
             keys.append(section_key)
 

pydotorg/tests/test_middleware.py

@@ -26,21 +26,21 @@ def test_redirects(self):
 
 
 class GlobalSurrogateKeyTests(TestCase):
-    def test_get_section_key(self):
+    def testget_section_key(self):
         """Test section key extraction from URL paths."""
-        middleware = GlobalSurrogateKey(lambda r: None)
+        middleware = GlobalSurrogateKey(lambda _: None)
 
-        self.assertEqual(middleware._get_section_key("/downloads/"), "downloads")
-        self.assertEqual(middleware._get_section_key("/downloads/release/python-3141/"), "downloads")
-        self.assertEqual(middleware._get_section_key("/events/"), "events")
-        self.assertEqual(middleware._get_section_key("/events/python-events/123/"), "events")
-        self.assertEqual(middleware._get_section_key("/sponsors/"), "sponsors")
+        self.assertEqual(middleware.get_section_key("/downloads/"), "downloads")
+        self.assertEqual(middleware.get_section_key("/downloads/release/python-3141/"), "downloads")
+        self.assertEqual(middleware.get_section_key("/events/"), "events")
+        self.assertEqual(middleware.get_section_key("/events/python-events/123/"), "events")
+        self.assertEqual(middleware.get_section_key("/sponsors/"), "sponsors")
 
-        #  returns None
-        self.assertIsNone(middleware._get_section_key("/"))
+        # returns None
+        self.assertIsNone(middleware.get_section_key("/"))
 
-        self.assertEqual(middleware._get_section_key("/downloads"), "downloads")
-        self.assertEqual(middleware._get_section_key("downloads/"), "downloads")
+        self.assertEqual(middleware.get_section_key("/downloads"), "downloads")
+        self.assertEqual(middleware.get_section_key("downloads/"), "downloads")
 
     @override_settings(GLOBAL_SURROGATE_KEY="pydotorg-app")
     def test_surrogate_key_header_includes_section(self):
@@ -58,4 +58,4 @@ def test_surrogate_key_header_homepage(self):
         response = self.client.get("/")
         self.assertTrue(response.has_header("Surrogate-Key"))
         surrogate_key = response["Surrogate-Key"]
-        self.assertIn("pydotorg-app", surrogate_key)
+        self.assertEqual(surrogate_key, "pydotorg-app")