Merge tag '4.0.2' into rel

Author: ericholscher

CHANGELOG.rst

@@ -1,3 +1,13 @@
+Version 4.0.2
+-------------
+
+:Date: March 04, 2020
+
+* `@ericholscher <https://github.com/ericholscher>`__: Don't call virtualenv with `--no-site-packages` (`#6738 <https://github.com/readthedocs/readthedocs.org/pull/6738>`__)
+* `@stsewd <https://github.com/stsewd>`__: Catch ConnectionError from request on api timing out (`#6735 <https://github.com/readthedocs/readthedocs.org/pull/6735>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Release 4.0.1 (`#6733 <https://github.com/readthedocs/readthedocs.org/pull/6733>`__)
+* `@humitos <https://github.com/humitos>`__: Improve Proxito 404 handler to render user-facing Maze when needed (`#6726 <https://github.com/readthedocs/readthedocs.org/pull/6726>`__)
+
 Version 4.0.1
 -------------
 

readthedocs/doc_builder/backends/sphinx.py

@@ -15,7 +15,7 @@
 from django.conf import settings
 from django.template import loader as template_loader
 from django.template.loader import render_to_string
-from requests.exceptions import Timeout
+from requests.exceptions import ConnectionError
 
 from readthedocs.api.v2.client import api
 from readthedocs.builds import utils as version_utils
@@ -111,6 +111,9 @@ def get_config_params(self):
         gitlab_version_is_editable = (self.version.type == 'branch')
         display_gitlab = gitlab_user is not None
 
+        versions = []
+        downloads = []
+        subproject_urls = []
         # Avoid hitting database and API if using Docker build environment
         if settings.DONT_HIT_API:
             if self.project.has_feature(Feature.ALL_VERSIONS_IN_HTML_CONTEXT):
@@ -120,9 +123,8 @@ def get_config_params(self):
                     privacy_level=PUBLIC,
                 )
             downloads = self.version.get_downloads(pretty=True)
+            subproject_urls = self.project.get_subproject_urls()
         else:
-            versions = []
-            downloads = []
             try:
                 versions = self.project.api_versions()
                 if not self.project.has_feature(Feature.ALL_VERSIONS_IN_HTML_CONTEXT):
@@ -132,9 +134,10 @@ def get_config_params(self):
                         if v.privacy_level == PUBLIC
                     ]
                 downloads = api.version(self.version.pk).get()['downloads']
-            except Timeout:
+                subproject_urls = self.project.get_subproject_urls()
+            except ConnectionError:
                 log.exception(
-                    'Timeout while fetching versions and downloads for Sphinx context. '
+                    'Timeout while fetching versions/downloads/subproject_urls for Sphinx context. '
                     'project: %s version: %s',
                     self.project.slug, self.version.slug,
                 )
@@ -152,6 +155,7 @@ def get_config_params(self):
             'commit': self.project.vcs_repo(self.version.slug).commit,
             'versions': versions,
             'downloads': downloads,
+            'subproject_urls': subproject_urls,
 
             # GitHub
             'github_user': github_user,

readthedocs/doc_builder/python_environments.py

@@ -290,7 +290,7 @@ def venv_path(self):
         return os.path.join(self.project.doc_path, 'envs', self.version.slug)
 
     def setup_base(self):
-        site_packages = '--no-site-packages'
+        site_packages = ''
         if self.config.python.use_system_site_packages:
             site_packages = '--system-site-packages'
         env_path = self.venv_path()

readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

@@ -84,7 +84,7 @@ context = {
     'downloads': [ {% for key, val in downloads.items %}
     ("{{ key }}", "{{ val }}"),{% endfor %}
     ],
-    'subprojects': [ {% for slug, url in project.get_subproject_urls %}
+    'subprojects': [ {% for slug, url in subproject_urls %}
         ("{{ slug }}", "{{ url }}"),{% endfor %}
     ],
     'slug': '{{ project.slug }}',

readthedocs/proxito/tests/test_old_redirects.py

@@ -11,6 +11,7 @@
 
 import django_dynamic_fixture as fixture
 import pytest
+from django.http import Http404
 from django.urls import reverse
 from django.test.utils import override_settings
 
@@ -201,11 +202,11 @@ def test_redirect_prefix_infinite(self):
             'http://project.dev.readthedocs.io/en/latest/redirect/',
         )
 
-        r = self.client.get(
-            '/en/latest/redirect/',
-            HTTP_HOST='project.dev.readthedocs.io',
-        )
-        self.assertEqual(r.status_code, 404)
+        with self.assertRaises(Http404):
+            r = self.client.get(
+                '/en/latest/redirect/',
+                HTTP_HOST='project.dev.readthedocs.io',
+            )
 
 
     def test_redirect_root(self):
@@ -461,12 +462,12 @@ def test_redirect_html_root_index(self):
             )
 
         with override_settings(PYTHON_MEDIA=True):
-            # File does not exist in storage media
-            r = self.client.get(
-                '/en/latest/',
-                HTTP_HOST='project.dev.readthedocs.io',
-            )
-            self.assertEqual(r.status_code, 404)
+            with self.assertRaises(Http404):
+                # File does not exist in storage media
+                r = self.client.get(
+                    '/en/latest/',
+                    HTTP_HOST='project.dev.readthedocs.io',
+                )
 
     def test_redirect_html_index(self):
         fixture.get(
@@ -526,20 +527,12 @@ def test_not_found_page_without_trailing_slash(self):
             from_url='/',
         )
 
-        # Use ``proxito_404_handler`` URL here to emulate the internal redirect
-        # that happens on NGINX (URL path will be
-        # http://project.dev.readthedocs.io/_proxito_404_/en/latest/section/file-not-found
-        # when the view receives it)
-        r = self.client.get(
-            reverse(
-                'proxito_404_handler',
-                kwargs={
-                    'proxito_path': '/en/latest/section/file-not-found',
-                }),
-            HTTP_HOST='project.dev.readthedocs.io',
-        )
-        # Avoid infinite redirect
-        self.assertEqual(r.status_code, 404)
+        with self.assertRaises(Http404):
+            # Avoid infinite redirect
+            r = self.client.get(
+                '/en/latest/section/file-not-found',
+                HTTP_HOST='project.dev.readthedocs.io',
+            )
 
 
 # FIXME: these tests are valid, but the problem I'm facing is that the request

readthedocs/proxito/urls.py

@@ -42,7 +42,7 @@
     ServeRobotsTXT,
     ServeSitemapXML,
 )
-from readthedocs.proxito.views.utils import fast_404
+from readthedocs.proxito.views.utils import proxito_404_page_handler, fast_404
 
 DOC_PATH_PREFIX = getattr(settings, 'DOC_PATH_PREFIX', '')
 
@@ -144,5 +144,5 @@
 ]
 
 # Use Django default error handlers to make things simpler
-handler404 = fast_404
+handler404 = proxito_404_page_handler
 handler500 = defaults.server_error

readthedocs/proxito/views/serve.py

@@ -277,10 +277,7 @@ def get(self, request, proxito_path, template_name='404.html'):
                     resp.status_code = 404
                     return resp
 
-        # Finally, return the default 404 page generated by Read the Docs
-        resp = render(request, template_name)
-        resp.status_code = 404
-        return resp
+        raise Http404('No custom 404 page found.')
 
 
 class ServeError404(SettingsOverrideObject):

readthedocs/proxito/views/utils.py

@@ -2,7 +2,7 @@
 import logging
 
 from django.http import HttpResponse
-from django.shortcuts import get_object_or_404
+from django.shortcuts import get_object_or_404, render
 
 from .decorators import map_project_slug, map_subproject_slug
 
@@ -19,6 +19,24 @@ def fast_404(request, *args, **kwargs):
     return HttpResponse('Not Found.', status=404)
 
 
+def proxito_404_page_handler(request, exception=None, template_name='404.html'):
+    """
+    Decide what 404 page return depending if it's an internal NGINX redirect.
+
+    We want to return fast when the 404 is used as an internal NGINX redirect to
+    reach our ``ServeError404`` view. However, if the 404 exception was risen
+    inside ``ServeError404`` view, we want to render the default Read the Docs
+    Maze page.
+    """
+
+    if request.resolver_match.url_name != 'proxito_404_handler':
+        return fast_404(request, exception, template_name)
+
+    resp = render(request, template_name)
+    resp.status_code = 404
+    return resp
+
+
 @map_project_slug
 @map_subproject_slug
 def _get_project_data_from_request(

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = readthedocs
-version = 4.0.1
+version = 4.0.2
 license = MIT
 description = Read the Docs builds and hosts documentation
 author = Read the Docs, Inc