Line Bot

どうも、ナナオです。 結構長いこと書いていますが、今回で完成かな…？（前回も同じこと言ったような気がするけど いや、完成させます！ 期日設定によって送られるメッセージ頻度を変化させる 最初の記事で想定していたように、このBotは全員が回答するまでメッセージを送り続けるようにしたいです。 その頻度は以下のように期日からの経過時間によって変わります。 期日まで 未回答者に1日に一回催促のDMが送られる 期日経過～1日 未回答者に1時間に一回催促のDMが送られる 期日経過1日～2日 未回答者に30分に一回催促のDMが送られる 期日経過3日～ 未回答者に15分に一回催促のDMが送られる これを実装していきます。 pub struct MultipleService { router: Router, scheduler: JobScheduler, } impl MultipleService { pub async fn new(pool: PgPool) -> Result<MultipleService, shuttle_runtime::Error> { let state = AxumState { pool: pool.clone() }; let router = Router::new() .route("/webhook", post(webhook)) .route("/healthcheck", get(healthcheck)) .with_state(state); let scheduler = JobScheduler::new().await.unwrap(); // 時間ごとにバッチを追加 // 1日に一回 let pool_clone = pool.clone(); let daily_job = Job::new_async("0 0 0 * * *", move |_, _| { let inner_pool = pool_clone.clone(); Self::send_message_with_deadline(inner_pool, DailyCondition) }).expect("ジョブの作成に失敗しました"); // 1時間に一回 let pool_clone = pool.clone(); let hourly_job = Job::new_async("0 0 * * * *", move |_, _| { let inner_pool = pool_clone.clone(); Self::send_message_with_deadline(inner_pool, HourlyCondition) }).expect("ジョブの作成に失敗しました"); // 30分に一回 let pool_clone = pool.clone(); let every_thirty_minutes_job = Job::new_async("0 */30 * * * *", move |_, _| { let inner_pool = pool_clone.clone(); Self::send_message_with_deadline(inner_pool, EveryThirtyMinutesCondition) }).expect("ジョブの作成に失敗しました"); // 15分に一回 let pool_clone = pool.clone(); let every_fifteen_minutes_job = Job::new_async("0 */15 * * * *", move |_, _| { let inner_pool = pool_clone.clone(); Self::send_message_with_deadline(inner_pool, EveryFifteenMinutesCondition) }).expect("ジョブの作成に失敗しました"); scheduler.add(daily_job).await.expect("スケジューラへジョブを追加するのに失敗しました。"); scheduler.add(hourly_job).await.expect("スケジューラへジョブを追加するのに失敗しました。"); scheduler.add(every_thirty_minutes_job).await.expect("スケジューラへジョブを追加するのに失敗しました。"); scheduler.add(every_fifteen_minutes_job).await.expect("スケジューラへジョブを追加するのに失敗しました。"); Ok(Self { router, scheduler, }) } // バッチ内の処理はほぼ同じことをやっているので共通関数として定義 fn send_message_with_deadline(pool: PgPool, cond: impl JobCondition + Send + 'static) -> Pin<Box<(dyn Future<Output = ()> + Send)>> { let inner_pool = pool.clone(); let http_client = HttpClient::new(); Box::pin(async move { let line_group_repository = LineGroupRepository::new(inner_pool); let all_line_group = line_group_repository.get_all() .await .expect("全てのline_group取得に失敗しました"); for line_group in all_line_group.iter() { if let Some(chousei_id) = line_group.chousei_id.clone() { let group_count = http_client.count_group_members(line_group.id.clone()) .await .expect(format!("line_groupの人数取得に失敗しました。id: {}", line_group.id).as_str()) .try_into() .expect("グループカウントをusizeに変換できませんでした"); let res = http_client.get_chousei_csv(chousei_id) .await .expect("調整さんのCSV取得に失敗しました"); // グループ内の人数より調整さんの回答者数が少ない場合はメッセージをプッシュします if res.member_info_map.len() < group_count { if let Some(deadline_date) = line_group.deadline_date { if cond.check(deadline_date) { // 実行時間ごとに条件が異なるため、JobConditionトレイトを使用して条件を入れ替え可能にしています。 let message = "調整さんに回答してください！".to_string(); http_client.push_message(line_group.id.clone(), vec![message]) .await .expect("lineのメッセージ送信に失敗しました"); } } } } } }) } } 少しだけテクいのは、send_message_with_deadline関数でJobConditionトレイトを使用しているあたりです。 ...

会社で発表したら緊張しすぎて手汗がすごい、ナナオです。 今回でおそらく完成させたい、LineBotのヤバいさんを早速実装していきます。 line_groupテーブルに調整さんのIDを設定できるようにする まずはマイグレーションを追加します。 sqlx-cliを使用しましょう。 sqlx migrate add add_column_chousei_id 作成されたマイグレーションファイルを実装します。 PostgreSQL: Documentation: 17: ALTER TABLE 調整さんのIDは小文字の英数字32桁からなる文字列なので、そのように定義します。 -- 調整さんのイベントIDを設定できる列を追加 ALTER TABLE "line_group" ADD COLUMN "chousei_id" varchar(32); この定義だと1グループにつき一つのイベントまでしか設定できませんが、そんなに立て続けに同じグループでイベントの出欠を取ることはないと信じています。 一旦この状態でshuttleを起動して、マイグレーションが問題なく適用されるか確認します。 cargo shuttle run DBを確認してみます。 postgres=# select * from line_group; id | deadline_date | chousei_id -----------------------------------+---------------+------------ C480b2f8b56ecaf62c2033867e2ff78b2 | 2023-11-12 | (1 行) 既存データにchousei_idが追加されています！ 続けて、LineGroupのモデルにchousei_idプロパティを追加してあげましょう。 #[derive(Debug, FromRow, Serialize, Deserialize)] pub struct LineGroup { pub id: String, pub deadline_date: NaiveDate, pub chousei_id: Option<String>, } 期日設定を行うCommandの実装にLineGroupの初期化処理があるので、ここにchousei_idの初期化も追加しておきます。 impl BotSetDeadlineCommand { async fn new( pool: Arc<PgPool>, group_id: &str, deadline_date: &str, ) -> Self { let repository = LineGroupRepository::new(&pool); let id = group_id.to_string(); let line_group_option = repository.select(id.clone()) .await .expect("期日設定中のline_groupの取得に失敗しました"); let deadline_date = NaiveDate::parse_from_str(deadline_date, "%Y-%m-%d") .expect("日付型への変換に失敗しました"); let line_group = match line_group_option { Some(mut line_group) => { line_group.id = id; line_group.deadline_date = deadline_date; line_group }, _ => LineGroup { id, deadline_date, chousei_id: None, } }; Self { pool, line_group } } } 期日設定によってchousei_idがリセットされないように、line_groupの初期化処理の前に既存のline_groupを取得するようにしました。 ...

どうも、ナナオです。 今回はCSVをパースして、未回答の人が誰かを取得する処理を実装していきます。 CSVパース処理の仕様 とりあえず、調整さん側の動きについて確認するためにイベントを作ってみます。 調整さん - 簡単スケジュール調整、出欠管理ツール 作ったイベントはこんな感じです。 作成したイベントに関連するURLは以下のようになっています。 イベントページのURL https://chouseisan.com/s?h={イベントID} CSVダウンロードのURL https://chouseisan.com/schedule/List/createCsv?h={イベントID}&charset=utf-8&row=choice イベントを作成してすぐにCSVを取得すると、以下のようなフォーマットになっています。 テストイベント 日程 11/15(水) 19:00〜 11/16(木) 19:00〜 11/17(金) 19:00〜 コメント これに回答すると以下のようになります。 テストイベント 日程,nanao 11/15(水) 19:00〜,◯ 11/16(木) 19:00〜,△ 11/17(金) 19:00〜,× コメント,test 回答者が増えると以下のようになります。 テストイベント 日程,nanao,test_1,test_2 11/15(水) 19:00〜,◯,×,△ 11/16(木) 19:00〜,△,△,△ 11/17(金) 19:00〜,×,◯,△ コメント,test,test_1,test_2 名前からLineのアカウント名を推測するという方法もあるんですが、ここはシンプルに回答者の数とグループ内の人数が合わない場合に通知するという感じにしましょう。 （ここまでやってて思ったんですが、調整さんだとちょっとカスタマイズ性にかけてしまいますね。。今後の改修ポイントかも） パース処理を実装 CSVをパースするためにまずはcsvモジュールを依存関係に追加します。 csv = "1.3.0" bytes = "1.5.0" # reqwestからのレスポンスボディをバイトで取得するため 前回、line_clientモジュールという名前で実装しましたが、調整さんへのリクエストも処理させたいのでhttp_clientという名前に変更して調整さんへのリクエスト処理を実装します。 // src/http_client.rs // ...中略... // 調整さんのCSV取得エンドポイントのレスポンスを表す構造体 pub struct GetChouseiCsv { title: String, csv_text: String, } // LineClient -> HttpClientに変更 pub struct HttpClient { client: Client, } impl HttpClient { // ...中略... // 調整CSVを取得する pub async fn get_chousei_csv(&self, event_id: String) -> Result<GetChouseiCsv, reqwest::Error> { let url = format!("https://chouseisan.com/schedule/List/createCsv?h={}&charset=utf-8&row=choice", event_id); let res_body = self.client.get(url).send().await?.text().await?; let lines: Vec<&str> = res_body.lines().collect(); let title = lines[0]; let csv_text = lines[2..].join("\n"); Ok(GetChouseiCsv{ title: title.to_string(), csv_text }) } } 実装できました。 ...

もう４回目の記事になるんですね。ナナオです。 今回は設定された期日まで15分おきにメッセージを送れるようにしてみたいと思います。 実装をモジュール化 今までの実装でメインモジュールがだいぶごちゃごちゃしてきたので分離してあげます。 LineGroupの構造体はmodel.rsを作ってそちらに移動します。 use sqlx::FromRow; use chrono::NaiveDate; use serde::{Serialize, Deserialize}; #[derive(FromRow, Serialize, Deserialize)] pub struct LineGroup { pub id: String, pub deadline_date: NaiveDate, } DBのline_groupに対する処理はrepository.rsを作ってそちらに移動します。 use crate::model::LineGroup; use sqlx::PgPool; pub struct LineGroupRepository<'a> { pool: &'a PgPool } impl<'a> LineGroupRepository<'a> { pub fn new(pool: &'a PgPool) -> Self { Self { pool } } pub async fn select(&self, id: String) -> Result<Option<LineGroup>, sqlx::Error> { let line_group = sqlx::query_as(r"SELECT * FROM line_group WHERE id = $1;") .bind(id) .fetch_optional(self.pool) .await?; Ok(line_group) } pub async fn update(&self, data: &LineGroup) -> Result<(), sqlx::Error> { sqlx::query(r"UPDATE line_group SET deadline_date = $2 WHERE id = $1;") .bind(&data.id) .bind(&data.deadline_date) .execute(self.pool) .await?; Ok(()) } pub async fn insert(&self, data: &LineGroup) -> Result<(), sqlx::Error> { sqlx::query(r"INSERT INTO line_group (id, deadline_date) VALUES ($1, $2);") .bind(&data.id) .bind(&data.deadline_date) .execute(self.pool) .await?; Ok(()) } } 署名認証処理はutils.rsを作ってそちらに移動します。 ...

意外とRustってとっつきやすいなと考えを改めました。ナナオです。 今回はメッセージから期日設定などを行えるように実装を修正していきます。 ヤバいさんのコマンドを呼び出す では具体的にどうやって期日設定を行うかといえば、「グループチャット内」で「矢倍くん宛」にメッセージを送ったときに行うようにしましょう。 また、期日設定以外にも調整さんのURLを設定できる必要があります。あとヘルプコマンドもあると便利ですね。 ということで、コマンドを３つ用意します。 調整さんのURL設定 「ヤバいさん https://chouseisan.com/s?h=[調整さんのイベントID]」と送られた場合に実行される 候補日に対してどのくらい回答しているか確認するため 期日設定 「ヤバいさん 2023-01-01」と送られた場合に実行される ヘルプ 「ヤバいさん」とだけ送られる、もしくは対応していないコマンドを送られた場合に実行される 使い方、コマンドの一覧を教えてくれる コマンドといえばコマンドパターンですね。 こんな感じのtraitを実装します。 trait BotCommand { fn execute(&self, value: Value); } これを使って、３つのコマンドを実装します。 struct BotSetDeadlineCommand { pool: PgPool, line_group: LineGroup, }; impl BotSetDeadlineCommand { /// コマンドのコンストラクタ /// DBの更新に必要な値を渡します fn new( pool: PgPool, group_id: &str, deadline_date: &str, ) -> Self { let line_group = LineGroup { id: group_id.to_string(), deadline_date: NaiveDate::parse_from_str(deadline_date, "%Y-%m-%d") .expect("日付型への変換に失敗しました") }; Self { pool, line_group } } } impl BotCommand for BotSetDeadlineCommand { fn execute(&self, value: Value) {} } // それ以外のコマンドも一応用意しておく struct BotSetUrlCommand; impl BotCommand for BotSetUrlCommand { fn execute(&self, value: Value) {} } struct BotHelpCommand; impl BotCommand for BotHelpCommand { fn execute(&self, value: Value) {} } まずは期日設定を行えるようにしましょう。 ...

開発楽しい、ナナオです。 前回まででMessaging APIのwebhookとの疎通確認ができました。 今回はもう少し踏み込んで期日設定を行えるようにしていきます。 ShutleにPostgresを導入する まず、設定された期日を保存しておくためのDBを用意します。 これにはShuttleが提供しているPostgresを使用します。 Shuttle Shared Databases - Shuttle また、基本的にDBクライアントとしてはSqlXを使用することが推奨されているようなので、依存関係を追加しておきます。 [dependencies] axum = "0.6.20" serde_json = "1.0.108" shuttle-axum = "0.31.0" shuttle-runtime = "0.31.0" shuttle-shared-db = { version = "0.31.0", features = ["postgres"] } sqlx = { version = "0.7.2", features = ["runtime-tokio-native-tls", "postgres"] } また、SqlX CLIもインストールしておきます。 cargo install sqlx-cli SQLX CLIでルートパッケージからマイグレーションファイルを追加しておきます。 sqlx migrate add init これでmigrationsというディレクトリがルートパッケージに作成されるはずです。 続けてマイグレーションファイルにグループテーブルを作成するSQLを実装します。 とりあえずグループIDと期日があれば十分でしょう。 -- Add migration script here CREATE TABLE line_group ( id varchar(33) primary key, deadline_date date ); ちなみにグループIDは33桁の文字列で、C[0-9a-f]{32}という正規表現で表されます。 LINEプラットフォーム用語集 - グループID 以下のdocker-composeファイルから、ローカルにDBを起動しておきます。 ...

早いものでもう11月ですね。ナナオです。 年末に近づいて忘年会シーズンとなってきました。 ただ忘年会の幹事をするとなると全員の日程調整がめんどくさいじゃないですか。 なかなか日程が合わないということもありますが、日程に関する回答をしてくれない人がいると何も決まりませんよね。 ということで今回は、調整さんで絶対に回答させるline botを作っていこうと思います。 仕様 絶対に回答させるのに効果的な方法ってなんだと思いますか？ 丁寧にお願いする？相手を信じて待つ？ いいえ違います、相手が回答するまで鬼電するのです。 結局これが一番効くんですよね。 ということで、line botの趣旨としては「鬼電」です。 たださすがに電話はできないので、メッセージをちょうどうざいくらいの間隔で送るようにします。 期日を過ぎてからの経過時間でどんどんメッセージ送信量が増えていくみたいな感じにします。 期日まで 未回答者に1日に一回催促のDMが送られる 期日経過～1日 未回答者に1時間に一回催促のDMが送られる 期日経過1日～2日 未回答者に30分に一回催促のDMが送られる 期日経過3日～ 未回答者に15分に一回催促のDMが送られる 設計 簡単にフローにしてみます。 LINEグループにbotを入れる 期日を設定する 期日を確認（全員回答するまで呼び出し続ける） 回答していない人を確認 回答していない人がいる場合、期日に応じた処理（DM送信）を行う なので、プログラムとしては「期日を設定する」ものと「期日を確認する」ものの二つが必要になります。 呼び出される場面がそれぞれ違います。 期日を設定する line botに対して期日を設定するメッセージが送られたとき 期日を確認する 定期的に呼び出す 15分に一回 回答していない人がいる場合、期日からの経過日数によって処理を分ける 期日設定に関してはMessaging APIのWebhookイベントを使用します。 今回はRustアプリを無料でデプロイ可能なクラウドプラットフォームShuttleを利用します！ Shuttle - Build Backends Fast Shuttleはよくわからなかったので、事前にちょっと触りつつ予習しておきました。 よければこちらの記事もぜひ。 Rustのshuttleを使ってみる【１】 Rustのshuttleを使ってみる【２】 Rustのshuttleを使ってみる【３】 調整さんから回答していない人の取得実装は、参考になるブログを見つけました。 調整さんリマインダLINE BOTを作ってみた - やらなイカ？ どうやら、調整さんのスケジュールIDが分かれば日にち候補をCSV形式でダウンロードができるようです。 （APIキーとか使わなくてもいいのはセキュリティ的にちょっと気になるけど） これを使って「参加者の誰が回答していないか」を取得し、未回答者がいる場合は適切な制裁を加えていきます。 実装のセットアップ まずはLine Messaging APIのチャネルを作成しましょう。 LINE Developers これがline botのベースになります。 ぼくの場合すでに以前プロバイダの作成をしていたので、チャネルの作成だけします。 とりあえず準備ができました。 ...