Resolve user identifiers to display or real names for incoming Slack messages

src/ctp_slack_bot/app.py

@@ -34,7 +34,7 @@ async def main() -> None:
     container.schedule_service()
 
     # Start the Slack socket mode handler in the background.
-    socket_mode_handler = container.socket_mode_handler()
+    socket_mode_handler = await container.socket_mode_handler()
     slack_bolt_task = create_task(socket_mode_handler.start_async())
     shutdown_signal_handler = create_shutdown_signal_handler()
     loop = get_running_loop()

src/ctp_slack_bot/services/slack_service.py

@@ -1,8 +1,10 @@
-from dependency_injector.resources import Resource
+from dependency_injector.resources import AsyncResource
 from loguru import logger
 from openai import OpenAI
 from pydantic import BaseModel
+from re import compile as compile_re
 from slack_bolt.async_app import AsyncApp
+from slack_sdk.web.async_slack_response import AsyncSlackResponse
 from typing import Any, Mapping, Self
 
 from ctp_slack_bot.enums import EventType
@@ -10,6 +12,9 @@ from ctp_slack_bot.models import SlackMessage, SlackResponse
 from ctp_slack_bot.services.event_brokerage_service import EventBrokerageService
 
 
+SLACK_USER_MENTION_PATTERN = compile_re(r"<@([A-Z0-9]+)>")
+
+
 class SlackService(BaseModel):
     """
     Service for interfacing with Slack.
@@ -17,6 +22,7 @@ class SlackService(BaseModel):
 
     event_brokerage_service: EventBrokerageService
     slack_bolt_app: AsyncApp
+    user_id_name_map: dict[str, str] # This is deliberately mutable; the map may change as new users are encountered.
 
     class Config:
         arbitrary_types_allowed = True
@@ -28,6 +34,7 @@ class SlackService(BaseModel):
         logger.debug("Created {}", self.__class__.__name__)
 
     def adapt_event_payload(self: Self, event: Mapping[str, Any]) -> SlackMessage:
+        text = SLACK_USER_MENTION_PATTERN.sub(lambda match: f"@{self.user_id_name_map.get(match.group(1))}", event.get("text", "")) # TODO: permit look-up of Slack again when not found.
         return SlackMessage(
             type=event.get("type"),
             subtype=event.get("subtype"),
@@ -36,7 +43,7 @@ class SlackService(BaseModel):
             user=event.get("user"),
             bot_id=event.get("bot_id"),
             thread_ts=event.get("thread_ts"),
-            text=event.get("text", ""),
+            text=text,
             ts=event.get("ts"),
             event_ts=event.get("event_ts")
         )
@@ -57,13 +64,23 @@ class SlackService(BaseModel):
         logger.debug("Received app mention for processing: {}", body.get("event", {}).get("text"))
         await self.process_message(body)
 
-    def register(self: Self) -> None:
+    def initialize(self: Self) -> None:
         self.slack_bolt_app.event("message")(self.handle_message_event)
         self.slack_bolt_app.event("app_mention")(self.handle_app_mention_event)
         logger.debug("Registered 2 handlers for Slack Bolt message and app mention events.")
 
-class SlackServiceResource(Resource):
-    def init(self: Self, event_brokerage_service: EventBrokerageService, slack_bolt_app: AsyncApp) -> SlackService:
-        slack_service = SlackService(event_brokerage_service=event_brokerage_service, slack_bolt_app=slack_bolt_app)
-        slack_service.register()
+
+class SlackServiceResource(AsyncResource):
+    async def init(self: Self, event_brokerage_service: EventBrokerageService, slack_bolt_app: AsyncApp) -> SlackService:
+        match await slack_bolt_app.client.users_list():
+            case AsyncSlackResponse(status_code=200, data={"ok": True, "members": users}):
+                user_id_name_map = {user["id"]: user["profile"]["display_name"] or user["real_name"]
+                                    for user
+                                    in users}
+                logger.debug("Obtained a list of {} user name(s) for the workspace: {}", len(user_id_name_map), user_id_name_map)
+            case something:
+                user_id_name_map = {}
+                logger.error("Could not obtain a list of user name for the workspace.")
+        slack_service = SlackService(event_brokerage_service=event_brokerage_service, slack_bolt_app=slack_bolt_app, user_id_name_map=user_id_name_map)
+        slack_service.initialize()
         return slack_service