Edited at

Slackシャッフル ランチ ボットをAWSサーバレスアーキテクチャで作る

More than 1 year has passed since last update.


はじめに


内容


  • Slackボットを作ります.

  • AWSサーバレスアーキテクチャとして開発します.

  • お題はシャッフルランチです.

これからSlackボットを作られる方や,AWSサーバレスアーキテクチャの初心者の方に参考になれば幸いです.


作るもの


みんなでランチに行きたい!が..

職場,サークル,その他組織のメンバの交流を図るのにランチは良いですよね.しかし,いつもと同じメンバと行ってしまう.一緒に行きたいけどなかなか誘えない.そんなときシャッフルランチを企画してみましょう.定期的に,ランダムでグループ分けしたメンバでランチに行きす.


Slackボットで出席日確認とグループ分け

ボットがシャッフルランチに参加できる日のアンケートを行い,それに基づいてメンバをランダムで割り振ります.




作り方


AWSサーバレスアーキテクチャ

本記事ではシャッフルランチをSlackボットをAWSサーバレスアーキテクチャで作ります.

具体的には以下のサービスを利用します.Slackを除いてすべてAWSのサービスです.

サービス
利用目的

Lambda
各種処理の実行のため

DynamoDB
メンバの名簿,出席可能かどうかを記録するため

CloudWatch
シャッフルランチボット定期実行のため

API Gateway
SlackイベントのWebhookとして利用するため

CloudFormation
各サービスへのデプロイ

ParameterStore
Slack APIのキーを保持するため

Slack
本ボットのUIを担当


仕様


シャッフルランチのルール

若干ややこしいですが,次のルールに基づいてシャッフルランチを開催・参加するものとします.


  • 毎週火曜日(*1)に開催される.(シャッフルランチ自体は毎週火曜に開催されているが,全員が参加するわけではない.)

  • メンバは一人あたり原則月2回(*1)参加する.

  • 前月の最終週に来月の出席可能日をアンケートする.例えばメンバは5月の出席可能日を4月最終数に回答する.

*1: オプションで変更可能


シナリオ

今日は2018年4月22日.横山さんがSlackを確認すると,ボットのこんなメッセージを見つけた.早速,横山さんは5月22日以外は都合が良いので,「出席できる」をクリックした.

数日後,改めてSlackを確認するとシャッフルランチの参加日と一緒に食事するメンバが割り振られていた.都合がつかず「出席できる」を押さなかった5月22日は避けられている.


  • 5月1: teamルイージ 森さん,田中さん,山下さん,佐藤さんの4人と食事することになった.

  • 5月15日: teamマリオ  渡辺さん, 臼井さん, 西村さん, 川瀬さんの4人と食事することになった.


構築していく

注: スクリーンショットは2018年4月1日現在の物です.


Slack Appの作成


作成

https://api.slack.com を開いて”Start Building”をクリック.Slack Appを作成します.


設定

管理画面が表示されたら"OAuth & Permissions"に移動します.

Scopesでプルダウンメニューから”Send messages as shuffle luncher”を選択します.

そして保存します.

保存すると,ページ上部の「Install App to Workspace」ボタンが押せるようになるので,押します.確認画面が表示されるので許可しましょう.


OAuth Access Tokenの発行を確認

OAuth認証トークンが発行されます.言うまでもないですが,流出させてはいけない文字列です.


Slack OAuthトークンをAWS側に保存

先ほどのOAuthトークンは,AWS側のプログラムからSlack APIにリクエストする際に必要ですが,直接コードに書くべきではありません.こういったパラメータを保持するためのサービス,ParameterStoreを利用しましょう.

Webのコンソールから Systems Manager, Parameter Storeへと進め,パラメータストアで保存します.

フィールド

名前
shuffle_luncher_slack_token

タイプ
SecureString


先ほどのトークン

ParameterStoreに保存しておけば AWS SDKに含まれる関数から値を取得できます.


できあがったもの


リポジトリ

今回,自分が作成したコードはGithubで公開しており,samファイルも記述したため,数個のコマンドで構築できます.細かい実装についてはGithubのコードを見ていただければ幸いです.


ビルド

git clone git@github.com:hiroyky/shuffle_luncher.git

cd shuffle_luncher
npm install
npm run build


デプロイ

aws-cliがインストールされて実行できることが前提です.

./deploy/deploy.sh <デプロイ時のS3バケット名> <SlackのチャンネルID>


  • デプロイ時のS3バケット名: デプロイするパッケージを保存するバケット名


    • SlackのチャンネルID: 投稿するSlackチャンネルのID,URLのmessages/<SlackのチャンネルID>




コードの要素

*コードの行数などは記事執筆時とずれる可能性があります.


出席可能日アンケート

概要
内容

エントリポイント
askForAttendanceDates

月の指定曜日の日付を算出し,Slackに投稿します.Attachementとしてボタン要素を作成しています.

CloudWatchからcronで実行すれば毎月アンケートされます.

https://github.com/hiroyky/shuffle_luncher/blob/master/src/drivers/slack-driver.ts#L13

const arg = {

token: this.env.slackToken,
channel: this.env.slackChannelId,
text: `シャッフルランチ出席可能日確認:出席できる日のボタンを全て押してください.${expires}まで`,
fallback: '',
attachments: new Array<any>()
};
candidateDates.forEach(date => {
arg.attachments.push({
callback_id: (date.getTime() / 1000).toString(),
title: `${date.getMonth()+1}${date.getDate()}日`,
attachment_type: 'default',
actions: [
{
type: 'button',
text: '出席できる',
name: `attendance_${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}`
}
]
});
arg.attachments.push({
callback_id: this.getAttachmentId(date),
text: ''
});
});

attachmentのcallback_idがどのボタンをクリックしたかの識別子になります.


ボタンを押されたときのイベント:出席可能日登録

ユーザがボタンを押したときのエントリポイントです.API Gatewayを経由して実行されます.

DynamoDBに日付をフィールドにして,出席できるとしてtrueが登録されます.

概要
内容

エントリポイント
interactoinHandler


Slack Webhook

Slack Appの設定画面で「Interactive Components」を開きます.「Request URL」にユーザがボタンを押したときにwebhookされるURLを指定します.インタラクションがあるたびにこのURLにPOSTされます.POSTの内容にはクリックしたユーザ情報や押したボタンの情報が含まれます.ボタンのcallback_idでどれが押されたかを取得します.


API Gateway

AWS Api GatewayにてWebhookのエントリポイントとなるAPIを作成します.APIはPOSTリクエストを受け取ると,LambdaのinteractoinHandlerを実行するように設定します.

設定できたらAPIのURLを先程のSlackの「Interactive Components」に設定します.


Lambda: Slack系の処理

API Gateway経由で実行されるLambdaを作成します.引数のeventにslackでボタンを押したユーザや押したボタンの識別子が含まれています.それを取得しましょう.

APIGatewayEventのbodyに含まれています.しかしながら次のようになっています.

body: 'payload=%7B%22type%22%3A%22interactive_message%22%2C.....'

payload=の右側の値を取得し,URLデコードし,JSON.parseする必要があります.

protected geSlacktPayload(event: APIGatewayEvent): InteractiveMessagePayload {

const body = event.body;
if(body === null) {
throw new HttpError(400, "request body is null");
}
const payload = body.split('&').map((param) => {
const keyValue = param.split('=');
return {key: keyValue[0], value: keyValue[1]};
}).filter((keyValue) => keyValue.key === 'payload')[0].value;

return JSON.parse(decodeURIComponent(payload)) as InteractiveMessagePayload;
}

https://github.com/hiroyky/shuffle_luncher/blob/master/src/slack-payload-parser.ts#L24-L34

すると次のようなJSONが取得できます.元のメッセージも含めていろいろ取得できています.(一部伏せ字にしています)

{

"type": "interactive_message",
"actions": [
{
"name": "attendance_2018-5-29",
"type": "button",
"value": ""
}
],
"callback_id": "1527552000",
"team": {
"id": "xxxxxxxxx",
"domain": "<Slackのドメイン名>"
},
"channel": {
"id": "xxxxxxxxxx",
"name": "general"
},
"user": {
"id": "xxxxxxxxxx",
"name": "user_name"
},
"action_ts": "1525132254.646051",
"message_ts": "1525109072.000136",
"attachment_id": "9",
"token": "xxxxxxxxxxxxxxxxxxxxxxx",
"is_app_unfurl": false,
"original_message": {
"text": "シャッフルランチ出席可能日確認:出席できる日のボタンを全て押してください.4月26日まで",
"username": "shuffle+luncher",
"bot_id": "B9SNL3VA4",
"attachments": [
{
"callback_id": "1525132800",
"title": "5月1日",
"id": 1,
"actions": [
{
"id": "1",
"name": "attendance_2018-5-1",
"text": "出席できる",
"type": "button",
"value": "",
"style": ""
}
],
"fallback": "5月1日"
},
{
"callback_id": "members-1525132800",
"id": 2,
"fallback": "[no+preview+available]"
},
{
"callback_id": "1525737600",
"title": "5月8日",
"id": 3,
"actions": [
{
"id": "2",
"name": "attendance_2018-5-8",
"text": "出席できる",
"type": "button",
"value": "",
"style": ""
}
],
"fallback": "5月8日"
},
{
"callback_id": "members-1525737600",
"id": 4,
"fallback": "[no+preview+available]"
},
{
"callback_id": "1526342400",
"title": "5月15日",
"id": 5,
"actions": [
{
"id": "3",
"name": "attendance_2018-5-15",
"text": "出席できる",
"type": "button",
"value": "",
"style": ""
}
],
"fallback": "5月15日"
},
{
"callback_id": "members-1526342400",
"id": 6,
"fallback": "[no+preview+available]"
},
{
"callback_id": "1526947200",
"title": "5月22日",
"id": 7,
"actions": [
{
"id": "4",
"name": "attendance_2018-5-22",
"text": "出席できる",
"type": "button",
"value": "",
"style": ""
}
],
"fallback": "5月22日"
},
{
"callback_id": "members-1526947200",
"id": 8,
"fallback": "[no+preview+available]"
},
{
"callback_id": "1527552000",
"title": "5月29日",
"id": 9,
"actions": [
{
"id": "5",
"name": "attendance_2018-5-29",
"text": "出席できる",
"type": "button",
"value": "",
"style": ""
}
],
"fallback": "5月29日"
},
{
"callback_id": "members-1527552000",
"id": 10,
"fallback": "[no+preview+available]"
}
],
"type": "message",
"subtype": "bot_message",
"ts": "1525109072.000136"
},
"response_url": "https://hooks.slack.com/actions/xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"trigger_id": "357062670966.329981082688.9177125d9306f3a50b8bdbf0071ec9b4"
}

例として,以下のように取得できますね.

const req = JSON.parse("上記JSON文字列");

// ボタンをクリックしたユーザ情報
const triggeredUser = req.user;

// どのボタンをクリックしたか
const buttonId = req.callback_id;

// 元のメッセージ
const originalMessage = req.original_message

元のメッセージを加工して,既存のメッセージを更新することができます.その際,original_messageのts(おそらくタイムスタンプ)が識別子になるようです.

ここでは,元のメッセージに出席できるユーザ一覧のアッタチメントを追加して,書き換えを行っています.

protected web = new WebClient();

async updateAttedanceMembers(attedanceMembers: User[], date: Date, org: OriginalMessage) {
const arg: any = Object.assign({}, org, {
token: this.env.slackToken,
channel: this.env.slackChannelId
});
const attachments = arg.attachments as Attachment[];
const index = attachments.findIndex((el, i, arr) => el.callback_id === this.getAttachmentId(date));
attachments[index] = {
text: `${attedanceMembers.map(m => m.displayName ? m.displayName : m.name).join(', ')}`,
callback_id: attachments[index].callback_id,
};
this.update(arg);
}

protected async update(arg: ChatUpdateArguments) {
return await this.web.chat.update(arg);
}


Lambda: DynamoDBに出席可能者の登録

もちろん加えて,出席できるユーザをDynamoDBに記録しています.


index.ts

 await memberManager.updateAttendanceOrNot(req.eventTriggeredUser, req.eventTriggeredDate);



member-manager.ts

async updateAttendanceOrNot(user:SlackUser, date:Date) {

const userData = await this.storageDriver.getUser(user.id);
const dstValue = !userData.isAttendance(date);
await this.storageDriver.updateUserAttedance(user.id, date, dstValue);
}


drivers/storage-driver.ts

async updateUserAttedance(slackId: string, date: Date, isAttendance: boolean) {

const param: DocumentClient.UpdateItemInput = {
TableName: this.env.dynamoDBTableName,
Key: { 'slack_id': slackId },
UpdateExpression: "set #date = :attendace",
ExpressionAttributeNames: {
"#date": util.getAttendanceFieldName(date)
},
ExpressionAttributeValues: {
":attendace": isAttendance
},
ReturnValues: 'NONE'
};
await this.db.update(param).promise();
}


シャッフルと通知

CloudWatchからcron実行されます.

メンバが「出席できる」と登録した日付を踏まえて,ランダムでメンバを割り振ります.

概要
内容

エントリポイント
shuffleMembers


リポジトリ