Improve unit tests around SayStream

Author: WilliamBergamin

slack_bolt/__init__.py

@@ -14,6 +14,7 @@
 from .context.fail import Fail
 from .context.respond import Respond
 from .context.say import Say
+from .context.say_stream import SayStream
 from .kwargs_injection import Args
 from .listener import Listener
 from .listener_matcher import CustomListenerMatcher
@@ -42,6 +43,7 @@
     "Fail",
     "Respond",
     "Say",
+    "SayStream",
     "Args",
     "Listener",
     "CustomListenerMatcher",

slack_bolt/context/say_stream/async_say_stream.py

@@ -32,7 +32,6 @@ 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,
@@ -52,16 +51,6 @@ async def __call__(
         if thread_ts is None:
             raise ValueError("say_stream without thread_ts here is unsupported")
 
-        if buffer_size:
-            return await self.client.chat_stream(
-                buffer_size=buffer_size,
-                channel=channel,
-                thread_ts=thread_ts,
-                recipient_team_id=recipient_team_id or self.team_id,
-                recipient_user_id=recipient_user_id or self.user_id,
-                **kwargs,
-            )
-
         return await self.client.chat_stream(
             channel=channel,
             thread_ts=thread_ts,

slack_bolt/context/say_stream/say_stream.py

@@ -32,7 +32,6 @@ 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,
@@ -52,16 +51,6 @@ def __call__(
         if thread_ts is None:
             raise ValueError("say_stream without thread_ts here is unsupported")
 
-        if buffer_size:
-            return self.client.chat_stream(
-                buffer_size=buffer_size,
-                channel=channel,
-                thread_ts=thread_ts,
-                recipient_team_id=recipient_team_id or self.team_id,
-                recipient_user_id=recipient_user_id or self.user_id,
-                **kwargs,
-            )
-
         return self.client.chat_stream(
             channel=channel,
             thread_ts=thread_ts,

tests/slack_bolt/context/test_say_stream.py

@@ -0,0 +1,84 @@
+from unittest.mock import MagicMock
+
+import pytest
+from slack_sdk import WebClient
+
+from slack_bolt.context.say_stream.say_stream import SayStream
+from slack_bolt.warning import ExperimentalWarning
+
+
+class TestSayStream:
+    def setup_method(self):
+        self.mock_client = MagicMock(spec=WebClient)
+        self.mock_client.chat_stream = MagicMock()
+
+    def test_missing_channel_raises(self):
+        say_stream = SayStream(client=self.mock_client, channel_id=None, thread_ts="111.222")
+        with pytest.warns(ExperimentalWarning):
+            with pytest.raises(ValueError, match="channel"):
+                say_stream()
+
+    def test_missing_thread_ts_raises(self):
+        say_stream = SayStream(client=self.mock_client, channel_id="C111", thread_ts=None)
+        with pytest.warns(ExperimentalWarning):
+            with pytest.raises(ValueError, match="thread_ts"):
+                say_stream()
+
+    def test_default_params(self):
+        say_stream = SayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+            team_id="T111",
+            user_id="U111",
+        )
+        say_stream()
+
+        self.mock_client.chat_stream.assert_called_once_with(
+            channel="C111",
+            thread_ts="111.222",
+            recipient_team_id="T111",
+            recipient_user_id="U111",
+        )
+
+    def test_parameter_overrides(self):
+        say_stream = SayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+            team_id="T111",
+            user_id="U111",
+        )
+        say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
+
+        self.mock_client.chat_stream.assert_called_once_with(
+            channel="C222",
+            thread_ts="333.444",
+            recipient_team_id="T222",
+            recipient_user_id="U222",
+        )
+
+    def test_buffer_size_passthrough(self):
+        say_stream = SayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+        )
+        say_stream(buffer_size=100)
+
+        self.mock_client.chat_stream.assert_called_once_with(
+            buffer_size=100,
+            channel="C111",
+            thread_ts="111.222",
+            recipient_team_id=None,
+            recipient_user_id=None,
+        )
+
+    def test_experimental_warning(self):
+        say_stream = SayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+        )
+        with pytest.warns(ExperimentalWarning, match="say_stream is experimental"):
+            say_stream()

tests/slack_bolt_async/context/test_async_say_stream.py

@@ -0,0 +1,90 @@
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+from slack_sdk.web.async_client import AsyncWebClient
+
+from slack_bolt.context.say_stream.async_say_stream import AsyncSayStream
+from slack_bolt.warning import ExperimentalWarning
+
+
+class TestAsyncSayStream:
+    def setup_method(self):
+        self.mock_client = MagicMock(spec=AsyncWebClient)
+        self.mock_client.chat_stream = AsyncMock()
+
+    @pytest.mark.asyncio
+    async def test_missing_channel_raises(self):
+        say_stream = AsyncSayStream(client=self.mock_client, channel_id=None, thread_ts="111.222")
+        with pytest.warns(ExperimentalWarning):
+            with pytest.raises(ValueError, match="channel"):
+                await say_stream()
+
+    @pytest.mark.asyncio
+    async def test_missing_thread_ts_raises(self):
+        say_stream = AsyncSayStream(client=self.mock_client, channel_id="C111", thread_ts=None)
+        with pytest.warns(ExperimentalWarning):
+            with pytest.raises(ValueError, match="thread_ts"):
+                await say_stream()
+
+    @pytest.mark.asyncio
+    async def test_default_params(self):
+        say_stream = AsyncSayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+            team_id="T111",
+            user_id="U111",
+        )
+        await say_stream()
+
+        self.mock_client.chat_stream.assert_called_once_with(
+            channel="C111",
+            thread_ts="111.222",
+            recipient_team_id="T111",
+            recipient_user_id="U111",
+        )
+
+    @pytest.mark.asyncio
+    async def test_parameter_overrides(self):
+        say_stream = AsyncSayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+            team_id="T111",
+            user_id="U111",
+        )
+        await say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
+
+        self.mock_client.chat_stream.assert_called_once_with(
+            channel="C222",
+            thread_ts="333.444",
+            recipient_team_id="T222",
+            recipient_user_id="U222",
+        )
+
+    @pytest.mark.asyncio
+    async def test_buffer_size_passthrough(self):
+        say_stream = AsyncSayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+        )
+        await say_stream(buffer_size=100)
+
+        self.mock_client.chat_stream.assert_called_once_with(
+            buffer_size=100,
+            channel="C111",
+            thread_ts="111.222",
+            recipient_team_id=None,
+            recipient_user_id=None,
+        )
+
+    @pytest.mark.asyncio
+    async def test_experimental_warning(self):
+        say_stream = AsyncSayStream(
+            client=self.mock_client,
+            channel_id="C111",
+            thread_ts="111.222",
+        )
+        with pytest.warns(ExperimentalWarning, match="say_stream is experimental"):
+            await say_stream()