Add SEO_JS_PRERENDER_TIMEOUT functionality

AUTHORS

@@ -5,4 +5,5 @@ denisvlr - https://github.com/denisvlr
 mattrobenolt - https://github.com/mattrobenolt
 thoop - https://github.com/thoop
 rchrd2 - https://github.com/rchrd2
-chazcb - https://github.com/chazcb
+chazcb - https://github.com/chazcb
+clifff - https://github.com/clifff

README.md

@@ -110,6 +110,9 @@ To use [prerender.io](http://prerender.io),
 ```python
 # Prerender.io token
 SEO_JS_PRERENDER_TOKEN = "123456789abcdefghijkl"
+
+# Optional timeout option (following requests timeout format)
+SEO_JS_PRERENDER_TIMEOUT = (5,5)
 ```
 
 You don't need to set `SEO_JS_BACKEND`, since it defaults to `"django_seo_js.backends.PrerenderIO"`.

django_seo_js/backends/base.py

@@ -68,3 +68,8 @@ def build_django_response_from_requests_response(self, response):
         r['content-length'] = len(response.content)
         r.status_code = response.status_code
         return r
+
+    def build_request_timeout_response(self):
+        r = HttpResponse()
+        r.status_code = 408
+        return r

django_seo_js/backends/prerender.py

@@ -1,5 +1,6 @@
 from django_seo_js import settings
 from base import SEOBackendBase, RequestsBasedBackend
+import requests
 
 
 class PrerenderIO(SEOBackendBase, RequestsBasedBackend):
@@ -16,6 +17,11 @@ def _get_token(self):
             raise ValueError("Missing SEO_JS_PRERENDER_TOKEN in settings.")
         return settings.PRERENDER_TOKEN
 
+    def _request_kwargs(self, kwargs):
+        if settings.PRERENDER_TIMEOUT is not False:
+            kwargs['timeout'] = settings.PRERENDER_TIMEOUT
+        return kwargs
+
     def get_response_for_url(self, url):
         """
         Accepts a fully-qualified url.
@@ -29,10 +35,17 @@ def get_response_for_url(self, url):
         headers = {
             'X-Prerender-Token': self.token,
         }
-        r = self.session.get(render_url, headers=headers, allow_redirects=False)
-        assert r.status_code < 500
+        get_options = {
+            'headers': headers,
+            'allow_redirects': False
+        }
 
-        return self.build_django_response_from_requests_response(r)
+        try:
+            r = self.session.get(render_url, **self._request_kwargs(get_options))
+            assert r.status_code < 500
+            return self.build_django_response_from_requests_response(r)
+        except requests.exceptions.Timeout:
+            return self.build_request_timeout_response()
 
     def update_url(self, url=None, regex=None):
         """

django_seo_js/settings.py

@@ -69,5 +69,6 @@
 BACKEND = getattr(django_settings, 'SEO_JS_BACKEND', 'django_seo_js.backends.PrerenderIO')
 
 PRERENDER_TOKEN = getattr(django_settings, 'SEO_JS_PRERENDER_TOKEN', None)
+PRERENDER_TIMEOUT = getattr(django_settings, 'SEO_JS_PRERENDER_TIMEOUT', False)
 PRERENDER_URL = getattr(django_settings, 'SEO_JS_PRERENDER_URL', None)
 PRERENDER_RECACHE_URL = getattr(django_settings, 'SEO_JS_PRERENDER_RECACHE_URL', None)

django_seo_js/tests/backends/test_prerender_io.py

@@ -1,5 +1,7 @@
 from django.test import TestCase
 from httmock import all_requests, HTTMock
+from mock import MagicMock
+import requests
 
 from django_seo_js.tests.utils import override_settings
 from django_seo_js.backends import PrerenderIO
@@ -43,6 +45,23 @@ def test_get_token(self):
         self.assertEqual(self.backend.token, "123124341adfsaf")
 
 
+class PrerenderTimeout(TestCase):
+
+    @override_settings(PRERENDER_TIMEOUT=5)
+    def test_timeout_setting(self):
+        self.backend = PrerenderIO()
+        self.assertEqual(self.backend._request_kwargs({}), {'timeout': 5})
+
+    @override_settings(PRERENDER_TIMEOUT=5)
+    def test_timeout_response(self):
+        self.backend = PrerenderIO()
+        self.backend.session.get = MagicMock(
+            side_effect=requests.exceptions.Timeout()
+        )
+        resp = self.backend.get_response_for_url("http://www.example.com")
+        self.assertEqual(resp.status_code, 408)
+
+
 class PrerenderIOTestMethods(TestCase):
 
     def setUp(self):