fix(types): accept a sequence of suggested prompts in assistant context (#1382)

Author: zimeg

slack_bolt/context/set_suggested_prompts/async_set_suggested_prompts.py

@@ -1,4 +1,4 @@
-from typing import List, Dict, Union, Optional
+from typing import Dict, List, Optional, Sequence, Union
 
 from slack_sdk.web.async_client import AsyncWebClient
 from slack_sdk.web.async_slack_response import AsyncSlackResponse
@@ -21,7 +21,7 @@ def __init__(
 
     async def __call__(
         self,
-        prompts: List[Union[str, Dict[str, str]]],
+        prompts: Sequence[Union[str, Dict[str, str]]],
         title: Optional[str] = None,
     ) -> AsyncSlackResponse:
         prompts_arg: List[Dict[str, str]] = []

slack_bolt/context/set_suggested_prompts/set_suggested_prompts.py

@@ -1,4 +1,4 @@
-from typing import List, Dict, Union, Optional
+from typing import Dict, List, Optional, Sequence, Union
 
 from slack_sdk import WebClient
 from slack_sdk.web import SlackResponse
@@ -21,7 +21,7 @@ def __init__(
 
     def __call__(
         self,
-        prompts: List[Union[str, Dict[str, str]]],
+        prompts: Sequence[Union[str, Dict[str, str]]],
         title: Optional[str] = None,
     ) -> SlackResponse:
         prompts_arg: List[Dict[str, str]] = []

tests/slack_bolt/context/test_set_suggested_prompts.py

@@ -0,0 +1,37 @@
+import pytest
+from slack_sdk import WebClient
+from slack_sdk.web import SlackResponse
+
+from slack_bolt.context.set_suggested_prompts import SetSuggestedPrompts
+from tests.mock_web_api_server import cleanup_mock_web_api_server, setup_mock_web_api_server
+
+
+class TestSetSuggestedPrompts:
+    def setup_method(self):
+        setup_mock_web_api_server(self)
+        valid_token = "xoxb-valid"
+        mock_api_server_base_url = "http://localhost:8888"
+        self.web_client = WebClient(token=valid_token, base_url=mock_api_server_base_url)
+
+    def teardown_method(self):
+        cleanup_mock_web_api_server(self)
+
+    def test_set_suggested_prompts(self):
+        set_suggested_prompts = SetSuggestedPrompts(client=self.web_client, channel_id="C111", thread_ts="123.123")
+        response: SlackResponse = set_suggested_prompts(prompts=["One", "Two"])
+        assert response.status_code == 200
+
+    def test_set_suggested_prompts_objects(self):
+        set_suggested_prompts = SetSuggestedPrompts(client=self.web_client, channel_id="C111", thread_ts="123.123")
+        response: SlackResponse = set_suggested_prompts(
+            prompts=[
+                "One",
+                {"title": "Two", "message": "What's before addition?"},
+            ],
+        )
+        assert response.status_code == 200
+
+    def test_set_suggested_prompts_invalid(self):
+        set_suggested_prompts = SetSuggestedPrompts(client=self.web_client, channel_id="C111", thread_ts="123.123")
+        with pytest.raises(TypeError):
+            set_suggested_prompts()

tests/slack_bolt_async/context/test_async_set_suggested_prompts.py

@@ -0,0 +1,45 @@
+import asyncio
+
+import pytest
+from slack_sdk.web.async_client import AsyncWebClient
+from slack_sdk.web.async_slack_response import AsyncSlackResponse
+
+from slack_bolt.context.set_suggested_prompts.async_set_suggested_prompts import AsyncSetSuggestedPrompts
+from tests.mock_web_api_server import cleanup_mock_web_api_server, setup_mock_web_api_server
+
+
+class TestAsyncSetSuggestedPrompts:
+    @pytest.fixture
+    def event_loop(self):
+        setup_mock_web_api_server(self)
+        valid_token = "xoxb-valid"
+        mock_api_server_base_url = "http://localhost:8888"
+        self.web_client = AsyncWebClient(token=valid_token, base_url=mock_api_server_base_url)
+
+        loop = asyncio.get_event_loop()
+        yield loop
+        loop.close()
+        cleanup_mock_web_api_server(self)
+
+    @pytest.mark.asyncio
+    async def test_set_suggested_prompts(self):
+        set_suggested_prompts = AsyncSetSuggestedPrompts(client=self.web_client, channel_id="C111", thread_ts="123.123")
+        response: AsyncSlackResponse = await set_suggested_prompts(prompts=["One", "Two"])
+        assert response.status_code == 200
+
+    @pytest.mark.asyncio
+    async def test_set_suggested_prompts_objects(self):
+        set_suggested_prompts = AsyncSetSuggestedPrompts(client=self.web_client, channel_id="C111", thread_ts="123.123")
+        response: AsyncSlackResponse = await set_suggested_prompts(
+            prompts=[
+                "One",
+                {"title": "Two", "message": "What's before addition?"},
+            ],
+        )
+        assert response.status_code == 200
+
+    @pytest.mark.asyncio
+    async def test_set_suggested_prompts_invalid(self):
+        set_suggested_prompts = AsyncSetSuggestedPrompts(client=self.web_client, channel_id="C111", thread_ts="123.123")
+        with pytest.raises(TypeError):
+            await set_suggested_prompts()