Zenn
PrAhaPublicationへの投稿
😸

相手がタスクを完了するまで鬼リマインドを続けるslackアプリ作った。もう...誰も催促しなくて済む世界にしたいの...

プラハの社長
2020/09/18に公開
Slack
個人開発
Bot
tech

メンションをつけた相手がタスクを完了するまで指定された周期でお尻を叩き続けるslackアプリ「penpen」を作った

https://penpen.netlify.app/

https://twitter.com/slack_penpen/status/1276800701176311810?s=20

こんなイメージ

  1. slashコマンドで起動します。/penpenの後に、リマインダーの内容と、お尻を叩きたい相手を指定します

image.png

  1. 以上

相手にはこんな風に見えます

image.png

終わったをクリックすると、リマインダーの一覧から消えます。ついでにリマインダーを設定した相手に「タスク完了したよ！」と通知してあげます

image.png

使い方はこんな感じです。

時間を細かく指定できる

every 3 hours や　every 2 days　など指定することで、お尻を叩く周期を選べます。

image.png

最短で１時間毎に相手をペンペンできます。

何人でも指定できる

1つのリマインダーに複数人を指定する事も可能です。一応、英語対応もしているため、slackの言語設定が日本語以外であれば、英語でお尻を叩いてくれます。

作ろうと思った背景

ケース１：自分の指示が忘れられる

エンジニア「あの、デザイナーさん、この画面のデザイン確認をお願いします」
デザイナー「はい分かりました」
エンジニア「頼んだやで」

（３時間後）

エンジニア「あのぅ・・・例のデザイン確認・・・」
デザイナー「あっ忘れてました。すぐやります」
エンジニア「頼んだやで」

（１時間後）

エンジニア「あの・・・・・」
デザイナー「あっ」

ケース2:相手からの指示を忘れる

エンジニア「うーん、ちょっと持ち帰らせてください」
企画「分かりました。じゃあ明日、結果を教えてください」
エンジニア「はいやで」

（明日）

企画「例の件どうなりました？」
エンジニア「あっ」

ケース3:自分から自分への指示を忘れる

エンジニア「あーしまった、ここのログ調査しなきゃいけないんだったー。trelloとか記載するの面倒だし、slackのreminderか、スマホのリマインダーでも設定しておこ」

（明日）

reminder「ログ調査やで」
エンジニア「今飯だから後でやるわ」

（3日後）

エンジニア「あっ」

.
.
.

...もう、誰かに催促されたり、誰かを催促しなくて済む世界にしたいの...

ってわけで、使いなれたslackを離れることなく、相手がタスクを完了するまで、地の果てまで追いかけてお尻を叩き続けるslackアプリを作ることに決めました

構成

  • インフラ：heroku, Cloud Scheduler, Pub/Sub, Cloud Functions
  • バックエンド：node.js, TypeScript, express, bolt
  • フロント:nuxt.js, netlify
    • 蛇足：最近nuxtが真のSSGに近づいた

制作期間

  • 約3日（16時間）
    • 環境構築: 1時間
    • API: 13時間
      • 単体テスト: ５時間
      • 機能実装: 8時間
    • FE: １時間
    • slackの設定: 1時間

仕組み

最初のうちboltは「これslashコマンドと普通のRESTエンドポイントどうやって共存させるんだろう」と若干ハマりましたが、こんな感じでexpressReceiverを取得してあげれば解決します

import { App, ExpressReceiver } from '@slack/bolt'

const receiver = new ExpressReceiver({ signingSecret: config.SLACK_SIGNING_SECRET })
const app = new App({
  token: config.SLACK_BOT_TOKEN,
  receiver
})

receiver.router.get('/task', getTaskAndUpdatedSendAtHandler(app, conn)) // 普通のREST
app.command(config.SLASH_COMMAND_NEW_TASK, slashPostTaskHandler(app, conn)) // slashコマンド
app.action(ACTIONS.buttonClick, deleteTaskHandler(app, conn)) // ボタンクリック時などのaction

app.start(config.PORT)

boltを使っておくとslackの会話内容をlistenして、例えば「これお願いします」みたいなワードに反応してpenpenが発言する、みたいな機能が簡単に作れるので、今後の対話性を見据えてboltを採用しました。

タスクを投稿する

  • slackのslashCommandを待ち受ける
    slashCommandは基本的に全てAPIの/slack/eventsエンドポイントで受け取る形になりますが、前述のboltを使うことでapp.command('hoge')とすれば/hogeに反応するようになります。

  • 発言を解析
    AIが発言を解析...していません。地道に正規表現でマッチしてます。 every 12 hours なら１２時間ごと、 every 3 monthsなら3ヶ月ごとなど、リマインダーの周期を決定します

  • タスクを保存
    TypeORMを使っています。

oauth認証

ユーザーからのアクション（slashコマンドやボタン押下）に対して応答するだけであれば、イベントが発火した時に引数に含まれるsay()を呼び出すだけで事足りますが、自分から積極的に発言していくウェイタイプのbotはoauth認証が必要です。これを準備していきましょう

ちなみにslackには現状2つのoauth認証フローがあって（非常にややこしい）

こちらが先代： https://api.slack.com/legacy/oauth
こちらが現役: https://api.slack.com/authentication/oauth-v2

間違ったドキュメントを読み解かないよう気をつけましょう！

  • slackApp作成後、管理画面で「配信を管理する」を押すと、埋め込み可能なボタンが取得できます

image.png

  • このボタンをLPなどに設置しましょう

image.png

  • このボタンをクリックしたユーザはslackのoauth認証画面に遷移し、そちらで認証後、こちらが指定したリダイレクト先に帰ってきます。その際urlのクエリにcode, stateが付与されているので、これを取得します。

    • nuxtはSSGの場合asyncDataなどでqueryにアクセスできないため、mounted等でアクセスせざるを得ないようです。（時間を惜しんで、ちゃんと調べていないけど）

  • code, state を自分が用意したAPIエンドポイントに渡します

  • API側でhttps://slack.com/api/oauth.v2.accessに対して、先ほど取得したcode,clientId,clientSecretなどを含めて送信します。

    • この時、application/jsonとapplication/x-www-form-urlencodedどちらを指定するか次第で、若干必要な情報が変わってきますのでご注意ください

  • さっき俺はstateが必要だと言ったな？あれは嘘だ

    • と言うのは大げさですが、stateは不正防止のために自分が照合するだけなので、無視しても不具合は起きません。一応penpenは照合しています。

  • https://slack.com/api/oauth.v2.accessからのレスポンスにslackのteamIdやteamNameやaccessTokenが含まれているので、これらをDBに保存しましょう。accessTokenは今後boltのpostMessageを実行する時など、ユーザのslackワークスペース上でやり取りするのに使います

タスクをリマインドする

  • Cloud Scheduler -> Pub/Sub -> Cloud Functionsの流れで定期的にAPIを叩いて、タスクの送信（リマインド）を実行

  • SlackのblockKitでメッセージを組み立てる

    • 「終わった！」ボタンを押した時に「どのタスクを」「誰が終了したのか」把握するため、ボタンのvalueに各種idを詰めておきます
    • image.png

  • メッセージを送信

    • あとはboltのapp.client.chat.postMessage()で送信しましょう。前述のoauth認証で取得したアクセストークンを使用します

完了したタスクをslackメッセージから削除する

  • boltのclient.chat.updateを使います

  • ここは少し注意が必要かもしれません。過去のslackメッセージを削除する場合、以下の情報が必要です

    • channelId
    • timestamp
    • accessToken

  • タイムスタンプが無いと、updateはメッセージを特定できないようです。なんかmessageIdとか無いの？と思ったんですが、タイムスタンプを使うみたいですね。まぁ充分なのかな。

  • ボタンをクリックした時にはメッセージのblockKitが丸ごと送られてくるので、そこから自分が削除したいメッセージを探し出して、更新します

    • blockKitが複雑なメッセージだとTypeScriptでparseするのが大変そうですが、そこは適宜に筋肉(any)で誤魔化しました

自分に割り振られたタスクの一覧を取得する

  • /penpen-listのスラッシュコマンドをフックに、自分宛のタスクを一覧化して送信する機能がありますが、これはまぁ・・・/penpenとほぼ変わらないので割愛します

単体テスト

  • 個人開発なので誰もレビュワーがおらず、不具合が怖いので一応テストはカバレッジ6割ぐらい書いてます。
  • 何の役に立つかわかりませんが、参考までにjestでboltをモックアウトする所だけ書いておきます
import { App } from '@slack/bolt'
jest.mock('@slack/bolt', () => {
  return {
    App: jest.fn().mockImplementation(() => {
      return {
        client: {
          chat: {
            postMessage: jest.fn(),
            update: jest.fn()
          }
        }
      }
    })
  }
})

const app = new App() // あとはモック化されてるので煮るなり焼くなりご自由に
  • ちなみにjestの場合はnode_modulesと同じ階層に__mocks__/@slack/bolt.jsを作って、その中でモックを定義しておけば自動的にモックされるので、明示的にjest.mock()を呼ぶ必要もなく、毎度モックをテストファイル毎に定義し直す必要もなく、簡単です

以上

以上が大体のpenpenの構成です。

  • タスク漏れを防ぎたい
  • 周りを何度も催促して疲れている

そんな方は、ぜひ使ってみてください。

（そして、もし壊れていたら、そっと教えてください...）

https://penpen.netlify.app/

PrAha
PrAhaPublication

株式会社PrAhaでは、株式会社アガルートのサービス「アガルートアカデミー」の開発、自社サービス「PrAha Challenge」の運営、スタートアップに特化したデザインと受託開発を行なっています。一緒に働いてくれる方を血眼になって探しています。

Discussion