はじめに
この記事では AWS Step Functions 内で他のサービスと統合し、人による承諾までワークフローを待機させる方法を紹介します。
ワークフローの待機について
AWS Step Functions内で .waitForTaskToken を使用することでコールバックが返されるまでワークフローを待機させることができます1。
試してみる
公式ドキュメントに 人間による承諾プロジェクト例をデプロイする があるので実施してみます。開発者ガイドに実行可能なテンプレートが整備されているのは便利ですね。
実行結果
CloudFormationの実行が完了すると Step Functions が作成されます。
Step Functions を実行するとSNS通知先で登録したメールアドレスにEメールが届きます。
その間、Step Functions のワークフローは停止しています。
Eメールの approve のリンクをクリックするワークフローが再開されます。
これで公式ドキュメントは終了なのですが、Eメールのリンクをクリックから Step Functions 再開までの流れが理解できなかったため、中身を詳しく見ていきます。
デプロイされた Step Functions の詳細
CloudFormationを確認すると、実行されるAWSサービスとして API Gateway, SNS, Lamnda①(LambdaHumanApprovalSendEmailFunction), Lambda②(LambdaApprovalFunction) の4つのリソースが作成されています。
SNSはメール通知に用いているとわかりますが、API Gateway と Lamnbda 2つの関係性がまだわかりません。
CloudWatch logを確認してみると、LambdaHumanApprovalSendEmailFunction → LambdaApprovalFunction の順番で実行されているようです。そのため、LambdaHumanApprovalSendEmailFunction の中身から確認していきます
LambdaHumanApprovalSendEmailFunction の詳細
LambdaHumanApprovalSendEmailFunction の ソースコードを見てみます。
39行目以降で SNS トピックを作成しており、LambdaHumanApprovalSendEmailFunction → SNSによるEメール発行 の順番で実行されているようです。
Eメールの本文は 31～37行目で作成されており、通知で届いたEメール文章とも一致します。
19行目で API Gateway エンドポイントを指定しており、作成した API Gateway をこの後に使っていそうです。
また22行目, 25行目で &taskToken というパラメータを設定しており、ここで Step Functions の実行ワークフローのトークンを付与していそうです。
LambdaHumanApprovalSendEmailFunction では API Gateway のエンドポイントや Step Functions のトークンを指定して Approve/Reject のURLを作成していることがわかりました。
次に、Approve/Reject をクリック先である API Gateway の動きを追っていきます。
API Gateway の詳細
API Gateway の構成はシンプルで、エンドポイントに来たリクエストを Lamnda につなげているようです
あとは接続先Lambdaである `` の詳細を確認すれば動きがつかめそうです。
LambdaApprovalFunction の詳細
LambdaApprovalFunction のソースコードを見てみます。
35～42行目でAPIリクエストのパラメータを読み取り、メッセージを設定しています。
その後、44行目で output(message) と taskToken の2つを Step Functions に送信しています。
この LambdaApprovalFunction によって停止中の Step Functions が再開されていそうですね。
実際に Step Functions のステートマシン詳細を見てみると、LambdaApprovalFunction が作成するメッセージを基に、後続のフローを判断しているようです。
仮に複数のワークフローが待機中だとしても、taskToken により一意のワークフローを指定できそうです。
人間による承諾プロジェクト例をデプロイする の構成
調べてみた結果を構成図に表してみると、以下のようになると理解しました。
まとめ
今回の記事では AWS Step Functions 内で人による承諾までワークフローを待機させる方法を紹介しました。
最初は Lambda がコールバック待機しているのかと思っていましたが、実際には Step Functions として待機しているようですね。
実際に運用する際には API Gateway のエンドポイントの保護などセキュリティ面を考慮する必要がありそうですが、Lambda 単独では難しいフローを実現できる点が便利に感じます。