Skip to content

Workflow steps decorator #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
seratch wants to merge 2 commits into from
Closed

Workflow steps decorator #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4dc58a
Add decorator based interface for Workflow Steps
seratch Oct 4, 2020
2248cf8
Update the code
seratch Oct 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 21 additions & 33 deletions examples/async_steps_from_apps.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@

from slack_sdk.web.async_client import AsyncSlackResponse, AsyncWebClient
from slack_bolt.async_app import AsyncApp, AsyncAck
from slack_bolt.workflows.step.async_step import AsyncConfigure, AsyncUpdate, AsyncComplete, AsyncFail
from slack_bolt.workflows.step.async_step import (
AsyncConfigure,
AsyncUpdate,
AsyncComplete,
AsyncFail,
)

logging.basicConfig(level=logging.DEBUG)

Expand Down Expand Up @@ -39,10 +44,7 @@ async def edit(ack: AsyncAck, step: dict, configure: AsyncConfigure):
"element": {
"type": "plain_text_input",
"action_id": "task_name",
"placeholder": {
"type": "plain_text",
"text": "Write a task name",
},
"placeholder": {"type": "plain_text", "text": "Write a task name",},
},
"label": {"type": "plain_text", "text": "Task name"},
},
Expand All @@ -65,10 +67,7 @@ async def edit(ack: AsyncAck, step: dict, configure: AsyncConfigure):
"element": {
"type": "plain_text_input",
"action_id": "task_author",
"placeholder": {
"type": "plain_text",
"text": "Write a task name",
},
"placeholder": {"type": "plain_text", "text": "Write a task name",},
},
"label": {"type": "plain_text", "text": "Task author"},
},
Expand All @@ -93,26 +92,20 @@ async def save(ack: AsyncAck, view: dict, update: AsyncUpdate):
},
},
outputs=[
{"name": "taskName", "type": "text", "label": "Task Name", },
{
"name": "taskDescription",
"type": "text",
"label": "Task Description",
},
{
"name": "taskAuthorEmail",
"type": "text",
"label": "Task Author Email",
},
]
{"name": "taskName", "type": "text", "label": "Task Name",},
{"name": "taskDescription", "type": "text", "label": "Task Description",},
{"name": "taskAuthorEmail", "type": "text", "label": "Task Author Email",},
],
)
await ack()


pseudo_database = {}


async def execute(step: dict, client: AsyncWebClient, complete: AsyncComplete, fail: AsyncFail):
async def execute(
step: dict, client: AsyncWebClient, complete: AsyncComplete, fail: AsyncFail
):
try:
await complete(
outputs={
Expand All @@ -121,10 +114,10 @@ async def execute(step: dict, client: AsyncWebClient, complete: AsyncComplete, f
"taskAuthorEmail": step["inputs"]["taskAuthorEmail"]["value"],
}
)
user: AsyncSlackResponse = await client.users_lookupByEmail(
user_lookup: AsyncSlackResponse = await client.users_lookupByEmail(
email=step["inputs"]["taskAuthorEmail"]["value"]
)
user_id = user["user"]["id"]
user_id = user_lookup["user"]["id"]
new_task = {
"task_name": step["inputs"]["taskName"]["value"],
"task_description": step["inputs"]["taskDescription"]["value"],
Expand All @@ -143,25 +136,20 @@ async def execute(step: dict, client: AsyncWebClient, complete: AsyncComplete, f
)
blocks.append({"type": "divider"})

home_tab_update: AsyncSlackResponse = await client.views_publish(
await client.views_publish(
user_id=user_id,
view={
"type": "home",
"title": {"type": "plain_text", "text": "Your tasks!"},
"blocks": blocks,
},
)
except:
await fail(error={
"message": "Something wrong!"
})
except Exception as err:
await fail(error={"message": f"Something wrong! {err}"})


app.step(
callback_id="copy_review",
edit=edit,
save=save,
execute=execute,
callback_id="copy_review", edit=edit, save=save, execute=execute,
)

if __name__ == "__main__":
Expand Down
182 changes: 182 additions & 0 deletions examples/async_steps_from_apps_decorator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
# ------------------------------------------------
# instead of slack_bolt in requirements.txt
import asyncio
import sys

sys.path.insert(1, "..")
# ------------------------------------------------

import logging

from slack_sdk.web.async_client import AsyncSlackResponse, AsyncWebClient
from slack_bolt.async_app import AsyncApp, AsyncAck
from slack_bolt.workflows.step.async_step import (
AsyncConfigure,
AsyncUpdate,
AsyncComplete,
AsyncFail,
AsyncWorkflowStep,
)

logging.basicConfig(level=logging.DEBUG)

# export SLACK_SIGNING_SECRET=***
# export SLACK_BOT_TOKEN=xoxb-***
app = AsyncApp()


# https://api.slack.com/tutorials/workflow-builder-steps

copy_review_step = AsyncWorkflowStep.builder("copy_review")


@copy_review_step.edit
async def edit(ack: AsyncAck, step: dict, configure: AsyncConfigure):
await ack()
await configure(
blocks=[
{
"type": "section",
"block_id": "intro-section",
"text": {
"type": "plain_text",
"text": "Create a task in one of the listed projects. The link to the task and other details will be available as variable data in later steps.",
},
},
{
"type": "input",
"block_id": "task_name_input",
"element": {
"type": "plain_text_input",
"action_id": "task_name",
"placeholder": {"type": "plain_text", "text": "Write a task name",},
},
"label": {"type": "plain_text", "text": "Task name"},
},
{
"type": "input",
"block_id": "task_description_input",
"element": {
"type": "plain_text_input",
"action_id": "task_description",
"placeholder": {
"type": "plain_text",
"text": "Write a description for your task",
},
},
"label": {"type": "plain_text", "text": "Task description"},
},
{
"type": "input",
"block_id": "task_author_input",
"element": {
"type": "plain_text_input",
"action_id": "task_author",
"placeholder": {"type": "plain_text", "text": "Write a task name",},
},
"label": {"type": "plain_text", "text": "Task author"},
},
]
)


@copy_review_step.save
async def save(ack: AsyncAck, view: dict, update: AsyncUpdate):
state_values = view["state"]["values"]
await update(
inputs={
"taskName": {
"value": state_values["task_name_input"]["task_name"]["value"],
},
"taskDescription": {
"value": state_values["task_description_input"]["task_description"][
"value"
],
},
"taskAuthorEmail": {
"value": state_values["task_author_input"]["task_author"]["value"],
},
},
outputs=[
{"name": "taskName", "type": "text", "label": "Task Name",},
{"name": "taskDescription", "type": "text", "label": "Task Description",},
{"name": "taskAuthorEmail", "type": "text", "label": "Task Author Email",},
],
)
await ack()


pseudo_database = {}



async def additional_matcher(step):
email = str(step.get("inputs", {}).get("taskAuthorEmail"))
if "@" not in email:
return False
return True


async def noop_middleware(next):
return await next()


async def notify_execution(client: AsyncWebClient, step: dict):
await asyncio.sleep(5)
await client.chat_postMessage(channel="#random", text=f"Step execution: ```{step}```")


@copy_review_step.execute(
matchers=[additional_matcher],
middleware=[noop_middleware],
lazy=[notify_execution],
)
async def execute(
step: dict, client: AsyncWebClient, complete: AsyncComplete, fail: AsyncFail
):
try:
await complete(
outputs={
"taskName": step["inputs"]["taskName"]["value"],
"taskDescription": step["inputs"]["taskDescription"]["value"],
"taskAuthorEmail": step["inputs"]["taskAuthorEmail"]["value"],
}
)
user_lookup: AsyncSlackResponse = await client.users_lookupByEmail(
email=step["inputs"]["taskAuthorEmail"]["value"]
)
user_id = user_lookup["user"]["id"]
new_task = {
"task_name": step["inputs"]["taskName"]["value"],
"task_description": step["inputs"]["taskDescription"]["value"],
}
tasks = pseudo_database.get(user_id, [])
tasks.append(new_task)
pseudo_database[user_id] = tasks

blocks = []
for task in tasks:
blocks.append(
{
"type": "section",
"text": {"type": "plain_text", "text": task["task_name"]},
}
)
blocks.append({"type": "divider"})

await client.views_publish(
user_id=user_id,
view={
"type": "home",
"title": {"type": "plain_text", "text": "Your tasks!"},
"blocks": blocks,
},
)
except Exception as err:
await fail(error={"message": f"Something wrong! {err}"})


app.step(copy_review_step)

if __name__ == "__main__":
app.start(3000) # POST http://localhost:3000/slack/events
35 changes: 8 additions & 27 deletions examples/steps_from_apps.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,7 @@ def edit(ack: Ack, step, configure: Configure):
"element": {
"type": "plain_text_input",
"action_id": "task_name",
"placeholder": {
"type": "plain_text",
"text": "Write a task name",
},
"placeholder": {"type": "plain_text", "text": "Write a task name",},
},
"label": {"type": "plain_text", "text": "Task name"},
},
Expand All @@ -73,10 +70,7 @@ def edit(ack: Ack, step, configure: Configure):
"element": {
"type": "plain_text_input",
"action_id": "task_author",
"placeholder": {
"type": "plain_text",
"text": "Write a task name",
},
"placeholder": {"type": "plain_text", "text": "Write a task name",},
},
"label": {"type": "plain_text", "text": "Task author"},
},
Expand All @@ -101,18 +95,10 @@ def save(ack: Ack, view: dict, update: Update):
},
},
outputs=[
{"name": "taskName", "type": "text", "label": "Task Name", },
{
"name": "taskDescription",
"type": "text",
"label": "Task Description",
},
{
"name": "taskAuthorEmail",
"type": "text",
"label": "Task Author Email",
},
]
{"name": "taskName", "type": "text", "label": "Task Name",},
{"name": "taskDescription", "type": "text", "label": "Task Description",},
{"name": "taskAuthorEmail", "type": "text", "label": "Task Author Email",},
],
)
ack()

Expand Down Expand Up @@ -161,16 +147,11 @@ def execute(step: dict, client: WebClient, complete: Complete, fail: Fail):
},
)
except Exception as err:
fail(error={
"message": "Something wrong!"
})
fail(error={"message": f"Something wrong! {err}"})


app.step(
callback_id="copy_review",
edit=edit,
save=save,
execute=execute,
callback_id="copy_review", edit=edit, save=save, execute=execute,
)

if __name__ == "__main__":
Expand Down
Loading