Merge pull request #85 from GabrielSalla/slack-add-mention-on-update

Slack: add mention on update option

Author: GabrielSalla

docs/plugins/slack.md

@@ -70,9 +70,11 @@ Parameters:
 - `channel`: The Slack channel where notifications will be sent.
 - `title`: A title for the notification to help users to identify the problem.
 - `issues_fields`: A list of fields from the issue data to include in the notification.
+- `min_priority_to_send`: Minimum alert priority that triggers a notification. Notifications will be sent if the alert is not acknowledged at the current priority level and it's is greater than or equal to this setting. Defaults to `low` (P4).
 - `mention`: Slack user or group to mention if the alert reaches a specified priority. Provide the Slack identifier for a user (e.g., `U0011223344`) or a group (e.g., `G0011223344`). Set to `None` to avoid mentioning anyone. Defaults to `None`.
 - `min_priority_to_mention`: Minimum alert priority that triggers a mention. Mentions will occur if the alert is not acknowledged at the current priority level and it's is greater than or equal to this setting. Defaults to `moderate` (P3).
-- `issue_show_limit`: Maximum number of issues to show in the notification. If the limit is reached, the message `XXX more...` will be shown at the and of the issues list, where `XXX` is the number of issues that are not being shown. Defaults to 10.
+- `mention_on_update`: If set to 'False', the mention will be sent when the alert becomes unacknowledged and the priority is greater than or equal to the minimum priority to mention. If the alert is updated and the alert continues to be unacknowledged, the mention will persist. When set to 'True', the mention will be deleted and sent again every time alert is updated, if the alert is not acknowledged and the priority is greater than or equal to the minimum priority to mention. This option can be used as a renotification. Defaults to `False`.
+- `issue_show_limit`: Maximum number of issues to show in the notification. If the limit is reached, the message `XXX more...` will be shown at the and of the issues list, where `XXX` is the number of issues not being shown. Defaults to 10.
 
 The Slack message will show the alert and its issues information. The notification will persist and will be updated until the alert is detected as solved, even if its priority falls to P5.
 

src/plugins/slack/notifications/slack_notification.py

@@ -40,19 +40,32 @@ class SlackNotification:
     - `channel`: The Slack channel where notifications will be sent (e.g., `C0011223344`).
     - `title`: A title for the notification to help users to identify the problem.
     - `issues_fields`: A list of fields from the issue data to include in the notification.
+    - `min_priority_to_send`: Minimum alert priority that triggers a notification. Notifications
+    will be sent if the alert is not acknowledged at the current priority level and it's greater
+    than or equal to this setting. Defaults to `low` (P4).
     - `mention`: Slack user or group to mention if the alert reaches a specified priority. Provide
     the Slack identifier for a user (e.g., `U0011223344`) or a group (e.g., `G0011223344`). Set to
     `None` to avoid mentioning anyone. Defaults to `None`.
     - `min_priority_to_mention`: Minimum alert priority that triggers a mention. Mentions will
     occur if the alert is not acknowledged at the current priority level and it's is greater than
     or equal to this setting. Defaults to `moderate` (P3).
+    - `mention_on_update`: If set to 'False', the mention will be sent when the alert becomes
+    unacknowledged and the priority is greater than or equal to the minimum priority to mention. If
+    the alert is updated and the alert continues to be unacknowledged, the mention will persist.
+    When set to 'True', the mention will be deleted and sent again every time alert is updated, if
+    the alert is not acknowledged and the priority is greater than or equal to the minimum priority
+    to mention. This option can be used as a renotification. Defaults to `False`.
+    -  `issue_show_limit`: Maximum number of issues to show in the notification. If the limit is
+    reached, the message `XXX more...` will be shown at the and of the issues list, where `XXX` is
+    the number of issues not being shown. Defaults to `10`.
     """
 
     channel: str
     title: str
     issues_fields: list[str]
     min_priority_to_send: int = AlertPriority.low
     mention: str | None = None
+    mention_on_update: bool = False
     min_priority_to_mention: int = AlertPriority.moderate
     issue_show_limit: int = 10
 
@@ -372,7 +385,11 @@ async def notification_mention(
         await _delete_mention(notification)
         return
 
-    # If already has a mention message, just return
+    # If the mention should be sent on update, delete the previous mention message
+    if notification_options.mention_on_update:
+        await _delete_mention(notification)
+
+    # If the mention message already exists, do not send it again
     if notification.data.get("mention_ts") is not None:
         return
 

tests/plugins/slack/notifications/test_slack_notification.py

@@ -1196,6 +1196,42 @@ async def test_notification_mention_already_sent(mocker, monkeypatch, sample_mon
     send_mention_spy.assert_not_called()
 
 
+async def test_notification_mention_mention_on_update(mocker, monkeypatch, sample_monitor: Monitor):
+    """'notification_mention' should resend a mention message if the notification already has
+    a notification mention message and the option 'mention_on_update' is set to 'True'"""
+    monkeypatch.setattr(slack_mock, "response_ts", "123123")
+    monkeypatch.setattr(slack_notification, "_should_have_mention", lambda *args: True)
+    delete_mention_spy: AsyncMock = mocker.spy(slack_notification, "_delete_mention")
+    send_mention_spy: AsyncMock = mocker.spy(slack_notification, "_send_mention")
+
+    alert = await Alert.create(
+        monitor_id=sample_monitor.id,
+    )
+    notification_options = slack_notification.SlackNotification(
+        channel="channel",
+        title="title",
+        issues_fields=["col"],
+        mention="mention",
+        min_priority_to_mention=5,
+        mention_on_update=True,
+    )
+    notification = await Notification.create(
+        monitor_id=sample_monitor.id,
+        alert_id=alert.id,
+        target="slack",
+        data={"channel": "channel", "ts": "33.55", "mention_ts": "11.22"},
+    )
+
+    await slack_notification.notification_mention(
+        sample_monitor, alert, notification, notification_options
+    )
+
+    delete_mention_spy.assert_awaited_once()
+    send_mention_spy.assert_awaited_once()
+    await notification.refresh()
+    assert notification.data == {"channel": "channel", "ts": "33.55", "mention_ts": "123123"}
+
+
 async def test_handle_slack_notification_no_alert(mocker):
     """'_handle_slack_notification' should just return if couldn't find an alert with the provided
     id"""