Revert "Failed check and status messaging in comment, part I" (#1021)

database/enums.py

@@ -26,16 +26,6 @@ class Notification(Enum):
     codecov_slack_app = "codecov_slack_app"
 
 
-notification_type_status_or_checks = {
-    Notification.status_changes,
-    Notification.status_patch,
-    Notification.status_project,
-    Notification.checks_changes,
-    Notification.checks_patch,
-    Notification.checks_project,
-}
-
-
 class NotificationState(Enum):
     pending = "pending"
     success = "success"

services/notification/__init__.py

@@ -15,7 +15,6 @@
 from shared.torngit.base import TorngitBaseAdapter
 from shared.yaml import UserYaml
 
-from database.enums import notification_type_status_or_checks
 from database.models.core import GITHUB_APP_INSTALLATION_DEFAULT_NAME, Owner, Repository
 from services.comparison import ComparisonProxy
 from services.decoration import Decoration
@@ -37,7 +36,6 @@
     ChecksWithFallback,
 )
 from services.notification.notifiers.codecov_slack_app import CodecovSlackAppNotifier
-from services.notification.notifiers.mixins.status import StatusState
 from services.yaml import read_yaml_field
 from services.yaml.reader import get_components_from_yaml
 
@@ -256,62 +254,15 @@ def notify(self, comparison: ComparisonProxy) -> list[IndividualResult]:
                 repoid=comparison.head.commit.repoid,
             ),
         )
-
-        results = []
-        status_or_checks_helper_text = {}
-        notifiers_to_notify = [
-            notifier
+        results = [
+            self.notify_individual_notifier(notifier, comparison)
             for notifier in self.get_notifiers_instances()
             if notifier.is_enabled()
         ]
-
-        status_or_checks_notifiers = [
-            notifier
-            for notifier in notifiers_to_notify
-            if notifier.notification_type in notification_type_status_or_checks
-        ]
-
-        all_other_notifiers = [
-            notifier
-            for notifier in notifiers_to_notify
-            if notifier.notification_type not in notification_type_status_or_checks
-        ]
-
-        status_or_checks_results = [
-            self.notify_individual_notifier(notifier, comparison)
-            for notifier in status_or_checks_notifiers
-        ]
-
-        if status_or_checks_results and all_other_notifiers:
-            # if the status/check fails, sometimes we want to add helper text to the message of the other notifications,
-            # to better surface that the status/check failed.
-            # so if there are status_and_checks_notifiers and all_other_notifiers, do the status_and_checks_notifiers first,
-            # look at the results of the checks, if any failed AND they are the type we have helper text for,
-            # add that text onto the other notifiers messages.
-            for result in status_or_checks_results:
-                notification_result = result["result"]
-                if (
-                    notification_result is not None
-                    and notification_result.data_sent.get("state")
-                    == StatusState.failure.value
-                ) and notification_result.data_sent.get("included_helper_text"):
-                    status_or_checks_helper_text.update(
-                        notification_result.data_sent["included_helper_text"]
-                    )
-                    # TODO: pass status_or_checks_helper_text to all_other_notifiers,
-                    #  where they can integrate the helper text into their messages
-        results = results + status_or_checks_results
-
-        results = results + [
-            self.notify_individual_notifier(notifier, comparison)
-            for notifier in all_other_notifiers
-        ]
         return results
 
     def notify_individual_notifier(
-        self,
-        notifier: AbstractBaseNotifier,
-        comparison: ComparisonProxy,
+        self, notifier: AbstractBaseNotifier, comparison: ComparisonProxy
     ) -> IndividualResult:
         commit = comparison.head.commit
         base_commit = comparison.project_coverage_base.commit

services/notification/notifiers/checks/patch.py

@@ -1,35 +1,18 @@
-from typing import Any, TypedDict
-
 from database.enums import Notification
 from services.comparison import ComparisonProxy, FilteredComparison
 from services.notification.notifiers.checks.base import ChecksNotifier
-from services.notification.notifiers.mixins.status import StatusPatchMixin, StatusState
+from services.notification.notifiers.mixins.status import StatusPatchMixin
 from services.yaml import read_yaml_field
 
 
-class CheckOutput(TypedDict):
-    title: str
-    summary: str
-    annotations: list[Any]
-
-
-class CheckResult(TypedDict):
-    state: StatusState
-    output: CheckOutput
-    included_helper_text: dict[str, str]
-
-
 class PatchChecksNotifier(StatusPatchMixin, ChecksNotifier):
     context = "patch"
-    notification_type_display_name = "check"
 
     @property
     def notification_type(self) -> Notification:
         return Notification.checks_patch
 
-    def build_payload(
-        self, comparison: ComparisonProxy | FilteredComparison
-    ) -> CheckResult:
+    def build_payload(self, comparison: ComparisonProxy | FilteredComparison) -> dict:
         """
         This method build the paylod of the patch github checks.
 
@@ -38,23 +21,17 @@ def build_payload(
         """
         if self.is_empty_upload():
             state, message = self.get_status_check_for_empty_upload()
-            result = CheckResult(
-                state=state,
-                output=CheckOutput(
-                    title="Empty Upload",
-                    summary=message,
-                    annotations=[],
-                ),
-                included_helper_text={},
-            )
-            return result
-        status_result = self.get_patch_status(
-            comparison, notification_type=self.notification_type_display_name
-        )
+            return {
+                "state": state,
+                "output": {
+                    "title": "Empty Upload",
+                    "summary": message,
+                },
+            }
+        state, message = self.get_patch_status(comparison)
         codecov_link = self.get_codecov_pr_link(comparison)
 
-        title = status_result["message"]
-        message = status_result["message"]
+        title = message
 
         should_use_upgrade = self.should_use_upgrade_decoration()
         if should_use_upgrade:
@@ -77,27 +54,23 @@ def build_payload(
             or should_use_upgrade
             or should_annotate is False
         ):
-            result = CheckResult(
-                state=status_result["state"],
-                output=CheckOutput(
-                    title=title,
-                    summary="\n\n".join([codecov_link, message]),
-                    annotations=[],
-                ),
-                included_helper_text=status_result["included_helper_text"],
-            )
-            return result
+            return {
+                "state": state,
+                "output": {
+                    "title": f"{title}",
+                    "summary": "\n\n".join([codecov_link, message]),
+                },
+            }
         diff = comparison.get_diff(use_original_base=True)
         #  TODO: Look into why the apply diff in get_patch_status is not saving state at this point
         comparison.head.report.apply_diff(diff)
         annotations = self.create_annotations(comparison, diff)
-        result = CheckResult(
-            state=status_result["state"],
-            output=CheckOutput(
-                title=title,
-                summary="\n\n".join([codecov_link, message]),
-                annotations=annotations,
-            ),
-            included_helper_text=status_result["included_helper_text"],
-        )
-        return result
+
+        return {
+            "state": state,
+            "output": {
+                "title": f"{title}",
+                "summary": "\n\n".join([codecov_link, message]),
+                "annotations": annotations,
+            },
+        }

services/notification/notifiers/mixins/status.py

@@ -1,7 +1,6 @@
 import logging
 from decimal import Decimal, InvalidOperation
 from enum import Enum
-from typing import Literal, TypedDict
 
 from services.comparison import ComparisonProxy, FilteredComparison
 from services.yaml.reader import round_number
@@ -14,35 +13,7 @@ class StatusState(Enum):
     failure = "failure"
 
 
-class StatusResult(TypedDict):
-    """
-    The mixins in this file do the calculations and decide the SuccessState for all Status and Checks Notifiers.
-    Checks have different fields than Statuses, so Checks are converted to the CheckResult type later.
-    """
-
-    state: Literal["success", "failure"]  # StatusState values
-    message: str
-    included_helper_text: dict[str, str]
-
-
-CUSTOM_TARGET_TEXT_PATCH_KEY = "custom_target_helper_text_patch"
-CUSTOM_TARGET_TEXT_PROJECT_KEY = "custom_target_helper_text_project"
-CUSTOM_TARGET_TEXT_VALUE = (
-    "Your {context} {notification_type} has failed because the patch coverage is below the target coverage. "
-    "You can increase the patch coverage or adjust the "
-    "[target](https://docs.codecov.com/docs/commit-status#target) coverage."
-)
-
-
-HELPER_TEXT_MAP = {
-    CUSTOM_TARGET_TEXT_PATCH_KEY: CUSTOM_TARGET_TEXT_VALUE,
-    CUSTOM_TARGET_TEXT_PROJECT_KEY: CUSTOM_TARGET_TEXT_VALUE,
-}
-
-
 class StatusPatchMixin(object):
-    context = "patch"
-
     def _get_threshold(self) -> Decimal:
         """
         Threshold can be configured by user, default is 0.0
@@ -58,7 +29,7 @@ def _get_threshold(self) -> Decimal:
 
     def _get_target(
         self, comparison: ComparisonProxy | FilteredComparison
-    ) -> tuple[Decimal | None, bool]:
+    ) -> Decimal | None:
         """
         Target can be configured by user, default is auto, which is the coverage level from the base report.
         Target will be None if no report is found to compare against.
@@ -68,24 +39,21 @@ def _get_target(
             target_coverage = Decimal(
                 str(self.notifier_yaml_settings.get("target")).replace("%", "")
             )
-            is_custom_target = True
         else:
             target_coverage = (
                 Decimal(comparison.project_coverage_base.report.totals.coverage)
                 if comparison.has_project_coverage_base_report()
                 and comparison.project_coverage_base.report.totals.coverage is not None
                 else None
             )
-            is_custom_target = False
-        return target_coverage, is_custom_target
+        return target_coverage
 
     def get_patch_status(
-        self, comparison: ComparisonProxy | FilteredComparison, notification_type: str
-    ) -> StatusResult:
+        self, comparison: ComparisonProxy | FilteredComparison
+    ) -> tuple[str, str]:
         threshold = self._get_threshold()
-        target_coverage, is_custom_target = self._get_target(comparison)
+        target_coverage = self._get_target(comparison)
         totals = comparison.get_patch_totals()
-        included_helper_text = {}
 
         # coverage affected
         if totals and totals.lines > 0:
@@ -116,16 +84,7 @@ def get_patch_status(
                     message = (
                         f"{coverage_rounded}% of diff hit (target {target_rounded}%)"
                     )
-                # TODO:
-                # if state == StatusState.failure.value and is_custom_target:
-                #     helper_text = HELPER_TEXT_MAP[CUSTOM_TARGET_TEXT_PATCH_KEY].format(
-                #         context=self.context, notification_type=notification_type
-                #     )
-                #     included_helper_text[CUSTOM_TARGET_TEXT_PATCH_KEY] = helper_text
-                #     message = message + " - " + helper_text
-            return StatusResult(
-                state=state, message=message, included_helper_text=included_helper_text
-            )
+            return state, message
 
         # coverage not affected
         if comparison.project_coverage_base.commit:
@@ -135,16 +94,10 @@ def get_patch_status(
             )
         else:
             description = "Coverage not affected"
-        return StatusResult(
-            state=StatusState.success.value,
-            message=description,
-            included_helper_text=included_helper_text,
-        )
+        return StatusState.success.value, description
 
 
 class StatusChangesMixin(object):
-    context = "changes"
-
     def is_a_change_worth_noting(self, change) -> bool:
         if not change.new and not change.deleted:
             # has totals and not -10m => 10h
@@ -191,7 +144,6 @@ def get_changes_status(
 
 class StatusProjectMixin(object):
     DEFAULT_REMOVED_CODE_BEHAVIOR = "adjust_base"
-    context = "project"
 
     def _apply_removals_only_behavior(
         self, comparison: ComparisonProxy | FilteredComparison
@@ -468,11 +420,6 @@ def _get_project_status(
             # use rounded numbers for messages
             target_rounded = round_number(self.current_yaml, target_coverage)
             message = f"{head_coverage_rounded}% (target {target_rounded}%)"
-            # TODO:
-            # helper_text = HELPER_TEXT_MAP[CUSTOM_TARGET_TEXT].format(
-            # context=self.context, notification_type=notification_type)
-            # included_helper_text[CUSTOM_TARGET_TEXT] = helper_text
-            # message = message + " - " + helper_text
             return state, message
 
         # use rounded numbers for messages

services/notification/notifiers/status/patch.py

@@ -1,6 +1,6 @@
 from database.enums import Notification
 from services.comparison import ComparisonProxy, FilteredComparison
-from services.notification.notifiers.mixins.status import StatusPatchMixin, StatusResult
+from services.notification.notifiers.mixins.status import StatusPatchMixin
 from services.notification.notifiers.status.base import StatusNotifier
 
 
@@ -17,24 +17,18 @@ class PatchStatusNotifier(StatusPatchMixin, StatusNotifier):
     """
 
     context = "patch"
-    notification_type_display_name = "status"
 
     @property
     def notification_type(self) -> Notification:
         return Notification.status_patch
 
-    def build_payload(
-        self, comparison: ComparisonProxy | FilteredComparison
-    ) -> StatusResult:
+    def build_payload(self, comparison: ComparisonProxy | FilteredComparison) -> dict:
         if self.is_empty_upload():
             state, message = self.get_status_check_for_empty_upload()
-            result = StatusResult(state=state, message=message, included_helper_text={})
-            return result
+            return {"state": state, "message": message}
 
-        result = self.get_patch_status(
-            comparison, notification_type=self.notification_type_display_name
-        )
+        state, message = self.get_patch_status(comparison)
         if self.should_use_upgrade_decoration():
-            result["message"] = self.get_upgrade_message()
+            message = self.get_upgrade_message()
 
-        return result
+        return {"state": state, "message": message}