bring assistant logic to general bolt logic

Author: WilliamBergamin

slack_bolt/context/assistant/assistant_utilities.py

@@ -1,4 +1,3 @@
-import warnings
 from typing import Optional
 
 from slack_sdk.web import WebClient
@@ -8,12 +7,8 @@
 
 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
-from ..set_suggested_prompts import SetSuggestedPrompts
-from ..set_title import SetTitle
 
 
 class AssistantUtilities:
@@ -34,48 +29,13 @@ def __init__(
         self.client = context.client
         self.thread_context_store = thread_context_store or DefaultAssistantThreadContextStore(context)
 
-        if has_channel_id_and_thread_ts(self.payload):
-            # assistant_thread_started
-            thread = self.payload["assistant_thread"]
-            self.channel_id = thread["channel_id"]
-            self.thread_ts = thread["thread_ts"]
-        elif self.payload.get("channel") is not None and self.payload.get("thread_ts") is not None:
-            # message event
-            self.channel_id = self.payload["channel"]
-            self.thread_ts = self.payload["thread_ts"]
+        if context.channel_id is not None and context.thread_ts is not None:
+            self.channel_id = context.channel_id
+            self.thread_ts = context.thread_ts
         else:
             # When moving this code to Bolt internals, no need to raise an exception for this pattern
             raise ValueError(f"Cannot instantiate Assistant for this event pattern ({self.payload})")
 
-    def is_valid(self) -> bool:
-        return self.channel_id is not None and self.thread_ts is not None
-
-    @property
-    def set_status(self) -> SetStatus:
-        warnings.warn(
-            "AssistantUtilities.set_status is deprecated. "
-            "Use the set_status argument directly in your listener function "
-            "or access it via context.set_status instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return SetStatus(self.client, self.channel_id, self.thread_ts)
-
-    @property
-    def set_title(self) -> SetTitle:
-        return SetTitle(self.client, self.channel_id, self.thread_ts)
-
-    @property
-    def set_suggested_prompts(self) -> SetSuggestedPrompts:
-        warnings.warn(
-            "AssistantUtilities.set_suggested_prompts is deprecated. "
-            "Use the set_suggested_prompts argument directly in your listener function "
-            "or access it via context.set_suggested_prompts instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return SetSuggestedPrompts(self.client, self.channel_id, self.thread_ts)
-
     @property
     def say(self) -> Say:
         def build_metadata() -> Optional[dict]:

slack_bolt/context/assistant/async_assistant_utilities.py

@@ -1,4 +1,3 @@
-import warnings
 from typing import Optional
 
 from slack_sdk.web.async_client import AsyncWebClient
@@ -11,12 +10,8 @@
 
 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
-from ..set_suggested_prompts.async_set_suggested_prompts import AsyncSetSuggestedPrompts
-from ..set_title.async_set_title import AsyncSetTitle
 
 
 class AsyncAssistantUtilities:
@@ -37,48 +32,13 @@ def __init__(
         self.client = context.client
         self.thread_context_store = thread_context_store or DefaultAsyncAssistantThreadContextStore(context)
 
-        if has_channel_id_and_thread_ts(self.payload):
-            # assistant_thread_started
-            thread = self.payload["assistant_thread"]
-            self.channel_id = thread["channel_id"]
-            self.thread_ts = thread["thread_ts"]
-        elif self.payload.get("channel") is not None and self.payload.get("thread_ts") is not None:
-            # message event
-            self.channel_id = self.payload["channel"]
-            self.thread_ts = self.payload["thread_ts"]
+        if context.channel_id is not None and context.thread_ts is not None:
+            self.channel_id = context.channel_id
+            self.thread_ts = context.thread_ts
         else:
             # When moving this code to Bolt internals, no need to raise an exception for this pattern
             raise ValueError(f"Cannot instantiate Assistant for this event pattern ({self.payload})")
 
-    def is_valid(self) -> bool:
-        return self.channel_id is not None and self.thread_ts is not None
-
-    @property
-    def set_status(self) -> AsyncSetStatus:
-        warnings.warn(
-            "AsyncAssistantUtilities.set_status is deprecated. "
-            "Use the set_status argument directly in your listener function "
-            "or access it via context.set_status instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return AsyncSetStatus(self.client, self.channel_id, self.thread_ts)
-
-    @property
-    def set_title(self) -> AsyncSetTitle:
-        return AsyncSetTitle(self.client, self.channel_id, self.thread_ts)
-
-    @property
-    def set_suggested_prompts(self) -> AsyncSetSuggestedPrompts:
-        warnings.warn(
-            "AsyncAssistantUtilities.set_suggested_prompts is deprecated. "
-            "Use the set_suggested_prompts argument directly in your listener function "
-            "or access it via context.set_suggested_prompts instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return AsyncSetSuggestedPrompts(self.client, self.channel_id, self.thread_ts)
-
     @property
     def say(self) -> AsyncSay:
         return AsyncSay(

slack_bolt/context/assistant/internals.py

@@ -5,6 +5,7 @@
 from slack_bolt.context.say_stream.async_say_stream import AsyncSayStream
 from slack_bolt.context.set_status.async_set_status import AsyncSetStatus
 from slack_bolt.context.set_suggested_prompts.async_set_suggested_prompts import AsyncSetSuggestedPrompts
+from slack_bolt.context.set_title.async_set_title import AsyncSetTitle
 from slack_bolt.middleware.async_middleware import AsyncMiddleware
 from slack_bolt.request.async_request import AsyncBoltRequest
 from slack_bolt.request.payload_utils import (
@@ -32,43 +33,48 @@ async def async_process(
         next: Callable[[], Awaitable[BoltResponse]],
     ) -> Optional[BoltResponse]:
         event = to_event(req.body)
-        if event is not None:
-            if is_assistant_event(req.body):
-                assistant = AsyncAssistantUtilities(
-                    payload=event,
-                    context=req.context,
-                    thread_context_store=self.thread_context_store,
-                )
-                req.context["say"] = assistant.say
-                req.context["set_title"] = assistant.set_title
-                # req.context["set_suggested_prompts"] = assistant.set_suggested_prompts
-                req.context["get_thread_context"] = assistant.get_thread_context
-                req.context["save_thread_context"] = assistant.save_thread_context
+        if event is None:
+            return await next()
+        if req.context.channel_id is None:
+            return await next()
 
-            if req.context.channel_id:
-                # TODO: in the future we might want to introduce a "proper" extract_ts utility
-                thread_ts = req.context.thread_ts or event.get("ts")
-                if (
-                    is_im_message_event(req.body)
-                    or is_assistant_thread_started_event(req.body)
-                    or is_assistant_thread_context_changed_event(req.body)
-                ):
-                    req.context["set_suggested_prompts"] = AsyncSetSuggestedPrompts(
-                        client=req.context.client,
-                        channel_id=req.context.channel_id,
-                        thread_ts=thread_ts,
-                    )
-                if thread_ts:
-                    req.context["set_status"] = AsyncSetStatus(
-                        client=req.context.client,
-                        channel_id=req.context.channel_id,
-                        thread_ts=thread_ts,
-                    )
-                    req.context["say_stream"] = AsyncSayStream(
-                        client=req.context.client,
-                        channel=req.context.channel_id,
-                        recipient_team_id=req.context.team_id or req.context.enterprise_id,
-                        recipient_user_id=req.context.user_id,
-                        thread_ts=thread_ts,
-                    )
+        if is_assistant_event(req.body):
+            # TODO: eventually we might remove this assistant specific logic
+            assistant = AsyncAssistantUtilities(
+                payload=event,
+                context=req.context,
+                thread_context_store=self.thread_context_store,
+            )
+            req.context["say"] = assistant.say
+            req.context["get_thread_context"] = assistant.get_thread_context
+            req.context["save_thread_context"] = assistant.save_thread_context
+
+        if (
+            is_im_message_event(req.body)
+            or is_assistant_thread_started_event(req.body)
+            or is_assistant_thread_context_changed_event(req.body)
+        ):
+            req.context["set_suggested_prompts"] = AsyncSetSuggestedPrompts(
+                client=req.context.client,
+                channel_id=req.context.channel_id,
+                thread_ts=req.context.thread_ts,
+            )
+            if req.context.thread_ts:
+                req.context["set_title"] = AsyncSetTitle(req.context.client, req.context.channel_id, req.context.thread_ts)
+
+        # TODO: in the future we might want to introduce a "proper" extract_ts utility
+        thread_ts_or_ts = req.context.thread_ts or event.get("ts")
+        if thread_ts_or_ts:
+            req.context["set_status"] = AsyncSetStatus(
+                client=req.context.client,
+                channel_id=req.context.channel_id,
+                thread_ts=thread_ts_or_ts,
+            )
+            req.context["say_stream"] = AsyncSayStream(
+                client=req.context.client,
+                channel=req.context.channel_id,
+                recipient_team_id=req.context.team_id or req.context.enterprise_id,
+                recipient_user_id=req.context.user_id,
+                thread_ts=thread_ts_or_ts,
+            )
         return await next()

slack_bolt/middleware/attaching_conversation_kwargs/async_attaching_conversation_kwargs.py

@@ -1,11 +1,12 @@
 from typing import Optional, Callable
 
-from slack_bolt.context.assistant.assistant_utilities import AssistantUtilities
 from slack_bolt.context.assistant.thread_context_store.store import AssistantThreadContextStore
 from slack_bolt.context.say_stream.say_stream import SayStream
 from slack_bolt.context.set_status.set_status import SetStatus
 from slack_bolt.context.set_suggested_prompts.set_suggested_prompts import SetSuggestedPrompts
+from slack_bolt.context.set_title import SetTitle
 from slack_bolt.middleware import Middleware
+from slack_bolt.context.assistant.assistant_utilities import AssistantUtilities
 from slack_bolt.request.payload_utils import (
     is_assistant_event,
     is_assistant_thread_context_changed_event,
@@ -26,43 +27,48 @@ def __init__(self, thread_context_store: Optional[AssistantThreadContextStore] =
 
     def process(self, *, req: BoltRequest, resp: BoltResponse, next: Callable[[], BoltResponse]) -> Optional[BoltResponse]:
         event = to_event(req.body)
-        if event is not None:
-            if is_assistant_event(req.body):
-                assistant = AssistantUtilities(
-                    payload=event,
-                    context=req.context,
-                    thread_context_store=self.thread_context_store,
-                )
-                req.context["say"] = assistant.say
-                req.context["set_title"] = assistant.set_title
-                # req.context["set_suggested_prompts"] = assistant.set_suggested_prompts
-                req.context["get_thread_context"] = assistant.get_thread_context
-                req.context["save_thread_context"] = assistant.save_thread_context
+        if event is None:
+            return next()
+        if req.context.channel_id is None:
+            return next()
+
+        if is_assistant_event(req.body):
+            # TODO: eventually we might remove this assistant specific logic
+            assistant = AssistantUtilities(
+                payload=event,
+                context=req.context,
+                thread_context_store=self.thread_context_store,
+            )
+            req.context["say"] = assistant.say
+            req.context["get_thread_context"] = assistant.get_thread_context
+            req.context["save_thread_context"] = assistant.save_thread_context
+
+        if (
+            is_im_message_event(req.body)
+            or is_assistant_thread_started_event(req.body)
+            or is_assistant_thread_context_changed_event(req.body)
+        ):
+            req.context["set_suggested_prompts"] = SetSuggestedPrompts(
+                client=req.context.client,
+                channel_id=req.context.channel_id,
+                thread_ts=req.context.thread_ts,
+            )
+            if req.context.thread_ts:
+                req.context["set_title"] = SetTitle(req.context.client, req.context.channel_id, req.context.thread_ts)
 
-            if req.context.channel_id:
-                # TODO: in the future we might want to introduce a "proper" extract_ts utility
-                thread_ts = req.context.thread_ts or event.get("ts")
-                if (
-                    is_im_message_event(req.body)
-                    or is_assistant_thread_started_event(req.body)
-                    or is_assistant_thread_context_changed_event(req.body)
-                ):
-                    req.context["set_suggested_prompts"] = SetSuggestedPrompts(
-                        client=req.context.client,
-                        channel_id=req.context.channel_id,
-                        thread_ts=thread_ts,
-                    )
-                if thread_ts:
-                    req.context["set_status"] = SetStatus(
-                        client=req.context.client,
-                        channel_id=req.context.channel_id,
-                        thread_ts=thread_ts,
-                    )
-                    req.context["say_stream"] = SayStream(
-                        client=req.context.client,
-                        channel=req.context.channel_id,
-                        recipient_team_id=req.context.team_id or req.context.enterprise_id,
-                        recipient_user_id=req.context.user_id,
-                        thread_ts=thread_ts,
-                    )
+        # TODO: in the future we might want to introduce a "proper" extract_ts utility
+        thread_ts_or_ts = req.context.thread_ts or event.get("ts")
+        if thread_ts_or_ts:
+            req.context["set_status"] = SetStatus(
+                client=req.context.client,
+                channel_id=req.context.channel_id,
+                thread_ts=thread_ts_or_ts,
+            )
+            req.context["say_stream"] = SayStream(
+                client=req.context.client,
+                channel=req.context.channel_id,
+                recipient_team_id=req.context.team_id or req.context.enterprise_id,
+                recipient_user_id=req.context.user_id,
+                thread_ts=thread_ts_or_ts,
+            )
         return next()

slack_bolt/middleware/attaching_conversation_kwargs/attaching_conversation_kwargs.py

@@ -37,6 +37,19 @@ def is_message_event(body: Dict[str, Any]) -> bool:
     return False
 
 
+def is_any_im_message_event(body: Dict[str, Any]) -> bool:
+    if is_message_event(body):
+        # Any message event with no subtype or any subtype (message_changed, message_deleted, etc.)
+        return body["event"].get("channel_type") == "im"
+    return False
+
+
+def is_im_message_event(body: Dict[str, Any]) -> bool:
+    if is_any_im_message_event(body):
+        return body["event"].get("subtype") in (None, "file_share")
+    return False
+
+
 def is_assistant_event(body: Dict[str, Any]) -> bool:
     return is_event(body) and (
         is_assistant_thread_started_event(body)
@@ -58,19 +71,6 @@ def is_assistant_thread_context_changed_event(body: Dict[str, Any]) -> bool:
     return False
 
 
-def is_any_im_message_event(body: Dict[str, Any]) -> bool:
-    if is_message_event(body):
-        # no subtype or message_changed, message_deleted etc.
-        return body["event"].get("channel_type") == "im"
-    return False
-
-
-def is_im_message_event(body: Dict[str, Any]) -> bool:
-    if is_any_im_message_event(body):
-        return body["event"].get("subtype") in (None, "file_share")
-    return False
-
-
 def is_user_message_event_in_assistant_thread(body: Dict[str, Any]) -> bool:
     if is_event(body):
         return (