2017-01-12

Slack のボットで定時アクション

Slack に設置したボットを一定時間ごとに発言するようにしたいと思います.
定時アクションができるようになると、天気の情報を毎朝ポストしてもらうなど活用の幅が広がります.

作業環境

Slack
Node.js 6.9.1 LTS
Botkit 0.4.9
node-cron 1.2.1

Node.js に cron を追加

Linux などの OS で定期的な処理を行うには cron → crontab - Wikipedia が使われます. Node.js でも同様に cron と呼ばれるモジュールがいくつかあります.
今回は Kelektivさんの node-cron を使いたいと思います.

ボットのプロジェクト・ディレクトリで以下のコマンドを実行し node-cron モジュールをインストールします.

1 2	c:\Develop\repos\slack-bot> npm install cron --save `-- cron@1.2.1

メモ
node-cron という名前のモジュールは Kelektivさんと Merenciaさんの 2つがあるので注意が必要です.
今回はタイムゾーンが指定できることと、日付指定の実行ができることなどから Kelektivさんのを使わせていただきました.
特にタイムゾーンを意識する必要がない場合は、Merenciaさんのもシンプルな実装でよいかもしれません.

Botkit での定時処理

とりあえず、月曜日～金曜日の毎朝 9:00 に挨拶をするようにしたいと思います.

const Botkit = require('botkit');
const cron = require('cron');

const controller = Botkit.slackbot();

controller.spawn({
    token : process.env.token
}).startRTM((err, bot, payload) => {
    new cron.CronJob({
        cronTime: '00 00 09 * * 1-5',
        onTick: () => {
            bot.say({
                channel: 'random',
                text: ':smiley: おはようございます！'
            });
        },
        start: true,
        timeZone: 'Asia/Tokyo'
    });
});

ボット起動時に cron の処理を登録したいので、startRTM() の中で new cron.CronJob() します.
cronTime は Cron Ranges に従い、起動したい時間を指定します. 今回は「月曜日～金曜日の毎朝 9:00」なので、前半の 00 00 09 ~~~ で 9:00 を指定し、後半の ~~~ * * 1-5 で毎月毎日(* * ~~~) に加えて最後の 1-5 で月曜日～金曜日(0 は日曜日) を指定します.
onTick に cronTime で指定したタイミングで行う処理を記述します. 今回は Botkit に #random チャンネルへ挨拶を発言しさせます.
start は true にすることで、そのまま cron の処理を開始させます. 処理開始を明示的に行いたい場合は false にし、開始したい場所で start() を呼び出しますが、今回は即時に処理を開始してよいので true にしました.
timeZone で cronTime に指定するタイムゾーンを明示します. 最近はクラウド環境を使ったりするのでタイムゾーンは意識的に書いておいた方がトラブルに合いにくい気がします.

※ 今回は #random へ発言するので channel: 'random' としていますが、ID で指定したほうがよいので https://slack.com/api/channels.list?token=[API_TOKEN] へアクセスして、ID を調べます. また、発言先のチャンネルへボットが参加している必要があります.