Slack アプリを AWS Lambda で動かす

やること

Slack アプリを AWS Lambda で動かす。
Slack アプリは Slack Bolt で開発し、Slackのショートカットからモーダルを起動する。

Slack Bolt とは

Slack アプリを手軽に作成するためのフレームワークで、Slack 社が提供している。Bot だけを作れるとかそういうわけではなく、色々なトリガーからアプリを起動させて色々な処理をさせることができる。トリガーは以下の通り。

Webhook 起動
ショートカット起動（イナズママークのやつ）
スラッシュコマンド起動

また、BlockKitBuilder を使えば、よりリッチな UI を実現できる。

シーケンス

開発言語

Node.js 12.16.1

依存関係のある npm パッケージ

@slack/bolt 2.2.3
@slack/logger 2.0.0
aws-serverless-express 3.3.8

開発環境のみの npm パッケージ

serverless 1.78.1
serverless-offline 6.5.0

ローカルのAPIはngrok で外部公開する必要がある。（この記事では割愛）

実装内容

// ------------------------
// Bolt 初期化処理
// ------------------------
const { App, ExpressReceiver } = require('@slack/bolt');
const { LogLevel } = require('@slack/logger');
const logLevel = process.env.SLACK_LOG_LEVEL || LogLevel.DEBUG;
const processBeforeResponse = false;

const receiver = new ExpressReceiver({
  signingSecret: process.env.SLACK_SIGNING_SECRET,
  processBeforeResponse,
});

const app = new App({
  token: process.env.SLACK_BOT_TOKEN, // Bot User OAuth Access Token
  logLevel,
  receiver,
  processBeforeResponse,
});

// ------------------------
// Bolt メイン処理
// ------------------------

// ショートカット起動
app.shortcut('{callback_id}', async ({ logger, client, body, ack }) => {
  // logic...
  await ack();
});

// レスポンス処理
app.view('{callback_id}', async ({ logger, client, body, ack }) => {
  // logic...
  await ack();
});

// ------------------------
// AWS Lambda ハンドラ
// リクエストを受け付けたらExpressサーバを起動する
// ------------------------
const awsServerlessExpress = require('aws-serverless-express');
const server = awsServerlessExpress.createServer(receiver.app);
module.exports.hello = (event, context) => {
  awsServerlessExpress.proxy(server, event, context);
};

Slack アプリ作成

アプリは、以下から作成できる。
https://api.slack.com/apps/new

Slack アプリ設定

アプリをショートカット起動する場合は、以下から設定する。「Callback ID」はソースコードの app.shortcut('{callback_id}')〜と一致させる。
https://api.slack.com/apps/{作成したアプリID}/interactive-messages

実装のポイント

Slack アプリはレスポンスを3秒以内を返さないとエラーになってしまうため、ack() をどのタイミングで返すかがキモになってくる。3 秒を超えるような処理を実装する場合は Lambda を分割し先に ack() をしてから、一方の Lambda を非同期処理させると良い。
BlockKitBuilder の JSON と app.view の callback_id が紐づいているので、view が開かない場合 callback_id を確認すると良い。
BlockKitBuilder の JSON に block_id と action_id を指定すれば、リクエストを input ごとに取得することできる。

さいごに

Lambda で Bolt を動かす場合、Lambda 起動+Bolt 起動の時間が乗ってくるため、3秒ルールが結構シビア。Lambda で動かすよりもサーバでBoltを動かす方が、考えることが少なくて済み、良い。
個人的な備忘の記事なので、不明点はコメントか参考になったURLをみてもらえればと。

参考になったURL