Skip to content

ワークフロー ​

ワークフロー は 1 回では終わらない仕事です。カードで決済し、倉庫の確認を待ち、3 日たっても返事がなければリマインダーを送る、といったものです。各部分はそれぞれ失敗しうるうえ、Edge の外の何かを待つ部分もあり、全体で数日かかることもあります。ワークフローを使うと、これを 1 つの関数として書き、失敗やデプロイや長い待ちをまたいで Edge に最後まで運ばせることができます。

実行はステップの並び ​

実行(run) は 1 つの関数と 1 つの入力です。Edge は ステップ ごとに関数を 1 回呼びます。バックグラウンドランナー での POST /_jobs/workflow/{name} で、ステップ名とそのステップの入力が渡されます。最初のステップは必ず start です。関数はステップ名を見てその部分の仕事をし、次に何をするかを返します。

応答Edge がすること
next次のステップの入力を保存し、すぐ実行する
sleep保存し、一定時間後または指定の時刻に実行する(最大 30 日)
wait保存し、シグナル が届いたら実行する。届かなければタイムアウト用のステップを実行する
done実行を完了にする。出力を付けられる
fail再試行せずに実行を失敗にする

そのため、ふつうは 1 つの関数がワークフローのすべてのステップを持ち、step で振り分けます。

js
function handler(request, env) {
  const { step, input } = JSON.parse(request.body);
  if (step === 'start') return answer({ next: { step: 'charge', input } });
  // …
}

Edge が保持するのは入力だけ ​

ステップとステップの間、関数は動いていません。メモリ上で待っているものはないので、1 週間の sleep にも費用はかからず、何回デプロイしても失われません。Edge があるステップから次のステップへ運ぶのは、応答で渡された 入力(最大 256 KiB)だけです。それより大きいものは非公開のデータオブジェクトや env.kv に置き、そのキーを入力に入れてください。

ステップが自分のコードの中で眠れないのも同じ理由です。サンドボックスにはタイマーがなく、1 日ランナーを占有するステップは待ち時間にも費用がかかります。代わりに sleep を返してください。

ステップは 2 回以上実行されることがある ​

配信は、ほかの バックグラウンドジョブ と同じく少なくとも 1 回です。タイムアウト、クラッシュ、5xx の応答など、再試行する価値のある失敗をしたステップは、実行の retries(既定 2)の回数まで、間隔を少しずつ広げながら同じ入力でもう一度実行されます。ワーカーがステップの途中で止まった場合も、そのステップはもう一度実行されます。各ステップは 2 回実行しても 1 回と同じ結果になるように書いてください。決済を実行 ID とステップをキーにする、作業がもう済んでいないか確かめてから行う、などです。

fail、4xx、または 5 つの応答のどれでもないものを返したステップは、実行を失敗にします。失敗した実行は、失敗したステップから再試行できます。

シグナルは外から届く ​

wait を返したステップは approved のようなシグナル名を指定します。実行はそのシグナルが送られるまで waiting のままです。シグナルを送るのは API や CLI を使う人、エージェント、または env.workflow.signal を呼ぶ関数です。届くと、シグナルのペイロードを持って次のステップが実行されます。実行が待つ前にシグナルが届いた場合、Edge はそれを保持し(最大 10 件)、実行が待った時点ですぐ先に進みます。同じキーで 2 回送られたシグナルは 1 回と数えます。

時間内にシグナルが届かなければ、実行は wait の on_timeout のステップに進みます。指定がなければ失敗します。

上限 ​

1 つの実行は最大 200 ステップ、90 日です。distribution ごとに、実行中・sleep 中・待機中の実行は 1,000 まで持てます。そのほかは 上限 にあります。

次に ​

複数ステップのワークフローを作る で、ひとつ通して作ります。