test: update async tests to expect chunks when flushing buffer

Author: zimeg

tests/slack_sdk_async/web/test_async_chat_stream.py

@@ -6,6 +6,7 @@
 from slack_sdk.models.blocks.basic_components import FeedbackButtonObject
 from slack_sdk.models.blocks.block_elements import FeedbackButtonsElement, IconButtonElement
 from slack_sdk.models.blocks.blocks import ContextActionsBlock
+from slack_sdk.models.messages.chunk import MarkdownTextChunk, TaskUpdateChunk
 from slack_sdk.web.async_client import AsyncWebClient
 from tests.mock_web_api_server import cleanup_mock_web_api_server, setup_mock_web_api_server
 from tests.slack_sdk.web.mock_web_api_handler import MockHandler
@@ -107,7 +108,10 @@ async def test_streams_a_short_message(self):
             stop_request = self.thread.server.chat_stream_requests.get("/chat.stopStream", {})
             self.assertEqual(stop_request.get("channel"), "C0123456789")
             self.assertEqual(stop_request.get("ts"), "123.123")
-            self.assertEqual(stop_request.get("markdown_text"), "nice!")
+            self.assertEqual(
+                json.dumps(stop_request.get("chunks")),
+                '[{"type": "markdown_text", "text": "nice!"}]',
+            )
 
     @async_test
     async def test_streams_a_long_message(self):
@@ -149,13 +153,19 @@ async def test_streams_a_long_message(self):
             start_request = self.thread.server.chat_stream_requests.get("/chat.startStream", {})
             self.assertEqual(start_request.get("channel"), "C0123456789")
             self.assertEqual(start_request.get("thread_ts"), "123.000")
-            self.assertEqual(start_request.get("markdown_text"), "**this messag")
+            self.assertEqual(
+                json.dumps(start_request.get("chunks")),
+                '[{"type": "markdown_text", "text": "**this messag"}]',
+            )
             self.assertEqual(start_request.get("recipient_team_id"), "T0123456789")
             self.assertEqual(start_request.get("recipient_user_id"), "U0123456789")
 
             append_request = self.thread.server.chat_stream_requests.get("/chat.appendStream", {})
             self.assertEqual(append_request.get("channel"), "C0123456789")
-            self.assertEqual(append_request.get("markdown_text"), "e is bold!")
+            self.assertEqual(
+                json.dumps(append_request.get("chunks")),
+                '[{"type": "markdown_text", "text": "e is bold!"}]',
+            )
             self.assertEqual(append_request.get("token"), "xoxb-chat_stream_test_token1")
             self.assertEqual(append_request.get("ts"), "123.123")
 
@@ -165,10 +175,75 @@ async def test_streams_a_long_message(self):
                 '[{"elements": [{"negative_button": {"text": {"emoji": true, "text": "bad", "type": "plain_text"}, "value": "-1"}, "positive_button": {"text": {"emoji": true, "text": "good", "type": "plain_text"}, "value": "+1"}, "type": "feedback_buttons"}, {"icon": "trash", "text": {"emoji": true, "text": "delete", "type": "plain_text"}, "type": "icon_button"}], "type": "context_actions"}]',
             )
             self.assertEqual(stop_request.get("channel"), "C0123456789")
-            self.assertEqual(stop_request.get("markdown_text"), "**")
+            self.assertEqual(
+                json.dumps(stop_request.get("chunks")),
+                '[{"type": "markdown_text", "text": "**"}]',
+            )
             self.assertEqual(stop_request.get("token"), "xoxb-chat_stream_test_token2")
             self.assertEqual(stop_request.get("ts"), "123.123")
 
+    @async_test
+    async def test_streams_a_chunk_message(self):
+        streamer = await self.client.chat_stream(
+            channel="C0123456789",
+            recipient_team_id="T0123456789",
+            recipient_user_id="U0123456789",
+            thread_ts="123.000",
+        )
+        await streamer.append(markdown_text="**this is ")
+        await streamer.append(markdown_text="buffered**")
+        await streamer.append(
+            chunks=[
+                TaskUpdateChunk(
+                    id="001",
+                    title="Counting...",
+                    status="pending",
+                ),
+            ],
+        )
+        await streamer.append(
+            chunks=[
+                MarkdownTextChunk(text="**this is unbuffered**"),
+            ],
+        )
+        await streamer.append(markdown_text="\n")
+        await streamer.stop(
+            chunks=[
+                MarkdownTextChunk(text=":space_invader:"),
+            ],
+        )
+
+        self.assertEqual(self.received_requests.get("/chat.startStream", 0), 1)
+        self.assertEqual(self.received_requests.get("/chat.appendStream", 0), 1)
+        self.assertEqual(self.received_requests.get("/chat.stopStream", 0), 1)
+
+        if hasattr(self.thread.server, "chat_stream_requests"):
+            start_request = self.thread.server.chat_stream_requests.get("/chat.startStream", {})
+            self.assertEqual(start_request.get("channel"), "C0123456789")
+            self.assertEqual(start_request.get("thread_ts"), "123.000")
+            self.assertEqual(
+                json.dumps(start_request.get("chunks")),
+                '[{"type": "markdown_text", "text": "**this is buffered**"}, {"id": "001", "status": "pending", "title": "Counting...", "type": "task_update"}]',
+            )
+            self.assertEqual(start_request.get("recipient_team_id"), "T0123456789")
+            self.assertEqual(start_request.get("recipient_user_id"), "U0123456789")
+
+            append_request = self.thread.server.chat_stream_requests.get("/chat.appendStream", {})
+            self.assertEqual(append_request.get("channel"), "C0123456789")
+            self.assertEqual(append_request.get("ts"), "123.123")
+            self.assertEqual(
+                json.dumps(append_request.get("chunks")),
+                '[{"text": "**this is unbuffered**", "type": "markdown_text"}]',
+            )
+
+            stop_request = self.thread.server.chat_stream_requests.get("/chat.stopStream", {})
+            self.assertEqual(stop_request.get("channel"), "C0123456789")
+            self.assertEqual(stop_request.get("ts"), "123.123")
+            self.assertEqual(
+                json.dumps(stop_request.get("chunks")),
+                '[{"type": "markdown_text", "text": "\\n"}, {"text": ":space_invader:", "type": "markdown_text"}]',
+            )
+
     @async_test
     async def test_streams_errors_when_appending_to_an_unstarted_stream(self):
         streamer = await self.client.chat_stream(