Resolver: allow to ignore custom domains (#9089)

This is useful if we want to get all domains this
project can be served from (we have project.domains,
but we are missing the "normal" one).

Specially, I'm going to use this on .com.

Author: stsewd

readthedocs/core/resolver.py

@@ -1,12 +1,12 @@
 """URL resolver for documentation."""
 
-import structlog
 from urllib.parse import urlunparse
 
+import structlog
 from django.conf import settings
 
-from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.builds.constants import EXTERNAL
+from readthedocs.core.utils.extend import SettingsOverrideObject
 
 log = structlog.get_logger(__name__)
 
@@ -152,11 +152,18 @@ def resolve_path(
             urlconf=urlconf or project.urlconf,
         )
 
-    def resolve_domain(self, project):
+    def resolve_domain(self, project, use_canonical_domain=True):
+        """
+        Get the domain from where the documentation of ``project`` is served from.
+
+        :param project: Project object
+        :param bool use_canonical_domain: If `True` use its canonical custom domain if available.
+        """
         canonical_project = self._get_canonical_project(project)
-        domain = canonical_project.get_canonical_custom_domain()
-        if domain:
-            return domain.domain
+        if use_canonical_domain and self._use_cname(canonical_project):
+            domain = canonical_project.get_canonical_custom_domain()
+            if domain:
+                return domain.domain
 
         if self._use_subdomain():
             return self._get_project_subdomain(canonical_project)
@@ -345,6 +352,10 @@ def _use_subdomain(self):
         """Make decision about whether to use a subdomain to serve docs."""
         return settings.USE_SUBDOMAIN and settings.PUBLIC_DOMAIN is not None
 
+    def _use_cname(self, project):
+        """Test if to allow direct serving for project on CNAME."""
+        return True
+
 
 class Resolver(SettingsOverrideObject):
 

readthedocs/projects/models.py

@@ -731,9 +731,9 @@ def alias(self):
         if self.is_subproject:
             return self.superprojects.first().alias
 
-    def subdomain(self):
+    def subdomain(self, use_canonical_domain=True):
         """Get project subdomain from resolver."""
-        return resolve_domain(self)
+        return resolve_domain(self, use_canonical_domain=use_canonical_domain)
 
     def get_downloads(self):
         downloads = {}

readthedocs/rtd_tests/tests/test_resolver.py

@@ -1,16 +1,9 @@
-from unittest import mock
-
 import django_dynamic_fixture as fixture
 import pytest
 from django.test import TestCase, override_settings
 
 from readthedocs.builds.constants import EXTERNAL
-from readthedocs.core.resolver import (
-    Resolver,
-    resolve,
-    resolve_domain,
-    resolve_path,
-)
+from readthedocs.core.resolver import Resolver, resolve, resolve_domain, resolve_path
 from readthedocs.projects.constants import PRIVATE
 from readthedocs.projects.models import Domain, Project, ProjectRelationship
 from readthedocs.rtd_tests.utils import create_user
@@ -359,7 +352,10 @@ def test_domain_resolver(self):
             url = resolve_domain(project=self.pip)
             self.assertEqual(url, 'pip.readthedocs.org')
 
-    @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
+    @override_settings(
+        PRODUCTION_DOMAIN="readthedocs.org",
+        PUBLIC_DOMAIN="readthedocs.io",
+    )
     def test_domain_resolver_with_domain_object(self):
         self.domain = fixture.get(
             Domain,
@@ -374,14 +370,23 @@ def test_domain_resolver_with_domain_object(self):
             url = resolve_domain(project=self.pip)
             self.assertEqual(url, 'docs.foobar.com')
 
-    @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
+            url = resolve_domain(project=self.pip, use_canonical_domain=False)
+            self.assertEqual(url, "pip.readthedocs.io")
+
+    @override_settings(
+        PRODUCTION_DOMAIN="readthedocs.org",
+        PUBLIC_DOMAIN="readthedocs.io",
+    )
     def test_domain_resolver_subproject(self):
         with override_settings(USE_SUBDOMAIN=False):
             url = resolve_domain(project=self.subproject)
             self.assertEqual(url, 'readthedocs.org')
         with override_settings(USE_SUBDOMAIN=True):
             url = resolve_domain(project=self.subproject)
-            self.assertEqual(url, 'pip.readthedocs.org')
+            self.assertEqual(url, "pip.readthedocs.io")
+
+            url = resolve_domain(project=self.subproject, use_canonical_domain=False)
+            self.assertEqual(url, "pip.readthedocs.io")
 
     @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
     def test_domain_resolver_subproject_itself(self):
@@ -404,14 +409,20 @@ def test_domain_resolver_subproject_itself(self):
             url = resolve_domain(project=self.pip)
             self.assertEqual(url, 'pip.readthedocs.org')
 
-    @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
+    @override_settings(
+        PRODUCTION_DOMAIN="readthedocs.org",
+        PUBLIC_DOMAIN="readthedocs.io",
+    )
     def test_domain_resolver_translation(self):
         with override_settings(USE_SUBDOMAIN=False):
             url = resolve_domain(project=self.translation)
             self.assertEqual(url, 'readthedocs.org')
         with override_settings(USE_SUBDOMAIN=True):
             url = resolve_domain(project=self.translation)
-            self.assertEqual(url, 'pip.readthedocs.org')
+            self.assertEqual(url, "pip.readthedocs.io")
+
+            url = resolve_domain(project=self.translation, use_canonical_domain=False)
+            self.assertEqual(url, "pip.readthedocs.io")
 
     @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
     def test_domain_resolver_translation_itself(self):
@@ -444,6 +455,9 @@ def test_domain_public(self):
             self.assertEqual(url, 'readthedocs.org')
         with override_settings(USE_SUBDOMAIN=True):
             url = resolve_domain(project=self.translation)
+            self.assertEqual(url, "pip.public.readthedocs.org")
+
+            url = resolve_domain(project=self.translation, use_canonical_domain=False)
             self.assertEqual(url, 'pip.public.readthedocs.org')
 
     @override_settings(