このページは Cloud Translation API によって翻訳されました。

カスタムプラグインを開発する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご覧ください。

Edge Microgateway v 3.3.x

視聴者

このトピックは、カスタムプラグインを記述して Edge Microgateway 機能を拡張するデベロッパーを対象としています。新しいプラグインを作成するには、JavaScript と Node.js の使用経験が必要です。

カスタム Edge Microgateway プラグインとは

プラグインは、Edge Microgateway に機能を追加する Node.js モジュールです。プラグインモジュールは一貫したパターンに従い、Edge Microgateway が認識している場所に保存されるため、モジュールが自動的に検出されて実行されます。Edge Microgateway のインストール時に、いくつかの事前定義プラグインが用意されています。これには、認証、Spar Arrest、割り当て、分析用のプラグインが含まれます。既存のプラグインについては、プラグインを使用するをご覧ください。

カスタムプラグインを作成することで、Microgateway に新しい機能を追加できます。デフォルトでは、Edge Microgateway は基本的にターゲットサービスとの間のリクエストとレスポンスを変更せずに渡す安全なパススループロキシです。カスタムプラグインを使用すると、Microgateway を通過するリクエストとレスポンスをプログラムで操作できます。

カスタムプラグインコードを配置する場所

カスタムプラグイン用のフォルダは、Edge Microgateway のインストールの一部として含まれています。

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins

ここで、[prefix] は npm プレフィックスディレクトリです。詳細については、Edge Microgateway のインストールの「Edge Microgateway がインストールされている場所」をご覧ください。

このデフォルトのプラグインディレクトリを変更できます。プラグインの場所をご覧ください。

事前定義されたプラグインの確認

独自のプラグインを開発する前に、事前定義されたプラグインの中に要件を遵守していないものがないか確認することをおすすめします。これらのプラグインは、次の場所にあります。

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins

ここで、[prefix] は npm 接頭辞ディレクトリです。Edge Microgateway のインストールの「Edge Microgateway がインストールされている場所」もご覧ください。

詳細については、Edge Microgateway に提供されている事前定義のプラグインもご覧ください。

簡単なプラグインを作成する

このセクションでは、シンプルなプラグインを作成するために必要な手順を説明します。このプラグインは、レスポンスデータを「Hello, World!」という文字列でオーバーライドし、ターミナルに出力します。

Edge Microgateway が実行されている場合は、ここで停止します。
```
edgemicro stop
```
cd をカスタムプラグインディレクトリに移動します。
cd [prefix]/lib/node_modules/edgemicro/plugins

ここで、[prefix] は npm プレフィックスディレクトリです。詳細については、Edge Microgateway のインストールの「Edge Microgateway がインストールされている場所」をご覧ください。
response-override という名前の新しいプラグインプロジェクトを作成し、そのプロジェクトに cd を作成します。
```
mkdir response-override && cd response-override
```
新しい Node.js プロジェクトを作成します。
```
npm init
```
[Return] を複数回押して、デフォルト値を受け入れます。
テキストエディタを使用して、index.js という名前の新しいファイルを作成します。
次のコードを index.js にコピーし、ファイルを保存します。
```
'use strict';
var debug = require('debug')

module.exports.init = function(config, logger, stats) {

  return {
   
    ondata_response: function(req, res, data, next) {
      debug('***** plugin ondata_response');
      next(null, null);
    },
    
    onend_response: function(req, res, data, next) {
      debug('***** plugin onend_response');
      next(null, "Hello, World!\n\n");
    }
  };
}
```
注: プラグイン関数（*_response）はイベントハンドラです。ondata_response 関数は、Edge Microgateway でデータチャンクが受信されるたびに呼び出されます。onend_response 関数は、レスポンスデータの最後のバイトが受信されたときに呼び出されます。

注: 注:next() 関数はすべてのプラグイン関数で必須です。この関数は、次に呼び出されるプラグイン関数に error（最初の引数）と data（2 番目の引数）を渡します。この例では、ondata_response の data 引数は null です。この引数を null に設定すると、onend_response のレスポンスデータをオーバーライドできます。引数を null に設定しなかった場合、onend_response でオーバーライドするかどうかにかかわらず、デフォルトではレスポンスにデータが渡されます。
作成したプラグインを Edge Microgateway 構成に追加する必要があります。ファイル $HOME/.edgemicro/[org]-[env]-config.yaml を開きます。ここで、org と env は Edge の組織名と環境名です。
以下に示すように、response-override プラグインを plugins:sequence 要素に追加します。
```
      ...
      
      plugins:
        dir: ../plugins
        sequence:
          - oauth
          - response-override
          
      ...
```
注: プラグインは plugins:sequence のリストに表示されている順序で実行されます。
Edge Microgateway を再起動します。

Edge Microgateway を介して API を呼び出します。Edge Microgateway の設定と構成:

curl -H 'x-api-key: uAM4gBSb6YoMvTHfx5lXJizYIpr5Jd' http://localhost:8000/hello/echo
Hello, World!

プラグインの構造

次の Edge Microgateway サンプルプラグインは、独自のプラグインを開発する際に遵守するパターンを示しています。このセクションで説明するサンプルプラグインのソースコードは plugins/header-uppercase/index.js. にあります。

プラグインは、ルートフォルダに package.json と index.js がある標準の NPM モジュールです。
プラグインは init() 関数をエクスポートする必要があります。
init() 関数は、config、logger、stats の 3 つの引数を取ります。これらの引数については、プラグインの init() 関数の引数で説明しています。
init() は、関数の存続期間中に特定のイベントが発生したときに呼び出される名前付き関数ハンドラを含むオブジェクトを返します。

イベントハンドラ関数

プラグインでは、これらのイベントハンドラ関数の一部またはすべてを実装する必要があります。これらの関数の実装は任意です。任意の関数は省略可能です。一般的なプラグインでは少なくともこれらの関数のサブセットが実装されます。

リクエストフローのイベントハンドラ

これらの関数は、Edge Microgateway のリクエストイベントで呼び出されます。

onrequest
ondata_request
onend_request
onclose_request
onerror_request

onrequest 関数

クライアントリクエストの開始時に呼び出されます。この関数は、リクエストの最初のバイトが Edge Microgateway で受信されたときに呼び出されます。この関数を使用して、リクエストヘッダー、URL、クエリパラメータ、HTTP メソッドにアクセスできます。次に、信頼できる最初の引数（Error のインスタンスなど）を指定して呼び出した場合、リクエストの処理が停止し、ターゲットリクエストが開始されません。

例:

onrequest: function(req, res, next) {
      debug('plugin onrequest');
      req.headers['x-foo-request-start'] = Date.now();
      next();
    }

ondata_request 関数

クライアントからチャンクチャンクを受信したときに呼び出されます。プラグインシーケンスの次のプラグインにリクエストデータを渡します。シーケンス内の最後のプラグインから返された値がターゲットに送信されます。次に示す典型的なユースケースは、リクエストデータをターゲットに送信する前に変換することです。

例:

ondata_request: function(req, res, data, next) {
      debug('plugin ondata_request ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    }

onend_request 関数

すべてのリクエストデータがクライアントから受信されたときに呼び出されます。

例:

onend_request: function(req, res, data, next) {
      debug('plugin onend_request');
      next(null, data);
    }

onclose_request 関数

クライアント接続が閉じられたことを示します。この関数はクライアント接続の信頼性が低い場合に使用します。このメソッドは、クライアントへのソケット接続が閉じられたときに呼び出されます。

例:

onclose_request: function(req, res, next) {
      debug('plugin onclose_request');
      next();
    }

onerror_request 関数

クライアントリクエストの受信中にエラーが発生した場合に呼び出されます。

例:

onerror_request: function(req, res, err, next) {
      debug('plugin onerror_request ' + err);
      next();
    }

レスポンスフローイベントハンドラ

これらの関数は、Edge Microgateway のレスポンスイベントで呼び出されます。

onresponse
ondata_response
onend_response
onclose_response
onerror_response

onresponse 関数

ターゲットレスポンスの開始時に呼び出されます。この関数は、Edge Microgateway がレスポンスの最初のバイトを受信すると呼び出されます。この関数を使用すると、レスポンスヘッダーとステータスコードにアクセスできます。

例:

onresponse: function(req, res, next) {      
    debug('plugin onresponse');     
    res.setHeader('x-foo-response-time', Date.now() - req.headers['x-foo-request-start'])    
    next();    
}

ondata_response 関数

ターゲットからデータチャンクが受信されたときに呼び出されます。

例:

ondata_response: function(req, res, data, next) {
      debug('plugin ondata_response ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    }

onend_response 関数

すべてのレスポンスデータがターゲットから受信されたときに呼び出されます。

例:

onend_response: function(req, res, data, next) {
      debug('plugin onend_response');
      next(null, data);
    }

onclose_response 関数

ターゲット接続が閉じられたことを示します。ターゲット接続が不安定な場合は、この関数を使用できます。ターゲットへのソケット接続が切断されたときに呼び出されます。

例:

onclose_response: function(req, res, next) {
      debug('plugin onclose_response');
      next();
    }

onerror_response 関数

ターゲットレスポンスの受信中にエラーが発生した場合に呼び出されます。

例:

onerror_response: function(req, res, err, next) {
      debug('plugin onerror_response ' + err);
      next();
    }

プラグインイベントハンドラ関数について知っておくべきこと

プラグインイベントハンドラ関数は、Edge Microgateway が特定の API リクエストを処理している間に発生した特定のイベントに応答して呼び出されます。

各 init() 関数ハンドラ（ondata_request、ondata_response など）は、処理が完了したときに next() コールバックを呼び出す必要があります。next() を呼び出さないと、処理が停止し、リクエストがハングします。
next() の最初の引数は、リクエスト処理を終了させるエラーである可能性があります。
ondata_ ハンドラと onend_ ハンドラは、ターゲットまたはクライアントに渡されるデータを含む 2 番目の引数を指定して next() を呼び出す必要があります。プラグインがバッファリングを行っていて、その時点で変換するのに十分なデータがない場合、この引数は null にすることができます。
すべてのリクエストとレスポンスに対応するために使用されるプラグインは 1 つだけです。プラグインが呼び出し間でリクエストごとの状態を保持する場合は、提供された request オブジェクト（req）に追加されたプロパティにその状態を保存します。このオブジェクトの存続期間は API 呼び出しの存続期間です。
すべてのエラーを注意深く捉え、エラーで next() を呼び出します。next() を呼び出さないと、API 呼び出しがハングします。
Edge TensorBoard の全体的なパフォーマンスに影響する可能性があるため、メモリリークが発生しないように注意してください。メモリ不足でクラッシュする可能性があります。
メインスレッドでコンピューティング負荷の高いタスクを行わないと、Node.js モデルに従う必要があります。これは、Edge Microgateway のパフォーマンスに悪影響を与える可能性があります。

プラグイン init() 関数について

このセクションでは、init() 関数に渡される引数 config、logger、stats について説明します。

config

Edge Microgateway 構成ファイルを Apigee Edge からダウンロードしたデータと結合して取得した構成データは、config という名前のオブジェクトに配置されます。

値が foo の構成パラメータを response-override というプラグインに追加するには、これを default.yaml ファイルに配置します。

response-override:
    param: foo

その後、次のようにプラグインコードでパラメータにアクセスできます。

// Called when response data is received
    ondata_response: function(req, res, data, next) {
      debug('***** plugin ondata_response');
      debug('***** plugin ondata_response: config.param: ' + config.param);
      next(null, data);
    },

この場合、プラグインのデバッグ出力に foo が表示されます。

Sun, 13 Dec 2015 21:25:08 GMT plugin:response-override ***** plugin ondata_response: config.param: foo

マージされたマイクロゲートウェイの構成にアクセスし、子オブジェクト config.emgConfigs 内の Apigee Edge データをダウンロードできます。たとえば、init 関数では、次のようにこの構成データにアクセスできます。

module.exports.init = function(config, logger, stats) {
   let emgconfigs = config.emgConfigs;

注: emgConfigs オブジェクトは v3.1.6 で追加されました。キー名 emgConfigs は予約されているため、YAML 構成ファイルのプラグインの構成の下で他の構成を定義するためには使用できません。定義されている場合、値は実行時に上書きされます。

emgConfigs に含まれるデータの例を次に示します。

{
    edgemicro:
    {
        port: 8000,
        max_connections: 1000,
        config_change_poll_interval: 600,
        logging:
        {
            level: 'error',
            dir: '/var/tmp',
            stats_log_interval: 60,
            rotate_interval: 24,
            stack_trace: false
        },
        plugins: { sequence: [Array] },
        global: { org: 'Your Org', env: 'test' }
    },
    headers:
    {
        'x-forwarded-for': true,
        'x-forwarded-host': true,
        'x-request-id': true,
        'x-response-time': true,
        via: true
    },
    proxies:
    [    {
                max_connections: 1000,
                name: 'edgemicro_delayed',
                revision: '1',
                proxy_name: 'default',
                base_path: '/edgemicro_delayed',
                target_name: 'default',
                url: 'https://httpbin.org/delay/10',
                timeout: 0
            }
    ],
    product_to_proxy: { EdgeMicroTestProduct: [ 'edgemicro-auth','edgemicro_delayed',] },
    product_to_scopes: {prod4: [ 'Admin', 'Guest', 'Student' ] },
    product_to_api_resource: { EdgeMicroTestProduct: [ '/*' ] },
    _hash: 0,
    keys: { key: 'Your key', secret: 'Your key ' },
    uid: 'Internally generated uuid',
    targets: []
  }

logger

システムロガー。現在使用されているロガーは、これらの関数をエクスポートします。オブジェクトには、文字列、HTTP リクエスト、HTTP レスポンス、Error インスタンスがあります。

info(object, message)
warn(object, message)
error(object, message)
trace(object, message)
debug(object, message)

stats

Microgateway インスタンスを通過するリクエストとレスポンスに関連するリクエスト、レスポンス、エラー、その他の集計統計情報を保持するオブジェクト。

treqErrors - エラーが発生したターゲットリクエストの数。
treqErrors - エラーが発生したターゲットレスポンスの数。
statusCodes - レスポンスコードの数を含むオブジェクト。

{
  1: number of target responses with 1xx response codes
  2: number of target responses with 2xx response codes
  3: number of target responses with 3xx response codes
  4: number of target responses with 4xx response codes
  5: number of target responses with 5xx response codes
  }

requests - リクエストの合計数。
responses - レスポンスの合計数。
connections - アクティブなターゲット接続の数。

next() 関数について

すべてのプラグインメソッドは、next() を呼び出して、シリーズの次のメソッドを処理し続ける必要があります（プラグインプロセスがハングします）。リクエストのライフサイクルで最初に呼び出されるメソッドは onrequest() です。次に呼び出されるメソッドは ondata_request() メソッドです。ondata_request は、POST リクエストなどで、リクエストにデータが含まれている場合にのみ呼び出されます。次に呼び出されるメソッドは onend_request() で、リクエストの処理が完了すると呼び出されます。onerror_* 関数はエラー時にのみ呼び出されるので、必要に応じてカスタムコードでエラーを処理できます。

リクエストでデータが送信され、ondata_request() が呼び出されたとします。この関数は次の 2 つのパラメータを指定して next() を呼び出します。

next(null, data);

慣例により、最初のパラメータはエラー情報を伝えるために使用されます。エラー情報は、チェーンの後続の関数で処理できます。Faly 引数 null に設定すると、エラーは発生せず、リクエストの処理は通常どおり行われます。この引数が true（Error オブジェクトなど）の場合、リクエスト処理は停止し、リクエストがターゲットに送信されます。

2 つ目のパラメータは、リクエストデータをチェーンの次の関数に渡します。追加の処理を行わない場合、リクエストデータは変更されず、API のターゲットに渡されます。ただし、このメソッド内でリクエストデータを変更し、変更されたリクエストをターゲットに渡すこともできます。たとえば、リクエストデータが XML で、ターゲットが JSON を想定している場合は、（a）リクエストヘッダーの Content-Type を application/json に変更し、任意の方法でリクエストデータを JSON に変換するコードを ondata_request() メソッドに追加します（たとえば、NPM から取得した Node.js xml2json コンバータを使用できます）。

どのように表示されるかを確認してみましょう。

ondata_request: function(req, res, data, next) {
  debug('****** plugin ondata_request');
  var translated_data = parser.toJson(data);
  next(null, translated_data);
},

この場合、リクエストデータ（XML と見なされます）は JSON に変換され、変換されたデータが next() を介してリクエストチェーンの次の関数に渡されてから、バックエンドターゲットに渡されます。

デバッグ用に変換したデータを出力するデバッグステートメントをもう 1 つ追加することもできます。次に例を示します。

ondata_request: function(req, res, data, next) {
  debug('****** plugin ondata_request');
  var translated_data = parser.toJson(data);
  debug('****** plugin ondata_response: translated_json: ' + translated_json);
  next(null, translated_data);
},

プラグインハンドラの実行順序について

Edge Microgateway のプラグインを作成する場合は、プラグインイベントハンドラの実行順序を理解する必要があります。

重要な点は、Edge Helm 構成ファイルでプラグインシーケンスを指定するときに、リクエストハンドラは昇順で実行され、レスポンスハンドラは降順で実行されることです。

次の例は、この実行シーケンスを理解するのに役立ちます。

1. 3 つのシンプルなプラグインを作成する

次のプラグインを検討してください。イベントハンドラが呼び出されたときにコンソールの出力を出力します。

plugins/plugin-1/index.js

module.exports.init = function(config, logger, stats) {

  return {

    onrequest: function(req, res, next) {
      console.log('plugin-1: onrequest');
      next();
    },

    onend_request: function(req, res, data, next) {
      console.log('plugin-1: onend_request');
      next(null, data);
    },

    ondata_response: function(req, res, data, next) {
      console.log('plugin-1: ondata_response ' + data.length);
      next(null, data);
    },

    onend_response: function(req, res, data, next) {
      console.log('plugin-1: onend_response');
      next(null, data);
    }
  };
}

次に、同じコードで plugin-2 と plugin-3 の 2 つのプラグインを追加することを検討してください（ただし、console.log() ステートメントをそれぞれ plugin-2 と plugin-3 に変更します）。

2. プラグインコードを確認する

<microgateway-root-dir>/plugins/plugin-1/index.js でエクスポートされたプラグイン関数は、リクエストとレスポンスの処理中に特定の時間に実行されるイベントハンドラです。たとえば、onrequest はリクエストヘッダーの最初のバイトを受信します。onend_response は、レスポンスデータの最後のバイトが受信された後に実行されます。

ondata_response ハンドラをご覧ください。レスポンスデータのチャンクが受信されるたびに呼び出されます。レスポンスデータがすべて一度に受信されるとは限らないことに注意してください。むしろ、データは任意の長さのチャンクで受信される可能性があります。

3. プラグインシーケンスにプラグインを追加する

この例のプラグインを、次の Edge 構成ファイル（~./edgemicro/config.yaml）のプラグインシーケンスに追加します。順序は重要です。プラグインハンドラの実行順序を定義します。

  plugins:
    dir: ../plugins
    sequence:
      - plugin-1
      - plugin-2
      - plugin-3

4. デバッグ出力を調べる

では、これらのプラグインが呼び出されたときに生成される出力を見てみましょう。注意すべき重要な点がいくつかあります。

プラグインシーケンスの Edge Microgateway 構成ファイル（~./edgemicro/config.yaml）では、イベントハンドラを呼び出す順序を指定します。
リクエストハンドラは、昇順（プラグインシーケンス 1、2、3 の出現順）で呼び出されます。
レスポンスハンドラは降順（3、2、1）で呼び出されます。
ondata_response ハンドラは、到着するデータのチャンクごとに 1 回呼び出されます。この例では（出力は下記に示す）、2 つのチャンクを受け取ります。

これら 3 つのプラグインが使用され、Edge Microgateway を介してリクエストを送信したときに生成されるデバッグ出力の例を次に示します。ハンドラが呼び出される順序に注目してください。

  plugin-1: onrequest
  plugin-2: onrequest
  plugin-3: onrequest

  plugin-1: onend_request
  plugin-2: onend_request
  plugin-3: onend_request

  plugin-3: ondata_response 931
  plugin-2: ondata_response 931
  plugin-1: ondata_response 931

  plugin-3: ondata_response 1808
  plugin-3: onend_response

  plugin-2: ondata_response 1808
  plugin-2: onend_response

  plugin-1: ondata_response 1808
  plugin-1: onend_response

まとめ

リクエストデータやレスポンスデータの蓄積や変換といったカスタムプラグイン機能を実装する場合、プラグインハンドラの呼び出し順序を理解することは非常に重要です。

リクエストハンドラは、Edge Microgateway 構成ファイルでプラグインが指定されている順序で実行され、レスポンスハンドラは逆の順序で実行されます。

プラグインでのグローバル変数の使用について

Edge Microgateway へのリクエストはすべてプラグインの同じインスタンスに送信されるため、別のクライアントからの 2 番目のリクエストの状態は最初のインスタンスを上書きします。プラグインの状態を保存する唯一の安全な場所は、リクエストまたはレスポンスオブジェクトのプロパティに状態を保存することです（このオブジェクトの存続期間はリクエストの存続期間に限定されます）。

プラグインのターゲット URL の書き換え

追加先: v2.3.3

プラグインコードの req.targetHostname と req.targetPath の変数を変更すると、プラグインのデフォルトのターゲット URL を動的にオーバーライドできます。

追加先: v2.4.x

ターゲットエンドポイントポートをオーバーライドして、HTTP と HTTPS を選択することもできます。プラグインコードの req.targetPort および req.targetSecure を変更します。HTTPS を選択するには、req.targetSecure を true に設定します。HTTP の場合は false に設定します。req.targetSecure を true に設定する場合は、こちらのディスカッションスレッドをご覧ください。

eurekaclient というサンプルプラグインが Edge Microgateway に追加されました。このプラグインは、req.targetPort および req.targetSecure 変数の使用方法を説明し、Edge Microgateway が Eureka をサービスエンドポイントカタログとして使用して動的エンドポイントルックアップを実行する方法を示しています。

サンプルプラグイン

これらのプラグインは、Edge Microgateway のインストールに付属しています。Edge Microgateway インストールの

[prefix]/lib/node_modules/edgemicro/plugins

累積リクエスト

このプラグインは、クライアントからデータチャンクを、リクエストオブジェクトに接続されている配列プロパティに蓄積します。すべてのリクエストデータを受信すると、配列がバッファに連結され、シーケンス内の次のプラグインに渡されます。後続のプラグインが蓄積されたリクエストデータを受け取るように、このプラグインはシーケンス内の最初のプラグインにする必要があります。

module.exports.init = function(config, logger, stats) {

  function accumulate(req, data) {

    if (!req._chunks) req._chunks = [];
    req._chunks.push(data);

  }

  return {

    ondata_request: function(req, res, data, next) {

      if (data && data.length > 0) accumulate(req, data);

      next(null, null);

    },


    onend_request: function(req, res, data, next) {

      if (data && data.length > 0) accumulate(req, data);

      var content = null;

      if (req._chunks && req._chunks.length) {

        content = Buffer.concat(req._chunks);

      }

      delete req._chunks;

      next(null, content);

    }

  };

}

累積応答

このプラグインは、ターゲットからデータチャンクを、レスポンスオブジェクトに関連付けられた配列プロパティに蓄積します。すべてのレスポンスデータを受信すると、配列はバッファに連結され、シーケンス内の次のプラグインに渡されます。このプラグインは、逆の順序で処理されるレスポンスを操作するため、最後のプラグインとして配置する必要があります。

module.exports.init = function(config, logger, stats) {

  function accumulate(res, data) {
    if (!res._chunks) res._chunks = [];
    res._chunks.push(data);
  }

  return {

    ondata_response: function(req, res, data, next) {
      if (data && data.length > 0) accumulate(res, data);
      next(null, null);
    },

    onend_response: function(req, res, data, next) {
      if (data && data.length > 0) accumulate(res, data);
      var content = Buffer.concat(res._chunks);
      delete res._chunks;
      next(null, content);
    }

  };

}

header-uppercase プラグイン

Edge Microgateway ディストリビューションには、<microgateway-root-dir>/plugins/header-uppercase というサンプルプラグインが含まれています。このサンプルには、各関数ハンドラを説明するコメントが含まれています。このサンプルは、ターゲットレスポンスの単純なデータ変換を行い、クライアントリクエストとターゲットレスポンスにカスタムヘッダーを追加します。

<microgateway-root-dir>/plugins/header-uppercase/index.js のソースコードは次のとおりです。

'use strict';

var debug = require('debug')('plugin:header-uppercase');

// required
module.exports.init = function(config, logger, stats) {

  var counter = 0;

  return {

    // indicates start of client request
    // request headers, url, query params, method should be available at this time
    // request processing stops (and a target request is not initiated) if
    // next is called with a truthy first argument (an instance of Error, for example)
    onrequest: function(req, res, next) {
      debug('plugin onrequest');
      req.headers['x-foo-request-id'] = counter++;
      req.headers['x-foo-request-start'] = Date.now();
      next();
    },

    // indicates start of target response
    // response headers and status code should be available at this time
    onresponse: function(req, res, next) {
      debug('plugin onresponse');
      res.setHeader('x-foo-response-id', req.headers['x-foo-request-id']);
      res.setHeader('x-foo-response-time', Date.now() - req.headers['x-foo-request-start']);
      next();
    },

    // chunk of request body data received from client
    // should return (potentially) transformed data for next plugin in chain
    // the returned value from the last plugin in the chain is written to the target
    ondata_request: function(req, res, data, next) {
      debug('plugin ondata_request ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    },

    // chunk of response body data received from target
    // should return (potentially) transformed data for next plugin in chain
    // the returned value from the last plugin in the chain is written to the client
    ondata_response: function(req, res, data, next) {
      debug('plugin ondata_response ' + data.length);
      var transformed = data.toString().toUpperCase();
      next(null, transformed);
    },

    // indicates end of client request
    onend_request: function(req, res, data, next) {
      debug('plugin onend_request');
      next(null, data);
    },

    // indicates end of target response
    onend_response: function(req, res, data, next) {
      debug('plugin onend_response');
      next(null, data);
    },

    // error receiving client request
    onerror_request: function(req, res, err, next) {
      debug('plugin onerror_request ' + err);
      next();
    },

    // error receiving target response
    onerror_response: function(req, res, err, next) {
      debug('plugin onerror_response ' + err);
      next();
    },

    // indicates client connection closed
    onclose_request: function(req, res, next) {
      debug('plugin onclose_request');
      next();
    },

    // indicates target connection closed
    onclose_response: function(req, res, next) {
      debug('plugin onclose_response');
      next();
    }

  };

}

変換

これは一般的な変換プラグインで、変更など、あらゆる種類の変換を実行できます。この例では、単にレスポンスとリクエストデータを大文字に変換しています。

 */
module.exports.init = function(config, logger, stats) {

  // perform content transformation here
  // the result of the transformation must be another Buffer
  function transform(data) {
    return new Buffer(data.toString().toUpperCase());
  }

  return {

    ondata_response: function(req, res, data, next) {
      // transform each chunk as it is received
      next(null, data ? transform(data) : null);
    },

    onend_response: function(req, res, data, next) {
      // transform accumulated data, if any
      next(null, data ? transform(data) : null);
    },

    ondata_request: function(req, res, data, next) {
      // transform each chunk as it is received
      next(null, data ? transform(data) : null);
    },

    onend_request: function(req, res, data, next) {
      // transform accumulated data, if any
      next(null, data ? transform(data) : null);
    }

  };

}