Fix #111 by correcting the logic to check event type

Author: seratch

slack_bolt/util/payload_utils.py

@@ -32,7 +32,7 @@ def is_event(body: Dict[str, Any]) -> bool:
 def is_workflow_step_execute(body: Dict[str, Any]) -> bool:
     return (
         is_event(body)
-        and body["event"]["type"] == "workflow_step_edit"
+        and body["event"]["type"] == "workflow_step_execute"
         and "workflow_step" in body["event"]
     )
 

tests/scenario_tests/test_workflow_steps.py

@@ -1,4 +1,5 @@
 import json
+import time as time_module
 from time import time
 from urllib.parse import quote
 
@@ -85,6 +86,8 @@ def test_execute(self):
         response = self.app.dispatch(request)
         assert response.status == 200
         assert self.mock_received_requests["/auth.test"] == 1
+        time_module.sleep(0.5)
+        assert self.mock_received_requests["/workflows.stepCompleted"] == 1
 
         self.app = App(client=self.web_client, signing_secret=self.signing_secret)
         self.app.step(

tests/scenario_tests_async/test_workflow_steps.py

@@ -105,6 +105,8 @@ async def test_execute(self):
         response = await self.app.async_dispatch(request)
         assert response.status == 200
         assert self.mock_received_requests["/auth.test"] == 1
+        await asyncio.sleep(0.5)
+        assert self.mock_received_requests["/workflows.stepCompleted"] == 1
 
         self.app = AsyncApp(client=self.web_client, signing_secret=self.signing_secret)
         self.app.step(

tests/slack_bolt/listener_matcher/test_builtins.py

@@ -3,7 +3,11 @@
 from urllib.parse import quote
 
 from slack_bolt import BoltRequest, BoltResponse
-from slack_bolt.listener_matcher.builtins import block_action, action
+from slack_bolt.listener_matcher.builtins import (
+    block_action,
+    action,
+    workflow_step_execute,
+)
 
 
 class TestBuiltins:
@@ -95,3 +99,39 @@ def test_block_action(self):
             )
             is False
         )
+
+    def test_workflow_step_execute(self):
+        payload = {
+            "team_id": "T111",
+            "enterprise_id": "E111",
+            "api_app_id": "A111",
+            "event": {
+                "type": "workflow_step_execute",
+                "callback_id": "copy_review",
+                "workflow_step": {
+                    "workflow_step_execute_id": "zzz-execution",
+                    "workflow_id": "12345",
+                    "workflow_instance_id": "11111",
+                    "step_id": "111-222-333-444-555",
+                    "inputs": {"taskName": {"value": "a"}},
+                    "outputs": [
+                        {"name": "taskName", "type": "text", "label": "Task Name"}
+                    ],
+                },
+                "event_ts": "1601541373.225894",
+            },
+            "type": "event_callback",
+            "event_id": "Ev111",
+            "event_time": 1601541373,
+        }
+
+        request = BoltRequest(body=f"payload={quote(json.dumps(payload))}")
+
+        m = workflow_step_execute("copy_review")
+        assert m.matches(request, None) == True
+
+        m = workflow_step_execute("copy_review_2")
+        assert m.matches(request, None) == False
+
+        m = workflow_step_execute(re.compile("copy_.+"))
+        assert m.matches(request, None) == True