faasjs-plugins-runtime

FaasJS プラグインとランタイム

デフォルトのワークフロー

1. 認証、テナント、リクエストメタデータ、権限スコープなど、複数の領域にまたがるビジネスコンテキストにはプラグインを使用します。
2. プラグインのライフサイクルフックは、明確な責務範囲、再試行に安全なマウント初期化、必要な場合の next() の呼び出しが1回だけになるように実装します。
3. DefineApiInject のモジュール拡張を通じて、注入フィールドの型を提供します。
4. フレームワークがロガーを提供する場合は注入されたロガーを優先し、単独で動作するコードではラベル付きロガーを作成します。
5. @faasjs/node-utils の使用は、Node 専用のブートストラップとツールの処理に限定します。

参照するドキュメント

• プラグインのインターフェース、ライフサイクルフック、注入フィールド、設定による読み込み、テスト：references/guidelines/plugins.md。
• ロガーの選択、レベル、フォーマット、タイミング、シークレットの取り扱い：references/guidelines/logger.md。
• loadConfig、.env の読み込み、モジュールフック、スキーマヘルパー、パスの包含チェック：references/guidelines/node-utils.md。

注意点

• 注入フィールドは InvokeData を変更して追加し、モジュール拡張で型の範囲をドキュメント化します。
• onMount は再試行に安全な実装にします。同時に呼び出された場合は1回の試行を共有し、失敗後の呼び出しでは再試行できるようにします。
• シークレットや機密性の高いペイロード全体をログに記録しないでください。
• モジュールフックの登録は、プロセスのブートストラップ時に行います。

検証

• 動作がライフサイクルの実行に依存する場合は、実際の Func インスタンスを使ってプラグインをテストします。
• onMount がリソースを管理する場合は、マウント成功の共有、マウント失敗の共有、失敗後の再試行をテストします。
• vp test <pattern> で対象を絞ってテストを実行します。
• プラグインまたはランタイムのファイルを変更した場合は、引き継ぎ前に vp check --fix を実行します。