Fix status reporting on PRs with the magic exit code

This was because we were using this logic to return a relative URL,
and then sending it to GitHub:

* https://github.com/readthedocs/readthedocs.org/blob/f86b5376ffc70242bdd677cb02f016429ff6bd4b/readthedocs/oauth/services/github.py#L459-L460
* https://github.com/readthedocs/readthedocs.org/blob/f86b5376ffc70242bdd677cb02f016429ff6bd4b/readthedocs/builds/models.py#L343-L349

Fixes #9791

Author: ericholscher

readthedocs/builds/tasks.py

@@ -389,6 +389,7 @@ def send_build_status(build_pk, commit, status, link_to_build=False):
     :param build_pk: Build primary key
     :param commit: commit sha of the pull/merge request
     :param status: build status failed, pending, or success to be sent.
+    :param link_to_build: When True, link to the built HTML
     """
     # TODO: Send build status for BitBucket.
     build = Build.objects.filter(pk=build_pk).first()
@@ -449,7 +450,9 @@ def send_build_status(build_pk, commit, status, link_to_build=False):
                 # Try to loop through services for users all social accounts
                 # to send successful build status
                 for service in services:
-                    success = service.send_build_status(build, commit, status)
+                    success = service.send_build_status(
+                        build, commit, status, link_to_build=link_to_build
+                    )
                     if success:
                         log.debug(
                             'Build status report sent correctly using an user account.',

readthedocs/core/utils/__init__.py

@@ -106,7 +106,8 @@ def prepare_build(
             version_type=version.type,
             build_pk=build.id,
             commit=commit,
-            status=BUILD_STATUS_PENDING
+            status=BUILD_STATUS_PENDING,
+            link_to_build=False,
         )
 
     if version.type != EXTERNAL:

readthedocs/projects/tasks/builds.py

@@ -482,7 +482,7 @@ def on_failure(self, exc, task_id, args, kwargs, einfo):
             )
 
         # NOTE: why we wouldn't have `self.data.build_commit` here?
-        # This attribute is set when we get it after clonning the repository
+        # This attribute is set when we get it after cloning the repository
         #
         # Oh, I think this is to differentiate a task triggered with
         # `Build.commit` than a one triggered just with the `Version` to build
@@ -508,6 +508,10 @@ def on_failure(self, exc, task_id, args, kwargs, einfo):
                 build_pk=self.data.build['id'],
                 commit=self.data.build_commit,
                 status=status,
+                # Fix bug where we were generating relative links to the version
+                # with ``get_absolute_url``.
+                # https://github.com/readthedocs/readthedocs.org/issues/9791
+                link_to_build=True,
             )
 
         # Update build object
@@ -578,6 +582,7 @@ def on_success(self, retval, task_id, args, kwargs):
                 build_pk=self.data.build['id'],
                 commit=self.data.build_commit,
                 status=BUILD_STATUS_SUCCESS,
+                link_to_build=True,
             )
 
         # Update build object

readthedocs/projects/tasks/utils.py

@@ -134,20 +134,21 @@ def finish_inactive_builds():
     )
 
 
-def send_external_build_status(version_type, build_pk, commit, status):
+def send_external_build_status(version_type, build_pk, commit, status, link_to_build):
     """
     Check if build is external and Send Build Status for project external versions.
 
      :param version_type: Version type e.g EXTERNAL, BRANCH, TAG
      :param build_pk: Build pk
      :param commit: commit sha of the pull/merge request
      :param status: build status failed, pending, or success to be sent.
+     :param link_to_build: When True, link to the built HTML
     """
 
     # Send status reports for only External (pull/merge request) Versions.
     if version_type == EXTERNAL:
         # call the task that actually send the build status.
-        send_build_status.delay(build_pk, commit, status)
+        send_build_status.delay(build_pk, commit, status, link_to_build=link_to_build)
 
 
 class BuildRequest(Request):

readthedocs/projects/tests/test_build_tasks.py

@@ -333,6 +333,7 @@ def test_successful_build(
             build_pk=self.build.pk,
             commit=self.build.commit,
             status=BUILD_STATUS_SUCCESS,
+            link_to_build=True,
         )
 
         build_complete.send.assert_called_once_with(
@@ -501,6 +502,7 @@ def test_failed_build(
             build_pk=self.build.pk,
             commit=self.build.commit,
             status=BUILD_STATUS_FAILURE,
+            link_to_build=True,
         )
 
         build_complete.send.assert_called_once_with(

readthedocs/rtd_tests/tests/test_celery.py

@@ -8,11 +8,7 @@
 from messages_extends.models import Message
 
 from readthedocs.builds import tasks as build_tasks
-from readthedocs.builds.constants import (
-    BUILD_STATUS_SUCCESS,
-    EXTERNAL,
-    LATEST,
-)
+from readthedocs.builds.constants import BUILD_STATUS_SUCCESS, EXTERNAL, LATEST
 from readthedocs.builds.models import Build, Version
 from readthedocs.oauth.models import RemoteRepository, RemoteRepositoryRelation
 from readthedocs.projects.models import Project
@@ -209,4 +205,3 @@ def test_send_build_status_no_remote_repo_or_social_account_gitlab(self, send_bu
 
         send_build_status.assert_not_called()
         self.assertEqual(Message.objects.filter(user=self.eric).count(), 1)
-

readthedocs/rtd_tests/tests/test_projects_tasks.py

@@ -21,14 +21,18 @@ def setUp(self):
     @patch('readthedocs.projects.tasks.utils.send_build_status')
     def test_send_external_build_status_with_external_version(self, send_build_status):
         send_external_build_status(
-            self.external_version.type, self.external_build.id,
-            self.external_build.commit, BUILD_STATUS_SUCCESS
+            self.external_version.type,
+            self.external_build.id,
+            self.external_build.commit,
+            BUILD_STATUS_SUCCESS,
+            link_to_build=True,
         )
 
         send_build_status.delay.assert_called_once_with(
             self.external_build.id,
             self.external_build.commit,
-            BUILD_STATUS_SUCCESS
+            BUILD_STATUS_SUCCESS,
+            link_to_build=False,
         )
 
     @patch('readthedocs.projects.tasks.utils.send_build_status')