Skip to content

複数ステップのワークフローを作る ​

このページでは、アカウントを作り、マネージャーの承認を待ち、ウェルカムメールを送り、3 日後にリマインダーを送るオンボーディングのワークフローを作ります。1 つの関数として動き、ステップごとに 1 回呼ばれます。ステップ、sleep、シグナルのしくみは ワークフロー を参照してください。

ワークフローはライブサイトを変えません。

以降、distribution は acme-marketing(d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38)、関数ランタイムは 01JBQZ8XKT4A9WN2CDEFGH5RM7 とします。

1. ステップを書く ​

各呼び出しにはステップ名、その入力、シグナル(あれば)が渡されます。次のステップを返してください。

js
function answer(value) {
  return { statusCode: 200, body: JSON.stringify(value) };
}

function handler(request, env) {
  const { step, input, signal } = JSON.parse(request.body);
  switch (step) {
    case 'start': {
      env.kv.put(`account:${input.email}`, 'pending', { ifAbsent: true });
      return answer({
        wait: { signal: 'approved', step: 'welcome', timeout_seconds: 7 * 86400, on_timeout: 'expire', input },
      });
    }
    case 'welcome':
      // signal は {name: 'approved', payload: {...}}
      return answer({ sleep: { seconds: 3 * 86400, step: 'remind', input: { ...input, by: signal.payload.by } } });
    case 'remind':
      return answer({ done: { output: { email: input.email, approved_by: input.by } } });
    case 'expire':
      return answer({ fail: { error: `nobody approved ${input.email}` } });
  }
  return { statusCode: 400, body: `unknown step ${step}` };
}
python
import json


def answer(value):
    return {"statusCode": 200, "body": json.dumps(value)}


def handler(request, env):
    event = json.loads(request["body"])
    step, data, signal = event["step"], event["input"], event["signal"]
    if step == "start":
        env.kv.put("account:" + data["email"], "pending", if_absent=True)
        return answer({"wait": {"signal": "approved", "step": "welcome", "timeout_seconds": 7 * 86400,
                                "on_timeout": "expire", "input": data}})
    if step == "welcome":
        return answer({"sleep": {"seconds": 3 * 86400, "step": "remind",
                                 "input": dict(data, by=signal["payload"]["by"])}})
    if step == "remind":
        return answer({"done": {"output": {"email": data["email"], "approved_by": data["by"]}}})
    if step == "expire":
        return answer({"fail": {"error": "nobody approved " + data["email"]}})
    return {"statusCode": 400, "body": "unknown step " + step}

ステップは 2 回実行されることがあるので、start ステップは ifAbsent で書き込み、再試行されても害がないようにしています(env.kv にはキーバリューの ストア付与 が必要です)。Edge がステップ間で運ぶのは input だけです。小さく保ってください。

2. 実行を開始する ​

text
acme-marketing で関数 01JBQZ8XKT4A9WN2CDEFGH5RM7 のワークフローを onboard という名前で開始して。
入力は {"email": "ana@example.com"}、冪等キーは ana@example.com で。
bash
edge workflows start acme-marketing --function 01JBQZ8XKT4A9WN2CDEFGH5RM7 --name onboard \
  --input '{"email": "ana@example.com"}' --key ana@example.com
bash
curl -s -X POST https://api.edge.deca-dev.com/v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38/workflows \
  -H "Authorization: Bearer $EDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"script_id": "01JBQZ8XKT4A9WN2CDEFGH5RM7", "name": "onboard",
       "input": {"email": "ana@example.com"}, "idempotency_key": "ana@example.com"}'

エージェントは edge_workflow_start を実行します。

json
{
  "run_id": "wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C",
  "name": "onboard",
  "status": "running",
  "step": "start",
  "created": true,
  …
}

同じキーでもう一度開始すると、同じ実行が created: false 付きで返ります。cron からスケジュールどおりに実行を開始するには、ターゲットを {"type": "workflow_start", "script_id": …}(CLI では --start-workflow)にします。

3. シグナルを送る ​

start ステップのあと、実行は approved を waiting で待ちます。Web アプリで Distributions を開き、acme-marketing を選んで Workflows の実行を見ると、Waiting for approved at welcome と表示され、ペイロードなしでシグナルを送る Send approved ボタンがあります。この例は payload.by を読むので、ペイロード付きで送ってください。

text
ワークフローの実行 wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C に approved シグナルをペイロード {"by": "kenji"} で送って。
bash
edge workflows signal wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C --name approved --payload '{"by": "kenji"}'
bash
curl -s -X POST https://api.edge.deca-dev.com/v1/workflows/wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C/signals \
  -H "Authorization: Bearer $EDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "approved", "payload": {"by": "kenji"}}'

エージェントは edge_workflow_signal を実行します。応答には delivered: true が入り、実行は welcome に進みます。実行が待つ前に送られたシグナルは保持され、delivered は false です。

4. 進み具合を追う ​

text
ワークフローの実行 wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C とそのステップを見せて。
bash
edge workflows get wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C
bash
curl -s https://api.edge.deca-dev.com/v1/workflows/wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C \
  -H "Authorization: Bearer $EDGE_TOKEN"

エージェントは edge_workflow_get を実行します。steps には各ステップの試行が、状態、エラー、所要時間とともに並びます。welcome の 3 日後、実行は sleep を終えて remind に進み、出力を持って completed になります。

終わったことを知るには、Webhook を workflow.completed と workflow.failed に登録します。Edge のイベントを Webhook に送る を参照してください。

5. キャンセルまたは再試行する ​

Web アプリでは、実行の行に、動いている間は Cancel、失敗したあとは Retry があります。

text
ワークフローの実行 wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C をキャンセルして。
bash
edge workflows cancel wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C
edge workflows retry wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C
bash
curl -s -X POST https://api.edge.deca-dev.com/v1/workflows/wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C/cancel \
  -H "Authorization: Bearer $EDGE_TOKEN"
curl -s -X POST https://api.edge.deca-dev.com/v1/workflows/wfr_01M4XC2D3F6G8H1J4K7L0Z2X5C/retry \
  -H "Authorization: Bearer $EDGE_TOKEN"

エージェントは edge_workflow_cancel または edge_workflow_retry を実行します。キャンセルは、すでに動いているステップは最後まで進めさせ、その応答を無視します。再試行は、失敗したステップをその入力で、試行回数をリセットしてもう一度実行します。

6. 自分のエンドポイントから開始とシグナル送信をする ​

関数は env.workflow で自分で実行を開始し、シグナルを送れます。たとえば登録フォームで実行を開始し、承認リンクでシグナルを送ります。分岐はステップの前に、同じ関数の中に書きます。関数は自分のスクリプトの実行をいつでも開始でき、シグナルも送れます。別の関数を開始するには、先にその関数をこの関数の workflow_starts に加えます(edge_function_update。関数ランタイム を参照)。

js
function handler(request, env) {
  if (request.path === '/_api/signup') {
    const { email } = JSON.parse(request.body);
    const { runId } = env.workflow.start('onboard', { email }, { idempotencyKey: email });
    return { statusCode: 202, body: JSON.stringify({ runId }) };
  }
  if (request.path === '/_api/approve') {
    const { runId, by } = JSON.parse(request.body);
    try {
      env.workflow.signal(runId, 'approved', { by });
    } catch (error) {
      if (error.code === 'run_finished') return { statusCode: 409, body: 'already finished' };
      throw error;
    }
    return { statusCode: 204, body: '' };
  }
  // …1 節のステップ
}
python
import json

def handler(request, env):
    if request["path"] == "/_api/signup":
        email = json.loads(request["body"])["email"]
        started = env.workflow.start("onboard", {"email": email}, idempotency_key=email)
        return {"statusCode": 202, "body": json.dumps({"runId": started["run_id"]})}
    if request["path"] == "/_api/approve":
        body = json.loads(request["body"])
        try:
            env.workflow.signal(body["runId"], "approved", {"by": body["by"]})
        except WorkflowError as error:
            if error.code == "run_finished":
                return {"statusCode": 409, "body": "already finished"}
            raise
        return {"statusCode": 204, "body": ""}
    # …1 節のステップ

両方のパスを wasm ルートで関数に割り当てます。env.workflow.get(runId) は実行の status、step、waiting_for を返し、完了後は output も返します。ステップは子の実行を開始できますが、自分の実行にシグナルは送れません。実行を進めるのはステップの答えです。

次に ​

ステップ、サイズ、時間の上限は 上限 にあります。