Skip to content

大きなファイルをバックグラウンドで生成する ​

通常のエンドポイントの呼び出しはすぐに応答する必要があり、大きなレポートや多数のファイルの ZIP を作るには時間が足りません。バックグラウンドルートは、訪問者にすぐジョブ id を返し、関数を通常の 30 倍の燃料で最大 5 分間実行します。結果は 7 日間保持されます。

一般的な流れは次のとおりです。関数は env.file でファイルを書き、そのリンクを返します。その間、訪問者のページはリンクの準備ができるまでジョブをポーリングします。

このページでは、次の状態を前提にします。

  • distribution acme-marketing(d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38)
  • function runtime(script 01M3RD5T2C8V7X1N4K6P9Q2W5Z)
  • その script に対する reports/* の非公開ファイルの付与

付与の手順は、関数からファイルを保存して配信するを参照してください。

1. ハンドラーを書く ​

ハンドラーは通常の function runtime です。ハンドラーの戻り値が、実行終了後のジョブの結果になります。

javascript
function handler(request, env) {
  const key = `reports/${Date.now()}.csv`;
  const writer = env.file.create(key, { contentType: 'text/csv' });
  const encoder = new TextEncoder();
  writer.append(encoder.encode('id,total\n'));
  for (let page = 0; page < 200; page += 1) {
    const lines = [];
    for (let i = 0; i < 5000; i += 1) lines.push(`${page * 5000 + i},${i % 97}`);
    writer.append(encoder.encode(lines.join('\n') + '\n'));
  }
  const file = writer.commit();
  const link = env.file.link(key, { ttlSeconds: 3600 });
  return {
    headers: { 'content-type': 'application/json' },
    body: JSON.stringify({ size: file.size, url: link.url }),
  };
}

バックグラウンドルートでは、1 回の実行で append により最大 5 GiB まで書き込めます。割り当てる前に edge_function_invoke でハンドラーを試してください。直接の invoke は通常の制限で実行されるので、小さめの出力で試してください。

2. バックグラウンドルートを割り当てる ​

この手順で訪問者がアクセスできるものが変わります。既存のパスもすべて含めてください。

text
acme-marketing で POST /_api/reports/build を script 01M3RD5T2C8V7X1N4K6P9Q2W5Z に
バックグラウンドルートとして割り当てて。既存のエンドポイントはすべて残して。
bash
edge api PATCH /v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 --input - <<'EOF'
{
  "runtime": {
    "api": {
      "routes": [
        { "match": "/_api/reports/build", "wasm": "01M3RD5T2C8V7X1N4K6P9Q2W5Z", "methods": ["POST"], "background": true }
      ]
    }
  }
}
EOF
bash
curl -s -X PATCH \
  https://api.edge.deca-dev.com/v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 \
  -H "Authorization: Bearer $EDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"runtime":{"api":{"routes":[{"match":"/_api/reports/build","wasm":"01M3RD5T2C8V7X1N4K6P9Q2W5Z","methods":["POST"],"background":true}]}}}'

エージェントは edge_distribution_update を実行します。パスは更新がコンパイルされた時点で有効になります。

3. ジョブを開始してポーリングする ​

bash
curl -s -X POST https://acme-marketing.edge.deca-dev.com/_api/reports/build \
  -H "x-amz-content-sha256: $(printf '' | sha256sum | cut -d' ' -f1)"
json
{ "job_id": "job_5f0c2a9e7b1d4c3f8a6e0b2d9c7f1a34", "status": "queued", "status_url": "/_api/_jobs/job_5f0c2a9e7b1d4c3f8a6e0b2d9c7f1a34" }

status_url を数秒ごとにポーリングします。status は queued から running に変わり、実行が終わると succeeded になって、関数のレスポンスが result に入ります。

json
{
  "job_id": "job_5f0c2a9e7b1d4c3f8a6e0b2d9c7f1a34",
  "status": "succeeded",
  "result": {
    "status_code": 200,
    "headers": { "content-type": "application/json" },
    "body": "{\"size\":7388890,\"url\":\"https://…\"}"
  },
  …
}

実行に失敗すると、status は failed になり、error_code に fuel_exhausted や deadline_exceeded などの理由が入ります。関数自身の出力は edge_function_logs で確認できます。

訪問者のページでも fetch で同じことをします。ルートに POST し、status が succeeded になるまで status_url をポーリングしてから、結果のリンクに訪問者を案内します。

リクエストボディは最大 192 KiB です。distribution あたり同時に実行できるバックグラウンド実行は 5 つまでです。6 つ目のリクエストには 429 が返るので、5 つのうちどれかが終わってから再試行してください。

次に読む ​