|
| 1 | +"""Run workflow and remote activity handlers in separate processes. |
| 2 | +
|
| 3 | +See docs/guides/separate-workers.md for installation and three-terminal usage. |
| 4 | +""" |
| 5 | +from __future__ import annotations |
| 6 | + |
| 7 | +import argparse |
| 8 | +import asyncio |
| 9 | +import json |
| 10 | +import logging |
| 11 | +import os |
| 12 | +import signal |
| 13 | +from uuid import uuid4 |
| 14 | + |
| 15 | +from durable_workflow import ActivityRetryPolicy, Client, Worker, activity, workflow |
| 16 | + |
| 17 | +WORKFLOW_TYPE = "examples.split-workers.greeter" |
| 18 | +ACTIVITY_TYPE = "examples.split-workers.greet" |
| 19 | + |
| 20 | + |
| 21 | +@activity.defn(name=ACTIVITY_TYPE) |
| 22 | +async def greet(name: str, retry_once: bool) -> str: |
| 23 | + info = activity.context().info |
| 24 | + print(json.dumps({ |
| 25 | + "event": "activity_attempt", "worker_id": info.worker_id, |
| 26 | + "attempt": info.attempt_number, "process_id": os.getpid(), |
| 27 | + }), flush=True) |
| 28 | + if retry_once and info.attempt_number == 1: |
| 29 | + raise RuntimeError("intentional first-attempt failure for the example") |
| 30 | + return f"hello, {name}" |
| 31 | + |
| 32 | + |
| 33 | +@workflow.defn(name=WORKFLOW_TYPE) |
| 34 | +class Greeter: |
| 35 | + def run(self, ctx, name: str, retry_once: bool, activity_queue: str | None): |
| 36 | + return (yield ctx.schedule_activity( |
| 37 | + ACTIVITY_TYPE, |
| 38 | + [name, retry_once], |
| 39 | + queue=activity_queue, |
| 40 | + retry_policy=ActivityRetryPolicy(max_attempts=2, initial_interval_seconds=1), |
| 41 | + start_to_close_timeout=5, |
| 42 | + schedule_to_close_timeout=20, |
| 43 | + )) |
| 44 | + |
| 45 | + |
| 46 | +def positive_slots(value: str) -> int: |
| 47 | + slots = int(value) |
| 48 | + if slots < 1: |
| 49 | + raise argparse.ArgumentTypeError("slots must be at least 1") |
| 50 | + return slots |
| 51 | + |
| 52 | + |
| 53 | +def parse_args() -> argparse.Namespace: |
| 54 | + parser = argparse.ArgumentParser(description=__doc__) |
| 55 | + roles = parser.add_subparsers(dest="role", required=True) |
| 56 | + for role in ("workflow", "activity"): |
| 57 | + worker = roles.add_parser(role, help=f"run only {role} handlers") |
| 58 | + worker.add_argument("--worker-id", required=True, help="unique for each live worker process") |
| 59 | + worker.add_argument("--queue", default="python-split") |
| 60 | + worker.add_argument("--slots", type=positive_slots, default=4) |
| 61 | + start = roles.add_parser("start", help="start a workflow and wait up to 30 seconds") |
| 62 | + start.add_argument("--queue", default="python-split") |
| 63 | + start.add_argument("--name", default="world") |
| 64 | + start.add_argument("--retry-once", action="store_true") |
| 65 | + start.add_argument("--activity-queue", help="optional explicit queue for the remote activity") |
| 66 | + inspect = roles.add_parser("inspect", help="read the registered worker roster (operator credential)") |
| 67 | + inspect.add_argument("--queue", default="python-split") |
| 68 | + return parser.parse_args() |
| 69 | + |
| 70 | + |
| 71 | +async def run_worker(client: Client, args: argparse.Namespace) -> None: |
| 72 | + workflow_role = args.role == "workflow" |
| 73 | + worker = Worker( |
| 74 | + client, |
| 75 | + task_queue=args.queue, |
| 76 | + worker_id=args.worker_id, |
| 77 | + workflows=[Greeter] if workflow_role else [], |
| 78 | + activities=[] if workflow_role else [greet], |
| 79 | + max_concurrent_workflow_tasks=args.slots if workflow_role else 1, |
| 80 | + max_concurrent_activity_tasks=1 if workflow_role else args.slots, |
| 81 | + poll_timeout=5, |
| 82 | + shutdown_timeout=10, |
| 83 | + ) |
| 84 | + shutdown = asyncio.Event() |
| 85 | + loop = asyncio.get_running_loop() |
| 86 | + for requested_signal in (signal.SIGINT, signal.SIGTERM): |
| 87 | + loop.add_signal_handler(requested_signal, shutdown.set) |
| 88 | + run_task = asyncio.create_task(worker.run()) |
| 89 | + shutdown_task = asyncio.create_task(shutdown.wait()) |
| 90 | + try: |
| 91 | + done, _ = await asyncio.wait({run_task, shutdown_task}, return_when=asyncio.FIRST_COMPLETED) |
| 92 | + if run_task in done: |
| 93 | + await run_task |
| 94 | + finally: |
| 95 | + shutdown_task.cancel() |
| 96 | + await asyncio.gather(shutdown_task, return_exceptions=True) |
| 97 | + try: |
| 98 | + await worker.stop() |
| 99 | + finally: |
| 100 | + await run_task |
| 101 | + for requested_signal in (signal.SIGINT, signal.SIGTERM): |
| 102 | + loop.remove_signal_handler(requested_signal) |
| 103 | + print(json.dumps({"event": "worker_stopped", "worker_id": worker.worker_id}), flush=True) |
| 104 | + |
| 105 | + |
| 106 | +async def main(args: argparse.Namespace) -> None: |
| 107 | + server_url = os.environ.get("SERVER_URL") |
| 108 | + token = os.environ.get("WORKFLOW_TOKEN") |
| 109 | + if not server_url or not token: |
| 110 | + raise SystemExit("set SERVER_URL and WORKFLOW_TOKEN; see the separate-workers guide") |
| 111 | + async with Client( |
| 112 | + server_url, token=token, namespace=os.environ.get("WORKFLOW_NAMESPACE", "default"), |
| 113 | + ) as client: |
| 114 | + if args.role in ("workflow", "activity"): |
| 115 | + await run_worker(client, args) |
| 116 | + elif args.role == "inspect": |
| 117 | + roster = await client.list_workers(task_queue=args.queue) |
| 118 | + print(json.dumps([{ |
| 119 | + "worker_id": worker.worker_id, |
| 120 | + "task_queue": worker.task_queue, |
| 121 | + "status": worker.status, |
| 122 | + "workflow_types": worker.supported_workflow_types, |
| 123 | + "activity_types": worker.supported_activity_types, |
| 124 | + "workflow_slots": worker.max_concurrent_workflow_tasks, |
| 125 | + "activity_slots": worker.max_concurrent_activity_tasks, |
| 126 | + } for worker in roster.workers], indent=2)) |
| 127 | + else: |
| 128 | + handle = await client.start_workflow( |
| 129 | + workflow_type=WORKFLOW_TYPE, |
| 130 | + workflow_id=f"python-split-{uuid4().hex}", |
| 131 | + task_queue=args.queue, |
| 132 | + input=[args.name, args.retry_once, args.activity_queue], |
| 133 | + execution_timeout_seconds=60, |
| 134 | + run_timeout_seconds=60, |
| 135 | + ) |
| 136 | + print(json.dumps({"event": "started", "workflow_id": handle.workflow_id, "run_id": handle.run_id})) |
| 137 | + result = await handle.result(timeout=30, poll_interval=0.2) |
| 138 | + print(json.dumps({"event": "completed", "result": result}), flush=True) |
| 139 | + |
| 140 | + |
| 141 | +if __name__ == "__main__": |
| 142 | + logging.basicConfig(level=logging.INFO) |
| 143 | + asyncio.run(main(parse_args())) |
0 commit comments