Merge branch 'main' into remove-say-stream-experiement

Author: zimeg

.github/workflows/ci-build.yml

@@ -44,8 +44,19 @@ jobs:
         uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
         with:
           python-version: ${{ env.LATEST_SUPPORTED_PY }}
-      - name: Run mypy verification
-        run: ./scripts/run_mypy.sh
+      - name: Install synchronous dependencies
+        run: |
+          pip install -U pip
+          pip install -U .
+          pip install -r requirements/tools.txt
+      - name: Type check synchronous modules
+        run: mypy --config-file pyproject.toml --exclude "async_|/adapter/"
+      - name: Install async and adapter dependencies
+        run: |
+          pip install -r requirements/async.txt
+          pip install -r requirements/adapter.txt
+      - name: Type check all modules
+        run: mypy --config-file pyproject.toml
 
   unittest:
     name: Unit tests
@@ -115,7 +126,7 @@ jobs:
           pytest tests/scenario_tests_async/ --junitxml=reports/test_scenario_async.xml
       - name: Upload test results to Codecov
         if: ${{ !cancelled() }}
-        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
+        uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0
         with:
           directory: ./reports/
           fail_ci_if_error: true
@@ -151,7 +162,7 @@ jobs:
         run: |
           pytest --cov=./slack_bolt/ --cov-report=xml
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
+        uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0
         with:
           fail_ci_if_error: true
           report_type: coverage
@@ -168,7 +179,7 @@ jobs:
     if: ${{ !success() && github.ref == 'refs/heads/main' && github.event_name != 'workflow_dispatch' }}
     steps:
       - name: Send notifications of failing tests
-        uses: slackapi/slack-github-action@91efab103c0de0a537f72a35f6b8cda0ee76bf0a # v2.1.1
+        uses: slackapi/slack-github-action@af78098f536edbc4de71162a307590698245be95 # v3.0.1
         with:
           errors: true
           webhook: ${{ secrets.SLACK_REGRESSION_FAILURES_WEBHOOK_URL }}

.github/workflows/dependencies.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Collect metadata
         id: metadata
-        uses: dependabot/fetch-metadata@21025c705c08248db411dc16f3619e6b5f9ea21a # v2.5.0
+        uses: dependabot/fetch-metadata@ffa630c65fa7e0ecfa0625b5ceda64399aea1b36 # v3.0.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Approve

.github/workflows/pypi-release.yml

@@ -52,7 +52,7 @@ jobs:
 
     steps:
       - name: Retrieve dist folder
-        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: release-dist
           path: dist/
@@ -76,7 +76,7 @@ jobs:
 
     steps:
       - name: Retrieve dist folder
-        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
         with:
           name: release-dist
           path: dist/

slack_bolt/app/app.py

@@ -69,7 +69,7 @@
     IgnoringSelfEvents,
     CustomMiddleware,
     AttachingFunctionToken,
-    AttachingAgentKwargs,
+    AttachingConversationKwargs,
 )
 from slack_bolt.middleware.assistant import Assistant
 from slack_bolt.middleware.message_listener_matches import MessageListenerMatches
@@ -133,7 +133,7 @@ def __init__(
         listener_executor: Optional[Executor] = None,
         # for AI Agents & Assistants
         assistant_thread_context_store: Optional[AssistantThreadContextStore] = None,
-        attaching_agent_kwargs_enabled: bool = True,
+        attaching_conversation_kwargs_enabled: bool = True,
     ):
         """Bolt App that provides functionalities to register middleware/listeners.
 
@@ -354,7 +354,7 @@ def message_hello(message, say):
             listener_executor = ThreadPoolExecutor(max_workers=5)
 
         self._assistant_thread_context_store = assistant_thread_context_store
-        self._attaching_agent_kwargs_enabled = attaching_agent_kwargs_enabled
+        self._attaching_conversation_kwargs_enabled = attaching_conversation_kwargs_enabled
 
         self._process_before_response = process_before_response
         self._listener_runner = ThreadListenerRunner(
@@ -844,8 +844,8 @@ def ask_for_introduction(event, say):
         def __call__(*args, **kwargs):
             functions = self._to_listener_functions(kwargs) if kwargs else list(args)
             primary_matcher = builtin_matchers.event(event, base_logger=self._base_logger)
-            if self._attaching_agent_kwargs_enabled:
-                middleware.insert(0, AttachingAgentKwargs(self._assistant_thread_context_store))
+            if self._attaching_conversation_kwargs_enabled:
+                middleware.insert(0, AttachingConversationKwargs(self._assistant_thread_context_store))
             return self._register_listener(list(functions), primary_matcher, matchers, middleware, True)
 
         return __call__
@@ -903,8 +903,8 @@ def __call__(*args, **kwargs):
             primary_matcher = builtin_matchers.message_event(
                 keyword=keyword, constraints=constraints, base_logger=self._base_logger
             )
-            if self._attaching_agent_kwargs_enabled:
-                middleware.insert(0, AttachingAgentKwargs(self._assistant_thread_context_store))
+            if self._attaching_conversation_kwargs_enabled:
+                middleware.insert(0, AttachingConversationKwargs(self._assistant_thread_context_store))
             middleware.insert(0, MessageListenerMatches(keyword))
             return self._register_listener(list(functions), primary_matcher, matchers, middleware, True)
 

slack_bolt/app/async_app.py

@@ -86,7 +86,7 @@
     AsyncIgnoringSelfEvents,
     AsyncUrlVerification,
     AsyncAttachingFunctionToken,
-    AsyncAttachingAgentKwargs,
+    AsyncAttachingConversationKwargs,
 )
 from slack_bolt.middleware.async_custom_middleware import (
     AsyncMiddleware,
@@ -142,7 +142,7 @@ def __init__(
         verification_token: Optional[str] = None,
         # for AI Agents & Assistants
         assistant_thread_context_store: Optional[AsyncAssistantThreadContextStore] = None,
-        attaching_agent_kwargs_enabled: bool = True,
+        attaching_conversation_kwargs_enabled: bool = True,
     ):
         """Bolt App that provides functionalities to register middleware/listeners.
 
@@ -363,7 +363,7 @@ async def message_hello(message, say):  # async function
         self._async_listeners: List[AsyncListener] = []
 
         self._assistant_thread_context_store = assistant_thread_context_store
-        self._attaching_agent_kwargs_enabled = attaching_agent_kwargs_enabled
+        self._attaching_conversation_kwargs_enabled = attaching_conversation_kwargs_enabled
 
         self._process_before_response = process_before_response
         self._async_listener_runner = AsyncioListenerRunner(
@@ -872,8 +872,8 @@ async def ask_for_introduction(event, say):
         def __call__(*args, **kwargs):
             functions = self._to_listener_functions(kwargs) if kwargs else list(args)
             primary_matcher = builtin_matchers.event(event, True, base_logger=self._base_logger)
-            if self._attaching_agent_kwargs_enabled:
-                middleware.insert(0, AsyncAttachingAgentKwargs(self._assistant_thread_context_store))
+            if self._attaching_conversation_kwargs_enabled:
+                middleware.insert(0, AsyncAttachingConversationKwargs(self._assistant_thread_context_store))
             return self._register_listener(list(functions), primary_matcher, matchers, middleware, True)
 
         return __call__
@@ -934,8 +934,8 @@ def __call__(*args, **kwargs):
                 asyncio=True,
                 base_logger=self._base_logger,
             )
-            if self._attaching_agent_kwargs_enabled:
-                middleware.insert(0, AsyncAttachingAgentKwargs(self._assistant_thread_context_store))
+            if self._attaching_conversation_kwargs_enabled:
+                middleware.insert(0, AsyncAttachingConversationKwargs(self._assistant_thread_context_store))
             middleware.insert(0, AsyncMessageListenerMatches(keyword))
             return self._register_listener(list(functions), primary_matcher, matchers, middleware, True)
 

slack_bolt/app/async_server.py

@@ -1,25 +1,28 @@
 import logging
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 from aiohttp import web
 
 from slack_bolt.adapter.aiohttp import to_bolt_request, to_aiohttp_response
 from slack_bolt.response import BoltResponse
 from slack_bolt.util.utils import get_boot_message
 
+if TYPE_CHECKING:
+    from slack_bolt.app.async_app import AsyncApp
+
 
 class AsyncSlackAppServer:
     port: int
     path: str
     host: str
-    bolt_app: "AsyncApp"  # type: ignore[name-defined]
+    bolt_app: "AsyncApp"
     web_app: web.Application
 
     def __init__(
         self,
         port: int,
         path: str,
-        app: "AsyncApp",  # type: ignore[name-defined]
+        app: "AsyncApp",
         host: Optional[str] = None,
     ):
         """Standalone AIOHTTP Web Server.
@@ -34,7 +37,7 @@ def __init__(
         self.port = port
         self.path = path
         self.host = host if host is not None else "0.0.0.0"
-        self.bolt_app: "AsyncApp" = app  # type: ignore[name-defined]
+        self.bolt_app: "AsyncApp" = app
         self.web_app = web.Application()
         self._bolt_oauth_flow = self.bolt_app.oauth_flow
         if self._bolt_oauth_flow:

slack_bolt/context/async_context.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 from slack_sdk.web.async_client import AsyncWebClient
 
@@ -16,6 +16,9 @@
 from slack_bolt.context.set_title.async_set_title import AsyncSetTitle
 from slack_bolt.util.utils import create_copy
 
+if TYPE_CHECKING:
+    from slack_bolt.listener.asyncio_runner import AsyncioListenerRunner
+
 
 class AsyncBoltContext(BaseContext):
     """Context object associated with a request from Slack."""
@@ -42,7 +45,7 @@ def to_copyable(self) -> "AsyncBoltContext":
 
     # The return type is intentionally string to avoid circular imports
     @property
-    def listener_runner(self) -> "AsyncioListenerRunner":  # type: ignore[name-defined]
+    def listener_runner(self) -> "AsyncioListenerRunner":
         """The properly configured listener_runner that is available for middleware/listeners."""
         return self["listener_runner"]
 

slack_bolt/context/context.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 from slack_sdk import WebClient
 
@@ -16,6 +16,9 @@
 from slack_bolt.context.set_title import SetTitle
 from slack_bolt.util.utils import create_copy
 
+if TYPE_CHECKING:
+    from slack_bolt.listener.thread_runner import ThreadListenerRunner
+
 
 class BoltContext(BaseContext):
     """Context object associated with a request from Slack."""
@@ -43,7 +46,7 @@ def to_copyable(self) -> "BoltContext":
 
     # The return type is intentionally string to avoid circular imports
     @property
-    def listener_runner(self) -> "ThreadListenerRunner":  # type: ignore[name-defined]
+    def listener_runner(self) -> "ThreadListenerRunner":
         """The properly configured listener_runner that is available for middleware/listeners."""
         return self["listener_runner"]
 

slack_bolt/kwargs_injection/args.py

@@ -104,7 +104,7 @@ def handle_buttons(args):
     save_thread_context: Optional[SaveThreadContext]
     """`save_thread_context()` utility function for AI Agents & Assistants"""
     say_stream: Optional[SayStream]
-    """`say_stream()` utility function for AI Agents & Assistants"""
+    """`say_stream()` utility function for conversations, AI Agents & Assistants"""
     # middleware
     next: Callable[[], None]
     """`next()` utility function, which tells the middleware chain that it can continue with the next one"""

slack_bolt/listener/async_listener_error_handler.py

@@ -48,9 +48,10 @@ async def handle(
         )
         returned_response = await self.func(**kwargs)
         if returned_response is not None and isinstance(returned_response, BoltResponse):
-            response.status = returned_response.status  # type: ignore[union-attr]
-            response.headers = returned_response.headers  # type: ignore[union-attr]
-            response.body = returned_response.body  # type: ignore[union-attr]
+            assert response is not None, "response must be provided when returning a BoltResponse from an error handler"
+            response.status = returned_response.status
+            response.headers = returned_response.headers
+            response.body = returned_response.body
 
 
 class AsyncDefaultListenerErrorHandler(AsyncListenerErrorHandler):