Use listener registry for assistant ordering

Author: Cr1stal

slack_bolt/app/app.py

@@ -20,6 +20,7 @@
     CallableAuthorize,
 )
 
+from slack_bolt.app.listener_registry import ListenerRegistry
 from slack_bolt.context.assistant.thread_context_store.store import AssistantThreadContextStore
 
 from slack_bolt.error import BoltError, BoltUnhandledRequestError
@@ -348,8 +349,7 @@ def message_hello(message, say):
         # --------------------------------------
 
         self._middleware_list: List[Middleware] = []
-        self._listeners: List[Listener] = []
-        self._assistant_listener_insertion_index = 0
+        self._listeners: ListenerRegistry[Listener] = ListenerRegistry()
 
         if listener_executor is None:
             listener_executor = ThreadPoolExecutor(max_workers=5)
@@ -706,9 +706,7 @@ def _register_assistant_listeners(self, assistant: Assistant) -> None:
             self._assistant_thread_context_store = assistant.thread_context_store
 
         def register_listener(listener: Listener) -> None:
-            # Keep Assistant listeners before catch-all listeners while preserving Assistant registration order.
-            self._listeners.insert(self._assistant_listener_insertion_index, listener)
-            self._assistant_listener_insertion_index += 1
+            self._listeners.append_assistant(listener)
 
         assistant._register_app_listeners(register_listener)
 

slack_bolt/app/async_app.py

@@ -8,6 +8,7 @@
 from aiohttp import web
 
 from slack_bolt.app.async_server import AsyncSlackAppServer
+from slack_bolt.app.listener_registry import ListenerRegistry
 from slack_bolt.context.assistant.thread_context_store.async_store import (
     AsyncAssistantThreadContextStore,
 )
@@ -360,8 +361,7 @@ async def message_hello(message, say):  # async function
         # --------------------------------------
 
         self._async_middleware_list: List[AsyncMiddleware] = []
-        self._async_listeners: List[AsyncListener] = []
-        self._assistant_listener_insertion_index = 0
+        self._async_listeners: ListenerRegistry[AsyncListener] = ListenerRegistry()
 
         self._assistant_thread_context_store = assistant_thread_context_store
         self._attaching_conversation_kwargs_enabled = attaching_conversation_kwargs_enabled
@@ -733,9 +733,7 @@ def _register_assistant_listeners(self, assistant: AsyncAssistant) -> None:
             self._assistant_thread_context_store = assistant.thread_context_store
 
         def register_listener(listener: AsyncListener) -> None:
-            # Keep Assistant listeners before catch-all listeners while preserving Assistant registration order.
-            self._async_listeners.insert(self._assistant_listener_insertion_index, listener)
-            self._assistant_listener_insertion_index += 1
+            self._async_listeners.append_assistant(listener)
 
         assistant._register_app_listeners(register_listener)
 

slack_bolt/app/listener_registry.py

@@ -0,0 +1,33 @@
+from typing import Generic, Iterator, List, TypeVar, Union, overload
+
+ListenerT = TypeVar("ListenerT")
+
+
+class ListenerRegistry(Generic[ListenerT]):
+    def __init__(self) -> None:
+        self._assistant_listeners: List[ListenerT] = []
+        self._listeners: List[ListenerT] = []
+
+    def append(self, listener: ListenerT) -> None:
+        self._listeners.append(listener)
+
+    def append_assistant(self, listener: ListenerT) -> None:
+        self._assistant_listeners.append(listener)
+
+    def __iter__(self) -> Iterator[ListenerT]:
+        yield from self._assistant_listeners
+        yield from self._listeners
+
+    def __len__(self) -> int:
+        return len(self._assistant_listeners) + len(self._listeners)
+
+    @overload
+    def __getitem__(self, index: int) -> ListenerT:
+        pass
+
+    @overload
+    def __getitem__(self, index: slice) -> List[ListenerT]:
+        pass
+
+    def __getitem__(self, index: Union[int, slice]) -> Union[ListenerT, List[ListenerT]]:
+        return list(self)[index]