Fix a bug where parsing assistant thread message event fails for beta feature enabled apps (#1184)

Author: seratch

slack_bolt/context/assistant/assistant_utilities.py

@@ -7,6 +7,7 @@
 
 from slack_bolt.context.context import BoltContext
 from slack_bolt.context.say import Say
+from .internals import has_channel_id_and_thread_ts
 from ..get_thread_context.get_thread_context import GetThreadContext
 from ..save_thread_context import SaveThreadContext
 from ..set_status import SetStatus
@@ -32,7 +33,7 @@ def __init__(
         self.client = context.client
         self.thread_context_store = thread_context_store or DefaultAssistantThreadContextStore(context)
 
-        if self.payload.get("assistant_thread") is not None:
+        if has_channel_id_and_thread_ts(self.payload):
             # assistant_thread_started
             thread = self.payload["assistant_thread"]
             self.channel_id = thread["channel_id"]

slack_bolt/context/assistant/async_assistant_utilities.py

@@ -10,6 +10,7 @@
 
 from slack_bolt.context.async_context import AsyncBoltContext
 from slack_bolt.context.say.async_say import AsyncSay
+from .internals import has_channel_id_and_thread_ts
 from ..get_thread_context.async_get_thread_context import AsyncGetThreadContext
 from ..save_thread_context.async_save_thread_context import AsyncSaveThreadContext
 from ..set_status.async_set_status import AsyncSetStatus
@@ -35,7 +36,7 @@ def __init__(
         self.client = context.client
         self.thread_context_store = thread_context_store or DefaultAsyncAssistantThreadContextStore(context)
 
-        if self.payload.get("assistant_thread") is not None:
+        if has_channel_id_and_thread_ts(self.payload):
             # assistant_thread_started
             thread = self.payload["assistant_thread"]
             self.channel_id = thread["channel_id"]

slack_bolt/context/assistant/internals.py

@@ -0,0 +1,9 @@
+def has_channel_id_and_thread_ts(payload: dict) -> bool:
+    """Verifies if the given payload has both channel_id and thread_ts under assistant_thread property.
+    This data pattern is available for assistant_* events.
+    """
+    return (
+        payload.get("assistant_thread") is not None
+        and payload["assistant_thread"].get("channel_id") is not None
+        and payload["assistant_thread"].get("thread_ts") is not None
+    )

slack_bolt/request/internals.py

@@ -220,8 +220,14 @@ def extract_thread_ts(payload: Dict[str, Any]) -> Optional[str]:
     # Thus, blindly setting this thread_ts to say utility can break existing apps' behaviors.
     if is_assistant_event(payload):
         event = payload["event"]
-        if event.get("assistant_thread") is not None:
+        if (
+            event.get("assistant_thread") is not None
+            and event["assistant_thread"].get("channel_id") is not None
+            and event["assistant_thread"].get("thread_ts") is not None
+        ):
             # assistant_thread_started, assistant_thread_context_changed
+            # "assistant_thread" property can exist for message event without channel_id and thread_ts
+            # Thus, the above if check verifies these properties exist
             return event["assistant_thread"]["thread_ts"]
         elif event.get("channel") is not None:
             if event.get("thread_ts") is not None:

tests/scenario_tests/test_events_assistant.py

@@ -82,6 +82,11 @@ def handle_user_message(say: Say, set_status: SetStatus, context: BoltContext):
         assert response.status == 200
         assert_target_called()
 
+        request = BoltRequest(body=user_message_event_body_with_assistant_thread, mode="socket_mode")
+        response = app.dispatch(request)
+        assert response.status == 200
+        assert_target_called()
+
         request = BoltRequest(body=message_changed_event_body, mode="socket_mode")
         response = app.dispatch(request)
         assert response.status == 200
@@ -163,6 +168,25 @@ def build_payload(event: dict) -> dict:
 )
 
 
+user_message_event_body_with_assistant_thread = build_payload(
+    {
+        "user": "W222",
+        "type": "message",
+        "ts": "1726133700.887259",
+        "text": "When Slack was released?",
+        "team": "T111",
+        "user_team": "T111",
+        "source_team": "T222",
+        "user_profile": {},
+        "thread_ts": "1726133698.626339",
+        "parent_user_id": "W222",
+        "channel": "D111",
+        "event_ts": "1726133700.887259",
+        "channel_type": "im",
+        "assistant_thread": {"XXX": "YYY"},
+    }
+)
+
 message_changed_event_body = build_payload(
     {
         "type": "message",

tests/scenario_tests_async/test_events_assistant.py

@@ -97,6 +97,11 @@ async def handle_user_message(say: AsyncSay, set_status: AsyncSetStatus, context
         assert response.status == 200
         await assert_target_called()
 
+        request = AsyncBoltRequest(body=user_message_event_body_with_assistant_thread, mode="socket_mode")
+        response = await app.async_dispatch(request)
+        assert response.status == 200
+        await assert_target_called()
+
         request = AsyncBoltRequest(body=message_changed_event_body, mode="socket_mode")
         response = await app.async_dispatch(request)
         assert response.status == 200
@@ -178,6 +183,26 @@ def build_payload(event: dict) -> dict:
 )
 
 
+user_message_event_body_with_assistant_thread = build_payload(
+    {
+        "user": "W222",
+        "type": "message",
+        "ts": "1726133700.887259",
+        "text": "When Slack was released?",
+        "team": "T111",
+        "user_team": "T111",
+        "source_team": "T222",
+        "user_profile": {},
+        "thread_ts": "1726133698.626339",
+        "parent_user_id": "W222",
+        "channel": "D111",
+        "event_ts": "1726133700.887259",
+        "channel_type": "im",
+        "assistant_thread": {"XXX": "YYY"},
+    }
+)
+
+
 message_changed_event_body = build_payload(
     {
         "type": "message",