Proxito: always use subdomain for serving docs

docs/dev/install.rst

@@ -346,7 +346,7 @@ Docker for builds
 
 Serve documentation under a subdomain
     There are a number of resolution bugs and cross-domain behavior that can
-    only be caught by using `USE_SUBDOMAIN` setting.
+    only be caught by using a ``PUBLIC_DOMAIN`` setting different from the ``PRODUCTION_DOMAIN`` setting.
 
 PostgreSQL as a database
     It is recommended that Postgres be used as the default database whenever

docs/dev/settings.rst

@@ -19,18 +19,10 @@ memory
     Examples: '200m' for 200MB of total memory, or '2g' for 2GB of
     total memory.
 
-USE_SUBDOMAIN
----------------
-
-Whether to use subdomains in URLs on the site, or the Django-served content.
-When used in production, this should be ``True``, as Nginx will serve this content.
-During development and other possible deployments, this might be ``False``.
-
 PRODUCTION_DOMAIN
 ------------------
 
-This is the domain that gets linked to throughout the site when used in production.
-It depends on `USE_SUBDOMAIN`, otherwise it isn't used.
+This is the domain that is used by the main application (not documentation pages).
 
 RTD_INTERSPHINX_URL
 -------------------

readthedocs/api/v3/tests/mixins.py

@@ -21,7 +21,6 @@
 @override_settings(
     PUBLIC_DOMAIN="readthedocs.io",
     PRODUCTION_DOMAIN="readthedocs.org",
-    USE_SUBDOMAIN=True,
     RTD_BUILD_MEDIA_STORAGE="readthedocs.rtd_tests.storage.BuildMediaFileSystemStorageTest",
     RTD_ALLOW_ORGANIZATIONS=False,
 )

readthedocs/core/context_processors.py

@@ -7,7 +7,6 @@ def readthedocs_processor(request):
     exports = {
         "PUBLIC_DOMAIN": settings.PUBLIC_DOMAIN,
         "PRODUCTION_DOMAIN": settings.PRODUCTION_DOMAIN,
-        "USE_SUBDOMAIN": settings.USE_SUBDOMAIN,
         "GLOBAL_ANALYTICS_CODE": settings.GLOBAL_ANALYTICS_CODE,
         "DASHBOARD_ANALYTICS_CODE": settings.DASHBOARD_ANALYTICS_CODE,
         "SITE_ROOT": settings.SITE_ROOT + "/",

readthedocs/core/resolver.py

@@ -62,8 +62,6 @@ def base_resolve_path(
         language=None,
         single_version=None,
         project_relationship=None,
-        subdomain=None,
-        cname=None,
         custom_prefix=None,
     ):
         """
@@ -77,12 +75,7 @@ def base_resolve_path(
         the path will be prefixed with the subproject prefix
         (defaults to ``/projects/<subproject-slug>/``).
         """
-        # Only support `/docs/project' URLs outside our normal environment. Normally
-        # the path should always have a subdomain or CNAME domain
-        if subdomain or cname or self._use_subdomain():
-            path = "/"
-        else:
-            path = "/docs/{project}/"
+        path = "/"
 
         if project_relationship:
             path = unsafe_join_url_path(path, project_relationship.subproject_prefix)
@@ -112,8 +105,6 @@ def resolve_path(
         version_slug=None,
         language=None,
         single_version=None,
-        subdomain=None,
-        cname=None,
     ):
         """Resolve a URL with a subset of fields defined."""
         version_slug = version_slug or project.get_default_version()
@@ -122,11 +113,6 @@ def resolve_path(
         filename = self._fix_filename(filename)
 
         parent_project, project_relationship = self._get_canonical_project_data(project)
-        cname = (
-            cname
-            or self._use_subdomain()
-            or parent_project.get_canonical_custom_domain()
-        )
         single_version = bool(project.single_version or single_version)
 
         # If the project is a subproject, we use the custom prefix
@@ -145,8 +131,6 @@ def resolve_path(
             language=language,
             single_version=single_version,
             project_relationship=project_relationship,
-            cname=cname,
-            subdomain=subdomain,
             custom_prefix=custom_prefix,
         )
 
@@ -385,7 +369,7 @@ def _use_custom_domain(self, custom_domain):
 
     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
+        return settings.PUBLIC_DOMAIN is not None
 
     def _use_cname(self, project):
         """Test if to allow direct serving for project on CNAME."""

readthedocs/embed/tests/test_api.py

@@ -33,7 +33,6 @@ def setup_method(self, settings):
         self.version.privacy_level = PUBLIC
         self.version.save()
 
-        settings.USE_SUBDOMAIN = True
         settings.PUBLIC_DOMAIN = "readthedocs.io"
         settings.RTD_DEFAULT_FEATURES = dict(
             [RTDProductFeature(TYPE_EMBED_API).to_item()]

readthedocs/embed/v3/tests/test_access.py

@@ -17,7 +17,6 @@
 
 
 @override_settings(
-    USE_SUBDOMAIN=True,
     PUBLIC_DOMAIN="readthedocs.io",
     RTD_ALLOW_ORGAZATIONS=False,
     RTD_DEFAULT_FEATURES=dict([RTDProductFeature(TYPE_EMBED_API).to_item()]),

readthedocs/embed/v3/tests/test_basics.py

@@ -9,7 +9,6 @@
 class TestEmbedAPIv3Basics:
     @pytest.fixture(autouse=True)
     def setup_method(self, settings):
-        settings.USE_SUBDOMAIN = True
         settings.PUBLIC_DOMAIN = "readthedocs.io"
         settings.RTD_EMBED_API_EXTERNAL_DOMAINS = ["docs.project.com"]
 

readthedocs/embed/v3/tests/test_external_pages.py

@@ -13,7 +13,6 @@
 class TestEmbedAPIv3ExternalPages:
     @pytest.fixture(autouse=True)
     def setup_method(self, settings):
-        settings.USE_SUBDOMAIN = True
         settings.PUBLIC_DOMAIN = "readthedocs.io"
         settings.RTD_EMBED_API_EXTERNAL_DOMAINS = ["docs.project.com"]
 

readthedocs/embed/v3/tests/test_internal_pages.py

@@ -20,7 +20,6 @@
 class TestEmbedAPIv3InternalPages:
     @pytest.fixture(autouse=True)
     def setup_method(self, settings):
-        settings.USE_SUBDOMAIN = True
         settings.PUBLIC_DOMAIN = "readthedocs.io"
         settings.RTD_EMBED_API_EXTERNAL_DOMAINS = []
         settings.RTD_DEFAULT_FEATURES = dict(

readthedocs/projects/views/private.py

@@ -755,11 +755,7 @@ def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
 
         # Get the default docs domain
-        ctx['default_domain'] = (
-            settings.PUBLIC_DOMAIN
-            if settings.USE_SUBDOMAIN
-            else settings.PRODUCTION_DOMAIN
-        )
+        ctx["default_domain"] = settings.PUBLIC_DOMAIN
 
         return ctx
 

readthedocs/proxito/middleware.py

@@ -200,12 +200,7 @@ def process_request(self, request):  # noqa
         request.unresolved_domain = None
 
         skip = any(request.path.startswith(reverse(view)) for view in self.skip_views)
-        if (
-            skip
-            or not settings.USE_SUBDOMAIN
-            or "localhost" in request.get_host()
-            or "testserver" in request.get_host()
-        ):
+        if skip:
             log.debug("Not processing Proxito middleware")
             return None
 

readthedocs/proxito/tests/test_old_redirects.py

@@ -6,7 +6,6 @@
 and adapted to use:
 
  * El Proxito
- * USE_SUBDOMAIN=True always
 """
 
 import django_dynamic_fixture as fixture

readthedocs/rtd_tests/tests/test_api.py

@@ -65,6 +65,7 @@
 from readthedocs.subscriptions.products import RTDProductFeature
 
 
+@override_settings(PUBLIC_DOMAIN="readthedocs.io")
 class APIBuildTests(TestCase):
     fixtures = ['eric.json', 'test_data.json']
 
@@ -253,15 +254,12 @@ def test_response_finished_and_success(self):
         resp = client.get('/api/v2/build/{build}/'.format(build=build.pk))
         self.assertEqual(resp.status_code, 200)
         build = resp.data
-        docs_url = 'http://readthedocs.org/docs/{project}/en/{version}/'.format(
-            project=project.slug,
-            version=version.slug,
-        )
-        self.assertEqual(build['state'], 'finished')
-        self.assertEqual(build['error'], '')
-        self.assertEqual(build['exit_code'], 0)
-        self.assertEqual(build['success'], True)
-        self.assertEqual(build['docs_url'], docs_url)
+        docs_url = f"http://{project.slug}.readthedocs.io/en/{version.slug}/"
+        self.assertEqual(build["state"], "finished")
+        self.assertEqual(build["error"], "")
+        self.assertEqual(build["exit_code"], 0)
+        self.assertEqual(build["success"], True)
+        self.assertEqual(build["docs_url"], docs_url)
         # Verify the path is trimmed
         self.assertEqual(
             build["commands"][0]["command"],
@@ -3108,6 +3106,7 @@ def test_webhook_build_another_branch(self, trigger_build):
         self.assertEqual(resp.data['versions'], ['v1.0'])
 
 
+@override_settings(PUBLIC_DOMAIN="readthedocs.io")
 class APIVersionTests(TestCase):
     fixtures = ['eric', 'test_data']
     maxDiff = None  # So we get an actual diff when it fails
@@ -3139,11 +3138,11 @@ def test_get_version_by_id(self):
             "built": False,
             "id": 18,
             "active": True,
-            "canonical_url": "http://readthedocs.org/docs/pip/en/0.8/",
+            "canonical_url": "http://pip.readthedocs.io/en/0.8/",
             "project": {
                 "analytics_code": None,
                 "analytics_disabled": False,
-                "canonical_url": "http://readthedocs.org/docs/pip/en/latest/",
+                "canonical_url": "http://pip.readthedocs.io/en/latest/",
                 "cdn_enabled": False,
                 "conf_py_file": "",
                 "container_image": None,
@@ -3203,7 +3202,7 @@ def test_get_active_versions(self):
             'active': 'true',
         }
         url = reverse("version-list")
-        with self.assertNumQueries(6):
+        with self.assertNumQueries(5):
             resp = self.client.get(url, data)
 
         self.assertEqual(resp.status_code, 200)
@@ -3213,15 +3212,15 @@ def test_get_active_versions(self):
         data.update({
             'active': 'false',
         })
-        with self.assertNumQueries(6):
+        with self.assertNumQueries(5):
             resp = self.client.get(url, data)
         self.assertEqual(resp.status_code, 200)
         self.assertEqual(resp.data['count'], pip.versions.filter(active=False).count())
 
     def test_project_get_active_versions(self):
         pip = Project.objects.get(slug="pip")
         url = reverse("project-active-versions", args=[pip.pk])
-        with self.assertNumQueries(6):
+        with self.assertNumQueries(5):
             resp = self.client.get(url)
         self.assertEqual(
             len(resp.data["versions"]), pip.versions.filter(active=True).count()

readthedocs/rtd_tests/tests/test_build_notifications.py

@@ -25,7 +25,6 @@
 @override_settings(
     PRODUCTION_DOMAIN="readthedocs.org",
     PUBLIC_DOMAIN="readthedocs.io",
-    USE_SUBDOMAIN=True,
 )
 class BuildNotificationsTests(TestCase):
     def setUp(self):

readthedocs/rtd_tests/tests/test_core_tags.py

@@ -7,12 +7,12 @@
 from readthedocs.projects.models import Project
 
 
-@override_settings(USE_SUBDOMAIN=False, PRODUCTION_DOMAIN="readthedocs.org")
+@override_settings(PRODUCTION_DOMAIN="readthedocs.org", PUBLIC_DOMAIN="readthedocs.org")
 class CoreTagsTests(TestCase):
     fixtures = ["eric", "test_data"]
 
     def setUp(self):
-        url_base = "http://{domain}/docs/pip{{version}}".format(
+        url_base = "http://pip.{domain}{{version}}".format(
             domain=settings.PRODUCTION_DOMAIN,
         )
 

readthedocs/rtd_tests/tests/test_footer.py

@@ -325,7 +325,6 @@ class TestFooterHTML(BaseTestFooterHTML, TestCase):
 
 
 @override_settings(
-    USE_SUBDOMAIN=True,
     PUBLIC_DOMAIN="readthedocs.io",
     PUBLIC_DOMAIN_USES_HTTPS=True,
 )

readthedocs/rtd_tests/tests/test_notifications.py

@@ -71,7 +71,6 @@ class TestNotification(Notification):
                 "SUPPORT_EMAIL": "[email protected]",
                 "TEMPLATE_ROOT": mock.ANY,
                 "USE_PROMOS": mock.ANY,
-                "USE_SUBDOMAIN": mock.ANY,
                 "USE_ORGANIZATIONS": mock.ANY,
             },
         )
@@ -236,7 +235,6 @@ def test_context_data(self):
             "SUPPORT_EMAIL": "[email protected]",
             "TEMPLATE_ROOT": mock.ANY,
             "USE_PROMOS": mock.ANY,
-            "USE_SUBDOMAIN": mock.ANY,
             "USE_ORGANIZATIONS": mock.ANY,
         }
         self.assertEqual(self.n.get_context_data(), context)

readthedocs/rtd_tests/tests/test_privacy.py

@@ -227,7 +227,6 @@ def test_private_public_repo_downloading(self):
     @override_settings(
         DEFAULT_PRIVACY_LEVEL="private",
         PUBLIC_DOMAIN="readthedocs.io",
-        USE_SUBDOMAIN=True,
     )
     def test_private_download_filename(self):
         self._create_kong("private", "private")
@@ -270,7 +269,6 @@ def test_private_download_filename(self):
     @override_settings(
         DEFAULT_PRIVACY_LEVEL="public",
         PUBLIC_DOMAIN="readthedocs.io",
-        USE_SUBDOMAIN=True,
     )
     def test_public_repo_downloading(self):
         self._create_kong("public", "public")
@@ -308,7 +306,6 @@ def test_public_repo_downloading(self):
     @override_settings(
         DEFAULT_PRIVACY_LEVEL="public",
         PUBLIC_DOMAIN="readthedocs.io",
-        USE_SUBDOMAIN=True,
     )
     def test_public_private_repo_downloading(self):
         self._create_kong("private", "private")
@@ -338,7 +335,6 @@ def test_public_private_repo_downloading(self):
     @override_settings(
         DEFAULT_PRIVACY_LEVEL="public",
         PUBLIC_DOMAIN="readthedocs.io",
-        USE_SUBDOMAIN=True,
     )
     def test_public_download_filename(self):
         self._create_kong("public", "public")