Skip to content

関数からファイルを保存して配信する ​

function runtime は、ファイルを返すだけでなく保存もできます。env.file を使うと、CSV のエクスポート、PDF の領収書、生成した画像、アーカイブを distribution のファイルストアに書き込み、後のリクエストで読み戻せます。訪問者は、公開の /_api パスか、有効期限の短いダウンロードリンクからファイルにアクセスします。

ファイルは公開か非公開のどちらかで、保存先のプレフィックスによって決まります。

  • 公開ファイルは、file ルートで /_api のパスから配信できます。
  • 非公開ファイルはルートでは配信されません。訪問者が受け取れるのは、関数が発行するリンクだけです。リンクの有効期間は最長 1 時間です。領収書など、1 人の訪問者のためのファイルは非公開にしてください。

このページでは、acme-marketing(d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38)にコンパイル済みの JavaScript の function runtime(script 01M3RD5T2C8V7X1N4K6P9Q2W5Z)がある状態を前提にします。まだない場合は、エンドポイントを追加するから始めてください。

function runtime とファイルの付与は、まだ Web コンソールでは管理できません。プレフィックスの付与はエージェントだけが行えます。対応する HTTP ルートや CLI コマンドはありません。

1. 関数にプレフィックスを付与する ​

関数が使えるのは、付与されたプレフィックスの下のキーだけです。付与はソースの外に保存されるので、コードが自分のアクセス範囲を広げることはできません。

text
acme-marketing で、script 01M3RD5T2C8V7X1N4K6P9Q2W5Z に、ファイルのプレフィックス
exports/* を公開、receipts/* を非公開として読み書きできるように付与して。

エージェントはプレフィックスごとに edge_file_prefix_set を実行します。応答には、プレフィックス、mode、visibility、付与の対象になる script が含まれます。script の一覧が空の付与は、その distribution のすべての関数に適用されます。プレフィックスの公開・非公開は、一度設定すると変更できません。公開と非公開の間でファイルを移すときは、新しいプレフィックスを使ってください。

この操作で本番サイトは変わりません。訪問者はまだファイルにアクセスできません。

2. ハンドラーからファイルを書く ​

javascript
function handler(request, env) {
  const rows = [['id', 'total'], ['1', '42'], ['2', '17']];
  const csv = rows.map((row) => row.join(',')).join('\n') + '\n';
  const saved = env.file.put('exports/report.csv', csv, { contentType: 'text/csv' });

  const receipt = new TextEncoder().encode('Receipt #1042\nTotal: 42\n');
  env.file.put('receipts/1042.txt', receipt, { contentType: 'text/plain' });
  const link = env.file.link('receipts/1042.txt', { ttlSeconds: 600 });

  return {
    headers: { 'content-type': 'application/json' },
    body: JSON.stringify({ report: '/_api/exports/report.csv', size: saved.size, receipt: link.url }),
  };
}

Python では、同じ呼び出しは env.file.put("exports/report.csv", csv, content_type="text/csv") と env.file.link(key, ttl_seconds=600) で、戻り値は辞書です。

put はファイルを新しく作ります。既存のファイルを置き換えるには現在の etag が必要です。これにより、2 つのリクエストが互いの書き込みを気づかずに上書きすることを防ぎます。

javascript
const current = env.file.head('exports/report.csv');
env.file.put('exports/report.csv', csv, { contentType: 'text/csv', ifMatch: current && current.etag });

1 回の呼び出しで動かせるのは 4 MiB までです。それより大きいファイルは、ライターを開いて分割して追記します。

javascript
const writer = env.file.create('exports/archive.zip', { contentType: 'application/zip' });
for (const chunk of chunks) writer.append(chunk);
const done = writer.commit(); // { etag, size }

ハンドラーが戻った時点で開いたままのライターは破棄され、何も保存されません。ハンドラーで fetch も呼ぶ場合は、書き込みを始める前に済ませてください。

3. パスを割り当てる前に試す ​

text
acme-marketing の script 01M3RD5T2C8V7X1N4K6P9Q2W5Z を GET /_api/report で
invoke して、書き込まれたファイルを一覧にして。

エージェントは edge_function_invoke を実行し、続けて edge_file_list を実行します。一覧には、キーごとに公開・非公開とサイズが表示されます。

json
{
  "items": [
    { "key": "exports/report.csv", "visibility": "public", "size": 20 },
    { "key": "receipts/1042.txt", "visibility": "private", "size": 25 }
  ]
}

edge_file_get は、ファイルのメタデータ、内容(4 MiB まで)、15 分間有効なダウンロードリンクのいずれかを返します。edge_file_delete はファイルを削除します。非公開ファイルには訪問者のデータが含まれることがあるので、必要なときだけ読んでください。

4. 公開プレフィックスを配信する ​

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

text
acme-marketing で、exports/ の下の公開ファイルを /_api/exports/* で配信して。
GET /_api/report は script 01M3RD5T2C8V7X1N4K6P9Q2W5Z のまま残して。
bash
edge api PATCH /v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 --input - <<'EOF'
{
  "runtime": {
    "api": {
      "routes": [
        { "match": "/_api/exports/*", "file": "exports/" },
        { "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/exports/*","file":"exports/"},{"match":"/_api/report","wasm":"01M3RD5T2C8V7X1N4K6P9Q2W5Z","methods":["GET"]}]}}}'

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

bash
curl -sI https://acme-marketing.edge.deca-dev.com/_api/exports/report.csv

画像、PDF、テキスト、CSV、JSON、音声、動画はブラウザーで開きます。HTML や SVG を含むそれ以外の種類は添付ファイルとしてダウンロードされるので、保存したファイルがサイトの一部として実行されることはありません。4 MiB を超えるファイルは、5 分間有効なダウンロードリンクにリダイレクトされます。このプレフィックスは関数が書き換えられるので、cache-control: no-store で配信されます。

次に読む ​