Feat/webhook resolve slack user (#953)

* Feat: add Slack email mapping functionality for payloads

* Feat: add Slack user mention replacement functionality

* Feat: integrate email mapping to Slack users in webhook handling

* fix: remove unused async

Author: gcharest

app/api/v1/routes/webhooks.py

@@ -10,6 +10,7 @@
 )
 from modules.slack import webhooks
 from modules.webhooks.base import handle_webhook_payload
+from modules.webhooks.slack import map_emails_to_slack_users
 
 
 logger = get_module_logger()
@@ -71,6 +72,7 @@ def handle_webhook(
         webhook_result.payload, WebhookPayload
     ):
         webhook_payload = webhook_result.payload
+        webhook_payload = map_emails_to_slack_users(webhook_payload)
         webhook_payload.channel = webhook["channel"]["S"]
         hook_type = webhook.get("hook_type", {}).get(
             "S", "alert"

app/integrations/slack/users.py

@@ -6,6 +6,7 @@
 import re
 from slack_sdk import WebClient
 from core.logging import get_module_logger
+from integrations.slack.client import SlackClientManager
 
 SLACK_USER_ID_REGEX = r"^[A-Z0-9]+$"
 
@@ -146,3 +147,45 @@ def replace_with_handle(match):
     # Use re.sub() with the callback function to replace all matches
     updated_message = re.sub(user_id_pattern, replace_with_handle, message)
     return updated_message
+
+
+def replace_users_emails_with_mention(text: str) -> str:
+    """Replace email addresses in the given text with Slack user mentions when resolvable.
+
+    Args:
+        text (str): The input text potentially containing email addresses.
+    Returns:
+        str: The modified text with email addresses replaced by Slack user mentions.
+    """
+
+    client = SlackClientManager.get_client()
+    if not client:
+        return text
+    email_pattern = r"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}"
+    matches = re.findall(email_pattern, text)
+    for email in matches:
+        response = client.users_lookupByEmail(email=email)
+        if response:
+            user: dict = response.get("user", {})
+            user_handle = user.get("id")
+            if user_handle:
+                text = text.replace(email, f"<@{user_handle}>")
+    return text
+
+
+def replace_users_emails_in_dict(data):
+    """Recursively replace email addresses in all string values within a nested dictionary or list.
+
+    Args:
+        data (dict or list): The input data structure potentially containing email addresses.
+    Returns:
+        dict or list: The modified data structure with email addresses replaced by Slack user mentions.
+    """
+    if isinstance(data, dict):
+        return {k: replace_users_emails_in_dict(v) for k, v in data.items()}
+    elif isinstance(data, list):
+        return [replace_users_emails_in_dict(item) for item in data]
+    elif isinstance(data, str):
+        return replace_users_emails_with_mention(data)
+    else:
+        return data

app/modules/webhooks/slack.py

@@ -0,0 +1,15 @@
+from integrations.slack.users import (
+    replace_users_emails_in_dict,
+    replace_users_emails_with_mention,
+)
+from models.webhooks import WebhookPayload
+
+
+def map_emails_to_slack_users(webhook_payload: WebhookPayload) -> WebhookPayload:
+    """Replace email addresses in a Slack webhook payload's 'blocks' or top-level 'text'
+    with Slack user mentions when resolvable; return the modified payload."""
+    if webhook_payload.text:
+        webhook_payload.text = replace_users_emails_with_mention(webhook_payload.text)
+    if webhook_payload.blocks:
+        webhook_payload.blocks = replace_users_emails_in_dict(webhook_payload.blocks)
+    return webhook_payload

app/tests/api/v1/test_webhooks.py

@@ -1,6 +1,5 @@
 from unittest.mock import patch, MagicMock, PropertyMock, call, ANY
 
-# from urllib import response
 import pytest
 import httpx
 from fastapi.testclient import TestClient
@@ -25,6 +24,7 @@ def test_client(bot_mock):
     return TestClient(test_app)
 
 
+@patch("api.v1.routes.webhooks.map_emails_to_slack_users")
 @patch("api.v1.routes.webhooks.log_to_sentinel")
 @patch("api.v1.routes.webhooks.append_incident_buttons")
 @patch("api.v1.routes.webhooks.handle_webhook_payload")
@@ -36,6 +36,7 @@ def test_handle_webhook(
     mock_handle_webhook_payload,
     mock_append_incident_buttons,
     mock_log_to_sentinel,
+    mock_map_emails_to_slack_users,
     test_client,
 ):
     payload = {"text": "some text"}
@@ -66,6 +67,7 @@ def test_handle_webhook(
     mock_handle_webhook_payload.assert_called_once_with(payload, ANY)
     mock_append_incident_buttons.assert_called_once()
     mock_log_to_sentinel.assert_called_once()
+    mock_map_emails_to_slack_users.assert_called_once()
 
 
 def test_handle_webhook_malformed_json_string(test_client):

app/tests/integrations/slack/test_users.py

@@ -291,3 +291,215 @@ def test_get_user_email_from_handle(mock_get_all_users):
         == "[email protected]"
     )
     assert users.get_user_email_from_handle(client, "@unknown_name") is None
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_success(mock_slack_client_manager):
+    mock_client = MagicMock()
+    mock_slack_client_manager.get_client.return_value = mock_client
+    mock_client.users_lookupByEmail.return_value = {"user": {"id": "U12345"}}
+
+    text = "Please contact [email protected] for more information."
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == "Please contact <@U12345> for more information."
+    mock_client.users_lookupByEmail.assert_called_once_with(
+        email="[email protected]"
+    )
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_multiple_emails(mock_slack_client_manager):
+    mock_client = MagicMock()
+    mock_slack_client_manager.get_client.return_value = mock_client
+
+    def mock_lookup_by_email(email):
+        if email == "[email protected]":
+            return {"user": {"id": "U12345"}}
+        elif email == "[email protected]":
+            return {"user": {"id": "U67890"}}
+        return None
+
+    mock_client.users_lookupByEmail.side_effect = mock_lookup_by_email
+
+    text = "Contact [email protected] or [email protected] for help."
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == "Contact <@U12345> or <@U67890> for help."
+    assert mock_client.users_lookupByEmail.call_count == 2
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_no_user_found(mock_slack_client_manager):
+    mock_client = MagicMock()
+    mock_slack_client_manager.get_client.return_value = mock_client
+    mock_client.users_lookupByEmail.return_value = None
+
+    text = "Please contact [email protected] for more information."
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == "Please contact [email protected] for more information."
+    mock_client.users_lookupByEmail.assert_called_once_with(email="[email protected]")
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_no_user_id(mock_slack_client_manager):
+    mock_client = MagicMock()
+    mock_slack_client_manager.get_client.return_value = mock_client
+    mock_client.users_lookupByEmail.return_value = {"user": {}}
+
+    text = "Please contact [email protected] for more information."
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == "Please contact [email protected] for more information."
+    mock_client.users_lookupByEmail.assert_called_once_with(
+        email="[email protected]"
+    )
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_no_client(mock_slack_client_manager):
+    mock_slack_client_manager.get_client.return_value = None
+
+    text = "Please contact [email protected] for more information."
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == "Please contact [email protected] for more information."
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_no_emails(mock_slack_client_manager):
+    mock_client = MagicMock()
+    mock_slack_client_manager.get_client.return_value = mock_client
+
+    text = "This text has no email addresses in it."
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == "This text has no email addresses in it."
+    mock_client.users_lookupByEmail.assert_not_called()
+
+
+@patch("integrations.slack.users.SlackClientManager")
+def test_replace_users_emails_with_mention_empty_text(mock_slack_client_manager):
+    mock_client = MagicMock()
+    mock_slack_client_manager.get_client.return_value = mock_client
+
+    text = ""
+    result = users.replace_users_emails_with_mention(text)
+
+    assert result == ""
+    mock_client.users_lookupByEmail.assert_not_called()
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_string_value(mock_replace_function):
+    mock_replace_function.return_value = "replaced text"
+
+    data = "[email protected]"
+    result = users.replace_users_emails_in_dict(data)
+
+    assert result == "replaced text"
+    mock_replace_function.assert_called_once_with("[email protected]")
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_simple_dict(mock_replace_function):
+    mock_replace_function.side_effect = lambda x: x.replace(
+        "[email protected]", "<@U12345>"
+    )
+
+    data = {"message": "Contact [email protected]", "title": "Important"}
+    result = users.replace_users_emails_in_dict(data)
+
+    expected = {"message": "Contact <@U12345>", "title": "Important"}
+    assert result == expected
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_nested_dict(mock_replace_function):
+    mock_replace_function.side_effect = lambda x: (
+        x.replace("[email protected]", "<@U67890>") if "[email protected]" in x else x
+    )
+
+    data = {
+        "user": {"contact": "[email protected]", "name": "Jane"},
+        "metadata": {"created_by": "system"},
+    }
+    result = users.replace_users_emails_in_dict(data)
+
+    expected = {
+        "user": {"contact": "<@U67890>", "name": "Jane"},
+        "metadata": {"created_by": "system"},
+    }
+    assert result == expected
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_list_of_strings(mock_replace_function):
+    mock_replace_function.side_effect = lambda x: (
+        x.replace("[email protected]", "<@U11111>") if "[email protected]" in x else x
+    )
+
+    data = ["Contact [email protected]", "No email here", "Another message"]
+    result = users.replace_users_emails_in_dict(data)
+
+    expected = ["Contact <@U11111>", "No email here", "Another message"]
+    assert result == expected
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_list_of_dicts(mock_replace_function):
+    mock_replace_function.side_effect = lambda x: (
+        x.replace("[email protected]", "<@U22222>") if "[email protected]" in x else x
+    )
+
+    data = [
+        {"message": "Contact [email protected]", "priority": "high"},
+        {"message": "No email", "priority": "low"},
+    ]
+    result = users.replace_users_emails_in_dict(data)
+
+    expected = [
+        {"message": "Contact <@U22222>", "priority": "high"},
+        {"message": "No email", "priority": "low"},
+    ]
+    assert result == expected
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_mixed_types(mock_replace_function):
+    def mock_replacement(x):
+        if "[email protected]" in x:
+            return x.replace("[email protected]", "<@U33333>")
+        return x
+
+    mock_replace_function.side_effect = mock_replacement
+
+    data = {
+        "text": "Contact [email protected]",
+        "number": 42,
+        "boolean": True,
+        "null_value": None,
+        "list": ["[email protected]", 123, False],
+    }
+    result = users.replace_users_emails_in_dict(data)
+
+    expected = {
+        "text": "Contact <@U33333>",
+        "number": 42,
+        "boolean": True,
+        "null_value": None,
+        "list": ["<@U33333>", 123, False],
+    }
+    assert result == expected
+
+
+@patch("integrations.slack.users.replace_users_emails_with_mention")
+def test_replace_users_emails_in_dict_non_string_non_dict_non_list(
+    mock_replace_function,
+):
+    data = 42
+    result = users.replace_users_emails_in_dict(data)
+
+    assert result == 42
+    mock_replace_function.assert_not_called()