surface the buffer_size override

Author: WilliamBergamin

slack_bolt/context/say_stream/async_say_stream.py

@@ -32,10 +32,11 @@ def __init__(
     async def __call__(
         self,
         *,
+        buffer_size: Optional[int] = None,
         channel: Optional[str] = None,
-        thread_ts: Optional[str] = None,
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
+        thread_ts: Optional[str] = None,
         **kwargs,
     ) -> AsyncChatStream:
         warnings.warn(
@@ -51,6 +52,15 @@ async def __call__(
         if thread_ts is None:
             raise ValueError("say_stream without thread_ts here is unsupported")
 
+        if buffer_size is not None:
+            return await self.client.chat_stream(
+                channel=channel,
+                thread_ts=thread_ts,
+                buffer_size=buffer_size,
+                recipient_team_id=recipient_team_id or self.recipient_team_id,
+                recipient_user_id=recipient_user_id or self.recipient_user_id,
+                **kwargs,
+            )
         return await self.client.chat_stream(
             channel=channel,
             thread_ts=thread_ts,

slack_bolt/context/say_stream/say_stream.py

@@ -32,10 +32,11 @@ def __init__(
     def __call__(
         self,
         *,
+        buffer_size: Optional[int] = None,
         channel: Optional[str] = None,
-        thread_ts: Optional[str] = None,
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
+        thread_ts: Optional[str] = None,
         **kwargs,
     ) -> ChatStream:
         warnings.warn(
@@ -51,6 +52,15 @@ def __call__(
         if thread_ts is None:
             raise ValueError("say_stream without thread_ts here is unsupported")
 
+        if buffer_size is not None:
+            return self.client.chat_stream(
+                channel=channel,
+                thread_ts=thread_ts,
+                buffer_size=buffer_size,
+                recipient_team_id=recipient_team_id or self.recipient_team_id,
+                recipient_user_id=recipient_user_id or self.recipient_user_id,
+                **kwargs,
+            )
         return self.client.chat_stream(
             channel=channel,
             thread_ts=thread_ts,

tests/slack_bolt/context/test_say_stream.py

@@ -7,6 +7,8 @@
 
 
 class TestSayStream:
+    default_chat_stream_buffer_size = WebClient.chat_stream.__kwdefaults__["buffer_size"]
+
     def setup_method(self):
         setup_mock_web_api_server(self)
         valid_token = "xoxb-valid"
@@ -38,6 +40,7 @@ def test_default_params(self):
         )
         stream = say_stream()
 
+        assert stream._buffer_size == self.default_chat_stream_buffer_size
         assert stream._stream_args == {
             "channel": "C111",
             "thread_ts": "111.222",
@@ -56,6 +59,7 @@ def test_parameter_overrides(self):
         )
         stream = say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
 
+        assert stream._buffer_size == self.default_chat_stream_buffer_size
         assert stream._stream_args == {
             "channel": "C222",
             "thread_ts": "333.444",
@@ -64,15 +68,30 @@ def test_parameter_overrides(self):
             "task_display_mode": None,
         }
 
-    def test_buffer_size_passthrough(self):
+    def test_buffer_size_overrides(self):
         say_stream = SayStream(
             client=self.web_client,
             channel="C111",
             thread_ts="111.222",
+            recipient_team_id="T111",
+            recipient_user_id="U111",
+        )
+        stream = say_stream(
+            buffer_size=100,
+            channel="C222",
+            thread_ts="333.444",
+            recipient_team_id="T222",
+            recipient_user_id="U222",
         )
-        stream = say_stream(buffer_size=100)
 
         assert stream._buffer_size == 100
+        assert stream._stream_args == {
+            "channel": "C222",
+            "thread_ts": "333.444",
+            "recipient_team_id": "T222",
+            "recipient_user_id": "U222",
+            "task_display_mode": None,
+        }
 
     def test_experimental_warning(self):
         say_stream = SayStream(

tests/slack_bolt_async/context/test_async_say_stream.py

@@ -11,6 +11,8 @@
 
 
 class TestAsyncSayStream:
+    default_chat_stream_buffer_size = AsyncWebClient.chat_stream.__kwdefaults__["buffer_size"]
+
     @pytest.fixture(scope="function", autouse=True)
     def setup_teardown(self):
         old_os_env = remove_os_env_temporarily()
@@ -48,6 +50,8 @@ async def test_default_params(self):
             recipient_user_id="U111",
         )
         stream = await say_stream()
+
+        assert stream._buffer_size == self.default_chat_stream_buffer_size
         assert stream._stream_args == {
             "channel": "C111",
             "thread_ts": "111.222",
@@ -67,6 +71,7 @@ async def test_parameter_overrides(self):
         )
         stream = await say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
 
+        assert stream._buffer_size == self.default_chat_stream_buffer_size
         assert stream._stream_args == {
             "channel": "C222",
             "thread_ts": "333.444",
@@ -76,15 +81,30 @@ async def test_parameter_overrides(self):
         }
 
     @pytest.mark.asyncio
-    async def test_buffer_size_passthrough(self):
+    async def test_buffer_size_overrides(self):
         say_stream = AsyncSayStream(
             client=self.web_client,
             channel="C111",
             thread_ts="111.222",
+            recipient_team_id="T111",
+            recipient_user_id="U111",
+        )
+        stream = await say_stream(
+            buffer_size=100,
+            channel="C222",
+            thread_ts="333.444",
+            recipient_team_id="T222",
+            recipient_user_id="U222",
         )
-        stream = await say_stream(buffer_size=100)
 
         assert stream._buffer_size == 100
+        assert stream._stream_args == {
+            "channel": "C222",
+            "thread_ts": "333.444",
+            "recipient_team_id": "T222",
+            "recipient_user_id": "U222",
+            "task_display_mode": None,
+        }
 
     @pytest.mark.asyncio
     async def test_experimental_warning(self):