Extend webhook notifications with build status

Author: saadmk11

readthedocs/core/utils/__init__.py

@@ -84,7 +84,7 @@ def prepare_build(
     # Avoid circular import
     from readthedocs.builds.models import Build
     from readthedocs.projects.models import Project
-    from readthedocs.projects.tasks import update_docs_task
+    from readthedocs.projects.tasks import update_docs_task, send_notifications
 
     build = None
 
@@ -115,6 +115,13 @@ def prepare_build(
         )
         kwargs['build_pk'] = build.pk
 
+        # Send only Webhook notification for build `triggered`
+        send_notifications.delay(
+            version.pk,
+            build_pk=build.pk,
+            send_email=False
+        )
+
     options = {}
     if project.build_queue:
         options['queue'] = project.build_queue

readthedocs/projects/tasks.py

@@ -382,9 +382,6 @@ def run(
             self.build_force = force
             self.config = None
 
-            # send Webhook notification for build `triggered`
-            self.send_notifications(send_email=False)
-
             setup_successful = self.run_setup(record=record)
             if not setup_successful:
                 return False
@@ -567,8 +564,9 @@ def run_build(self, docker, record):
                 # TODO the build object should have an idea of these states,
                 # extend the model to include an idea of these outcomes
                 outcomes = self.build_docs()
-                # send Webhook notification for build status `building`
+                # Send only Webhook notification for build status `building`
                 self.send_notifications(send_email=False)
+
                 build_id = self.build.get('id')
             except vcs_support_utils.LockTimeout as e:
                 self.task.retry(exc=e, throw=False)
@@ -592,7 +590,7 @@ def run_build(self, docker, record):
         if self.build_env.failed:
             self.send_notifications()
 
-        # send Webhook notification for build `successful`
+        # Send only Webhook notification for build `successful`
         if self.build_env.successful:
             self.send_notifications(send_email=False)
 
@@ -834,6 +832,7 @@ def build_docs(self):
         :rtype: dict
         """
         self.build_env.update_build(state=BUILD_STATE_BUILDING)
+
         before_build.send(sender=self.version)
 
         outcomes = defaultdict(lambda: False)
@@ -1455,6 +1454,7 @@ def webhook_notification(version, build, hook_url):
         'slug': project.slug,
         'build': {
             'id': build.id,
+            'commit': build.commit,
             'state': build.state,
             'success': build.success,
             'date': build.date.strftime('%Y-%m-%d %H:%M:%S'),

readthedocs/rtd_tests/tests/test_celery.py

@@ -136,7 +136,7 @@ def test_update_docs_unexpected_build_exception(self, mock_build_docs):
     @patch('readthedocs.projects.tasks.UpdateDocsTaskStep.build_docs', new=MagicMock)
     @patch('readthedocs.projects.tasks.UpdateDocsTaskStep.send_notifications')
     @patch('readthedocs.projects.tasks.UpdateDocsTaskStep.setup_vcs')
-    def test_only_triggered_build_notification_on_version_locked_error(self, mock_setup_vcs, mock_send_notifications):
+    def test_no_notification_on_version_locked_error(self, mock_setup_vcs, mock_send_notifications):
         mock_setup_vcs.side_effect = VersionLockedError()
 
         build = get(
@@ -151,8 +151,7 @@ def test_only_triggered_build_notification_on_version_locked_error(self, mock_se
                 intersphinx=False,
             )
 
-        # only called when build is triggered
-        mock_send_notifications.assert_called_once()
+        mock_send_notifications.assert_not_called()
         self.assertTrue(result.successful())
 
     def test_sync_repository(self):

readthedocs/settings/dev.py

@@ -59,17 +59,17 @@ def LOGGING(self):  # noqa - avoid pep8 N802
         logging['disable_existing_loggers'] = False
         return logging
 
-    @property
-    def INSTALLED_APPS(self):
-        apps = super().INSTALLED_APPS
-        apps.append('debug_toolbar')
-        return apps
-
-    @property
-    def MIDDLEWARE(self):
-        middlewares = list(super().MIDDLEWARE)
-        middlewares.insert(0, 'debug_toolbar.middleware.DebugToolbarMiddleware')
-        return middlewares
+    # @property
+    # def INSTALLED_APPS(self):
+    #     apps = super().INSTALLED_APPS
+    #     apps.append('debug_toolbar')
+    #     return apps
+    #
+    # @property
+    # def MIDDLEWARE(self):
+    #     middlewares = list(super().MIDDLEWARE)
+    #     middlewares.insert(0, 'debug_toolbar.middleware.DebugToolbarMiddleware')
+    #     return middlewares
 
 
 CommunityDevSettings.load_settings(__name__)

readthedocs/urls.py

@@ -133,11 +133,11 @@
 if getattr(settings, 'ALLOW_ADMIN', True):
     groups.append(admin_urls)
 if getattr(settings, 'DEBUG', False):
-    import debug_toolbar
-
-    debug_urls += [
-        url(r'^__debug__/', include(debug_toolbar.urls)),
-    ]
+    # import debug_toolbar
+    #
+    # debug_urls += [
+    #     url(r'^__debug__/', include(debug_toolbar.urls)),
+    # ]
     groups.append(debug_urls)
 
 urlpatterns = reduce(add, groups)