Add step arg and fix bugs

Author: seratch

samples/async_steps_from_apps.py

@@ -21,7 +21,7 @@
 # https://api.slack.com/tutorials/workflow-builder-steps
 
 
-async def edit(ack: AsyncAck, configure: AsyncConfigure):
+async def edit(ack: AsyncAck, step: dict, configure: AsyncConfigure):
     await ack()
     await configure(
         blocks=[
@@ -76,8 +76,8 @@ async def edit(ack: AsyncAck, configure: AsyncConfigure):
     )
 
 
-async def save(ack: AsyncAck, body: dict, update: AsyncUpdate):
-    state_values = body["view"]["state"]["values"]
+async def save(ack: AsyncAck, view: dict, update: AsyncUpdate):
+    state_values = view["state"]["values"]
     await update(
         inputs={
             "taskName": {
@@ -112,9 +112,8 @@ async def save(ack: AsyncAck, body: dict, update: AsyncUpdate):
 pseudo_database = {}
 
 
-async def execute(body: dict, client: AsyncWebClient, complete: AsyncComplete, fail: AsyncFail):
+async def execute(step: dict, client: AsyncWebClient, complete: AsyncComplete, fail: AsyncFail):
     try:
-        step = body["event"]["workflow_step"]
         await complete(
             outputs={
                 "taskName": step["inputs"]["taskName"]["value"],

samples/steps_from_apps.py

@@ -2,7 +2,6 @@
 # instead of slack_bolt in requirements.txt
 import sys
 
-
 sys.path.insert(1, "..")
 # ------------------------------------------------
 
@@ -30,7 +29,7 @@ def log_request(logger, body, next):
 # https://api.slack.com/tutorials/workflow-builder-steps
 
 
-def edit(ack: Ack, configure: Configure):
+def edit(ack: Ack, step, configure: Configure):
     ack()
     configure(
         blocks=[
@@ -85,8 +84,8 @@ def edit(ack: Ack, configure: Configure):
     )
 
 
-def save(ack: Ack, body: dict, update: Update):
-    state_values = body["view"]["state"]["values"]
+def save(ack: Ack, view: dict, update: Update):
+    state_values = view["state"]["values"]
     update(
         inputs={
             "taskName": {
@@ -121,15 +120,14 @@ def save(ack: Ack, body: dict, update: Update):
 pseudo_database = {}
 
 
-def execute(body: dict, client: WebClient, complete: Complete, fail: Fail):
-    step = body["event"]["workflow_step"]
+def execute(step: dict, client: WebClient, complete: Complete, fail: Fail):
     try:
         complete(
             outputs={
-                    "taskName": step["inputs"]["taskName"]["value"],
-                    "taskDescription": step["inputs"]["taskDescription"]["value"],
-                    "taskAuthorEmail": step["inputs"]["taskAuthorEmail"]["value"],
-                }
+                "taskName": step["inputs"]["taskName"]["value"],
+                "taskDescription": step["inputs"]["taskDescription"]["value"],
+                "taskAuthorEmail": step["inputs"]["taskAuthorEmail"]["value"],
+            }
         )
 
         user: SlackResponse = client.users_lookupByEmail(
@@ -167,6 +165,7 @@ def execute(body: dict, client: WebClient, complete: Complete, fail: Fail):
             "message": "Something wrong!"
         })
 
+
 app.step(
     callback_id="copy_review",
     edit=edit,

slack_bolt/app/app.py

@@ -362,10 +362,7 @@ def step(
         step = callback_id
         if isinstance(callback_id, (str, Pattern)):
             step = WorkflowStep(
-                callback_id=callback_id,
-                edit=edit,
-                save=save,
-                execute=execute,
+                callback_id=callback_id, edit=edit, save=save, execute=execute,
             )
         elif not isinstance(step, WorkflowStep):
             raise BoltError("Invalid step object")

slack_bolt/app/async_app.py

@@ -378,10 +378,7 @@ def step(
         step = callback_id
         if isinstance(callback_id, (str, Pattern)):
             step = AsyncWorkflowStep(
-                callback_id=callback_id,
-                edit=edit,
-                save=save,
-                execute=execute,
+                callback_id=callback_id, edit=edit, save=save, execute=execute,
             )
         elif not isinstance(step, AsyncWorkflowStep):
             raise BoltError("Invalid step object")

slack_bolt/kwargs_injection/async_utils.py

@@ -13,6 +13,7 @@
     to_command,
     to_event,
     to_message,
+    to_step,
 )
 
 
@@ -41,6 +42,7 @@ def build_async_required_kwargs(
         "command": to_command(request.body),
         "event": to_event(request.body),
         "message": to_message(request.body),
+        "step": to_step(request.body),
         # utilities
         "ack": request.context.ack,
         "say": request.context.say,
@@ -56,6 +58,7 @@ def build_async_required_kwargs(
         or all_available_args["command"]
         or all_available_args["event"]
         or all_available_args["message"]
+        or all_available_args["step"]
         or request.body
     )
     for k, v in request.context.items():

slack_bolt/kwargs_injection/utils.py

@@ -13,6 +13,7 @@
     to_command,
     to_event,
     to_message,
+    to_step,
 )
 
 
@@ -41,6 +42,7 @@ def build_required_kwargs(
         "command": to_command(request.body),
         "event": to_event(request.body),
         "message": to_message(request.body),
+        "step": to_step(request.body),
         # utilities
         "ack": request.context.ack,
         "say": request.context.say,
@@ -56,6 +58,7 @@ def build_required_kwargs(
         or all_available_args["command"]
         or all_available_args["event"]
         or all_available_args["message"]
+        or all_available_args["step"]
         or request.body
     )
     for k, v in request.context.items():

slack_bolt/listener/async_listener_error_handler.py

@@ -14,6 +14,7 @@
     to_command,
     to_event,
     to_message,
+    to_step,
 )
 
 
@@ -66,6 +67,7 @@ async def handle(
             "command": to_command(request.body),
             "event": to_event(request.body),
             "message": to_message(request.body),
+            "step": to_step(request.body),
             # utilities
             "say": request.context.say,
             "respond": request.context.respond,
@@ -78,6 +80,7 @@ async def handle(
             or all_available_args["command"]
             or all_available_args["event"]
             or all_available_args["message"]
+            or all_available_args["step"]
             or request.body
         )
 

slack_bolt/listener/listener_error_handler.py

@@ -14,6 +14,7 @@
     to_command,
     to_event,
     to_message,
+    to_step,
 )
 
 
@@ -60,6 +61,7 @@ def handle(
             "command": to_command(request.body),
             "event": to_event(request.body),
             "message": to_message(request.body),
+            "step": to_step(request.body),
             # utilities
             "say": request.context.say,
             "respond": request.context.respond,
@@ -72,6 +74,7 @@ def handle(
             or all_available_args["command"]
             or all_available_args["event"]
             or all_available_args["message"]
+            or all_available_args["step"]
             or request.body
         )
 

slack_bolt/listener_matcher/builtins.py

@@ -110,13 +110,14 @@ def func(body: Dict[str, Any]) -> bool:
 
 
 def workflow_step_execute(
-    asyncio: bool = False,
+    callback_id: Union[str, Pattern], asyncio: bool = False,
 ) -> Union[ListenerMatcher, "AsyncListenerMatcher"]:
     def func(body: Dict[str, Any]) -> bool:
         return (
             is_event(body)
             and _matches("workflow_step_execute", body["event"]["type"])
             and "workflow_step" in body["event"]
+            and _matches(callback_id, body["event"]["callback_id"])
         )
 
     return build_listener_matcher(func, asyncio)

slack_bolt/util/payload_utils.py

@@ -29,6 +29,14 @@ 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 "workflow_step" in body["event"]
+    )
+
+
 # -------------------
 # Slash Commands
 # -------------------
@@ -205,6 +213,21 @@ def is_workflow_step_save(body: Dict[str, Any]) -> bool:
     return is_view_submission(body) and body["view"]["type"] == "workflow_step"
 
 
+# -------------------
+# Workflow Steps
+# -------------------
+
+
+def to_step(body: Dict[str, Any]) -> Optional[Dict[str, Any]]:
+    # edit
+    if is_workflow_step_edit(body):
+        return body["workflow_step"]
+    # execute
+    if is_workflow_step_execute(body):
+        return body["event"]["workflow_step"]
+    return None
+
+
 # ------------------------------------------
 # Internal Utilities
 # ------------------------------------------