TypeScriptでAWS SQSを使う

AWS SDK for Javascriptを使って、AmazonSQSを試してみます。

AmazonSQS

公式サイト：https://aws.amazon.com/jp/sqs/

マイクロサービス、分散システム、およびサーバーレスアプリケーション用の完全マネージド型メッセージキューです。
メッセージの順番が保証されず、ちょっと安く利用できる標準キューと、高スループットでメッセージの順番が保証されているFIFOキューの2種類のキュータイプがあります。

細かい機能は公式サイトを見ていただけたらと思います。

SQSは使用した分で課金される＆一定量を超えない限り課金されない、ので放置していても課金が発生せず、作った後に削除する必要がないのも試しやすい点です。

AWS SDK for Javascript

公式サイト：https://aws.amazon.com/jp/sdk-for-javascript/

JavaScriptから呼び出すAWS SDKです。AWSのサービスを簡単に使うことができます。
当たり前ですが、今の業務がTypeScript、Node.jsを使っているので、今回はJavaScriptにしていますが、他の言語でも同じように使うことができます。

AmazonSQSのHello World

コードを書く前に先にSQSをコンソール画面から作成して使ってみます。

ドキュメント：https://aws.amazon.com/jp/getting-started/hands-on/send-messages-distributed-applications/

ドキュメントに載っている通り、Queueを作り、簡単なメッセージの送信と受信をするところをやります。

Amazon SQSの画面に進み、Create queueでQueueを作ります。
Typeは簡単な動作を見るだけなので、今回はStandardにします。

キュー作成後、Send and receive messagesを押し、Send Messageでメッセージの送信、poll for messagesでメッセージの取り出しをします。

キュー作りはこれで終わりです。簡単ですね。

AWS SDK for Javascriptでメッセージの送信＆受信＋イベントを実行する

メッセージの送信＋受信を確認して、SQS→Lambda→Slack通知あたりをする簡単なシステムを作ってみます。

IAMユーザの作成

今回はSQSへのアクセスからローカルから行う際にIAMユーザを使いますので、そのユーザを作ります。
必要なポリシーとしては、SQSのReceiveMessageとSendMessageになります。

メッセージの送信（と受信）

@aws-sdk/client-sqsというパッケージを使います。
ドキュメントは下記。(概要はドキュメントの方がわかりやすいですが、型などで記載がないものがあったので、細かいところはコードから参照した方が良さそうです。)
https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sqs/

今回はメッセージの送信と受信（動作確認だけ）を行うので、SQSClientと
SendMessageCommandとReceiveMessageCommandを使います。

最初にSQSを触るためのクライアントであるSQSClientのインスタンスを作ります。
今回は必要な権限を持つIAMユーザを作成し、そのアクセスキーを使います。

クレデンシャルの指定は、下記のように指定するとできます。

const sqs_client = new SQSClient({
  credentials: {
    accessKeyId: 'test', // AWS access key ID
    secretAccessKey: 'test', // AWS secret access key
  }
});

Node.jsに認証情報をロードする方法として、環境変数で指定された認証情報ファイルからの読み込み、環境変数からの読み込みがあります。
上記のようにconstructorで指定しない場合、認証情報ファイルの環境変数AWS_PROFILEやAWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEYの情報が設定されます。

次にメッセージの送信と受信ですが、これもドキュメントを読んで書くだけになります。細かいところは割愛しますが、下記のようなコードで動きます。

メッセージの送信

const params = {
  QueueUrl: `${キューのURL}`,
  MessageBody: `${メッセージのボディ}`,
  DelaySeconds: 10,
};
const command = new SendMessageCommand(params);
await sqs_client.send(command);

メッセージの受信

const params = {
  AttributeNames: ["SentTimestamp"],
  MaxNumberOfMessages: 1,
  MessageAttributeNames: ["All"],
  QueueUrl: `${キューのURL}`,
  WaitTimeSeconds: 10,
};
const command = new ReceiveMessageCommand(params);
await sqs_client.send(command);

ここまでできたら、実際にキューにメッセージを送信・受信を試します。
キューに入ったメッセージは、コンソール画面で簡単に確認できます。

実装例のGithub：https://github.com/KouheiHara/AWSForJavascript

Lambdaの設定

Lambdaの設定としては、SQSをトリガーを設定し、受け取ったメッセージのテキストを通知するようにします。
Lambdaのトリガーの設定時、SQSのメッセージの受信などをするため、Roleの設定が必要になります。今回はLambdaに割り当てるので、AWS Service Roleを作ります。

Trust relationshipsのPrincipalのServiceをlambdaに設定します。（これでLambda側から紐づけることができるようになります。）

後はSQSをトリガーとして設定するのに、必要なポリシーを設定するだけです。これはトリガーの設定時に必要なポリシーを教えてくれるので、その必要な分だけ設定します。

Slack通知はSlack APIを使います。今回はchat.postMessageAPIでメッセージを送ります。
https://api.slack.com/methods/chat.postMessage`

SQSから受け取ったメッセージのbodyを受け取り、下記のようなコードSlack通知を行います。

exports.handler = async (event) => {
  const text = event.Records[0].body;
  const payload = {
    channel: 'My Channel',
    blocks: [
      {
        "type": "section",
        "text": {
          "type": "mrkdwn",
          "text": text,
        }
      },
    ],
  };

  const options = {
    hostname: 'slack.com',
    port: 443,
    path: '/api/chat.postMessage',
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer Token'
    }
  };

  const res = await request(
    options,
    JSON.stringify(payload),
  );
  console.log('statusCode:', res.statusCode);

  return { statusCode: 200, body: 'OK' };
};

あとは、SQSにメッセージを送信すると、Slackに通知されることを確認して終わりです。

まとめ

AWS SDK for JavascriptでSQSへのメッセージの送信、Lambdaでメッセージ受信、Slack通知まで行いましたが、便利なのに対して、比較的に簡単なので、色々なところで使えそうかなと思いました。

あとは、私だけかもしれませんが、AWS SDKのドキュメントが新しくなって、逆に読みにくくなったと感じました。