Refactor purge_url() (#1340)

* Allow multiple URLs to be purged at once.
* Use urllib.parse.urljoin() instead of format so the paths can
  omit the leading slash.
* Use a request session to purge URLs. This should reduce the
  overhead of opening up a connection for each URL to purge.
* Rename purge_url() to purge_urls().

Author: jaap3

downloads/models.py

@@ -12,7 +12,7 @@
 
 from boxes.models import Box
 from cms.models import ContentManageable, NameSlugModel
-from fastly.utils import purge_url
+from fastly.utils import purge_urls
 from pages.models import Page
 
 from .managers import ReleaseManager
@@ -242,21 +242,23 @@ def purge_fastly_download_pages(sender, instance, **kwargs):
 
     # Only purge on published instances
     if instance.is_published:
-        # Purge our common pages
-        purge_url('/downloads/')
-        purge_url('/downloads/latest/python2/')
-        purge_url('/downloads/latest/python3/')
-        purge_url('/downloads/mac-osx/')
-        purge_url('/downloads/source/')
-        purge_url('/downloads/windows/')
+        purge_urls(
+            # Purge our common pages
+            '/downloads/',
+            '/downloads/latest/python2/',
+            '/downloads/latest/python3/',
+            '/downloads/mac-osx/',
+            '/downloads/source/',
+            '/downloads/windows/',
+            # See issue #584 for details
+            '/box/supernav-python-downloads/',
+            '/box/homepage-downloads/',
+            '/box/download-sources/',
+            # Purge the release page itself
+            instance.get_absolute_url(),
+        )
         if instance.get_version() is not None:
-            purge_url('/ftp/python/{}/'.format(instance.get_version()))
-        # See issue #584 for details
-        purge_url('/box/supernav-python-downloads/')
-        purge_url('/box/homepage-downloads/')
-        purge_url('/box/download-sources/')
-        # Purge the release page itself
-        purge_url(instance.get_absolute_url())
+            purge_urls('/ftp/python/{}/'.format(instance.get_version()))
 
 
 @receiver(post_save, sender=Release)

fastly/utils.py

@@ -1,22 +1,20 @@
+import urllib.parse
+
 import requests
 
 from django.conf import settings
 
 
-def purge_url(path):
+def purge_urls(*paths):
     """
-    Purge a Fastly.com URL given a path. path argument must begin with a slash
+    Purge Fastly cache for each given path.
     """
-    if settings.DEBUG:
-        return
-
     api_key = getattr(settings, 'FASTLY_API_KEY', None)
-    if api_key:
-        response = requests.request(
-            'PURGE',
-            'https://www.python.org{}'.format(path),
-            headers={'Fastly-Key': api_key},
-        )
-        return response
+    if not api_key or settings.DEBUG:
+        return
 
-    return None
+    with requests.session() as session:
+        session.headers['Fastly-Key'] = api_key
+        for path in paths:
+            url = urllib.parse.urljoin('https://www.python.org', path)
+            session.request('PURGE', url)

jobs/models.py

@@ -11,7 +11,7 @@
 from markupfield.fields import MarkupField
 
 from cms.models import ContentManageable, NameSlugModel
-from fastly.utils import purge_url
+from fastly.utils import purge_urls
 
 from .managers import JobQuerySet, JobTypeQuerySet, JobCategoryQuerySet
 from .signals import (
@@ -263,6 +263,8 @@ def purge_fastly_cache(sender, instance, **kwargs):
         return
 
     if instance.status == Job.STATUS_APPROVED:
-        purge_url(reverse('jobs:job_detail', kwargs={'pk': instance.pk}))
-        purge_url(reverse('jobs:job_list'))
-        purge_url(reverse('jobs:job_rss'))
+        purge_urls(
+            reverse('jobs:job_detail', kwargs={'pk': instance.pk}),
+            reverse('jobs:job_list'),
+            reverse('jobs:job_rss'),
+        )

pages/models.py

@@ -18,7 +18,7 @@
 from markupfield.fields import MarkupField
 
 from cms.models import ContentManageable
-from fastly.utils import purge_url
+from fastly.utils import purge_urls
 
 from .managers import PageQuerySet
 
@@ -86,7 +86,7 @@ def purge_fastly_cache(sender, instance, **kwargs):
     Purge fastly.com cache if in production and the page is published.
     Requires settings.FASTLY_API_KEY being set
     """
-    purge_url('/{}'.format(instance.path))
+    purge_urls(instance.path)
 
 
 def page_image_path(instance, filename):

successstories/models.py

@@ -14,7 +14,7 @@
 from boxes.models import Box
 from cms.models import ContentManageable, NameSlugModel
 from companies.models import Company
-from fastly.utils import purge_url
+from fastly.utils import purge_urls
 
 
 PSF_TO_EMAILS = ['[email protected]']
@@ -109,11 +109,11 @@ def update_successstories_supernav(sender, instance, created, **kwargs):
         )
 
         # Purge Fastly cache
-        purge_url('/box/supernav-python-success-stories/')
+        purge_urls('/box/supernav-python-success-stories/')
 
     if instance.is_published:
         # Purge the page itself
-        purge_url(instance.get_absolute_url())
+        purge_urls(instance.get_absolute_url())
 
 
 @receiver(post_save, sender=Story)