feat(integration): Allow passing of RuleFireHistory (#67214)

We need to be able to access the instance of RuleFireHistory in the
Slack notifications, such that we can record it for the notification
message, and then try to get a plausible slack thread in future fires.
To do this without having to query for the row/instance again, we need
to be able to first grab the instance of the record when it's created,
and pass that down to the action, specially only for Slack.

In a previous attempt, we caused an issue because we had to query by a
non-index column. We can avoid that altogether by just passing down the
object that we need. Previous problem:
#66936

Author: ykamo001

src/sentry/rules/actions/base.py

@@ -7,20 +7,24 @@
 
 from sentry.eventstore.models import GroupEvent
 from sentry.models.rule import Rule
+from sentry.models.rulefirehistory import RuleFireHistory
 from sentry.rules.base import CallbackFuture, EventState, RuleBase
 
 logger = logging.getLogger("sentry.rules")
 
 
-def instantiate_action(rule: Rule, action):
+def instantiate_action(rule: Rule, action, rule_fire_history: RuleFireHistory | None = None):
     from sentry.rules import rules
 
-    action_cls = rules.get(action["id"])
+    action_id = action["id"]
+    action_cls = rules.get(action_id)
     if action_cls is None:
         logger.warning("Unregistered action %r", action["id"])
         return None
 
-    action_inst = action_cls(rule.project, data=action, rule=rule)
+    action_inst = action_cls(
+        rule.project, data=action, rule=rule, rule_fire_history=rule_fire_history
+    )
     if not isinstance(action_inst, EventAction):
         logger.warning("Unregistered action %r", action["id"])
         return None

src/sentry/rules/base.py

@@ -11,6 +11,7 @@
 from sentry.eventstore.models import GroupEvent
 from sentry.models.project import Project
 from sentry.models.rule import Rule
+from sentry.models.rulefirehistory import RuleFireHistory
 from sentry.snuba.dataset import Dataset
 from sentry.types.condition_activity import ConditionActivity
 from sentry.types.rules import RuleFuture
@@ -61,11 +62,13 @@ def __init__(
         project: Project,
         data: dict[str, Any] | None = None,
         rule: Rule | None = None,
+        rule_fire_history: RuleFireHistory | None = None,
     ) -> None:
         self.project = project
         self.data = data or {}
         self.had_data = data is not None
         self.rule = rule
+        self.rule_fire_history = rule_fire_history
 
     id: ClassVar[str]
     label: ClassVar[str]

src/sentry/rules/history/backends/postgres.py

@@ -47,8 +47,8 @@ def record(
         group: Group,
         event_id: str | None = None,
         notification_uuid: str | None = None,
-    ) -> None:
-        RuleFireHistory.objects.create(
+    ) -> RuleFireHistory | None:
+        return RuleFireHistory.objects.create(
             project=rule.project,
             rule=rule,
             group=group,

src/sentry/rules/history/base.py

@@ -8,6 +8,8 @@
 from sentry.utils.services import Service
 
 if TYPE_CHECKING:
+    from typing import Any
+
     from sentry.models.group import Group
     from sentry.models.rule import Rule
     from sentry.utils.cursors import Cursor, CursorResult
@@ -40,7 +42,7 @@ def record(
         group: Group,
         event_id: str | None = None,
         notification_uuid: str | None = None,
-    ) -> None:
+    ) -> Any | None:
         """
         Records an instance of an issue alert being fired for a given group.
         """

src/sentry/rules/processor.py

@@ -15,6 +15,7 @@
 from sentry.models.environment import Environment
 from sentry.models.grouprulestatus import GroupRuleStatus
 from sentry.models.rule import Rule
+from sentry.models.rulefirehistory import RuleFireHistory
 from sentry.models.rulesnooze import RuleSnooze
 from sentry.rules import EventState, history, rules
 from sentry.rules.actions.base import instantiate_action
@@ -262,13 +263,18 @@ def apply_rule(self, rule: Rule, status: GroupRuleStatus) -> None:
             )
 
         notification_uuid = str(uuid.uuid4())
-        history.record(rule, self.group, self.event.event_id, notification_uuid)
-        self.activate_downstream_actions(rule, notification_uuid)
+        rule_fire_history = history.record(rule, self.group, self.event.event_id, notification_uuid)
+        self.activate_downstream_actions(rule, notification_uuid, rule_fire_history)
 
-    def activate_downstream_actions(self, rule: Rule, notification_uuid: str | None = None) -> None:
+    def activate_downstream_actions(
+        self,
+        rule: Rule,
+        notification_uuid: str | None = None,
+        rule_fire_history: RuleFireHistory | None = None,
+    ) -> None:
         state = self.get_state()
         for action in rule.data.get("actions", ()):
-            action_inst = instantiate_action(rule, action)
+            action_inst = instantiate_action(rule, action, rule_fire_history)
             if not action_inst:
                 continue
 

tests/sentry/integrations/slack/actions/__init__.py

@@ -0,0 +1,35 @@
+from uuid import uuid4
+
+from sentry.integrations.slack import SlackNotifyServiceAction
+from sentry.models.rulefirehistory import RuleFireHistory
+from sentry.testutils.cases import TestCase
+
+
+class TestInit(TestCase):
+    def setUp(self) -> None:
+        self.rule = self.create_project_rule(project=self.project)
+        self.notification_uuid = str(uuid4())
+        self.event_id = 456
+        self.rule_fire_history = RuleFireHistory.objects.create(
+            project=self.project,
+            rule=self.rule,
+            group=self.group,
+            event_id=self.event_id,
+            notification_uuid=self.notification_uuid,
+        )
+
+    def test_when_rule_fire_history_is_passed_in(self) -> None:
+        instance = SlackNotifyServiceAction(
+            self.project, data={}, rule=self.rule, rule_fire_history=self.rule_fire_history
+        )
+        assert instance.rule_fire_history is not None
+
+    def test_when_rule_fire_history_is_not_passed_in(self) -> None:
+        instance = SlackNotifyServiceAction(self.project, data={}, rule=self.rule)
+        assert instance.rule_fire_history is None
+
+    def test_when_rule_fire_history_is_none(self) -> None:
+        instance = SlackNotifyServiceAction(
+            self.project, data={}, rule=self.rule, rule_fire_history=None
+        )
+        assert instance.rule_fire_history is None

tests/sentry/integrations/slack/actions/notification/__init__.py

@@ -0,0 +1,7 @@
+from sentry.rules.actions import EventAction
+from sentry.testutils.cases import TestCase
+
+
+class TestRuleType(TestCase):
+    def test_default(self) -> None:
+        assert EventAction.rule_type == "action/event"

tests/sentry/integrations/slack/actions/notification/test_slack_notify_service_action.py

@@ -0,0 +1,39 @@
+from uuid import uuid4
+
+from sentry.integrations.slack import SlackNotifyServiceAction
+from sentry.models.rulefirehistory import RuleFireHistory
+from sentry.rules.actions.base import instantiate_action
+from sentry.testutils.cases import TestCase
+
+
+class TestInstantiateAction(TestCase):
+    def setUp(self) -> None:
+        self.rule = self.create_project_rule(project=self.project)
+        self.notification_uuid = str(uuid4())
+        self.event_id = 456
+        self.rule_fire_history = RuleFireHistory.objects.create(
+            project=self.project,
+            rule=self.rule,
+            group=self.group,
+            event_id=self.event_id,
+            notification_uuid=self.notification_uuid,
+        )
+
+    def test_passes_in_rule_fire_history(self) -> None:
+        action = {
+            "id": SlackNotifyServiceAction.id,
+        }
+
+        instance = instantiate_action(
+            rule=self.rule, action=action, rule_fire_history=self.rule_fire_history
+        )
+        assert instance.rule_fire_history is not None
+        assert instance.rule_fire_history == self.rule_fire_history
+
+    def test_respects_empty_rule_fire_history(self) -> None:
+        action = {
+            "id": SlackNotifyServiceAction.id,
+        }
+
+        instance = instantiate_action(rule=self.rule, action=action)
+        assert instance.rule_fire_history is None

tests/sentry/rules/actions/__init__.py

@@ -29,6 +29,11 @@ def test(self):
         assert RuleFireHistory.objects.filter(rule=rule, group=group_2).count() == 1
         assert RuleFireHistory.objects.filter(rule=rule).count() == 3
 
+    def test_returns_new_instance(self) -> None:
+        rule = Rule.objects.create(project=self.event.project)
+        new_instance = self.backend.record(rule, self.group)
+        assert new_instance is not None
+
 
 @freeze_time()
 class FetchRuleGroupsPaginatedTest(BasePostgresRuleHistoryBackendTest):