add tests, change empty lists to None

Author: saponifi3d

src/sentry/workflow_engine/types.py

@@ -106,19 +106,19 @@ def get_snapshot(self) -> dict[str, Any]:
         if self.associated_detector:
             associated_detector = self.associated_detector.get_snapshot()
 
-        workflow_ids = []
+        workflow_ids = None
         if self.workflows:
             workflow_ids = [workflow.id for workflow in self.workflows]
 
-        triggered_workflows = []
+        triggered_workflows = None
         if self.triggered_workflows:
             triggered_workflows = [workflow.get_snapshot() for workflow in self.triggered_workflows]
 
-        action_filter_conditions = []
+        action_filter_conditions = None
         if self.action_groups:
             action_filter_conditions = [group.get_snapshot() for group in self.action_groups]
 
-        triggered_actions = []
+        triggered_actions = None
         if self.triggered_actions:
             triggered_actions = [action.get_snapshot() for action in self.triggered_actions]
 

tests/sentry/workflow_engine/test_task.py

@@ -154,13 +154,15 @@ def test_process_workflow_activity__no_workflows(self, mock_logger) -> None:
             mock_logger.info.assert_called_once_with(
                 "workflow_engine.process_workflows.evaluation.workflows.not_triggered",
                 extra={
-                    "debug_msg": "No workflows are associated with the detector in the event",
-                    "group_event": self.activity,
-                    "action_groups": None,
+                    "workflow_ids": None,
+                    "associated_detector": self.detector.get_snapshot(),
+                    "event": self.activity,
+                    "group": self.activity.group,
+                    "event_data": self.activity.data,
+                    "action_filter_conditions": None,
                     "triggered_actions": None,
-                    "workflows": set(),
                     "triggered_workflows": None,
-                    "associated_detector": self.detector,
+                    "debug_msg": "No workflows are associated with the detector in the event",
                 },
             )
 
@@ -199,13 +201,15 @@ def test_process_workflow_activity__workflows__no_actions(
         mock_logger.info.assert_called_once_with(
             "workflow_engine.process_workflows.evaluation.workflows.triggered",
             extra={
-                "debug_msg": "No items were triggered or queued for slow evaluation",
-                "group_event": self.activity,
-                "action_groups": None,
+                "workflow_ids": [self.workflow.id],
+                "associated_detector": self.detector.get_snapshot(),
+                "event": self.activity,
+                "group": self.activity.group,
+                "event_data": self.activity.data,
+                "action_filter_conditions": None,
                 "triggered_actions": None,
-                "workflows": {self.workflow},
-                "triggered_workflows": set(),  # from the mock
-                "associated_detector": self.detector,
+                "triggered_workflows": None,
+                "debug_msg": "No items were triggered or queued for slow evaluation",
             },
         )
 
@@ -241,25 +245,15 @@ def test_process_workflow_activity(
         )
 
         mock_filter_actions.assert_called_once_with({self.action_group}, expected_event_data)
-        mock_logger.info.assert_called_once_with(
-            "workflow_engine.process_workflows.evaluation.actions.triggered",
-            extra={
-                "debug_msg": None,
-                "group_event": self.activity,
-                "action_groups": {self.action_group},
-                "triggered_actions": set(),
-                "workflows": {self.workflow},
-                "triggered_workflows": {self.workflow},
-                "associated_detector": self.detector,
-            },
-        )
 
     @mock.patch("sentry.workflow_engine.processors.workflow.evaluate_workflow_triggers")
     @mock.patch("sentry.workflow_engine.tasks.workflows.logger")
     def test_process_workflow_activity__success_logs(
         self, mock_logger, mock_evaluate_workflow_triggers
     ) -> None:
         self.workflow = self.create_workflow(organization=self.organization)
+
+        # Add additional data to ensure logs work as expected
         self.workflow.when_condition_group = self.create_data_condition_group()
         self.create_data_condition(condition_group=self.workflow.when_condition_group)
         self.workflow.save()