Proxito: redirect to main project from subprojects (#8187)

Closes #7881
We can revert #7880
after releasing this.

Author: stsewd

readthedocs/proxito/middleware.py

@@ -6,16 +6,16 @@
 Additional processing is done to get the project from the URL in the ``views.py`` as well.
 """
 import logging
-import sys
 import re
+import sys
 from urllib.parse import urlparse
 
 from django.conf import settings
-from django.shortcuts import render, redirect
-from django.utils.deprecation import MiddlewareMixin
+from django.shortcuts import redirect, render
 from django.urls import reverse
+from django.utils.deprecation import MiddlewareMixin
 
-from readthedocs.projects.models import Domain, Project
+from readthedocs.projects.models import Domain, Project, ProjectRelationship
 
 log = logging.getLogger(__name__)  # noqa
 
@@ -66,6 +66,12 @@ def map_host_to_project_slug(request):  # pylint: disable=too-many-return-statem
             ).exists():
                 log.debug('Proxito Public Domain -> Canonical Domain Redirect: host=%s', host)
                 request.canonicalize = 'canonical-cname'
+            elif (
+                ProjectRelationship.objects.
+                filter(child__slug=project_slug).exists()
+            ):
+                log.debug('Proxito Public Domain -> Subproject Main Domain Redirect: host=%s', host)
+                request.canonicalize = 'subproject-main-domain'
             return project_slug
 
         # TODO: This can catch some possibly valid domains (docs.readthedocs.io.com) for example

readthedocs/proxito/tests/test_middleware.py

@@ -73,6 +73,42 @@ def test_canonical_cname_redirect(self):
             self.assertTrue(hasattr(request, 'canonicalize'))
             self.assertEqual(request.canonicalize, 'canonical-cname')
 
+    def test_subproject_redirect(self):
+        """Requests to a subproject should redirect to the domain of the main project."""
+        subproject = get(
+            Project,
+            name='subproject',
+            slug='subproject',
+            users=[self.owner],
+            privacy_level=PUBLIC,
+        )
+        subproject.versions.update(privacy_level=PUBLIC)
+        get(
+            ProjectRelationship,
+            parent=self.pip,
+            child=subproject,
+        )
+
+        for url in (self.url, '/subdir/', '/en/latest/'):
+            request = self.request(url, HTTP_HOST='subproject.dev.readthedocs.io')
+            res = self.run_middleware(request)
+            self.assertIsNone(res)
+            self.assertEqual(getattr(request, 'canonicalize', None), 'subproject-main-domain')
+
+        # Using a custom domain in a subproject isn't supported (or shouldn't be!).
+        cname = 'docs.random.com'
+        domain = get(
+            Domain,
+            project=subproject,
+            domain=cname,
+            canonical=True,
+            https=True,
+        )
+        request = self.request(self.url, HTTP_HOST='subproject.dev.readthedocs.io')
+        res = self.run_middleware(request)
+        self.assertIsNone(res)
+        self.assertEqual(getattr(request, 'canonicalize', None), 'canonical-cname')
+
     # We are not canonicalizing custom domains -> public domain for now
     @pytest.mark.xfail(strict=True)
     def test_canonical_cname_redirect_public_domain(self):

readthedocs/proxito/tests/test_redirects.py

@@ -55,6 +55,57 @@ def test_single_version_subproject_root_url_no_slash(self):
             r['Location'], 'https://project.dev.readthedocs.io/projects/subproject/',
         )
 
+    def test_subproject_redirect(self):
+        r = self.client.get('/', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://project.dev.readthedocs.io/projects/subproject/en/latest/',
+        )
+
+        r = self.client.get('/en/latest/', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://project.dev.readthedocs.io/projects/subproject/en/latest/',
+        )
+
+        r = self.client.get('/en/latest/foo/bar', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://project.dev.readthedocs.io/projects/subproject/en/latest/foo/bar',
+        )
+
+        self.domain.canonical = True
+        self.domain.save()
+        r = self.client.get('/en/latest/foo/bar', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://docs1.example.com/projects/subproject/en/latest/foo/bar',
+        )
+
+    def test_single_version_subproject_redirect(self):
+        self.subproject.single_version = True
+        self.subproject.save()
+
+        r = self.client.get('/', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://project.dev.readthedocs.io/projects/subproject/',
+        )
+
+        r = self.client.get('/foo/bar/', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://project.dev.readthedocs.io/projects/subproject/foo/bar/',
+        )
+
+        self.domain.canonical = True
+        self.domain.save()
+        r = self.client.get('/foo/bar', HTTP_HOST='subproject.dev.readthedocs.io')
+        self.assertEqual(r.status_code, 302)
+        self.assertEqual(
+            r['Location'], 'https://docs1.example.com/projects/subproject/foo/bar',
+        )
+
     def test_root_redirect_with_query_params(self):
         r = self.client.get('/?foo=bar', HTTP_HOST='project.dev.readthedocs.io')
         self.assertEqual(r.status_code, 302)

readthedocs/rtd_tests/tests/test_footer.py

@@ -7,15 +7,12 @@
 from django_dynamic_fixture import get
 from rest_framework.test import APIRequestFactory
 
-from readthedocs.api.v2.views.footer_views import (
-    FooterHTML,
-    get_version_compare_data,
-)
+from readthedocs.api.v2.views.footer_views import get_version_compare_data
 from readthedocs.builds.constants import BRANCH, EXTERNAL, LATEST, TAG
 from readthedocs.builds.models import Version
 from readthedocs.core.middleware import ReadTheDocsSessionMiddleware
 from readthedocs.projects.constants import PUBLIC
-from readthedocs.projects.models import Feature, Project
+from readthedocs.projects.models import Project
 
 
 class BaseTestFooterHTML:
@@ -427,7 +424,7 @@ def test_highest_version_without_tags(self):
 class TestFooterPerformance(TestCase):
     # The expected number of queries for generating the footer
     # This shouldn't increase unless we modify the footer API
-    EXPECTED_QUERIES = 14
+    EXPECTED_QUERIES = 15
 
     def setUp(self):
         self.pip = get(
@@ -485,7 +482,6 @@ def test_domain_queries(self):
             canonical=True,
         )
 
-        # Setting up a custom domain increases only one query.
-        with self.assertNumQueries(self.EXPECTED_QUERIES + 1):
+        with self.assertNumQueries(self.EXPECTED_QUERIES):
             response = self.client.get(self.url, HTTP_HOST=domain)
             self.assertContains(response, domain)