エラー処理のベストプラクティス

API呼び出しから返されるエラー条件は、適切な方法で処理する必要があります。これを怠ると例外が処理されない状況につながり、パイプラインの実行が途中で終了し、最終的に認証エラーが返される可能性があります。

異常な操作の可視性と診断を向上させるために、エラーイベントログを外部サービスに送信することをお勧めします。サブスクリプションプランで提供されるログ保持期間を超えてログイベントを保持および分析するには、Auth0ログストリーミングを使用します。DataDogやAWS EventBridgeなどのサービスを使用できます。Auth0 Marketplaceのログストリーミングセクションでは、ログを外部サービスに送信する機能も提供しています。

ルールの実行時間には時間制限があります。詳細については、カスタムデータベースアクションスクリプト実行のベストプラクティスをお読みください。この期間内にエラー状態から回復できない場合（または回復する可能性がない場合）、エラー状態を明示的に返す必要があります。これは、次のように、Node Errorオブジェクトのインスタンスを返すことでルール実行を完了するのと同じくらい簡単です。

return callback(new Error('some description'));

詳細については、クラス: nodejs.orgにエラーをお読みください。

または、Auth0固有のUnauthorizedErrorのインスタンスを返すこともできます。これにより、認証を開始したアプリケーション（つまり、/authorizeエンドポイントへのリダイレクトを開始したアプリケーション）に、指定されたエラーの説明を含む不正なエラー状態が返されます。これにより、アプリケーションは条件付き再試行機能を提供でき、特定の条件に基づいてアクセスを拒否するルールを実装できます。

return callback(new UnauthorizedError('some description'), user, context);

UnauthorizedErrorオブジェクトは、指定された説明のみを返します。不正なエラー条件に対して特定の処理を使用するには、説明をフォーマットして、簡単にアクセスできるエラーコード情報を含めることをお勧めします。例:

'[00043] - my specific error description'）

キャッチされないJavaScript例外などの予期しないエラー条件により、パイプラインの実行が途中で終了し、最終的に認証エラーが返される可能性があります。

非同期操作を伴う状況では、Promiseオブジェクト処理を使用するときにcatchハンドラーを使用する必要があります。Promiseオブジェクト処理は、非同期操作中のエラー処理にも効果的です。以下に示すように、Promiseオブジェクトを使用して、たとえば同期関数呼び出しをラップすると、Promiseチェーンなどを使用してカスケード エラー処理を簡単に実装できます。Promiseオブジェクトの詳細については、MDN Web DocsのPromiseを参照してください。Promiseチェーンの詳細については、Error Handling with Promises on javascript.infoのPromiseによるエラー処理をお読みください。

return new Promise(function(resolve, reject) {
    jwt.verify(
      token,
      secret,{
      clockTolerance: 5},
      function(err, decoded) {
        if (err) {
          reject(err);
        } else {
          resolve(decoded);
      }
    });
  });

または、同期操作中に発生するJavaScript例外を処理するためにtry...catch処理を使用することもできます。詳細については、MDN Web Docsのtry...catchをお読みください。 このタイプの例外処理を設定するとパフォーマンスコストが発生する場合が多いため、多用しないようにして。ルールのパフォーマンスは可能な限り最適化する必要があります。より実用的なアプローチは、例外が発生した後に処理するのではなく、例外が発生しないようにする処理を実装することです。ベストプラクティスの詳細については、パフォーマンスのベストプラクティスを参照してください。

初期化されていないオブジェクトを使用すると、例外が発生する可能性があります。オブジェクトの存在が疑われる場合は、宣言の一部として初期化を含めることをお勧めします。例：

user.user_metadata = user.user_metadata || {})

ルールでは、例外が発生しないようにするための手順を実行することがベストプラクティスであり、通常、例外処理を実装するよりもパフォーマンスとリソースの使用の点でコストが低くなります。

• デバッグのベストプラクティス
• ルールのベストプラクティス