移行ツール

Auth0 Dashboardのルール移行ツールを使用して、ルールからアクションへの移行プロセスを簡素化します。新しいツールは、ルールからアクションへの切り替えを簡単にするだけでなく、一般的なルールパターンについての組み込みのガイダンスや修正も提供しています。

移行前

移行を開始する前に、「RulesからActionsに移行する」をご覧ください。.この移行ガイドは、ルールとアクションの違いが説明されている優れたリソースであり、移行過程においても役立つツールです。

ルールはアクションの前に実行されるため、実行順序の逆にルールを移行する必要があります。既存のフローで最後に実行するルールを移行し、最初のルールまで時系列を遡って移行していきます。

この順序で移行を行わないと、ルールとアクションの順序における依存関係によって予期せぬ結果が生じ、エラーが発生する可能性があります。

移行ツールを使うと、何か問題が発生した場合に、安全かつ簡単にロールバックすることができます。ルールを再有効化すると、対応するアクションロジックがスキップされます。

ルールの移行を開始するには、［Auth Pipeline（Authパイプライン）］>［Rules（ルール）］を選択します。選択すると、ルールとそれらを個別に移行するオプションが提供されます。

移行は［Migrate to Action（アクションに移行）］を選択するまで開始されません。新しいアクションを有効化するタイミングは、開発者が選択ができます。

［Migrate to Action（アクションへの移行）］を選択すると、新しいアクションの作成が求められます。

［Create（作成）］を選択すると、新しいアクションが作成され、Actions Editor（アクションエディター）が表示されます。

ルールがアクションに移行され、アクティブのままになっていると、ルールはロジックが実行される前に終了します。

これは、api.rules.wasExecuted()を呼び出すことで実行されます。wasExecuted関数がルールIDを含む文字列を使用する場合、そのルールがすでに実行されているとtrueが返され、実行されていないとfalseが返されます。

これは、ロジックが2回実行されるのを防ぐのに役立つツールです。参照されたルールを無効にすると、即座にこの関数がfalseを返し、ビジネスロジックがアクションで実行されるようになります。

ルールIDの値は、［Migrate to Action（アクションに移行）］機能を使って移行したルールでは自動的に指定されます。

api.rules.wasExecuted() 関数の詳細については、「アクショントリガー: post-login - APIオブジェクト」を参照してください。

Actions Editor（アクションエディター）で［Rules（ルール）］ボタンを選択して、ルール移行ツールを読み込みます。ここで、移行されたルールのコードをすぐに参照することができます。サイドバーで選択したルールのコードを確認してください。

ルール関数の内容をコピーして、アクション内の「// YOUR CODE HERE」コメントの下に貼り付けます。おそらく、このコードはアクションのプログラミングモデルに適合しません。

Actions Editor（アクションエディター）は、コードのリファクタリングが必要な箇所のフィードバックを表示します。また、ほとんどの状況で、自動修正の方法が提案されます。提案の確認や修正を行うには、下線のあるコードの上にカーソルを置きます。

Quick Fix（クイック修正）モーダルからオプションを選択すると、アクション特定の更新を適用できることがあります。

推奨の修正を選択すると、コードが互換性のあるものに自動更新されます。

自動的に修正を適用できない場合もありますが、その場合でもガイダンスが提供されます。

たとえば、ルールのcallback関数の場合、エラーにはapi.access.deny、正常処理にはreturnの使用が推奨されます。

アクションは移行過程の重要な一部であるため、エディターで直接テストすることができます。詳細については、「アクションをテストする」を参照してください。

運用環境で移行ロジックを有効にする際には、まず開発テナントのすべての移行ロジックを検証することを強くお勧めします。

アクションコードが更新され、切り替えの準備ができたら、以下を行います。

［Deploy（導入）］を選択します。
導入を確認するアラートが表示されたら、［Add to flow（フローに追加）］を選択します。
新しく作成したアクションをフローに追加し、［Apply（適用）］を選択します。
［Continue（続行）］を選択して、選択されたルールを無効化し、新しいアクションを有効にすると同時に元のルールを無効にします。準備が整っていない場合は［Cancel（キャンセル）］を選択して、ルールの無効化と移行したアクションロジックの有効化を後で行うことができます。

フローにアクションを追加する方法については、「初めてアクションを作成する」を参照してください。

ルールを再有効化すると、対応するアクションロジックがスキップされます。

このプロセスを繰り返すことで、ログインフローにあるルールをそれぞれ移行することができます。ルールは、ログインフローで実行される順序とは逆の順序で移行する必要があることを忘れないでください。