faasjs-api-jobs

FaasJS API とジョブ

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

1. API ファイルとジョブファイルは、その動作を所有する機能スライス内に配置します。
2. 外部入力のスキーマは境界で定義し、ビジネス入力には params.key からアクセスできる状態を保ちます。
3. 想定される API エラーには、明示的なステータスコードを指定した HttpError を使用します。通常の Error は内部エラー用に限定します。
4. Cookie、セッション、ヘッダー、ステータス、本文、コンテンツタイプには、注入された HTTP ヘルパーを使用します。
5. ジョブは少なくとも 1 回実行されるものとして扱います。エンキューは明示的に行い、生成されるパスを実行時の検出方法と一致させます。

参照するドキュメント

• .api.ts、defineApi、スキーマ、params、エラー、注入フィールド、型生成については、references/guidelines/define-api.md を参照してください。
• Cookie、セッション、レスポンスヘルパー、HTTP プラグイン設定については、references/guidelines/http-plugin.md を参照してください。
• 静的ファイルの配信とミドルウェアについては、references/guidelines/middleware.md を参照してください。
• .job.ts、defineJob、enqueueJob、プロセスの所有権、トランザクションと連動したエンキューについては、references/guidelines/jobs.md を参照してください。
• 生成されるジョブパス、params 型、typegen、重複パス、検出ルートについては、references/guidelines/job-types-and-paths.md を参照してください。
• Cron 式、スケジューラーの重複排除、再試行、試行回数、リースの有効期限については、references/guidelines/job-scheduling-and-retries.md を参照してください。
• ハンドラー、キュー、ワーカー、スケジューラー、トランザクション、型、検出に関する直接テストについては、references/guidelines/job-testing.md を参照してください。

注意点

• handler({ params }) のように、ハンドラーコンテキストの最上位だけを分割代入します。params からビジネスフィールドを分割代入しないでください。
• .api.ts または .job.ts ファイルの追加、名前変更、移動、削除の後は、npx faas types を実行してください。通常のハンドラー編集ではパス宣言は変わりません。
• 動的な文字列を生成済みのジョブパス型にキャストしたり、コールバックの実行後もトランザクションクライアントを保持したりしないでください。
• データの読み取りや変更の前に、ユーザー、テナント、組織、プロジェクト、ロール、権限のスコープを確認してください。
• シークレット、トークン、パスワード、Cookie、機密情報を含むペイロード全体、またはマスキングされていないサードパーティのレスポンスをログに記録しないでください。

検証

• vp test <pattern> で、対象を絞った API またはジョブのテストを実行します。
• API またはジョブのパス構成を変更した後は、npx faas types を実行します。
• バックエンドのファイルを変更した場合は、引き渡し前に vp check --fix を実行します。