Edge Security Acceleration:Fetch API

Fetch API メソッドの定義

Fetch は完全に非同期です。await を使用しない限り、スクリプトの実行をブロックしません。一度に最大 4 つのサブリクエストを送信できます。基盤となるレイヤーでは持続的接続が使用されるため、接続プールを管理する必要はありません。

Fetch は HTTP または HTTPS リクエストを行うことができます。各 redirect は 1 つのリクエストとしてカウントされます。各 fetch リクエストは、最大 12 回の redirect 操作をサポートします。

• メソッドの定義

  fetch(arg, init)。詳細については、MDN ドキュメントの WorkerOrGlobalScope.fetch() をご参照ください。

• メソッドの制限

  • Fetch API はドメイン名のみをサポートし、IP アドレスはサポートしません。HTTP リクエストのデフォルトポートは 80、HTTPS リクエストのデフォルトポートは 443 です。

  • init パラメーターの credentials、referrer、referrerPolicy、cache、および integrity プロパティは効果がありません。

  • redirect のデフォルト値は follow です。これは、fetch がオリジンサーバーからの 3xx 応答をフォローすることを意味します。fetch が 3xx 応答をフォローしないようにするには、redirect を manual に設定します。

  説明

  • ブラウザで利用可能なさまざまな Fetch モードは適用されません。例えば、CDN、DCDN、または ESA では、CORS フェッチ を使用して任意のオリジンサーバーからデータを取得できます。

  • 4 つ以上のサブリクエストを送信するには、かチケットを送信してクォータの引き上げをリクエストしてください。

  • リクエスト URL の全長は 4 KB を超えることはできません。

  • 関数が Fetch を使用して取得する Gzip 圧縮されたリソースは、デフォルトで解凍されます。デフォルトの解凍を防ぐには、manual パラメーターを追加します。詳細については、「解凍」セクションをご参照ください。

• タイムアウト期間の設定

  • タイムアウト関数

    /**
     * リクエストタイムアウト制御の実装
     *
     * @param {Number} timeout タイムアウト期間 (ms)
     * @param {Object} config タイムアウト設定
     *   - @param {Object|Funtion} handler タイムアウト時に返す値
     * @returns
     */
    const RequestTimeout = (timeout, config) => {
      return new Promise((resolve) => {
        const { handler = null } = config;
        let timer = setTimeout(() => {
          clearTimeout(timer);
          timer = null;
    
          const defaultRes = (typeof handler === 'function' ? handler() : handler) || {};
          resolve(defaultRes);
        }, timeout);
      });
    };

  • 呼び出し例

    const KV_TIMEOUT = 1000;
    let edgekv = new EdgeKV({
      namespace: KV_NS,
    });
    
    let kvRequest = edgekv.get(key, getType);
    let timeoutPromise = RequestTimeout(KV_TIMEOUT, {
      handler: {
        res: {},
        errorMessage: `kv request timeout (${KV_TIMEOUT}ms)`,
      }
    });
    
    let resp = await Promise.race([
      kvRequest,
      timeoutPromise,
    ]);
    
    if (resp === undefined) {
      return "kv not found, key = " + key;
    } else {
      return resp;
    }

リダイレクト

解凍

content-length

Headers

• 定義

  Headers オブジェクトの詳細については、Headers をご参照ください。

• 制限

  ヘッダーは消費されるメモリリソースの量を記録します。Headers オブジェクトの最大サイズは 8 KB です。Headers オブジェクトのサイズがこの制限を超えると、JavaScript 例外がスローされます。

• ブラックリスト

  Fetch API はヘッダーのブラックリストを使用します。ブラックリストにあるヘッダーを読み書きしようとすると、例外がスローされます。次のリストは、ブラックリストに含まれるヘッダーです。

  • expect

  • te

  • trailer

  • upgrade

  • proxy-connection

  • connection

  • keep-alive

  • dnt

  • host

  • 予約済みヘッダー

Request

• 定義

  詳細については、MDN ドキュメントの Request をご参照ください。

• 制限

  Request オブジェクトの次のプロパティは実装されておらず、CDN、DCDN、または ESA のコンテキストでは適用されません。

  • context

  • credentials

  • destination

  • integrity

  • mode

  • referrer

  • referrerPolicy

  • cache

• 一般的な使用方法

  • リクエストメソッドの取得：request.method。

  • リクエスト URL の取得：request.url。

  • リクエストヘッダーの取得：request.headers。

  • リクエストペイロードの取得：request.body。本文は ReadableStream オブジェクトです。

  • JSON の取得：await request.json()。

  • フォームデータの取得：await request.formData()。

  • UTF-8 文字列の取得：await request.text()。

  Request インターフェイスは標準の拡張です。これにより、リクエスト本文を無視しながら、本文ストリームが基盤となるソケットから完全に読み取られることを保証できます。本文は JavaScript 仮想マシンのメモリに読み込まれないため、ガベージコレクション (GC) の遅延を回避できます。Fetch リクエストの本文を読み取る必要がない場合は、request.ignore を呼び出します。例：await request.ignore()。これにより、本文が完全に読み取られた後、ランタイムが自動的に接続を接続プールに戻して再利用するため、パフォーマンスが向上します。

Response

• 定義

  詳細については、MDN ドキュメントの Response をご参照ください。

• 制限

  Response オブジェクトの useFinalURLS および error プロパティは実装されておらず、CDN、DCDN、または ESA のコンテキストでは適用されません。

• 一般的な使用方法

  • レスポンスコードの取得：response.status。

  • レスポンスの理由フレーズの取得：response.statusText。

  • レスポンスヘッダーの取得：response.headers。

  • レスポンス URL の取得：response.url。これは、すべてのリダイレクト後の最終的な URL です。

  • すべてのリダイレクト URL のリストを取得 (非標準)：response.urlList。Response オブジェクトは、Request オブジェクトと同様に body mixin を実装しています。同様のメソッドを使用して body オブジェクトを取得できます。

FormData

• 定義

  FormData 操作の詳細については、FormData をご参照ください。

• 制限

  FormData 操作は Headers 操作に似ています。FormData はヘッダーのサイズを制限します。ヘッダーのサイズが上限を超えると、例外がスローされます。FormData を HTTP リクエスト本文として送信する場合、content-type はデフォルトで form-data/multipart に設定されます。

URLSearchParams

• 定義

  URLSearchParams 操作の詳細については、URLSearchParams() をご参照ください。

• 制限

  URLSearchParams を HTTP リクエスト本文として送信する場合、content-type はデフォルトで application/x-www-form-urlencode に設定されます。データサイズは 1,000 バイトを超えることはできません。

Blob と File

• 定義

  • Blob 操作の詳細については、Blob をご参照ください。

  • File 操作の詳細については、File をご参照ください。

• 制限

  ER は、Blob および File 操作の標準に準拠した Blob および File クラスをサポートしています。ER はファイルの読み書きができません。ER がサポートする Blob および File クラスをレスポンス本文に渡すことができます。content-type ヘッダーの値は、Blob または File 操作の MIME タイプと同じです。