Skip to content

関数からファイルを返す ​

function runtime はテキストの代わりにファイルで応答できます。CSV のエクスポート、PDF の領収書、生成した画像などです。訪問者のブラウザーは、指定した content type でバイト列を受け取ります。content-disposition でその場で開くかダウンロードするかが決まります。

このページでは、すでに公開中で function runtime を作成できる distribution を前提にします。例では acme-marketing(d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38)を使います。function runtime を作るのが初めてなら、エンドポイントを追加するから始めてください。

function runtime はまだ Web コンソールでは管理できません。作成とテストはエージェント経由で行います。

1. バイト列を返すハンドラーを書く ​

content-type ヘッダーを付け、バイト列をボディとして返します。JavaScript では Uint8Array(または ArrayBuffer)です。

javascript
// report.js
function handler(request) {
  const rows = [['id', 'total'], ['1', '42'], ['2', '17']];
  const csv = new TextEncoder().encode(rows.map((row) => row.join(',')).join('\n') + '\n');
  return {
    headers: {
      'content-type': 'text/csv',
      'content-disposition': 'attachment; filename="report.csv"',
    },
    body: csv,
  };
}

Python では bytes を返します。

python
def handler(request):
    csv = "id,total\n1,42\n2,17\n".encode()
    return {
        "headers": {
            "content-type": "text/csv",
            "content-disposition": 'attachment; filename="report.csv"',
        },
        "body": csv,
    }

Rust、TinyGo、C、AssemblyScript はエンベロープを自分で書きます。"bodyEncoding":"base64" を付け、body にバイト列の base64 を入れてください。

content-type ヘッダーは必須です。ないと訪問者には汎用の 500 が返り、理由は関数のログに残ります。デコード後のファイルは 4 MiB まで返せます。

2. 作成してビルドを待つ ​

text
acme-marketing の distribution に report.js から JavaScript の function runtime を作って。
/_api のパスはまだ割り当てないで。ビルドが成功したら script id を教えて。

エージェントは edge_function_create を実行し、ビルドが succeeded になるまで edge_function_get で確認します。公開中のサイトは変わりません。このページでは script id を 01M3RD5T2C8V7X1N4K6P9Q2W5Z とします。実際の値は異なります。

3. 公開する前にファイルを確認する ​

text
acme-marketing の script 01M3RD5T2C8V7X1N4K6P9Q2W5Z を GET /_api/report で
invoke して、ボディをデコードして見せて。

エージェントは edge_function_invoke を実行します。結果は body_encoding: "base64" で、body にファイルの base64 が入ります。

json
{
  "status_code": 200,
  "headers": { "content-type": "text/csv", "content-disposition": "attachment; filename=\"report.csv\"" },
  "body": "aWQsdG90YWwKMSw0MgoyLDE3Cg==",
  "body_encoding": "base64",
  "fuel_used": 61204,
  …
}

バイト列を返す処理はサイズにかかわらず軽量です。ただし、作る処理はそうとは限りません。JavaScript や Python で 1 バイトずつループすると燃料(fuel)をすぐに使い切るので、大きなファイルが fuel_exhausted で失敗する場合は、文字列や配列単位で作ってください(TextEncoder、new Uint8Array(n)、bytes(n))。

4. /_api に割り当てる ​

この手順で訪問者がアクセスできるものが変わります。runtime を送るとエンドポイントの割り当て全体が置き換わるので、既存のエンドポイントも同じ更新に含めてください。

text
acme-marketing で GET /_api/report を script 01M3RD5T2C8V7X1N4K6P9Q2W5Z に割り当てて。
既存のエンドポイントはすべて残して。
bash
edge api PATCH /v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 --input - <<'EOF'
{
  "runtime": {
    "api": {
      "routes": [
        { "match": "/_api/report", "wasm": "01M3RD5T2C8V7X1N4K6P9Q2W5Z", "methods": ["GET"] }
      ]
    }
  }
}
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/report","wasm":"01M3RD5T2C8V7X1N4K6P9Q2W5Z","methods":["GET"]}]}}}'

エージェントは edge_distribution_update を実行します。新しいパスは更新がコンパイルされた時点で有効になります。エンドポイントにはプレビューも promote もありません。取り下げるときは、そのパスを除いた割り当てをもう一度送ってください。

ダウンロードして確認します。

bash
curl -sO -J https://acme-marketing.edge.deca-dev.com/_api/report

-J により、content-disposition の名前 report.csv で保存されます。

バイナリのリクエストボディを読む ​

content-type がテキストでないリクエスト(image/png や application/pdf など)は、request.bodyEncoding が "base64" になり、ボディは base64 でハンドラーに届きます。テキストのボディ(text/*、JSON、XML、フォーム、または content type なし)は "utf8" でテキストのまま届きます。

javascript
function handler(request, env) {
  const bytes = request.bodyEncoding === 'base64'
    ? env.base64.decode(request.body)
    : new TextEncoder().encode(request.body || '');
  return { headers: { 'content-type': 'application/json' }, body: JSON.stringify({ size: bytes.length }) };
}

リクエストボディの上限は 1 MiB です。POST と PUT では、ボディの SHA-256 を小文字の 16 進で x-amz-content-sha256 に入れて送る必要があります。パスを割り当てる前にバイナリのボディで試すときは、エージェントに body_encoding: "base64" で invoke するよう頼んでください。

次に読む ​