Ref #984: do not post comments if body is empty (#997)

Author: leplatrem

jbi/jira/service.py

@@ -120,10 +120,11 @@ def add_jira_comment(self, context: ActionContext):
         commenter = context.event.user.login if context.event.user else "unknown"
         comment = context.bug.comment
         assert comment  # See jbi.steps.create_comment()
+        assert comment.body  # Also see jbi.steps.create_comment()
 
         issue_key = context.jira.issue
         formatted_comment = (
-            f"*{commenter}* commented: \n{markdown_to_jira(comment.body or "")}"
+            f"*{commenter}* commented: \n{markdown_to_jira(comment.body)}"
         )
         jira_response = self.client.issue_add_comment(
             issue_key=issue_key,

jbi/steps.py

@@ -57,6 +57,13 @@ def create_comment(context: ActionContext, *, jira_service: JiraService) -> Step
         )
         return (StepStatus.NOOP, context)
 
+    if not bug.comment.body:
+        logger.info(
+            "Comment message is empty",
+            extra=context.model_dump(),
+        )
+        return (StepStatus.NOOP, context)
+
     jira_response = jira_service.add_jira_comment(context)
     context = context.append_responses(jira_response)
     return (StepStatus.SUCCESS, context)

tests/unit/test_steps.py

@@ -234,6 +234,30 @@ def test_added_comment(
     )
 
 
+def test_empty_comment_not_added(
+    action_context_factory, mocked_jira, action_params_factory
+):
+    empty_comment_context = action_context_factory(
+        operation=Operation.COMMENT,
+        bug__see_also=["https://mozilla.atlassian.net/browse/JBI-234"],
+        bug__with_comment=True,
+        bug__comment__number=2,
+        bug__comment__body="",
+        bug__comment__is_private=False,
+        event__target="comment",
+        event__user__login="[email protected]",
+        jira__issue="JBI-234",
+    )
+
+    callable_object = Executor(
+        action_params_factory(jira_project_key=empty_comment_context.jira.project)
+    )
+
+    callable_object(context=empty_comment_context)
+
+    mocked_jira.issue_add_comment.assert_not_called()
+
+
 def test_jira_returns_an_error(
     context_create_example: ActionContext, mocked_jira, action_params_factory
 ):