add force notify option

Author: joseph-sentry

apps/worker/services/comparison/__init__.py

@@ -33,6 +33,7 @@ class ComparisonContext:
     # We need to send commit statuses to this other commit, to guarantee that the check is not ignored.
     # See https://docs.gitlab.com/ee/ci/pipelines/merged_results_pipelines.html#successful-merged-results-pipeline-overrides-a-failed-branch-pipeline
     gitlab_extra_shas: set[str] | None = None
+    force_notify: bool = False
 
 
 NOT_RESOLVED: Any = object()

apps/worker/services/notification/notifiers/checks/base.py

@@ -95,6 +95,18 @@ def notify(
         comparison: ComparisonProxy,
         status_or_checks_helper_text: dict[str, str] | None = None,
     ) -> NotificationResult:
+        force_notify = getattr(comparison.context, "force_notify", False)
+
+        if not force_notify:
+            validation_result = self._perform_validation_checks(comparison)
+            if validation_result:
+                return validation_result
+
+        return self._perform_notification(comparison)
+
+    def _perform_validation_checks(
+        self, comparison: ComparisonProxy
+    ) -> NotificationResult | None:
         if comparison.pull is None or ():
             log.debug(
                 "Falling back to commit_status: Not a pull request",
@@ -132,7 +144,7 @@ def notify(
                 data_sent=None,
                 data_received=None,
             )
-        if comparison.pull.state != "open":
+        if comparison.pull and comparison.pull.state != "open":
             log.debug(
                 "Falling back to commit_status: Pull request closed",
                 extra={
@@ -187,28 +199,37 @@ def notify(
                 data_sent=None,
                 data_received=None,
             )
+
+        flag_coverage_not_uploaded_behavior = (
+            self.determine_status_check_behavior_to_apply(
+                comparison, "flag_coverage_not_uploaded_behavior"
+            )
+        )
+        if (
+            flag_coverage_not_uploaded_behavior == "exclude"
+            and not self.flag_coverage_was_uploaded(comparison)
+        ):
+            return NotificationResult(
+                notification_attempted=False,
+                notification_successful=None,
+                explanation="exclude_flag_coverage_not_uploaded_checks",
+                data_sent=None,
+                data_received=None,
+            )
+
+        return None
+
+    def _perform_notification(self, comparison: ComparisonProxy) -> NotificationResult:
         payload = None
         try:
             with nullcontext():
-                # If flag coverage wasn't uploaded, apply the appropriate behavior
                 flag_coverage_not_uploaded_behavior = (
                     self.determine_status_check_behavior_to_apply(
                         comparison, "flag_coverage_not_uploaded_behavior"
                     )
                 )
                 if not comparison.has_head_report():
                     payload = self.build_payload(comparison)
-                elif (
-                    flag_coverage_not_uploaded_behavior == "exclude"
-                    and not self.flag_coverage_was_uploaded(comparison)
-                ):
-                    return NotificationResult(
-                        notification_attempted=False,
-                        notification_successful=None,
-                        explanation="exclude_flag_coverage_not_uploaded_checks",
-                        data_sent=None,
-                        data_received=None,
-                    )
                 elif (
                     flag_coverage_not_uploaded_behavior == "pass"
                     and not self.flag_coverage_was_uploaded(comparison)

apps/worker/services/notification/notifiers/comment/__init__.py

@@ -92,19 +92,25 @@ def notify(
                 },
             )
 
-        for condition in self.notify_conditions:
-            condition_result = condition.check_condition(
-                notifier=self, comparison=comparison
-            )
-            if condition_result == False:
-                side_effect_result = condition.on_failure_side_effect(self, comparison)
-                default_result = NotificationResult(
-                    notification_attempted=False,
-                    explanation=condition.failure_explanation,
-                    data_sent=None,
-                    data_received=None,
+        force_notify = getattr(comparison.context, "force_notify", False)
+
+        if not force_notify:
+            for condition in self.notify_conditions:
+                condition_result = condition.check_condition(
+                    notifier=self, comparison=comparison
                 )
-                return default_result.merge(side_effect_result)
+                if condition_result == False:
+                    side_effect_result = condition.on_failure_side_effect(
+                        self, comparison
+                    )
+                    default_result = NotificationResult(
+                        notification_attempted=False,
+                        explanation=condition.failure_explanation,
+                        data_sent=None,
+                        data_received=None,
+                    )
+                    return default_result.merge(side_effect_result)
+
         pull = comparison.pull
         try:
             message = self.build_message(

apps/worker/services/notification/notifiers/generics.py

@@ -88,7 +88,10 @@ def notify(
         filtered_comparison = comparison.get_filtered_comparison(
             **self.get_notifier_filters()
         )
-        if self.should_notify_comparison(filtered_comparison):
+
+        force_notify = getattr(comparison.context, "force_notify", False)
+
+        if force_notify or self.should_notify_comparison(filtered_comparison):
             result = self.do_notify(filtered_comparison)
         else:
             result = NotificationResult(

apps/worker/services/notification/notifiers/status/base.py

@@ -148,7 +148,18 @@ def notify(
         comparison: ComparisonProxy,
         status_or_checks_helper_text: dict[str, str] | None = None,
     ) -> NotificationResult:
-        payload = None
+        force_notify = getattr(comparison.context, "force_notify", False)
+
+        if not force_notify:
+            validation_result = self._perform_validation_checks(comparison)
+            if validation_result:
+                return validation_result
+
+        return self._perform_notification(comparison)
+
+    def _perform_validation_checks(
+        self, comparison: ComparisonProxy
+    ) -> NotificationResult | None:
         if not self.can_we_set_this_status(comparison):
             return NotificationResult(
                 notification_attempted=False,
@@ -163,6 +174,28 @@ def notify(
                 explanation="need_more_builds",
                 data_sent=None,
             )
+
+        # Check flag coverage behavior when force_notify is False
+        flag_coverage_not_uploaded_behavior = (
+            self.determine_status_check_behavior_to_apply(
+                comparison, "flag_coverage_not_uploaded_behavior"
+            )
+        )
+        if (
+            flag_coverage_not_uploaded_behavior == "exclude"
+            and not self.flag_coverage_was_uploaded(comparison)
+        ):
+            return NotificationResult(
+                notification_attempted=False,
+                notification_successful=None,
+                explanation="exclude_flag_coverage_not_uploaded_checks",
+                data_sent=None,
+                data_received=None,
+            )
+
+        return None
+
+    def _perform_notification(self, comparison: ComparisonProxy) -> NotificationResult:
         # Filter the coverage report based on fields in this notification's YAML settings
         # e.g. if "paths" is specified, exclude the coverage not on those paths
         try:
@@ -174,17 +207,6 @@ def notify(
             )
             if not comparison.has_head_report():
                 payload = self.build_payload(comparison)
-            elif (
-                flag_coverage_not_uploaded_behavior == "exclude"
-                and not self.flag_coverage_was_uploaded(comparison)
-            ):
-                return NotificationResult(
-                    notification_attempted=False,
-                    notification_successful=None,
-                    explanation="exclude_flag_coverage_not_uploaded_checks",
-                    data_sent=None,
-                    data_received=None,
-                )
             elif (
                 flag_coverage_not_uploaded_behavior == "pass"
                 and not self.flag_coverage_was_uploaded(comparison)
@@ -262,6 +284,11 @@ def get_status_external_name(self) -> str:
     def maybe_send_notification(
         self, comparison: ComparisonProxy, payload: dict
     ) -> NotificationResult:
+        force_notify = getattr(comparison.context, "force_notify", False)
+
+        if force_notify:
+            return self.send_notification(comparison, payload)
+
         base_commit = (
             comparison.project_coverage_base.commit
             if comparison.project_coverage_base
@@ -306,14 +333,19 @@ def maybe_send_notification(
             )
 
     def send_notification(self, comparison: ComparisonProxy, payload):
+        force_notify = getattr(comparison.context, "force_notify", False)
+
         repository_service = self.repository_service
         title = self.get_status_external_name()
         head_commit_sha = comparison.head.commit.commitid
         head_report = comparison.head.report
         state = payload["state"]
         message = payload["message"]
         url = payload["url"]
-        if self.status_already_exists(comparison, title, state, message):
+
+        if not force_notify and self.status_already_exists(
+            comparison, title, state, message
+        ):
             log.info(
                 "Status already set",
                 extra={"context": title, "description": message, "state": state},

apps/worker/tasks/notify.py

@@ -73,6 +73,10 @@
 class NotifyTask(BaseCodecovTask, name=notify_task_name):
     throws = (SoftTimeLimitExceeded,)
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.force_notify = False
+
     def run_impl(
         self,
         db_session: Session,
@@ -81,10 +85,12 @@ def run_impl(
         commitid: str,
         current_yaml=None,
         empty_upload=None,
+        force_notify: bool = False,
         **kwargs,
     ):
+        self.force_notify = force_notify
         redis_connection = get_redis_connection()
-        if self.has_upcoming_notifies_according_to_redis(
+        if not self.force_notify and self.has_upcoming_notifies_according_to_redis(
             redis_connection, repoid, commitid
         ):
             log.info(
@@ -198,12 +204,14 @@ def run_impl_within_lock(
         assert commit, "Commit not found in database."
 
         test_result_commit_report = commit.commit_report(ReportType.TEST_RESULTS)
-        if (
+        test_failures_detected = (
             test_result_commit_report is not None
             and test_result_commit_report.test_result_totals is not None
             and not test_result_commit_report.test_result_totals.error
             and test_result_commit_report.test_result_totals.failed > 0
-        ):
+        )
+
+        if test_failures_detected and not self.force_notify:
             return {
                 "notify_attempted": False,
                 "notifications": None,
@@ -288,23 +296,31 @@ def run_impl_within_lock(
                 },
             )
             self.log_checkpoint(UploadFlow.NOTIF_GIT_CLIENT_ERROR)
-            return {
-                "notified": False,
-                "notifications": None,
-                "reason": "not_able_fetch_ci_result",
-            }
+            if not self.force_notify:
+                return {
+                    "notified": False,
+                    "notifications": None,
+                    "reason": "not_able_fetch_ci_result",
+                }
+            else:
+                ci_results = None
         except TorngitServerFailureError:
             log.info(
                 "Unable to fetch CI results due to server issues. Not notifying user",
                 extra={"repoid": commit.repoid, "commit": commit.commitid},
             )
             self.log_checkpoint(UploadFlow.NOTIF_GIT_SERVICE_ERROR)
-            return {
-                "notified": False,
-                "notifications": None,
-                "reason": "server_issues_ci_result",
-            }
-        if self.should_wait_longer(current_yaml, commit, ci_results):
+            if not self.force_notify:
+                return {
+                    "notified": False,
+                    "notifications": None,
+                    "reason": "server_issues_ci_result",
+                }
+            else:
+                ci_results = None
+        if (not self.force_notify) and self.should_wait_longer(
+            current_yaml, commit, ci_results
+        ):
             log.info(
                 "Not sending notifications yet because we are waiting for CI to finish",
                 extra={"repoid": commit.repoid, "commit": commit.commitid},
@@ -346,9 +362,15 @@ def run_impl_within_lock(
         head_report = report_service.get_existing_report_for_commit(
             commit, report_class=ReadOnlyReport
         )
-        if self.should_send_notifications(
-            current_yaml, commit, ci_results, head_report
-        ):
+
+        if self.force_notify:
+            should_notify = True
+        else:
+            should_notify = self.should_send_notifications(
+                current_yaml, commit, ci_results, head_report
+            )
+
+        if should_notify:
             enriched_pull = async_to_sync(
                 fetch_and_update_pull_request_information_from_commit
             )(repository_service, commit, current_yaml)
@@ -360,7 +382,8 @@ def run_impl_within_lock(
                 base_commit = self.fetch_parent(commit)
 
             if (
-                enriched_pull
+                not self.force_notify
+                and enriched_pull
                 and not self.send_notifications_if_commit_differs_from_pulls_head(
                     commit, enriched_pull, current_yaml
                 )
@@ -640,6 +663,7 @@ def submit_third_party_notifications(
                 gh_app_installation_name=installation_name_to_use,
                 gh_is_using_codecov_commenter=gh_is_using_codecov_commenter,
                 gitlab_extra_shas=gitlab_extra_shas_to_notify,
+                force_notify=self.force_notify,
             ),
         )