Hosting: manual integrations via build contract

readthedocs/doc_builder/director.py

@@ -638,6 +638,10 @@ def store_readthedocs_build_yaml(self):
             "readthedocs-build.yaml",
         )
 
+        if not os.path.exists(yaml_path):
+            log.debug("Build output YAML file (readtehdocs-build.yaml) does not exist.")
+            return
+
         try:
             with open(yaml_path, "r") as f:
                 data = yaml.safe_load(f)

readthedocs/doc_builder/environments.py

@@ -305,25 +305,30 @@ def run(self):
         # Create a copy of the environment to update PATH variable
         environment = self._environment.copy()
         # Default PATH variable
-        environment[
-            "PATH"
-        ] = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
-        # Add asdf extra paths
-        environment["PATH"] += (
-            ":/home/{settings.RTD_DOCKER_USER}/.asdf/shims"
-            ":/home/{settings.RTD_DOCKER_USER}/.asdf/bin"
+        # This default comes from our Docker image:
+        #
+        # $ docker run --user docs -it --rm readthedocs/build:ubuntu-22.04 /bin/bash
+        # docs@bfe702e31cdd:~$ echo $PATH
+        # /home/docs/.asdf/shims:/home/docs/.asdf/bin
+        #  :/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+        # docs@bfe702e31cdd:~$
+        asdf_paths = (
+            f"/home/{settings.RTD_DOCKER_USER}/.asdf/shims"
+            f":/home/{settings.RTD_DOCKER_USER}/.asdf/bin"
         )
-
         if settings.RTD_DOCKER_COMPOSE:
-            environment["PATH"] += ":/root/.asdf/shims:/root/.asdf/bin"
+            asdf_paths += ":/root/.asdf/shims:/root/.asdf/bin"
+
+        default_paths = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+        environment["PATH"] = f"{asdf_paths}:{default_paths}"
 
         # Prepend the BIN_PATH if it's defined
         if self.bin_path:
-            path = environment.get("PATH")
-            bin_path = self._escape_command(self.bin_path)
-            environment["PATH"] = bin_path
-            if path:
-                environment["PATH"] += f":{path}"
+            original_path = environment.get("PATH")
+            escaped_bin_path = self._escape_command(self.bin_path)
+            environment["PATH"] = escaped_bin_path
+            if original_path:
+                environment["PATH"] = f"{escaped_bin_path}:{original_path}"
 
         try:
             exec_cmd = client.exec_create(

readthedocs/projects/tests/test_build_tasks.py

@@ -216,6 +216,7 @@ def test_build_updates_documentation_type(self, load_yaml_config):
         assert self.requests_mock.request_history[7]._request.method == "PATCH"
         assert self.requests_mock.request_history[7].path == "/api/v2/version/1/"
         assert self.requests_mock.request_history[7].json() == {
+            "build_data": None,
             "built": True,
             "documentation_type": "mkdocs",
             "has_pdf": True,
@@ -457,6 +458,7 @@ def test_successful_build(
         assert self.requests_mock.request_history[7]._request.method == "PATCH"
         assert self.requests_mock.request_history[7].path == "/api/v2/version/1/"
         assert self.requests_mock.request_history[7].json() == {
+            "build_data": None,
             "built": True,
             "documentation_type": "sphinx",
             "has_pdf": True,

readthedocs/proxito/middleware.py

@@ -285,8 +285,6 @@ def add_hosting_integrations_headers(self, request, response):
             project = Project.objects.get(slug=project_slug)
             if project.has_feature(Feature.HOSTING_INTEGRATIONS):
                 response["X-RTD-Hosting-Integrations"] = "true"
-            else:
-                response["X-RTD-Hosting-Integrations"] = "false"
 
     def process_response(self, request, response):  # noqa
         self.add_proxito_headers(request, response)

readthedocs/proxito/tests/test_hosting.py

@@ -0,0 +1,123 @@
+"""Test hosting views."""
+
+import django_dynamic_fixture as fixture
+import pytest
+from django.conf import settings
+from django.contrib.auth.models import User
+from django.test import TestCase, override_settings
+from django.urls import reverse
+
+from readthedocs.builds.constants import EXTERNAL, INTERNAL, LATEST
+from readthedocs.builds.models import Build
+from readthedocs.projects.constants import PUBLIC
+from readthedocs.projects.models import Project
+
+
+@override_settings(
+    PUBLIC_DOMAIN="dev.readthedocs.io",
+    PUBLIC_DOMAIN_USES_HTTPS=True,
+)
+@pytest.mark.proxito
+class TestReadTheDocsConfigJson(TestCase):
+    def setUp(self):
+        self.user = fixture.get(User, username="user")
+        self.user.set_password("user")
+        self.user.save()
+
+        self.project = fixture.get(
+            Project,
+            slug="project",
+            language="en",
+            privacy_level=PUBLIC,
+            external_builds_privacy_level=PUBLIC,
+            repo="git://10.10.0.1/project",
+            programming_language="words",
+            single_version=False,
+            users=[self.user],
+            main_language_project=None,
+        )
+        self.project.versions.update(
+            privacy_level=PUBLIC,
+            built=True,
+            active=True,
+            type=INTERNAL,
+            identifier="1a2b3c",
+        )
+        self.version = self.project.versions.get(slug=LATEST)
+        self.build = fixture.get(
+            Build,
+            version=self.version,
+        )
+
+    def test_get_config(self):
+        r = self.client.get(
+            reverse("proxito_readthedocs_config_json"),
+            {"url": "https://project.dev.readthedocs.io/en/latest/"},
+            secure=True,
+            HTTP_HOST="project.dev.readthedocs.io",
+        )
+        assert r.status_code == 200
+
+        expected = {
+            "comment": "THIS RESPONSE IS IN ALPHA FOR TEST PURPOSES ONLY AND IT'S GOING TO CHANGE COMPLETELY -- DO NOT USE IT!",
+            "project": {
+                "slug": self.project.slug,
+                "language": self.project.language,
+                "repository_url": self.project.repo,
+                "programming_language": self.project.programming_language,
+            },
+            "version": {
+                "slug": self.version.slug,
+                "external": self.version.type == EXTERNAL,
+            },
+            "build": {
+                "id": self.build.pk,
+            },
+            "domains": {
+                "dashboard": settings.PRODUCTION_DOMAIN,
+            },
+            "readthedocs": {
+                "analytics": {
+                    "code": None,
+                }
+            },
+            "features": {
+                "analytics": {
+                    "code": None,
+                },
+                "external_version_warning": {
+                    "enabled": True,
+                    "query_selector": "[role=main]",
+                },
+                "non_latest_version_warning": {
+                    "enabled": True,
+                    "query_selector": "[role=main]",
+                    "versions": [
+                        "latest",
+                    ],
+                },
+                "doc_diff": {
+                    "enabled": True,
+                    "base_url": "https://project.dev.readthedocs.io/en/latest/index.html",
+                    "root_selector": "[role=main]",
+                    "inject_styles": True,
+                    "base_host": "",
+                    "base_page": "",
+                },
+                "flyout": {
+                    "translations": [],
+                    "versions": [
+                        {"slug": "latest", "url": "/en/latest/"},
+                    ],
+                    "downloads": [],
+                    "vcs": {
+                        "url": "https://github.com",
+                        "username": "readthedocs",
+                        "repository": "test-builds",
+                        "branch": self.version.identifier,
+                        "filepath": "/docs/index.rst",
+                    },
+                },
+            },
+        }
+        assert r.json() == expected

readthedocs/proxito/views/hosting.py

@@ -7,6 +7,7 @@
 
 from readthedocs.builds.constants import EXTERNAL
 from readthedocs.core.mixins import CDNCacheControlMixin
+from readthedocs.core.resolver import resolver
 from readthedocs.core.unresolver import unresolver
 
 log = structlog.get_logger(__name__)  # noqa
@@ -15,21 +16,29 @@
 class ReadTheDocsConfigJson(CDNCacheControlMixin, View):
     def get(self, request):
 
+        url = request.GET.get("url")
+        if not url:
+            return JsonResponse(
+                {"error": "'url' GET attribute is required"},
+                status=400,
+            )
+
         unresolved_domain = request.unresolved_domain
         project = unresolved_domain.project
 
         # TODO: why the UnresolvedURL object is not injected in the `request` by the middleware.
         # Is is fine to calculate it here?
-        unresolved_url = unresolver.unresolve_url(request.headers.get("Referer"))
+        unresolved_url = unresolver.unresolve_url(url)
         version = unresolved_url.version
 
         # TODO: use Referrer header or GET arguments for Version / Build
         project.get_default_version()
         build = version.builds.last()
 
         # TODO: define how it will be the exact JSON object returned here
-        # NOTE: we could use the APIv3 serializers for some of these objects if we want to keep consistency.
-        # However, those may require some extra db calls that we probably want to avoid.
+        # NOTE: we could use the APIv3 serializers for some of these objects
+        # if we want to keep consistency. However, those may require some
+        # extra db calls that we probably want to avoid.
         data = {
             "comment": (
                 "THIS RESPONSE IS IN ALPHA FOR TEST PURPOSES ONLY"
@@ -68,12 +77,28 @@ def get(self, request):
                     "enabled": True,
                     "query_selector": "[role=main]",
                     "versions": list(
-                        project.versions.filter(active=True).values_list(
-                            "slug", flat=True
-                        )
+                        project.versions.filter(active=True)
+                        .only("slug")
+                        .values_list("slug", flat=True)
                     ),
                 },
-                "doc_diff": True,
+                "doc_diff": {
+                    "enabled": True,
+                    # "http://test-builds-local.devthedocs.org/en/latest/index.html"
+                    "base_url": f"""{resolver.resolve(
+                        project=project,
+                        version_slug=project.get_default_version(),
+                        language=project.language,
+                        filename=unresolved_url.filename,
+                    )}""",
+                    "root_selector": "[role=main]",
+                    "inject_styles": True,
+                    # NOTE: `base_host` and `base_page` are not required, since
+                    # we are constructing the `base_url` in the backend instead
+                    # of the frontend, as the doc-diff extension does.
+                    "base_host": "",
+                    "base_page": "",
+                },
                 "flyout": {
                     "translations": [],
                     "versions": [