add some tests and make sure things are working

Author: saponifi3d

src/sentry/workflow_engine/tasks.py

@@ -1,16 +1,14 @@
-from typing import TYPE_CHECKING
-
 from sentry.issues.status_change_consumer import group_status_update_registry
+from sentry.issues.status_change_message import StatusChangeMessageData
+from sentry.models.activity import Activity
+from sentry.models.group import Group
 from sentry.silo.base import SiloMode
 from sentry.tasks.base import instrumented_task
 from sentry.taskworker import config, namespaces, retry
+from sentry.types.activity import ActivityType
 from sentry.utils import metrics
 
-if TYPE_CHECKING:
-    from sentry.issues.status_change_message import StatusChangeMessageData
-    from sentry.models.activity import Activity
-    from sentry.models.group import Group
-    from sentry.workflow_engine.models import Detector
+SUPPORTED_ACTIVITIES = [ActivityType.SET_RESOLVED]
 
 
 @instrumented_task(
@@ -30,7 +28,7 @@
         ),
     ),
 )
-def process_workflow_task(activity_id: Activity.id, detector_id: Detector.id) -> None:
+def process_workflow_task(activity_id: int, detector_id: int) -> None:
     """
     Process a workflow task identified by the given Activity ID and Detector ID.
 
@@ -56,6 +54,10 @@ def workflow_status_update_handler(
     Since this handler is called in process for the activity, we want
     to queue a task to process workflows asynchronously.
     """
+    if activity.type not in SUPPORTED_ACTIVITIES:
+        # If the activity type is not supported, we do not need to process it.
+        return
+
     detector_id = status_change_message.get("detector_id")
 
     if detector_id is None:
@@ -65,8 +67,7 @@ def workflow_status_update_handler(
         return
 
     # TODO - implement in follow-up PR for now, just track a metric that we are seeing the activities.
+    # process_workflow_task.delay(activity.id, detector_id)
     metrics.incr(
         "workflow_engine.process_workflow.activity_update", tags={"activity_type": activity.type}
     )
-    # TODO - should this also set the group id so we can set it on WorkflowEventData at the top level? :thinking:
-    # process_workflow_task.delay(activity.id, detector_id)

tests/sentry/workflow_engine/test_tasks.py

@@ -0,0 +1,70 @@
+from unittest import mock
+
+from sentry.issues.status_change_consumer import update_status
+from sentry.issues.status_change_message import StatusChangeMessageData
+from sentry.models.group import GroupStatus
+from sentry.testutils.cases import TestCase
+from sentry.types.activity import ActivityType
+from sentry.types.group import GroupSubStatus
+from sentry.workflow_engine.tasks import workflow_status_update_handler
+
+
+class IssuePlatformIntegrationTests(TestCase):
+    def test_handler_invoked__when_resolved(self):
+        """
+        Integration test to ensure the `update_status` method
+        will correctly invoke the `workflow_state_update_handler`
+        and increment the metric.
+        """
+        detector = self.create_detector()
+        group = self.create_group(
+            project=self.project,
+            status=GroupStatus.UNRESOLVED,
+            substatus=GroupSubStatus.ESCALATING,
+        )
+
+        message = StatusChangeMessageData(
+            id="test_message_id",
+            project_id=self.project.id,
+            new_status=GroupStatus.RESOLVED,
+            new_substatus=None,
+            fingerprint=["test_fingerprint"],
+            detector_id=detector.id,
+        )
+
+        with mock.patch("sentry.workflow_engine.tasks.metrics.incr") as mock_incr:
+            update_status(group, message)
+            mock_incr.assert_called_with(
+                "workflow_engine.process_workflow.activity_update",
+                tags={"activity_type": ActivityType.SET_RESOLVED.value},
+            )
+
+
+def WorkflowStatusUpdateHandlerTests(TestCase):
+    def test__no_detector_id(self):
+        """
+        Test that the workflow_status_update_handler does not crash
+        when no detector_id is provided in the status change message.
+        """
+        group = self.create_group(project=self.project)
+        activity = self.create_activity(
+            group=group,
+            type=ActivityType.SET_RESOLVED,
+            data={"fingerprint": ["test_fingerprint"]},
+        )
+
+        message = StatusChangeMessageData(
+            id="test_message_id",
+            project_id=self.project.id,
+            new_status=GroupStatus.RESOLVED,
+            new_substatus=None,
+            fingerprint=["test_fingerprint"],
+            detector_id=None,  # No detector_id provided
+        )
+
+        with mock.patch("sentry.workflow_engine.tasks.metrics.incr") as mock_incr:
+            workflow_status_update_handler(group, message, activity)
+            mock_incr.assert_called_with(
+                "workflow_engine.error.tasks.no_detector_id",
+                tags={"activity_type": ActivityType.SET_RESOLVED.value},
+            )