kmc-jp / reikai-kouza

例会講座の自動割当システム

例会講座

⚡ 概要

議題/2021/例会・例会講座の見直し

📅 スラッシュコマンド

/reikai-kouza-check

例会講座の担当日を確認する。

/reikai-kouza-cancel

例会講座の担当をキャンセルする。手続きは送られてきた内容に従ってください。

🔨 ビルド

docker を用いる場合

以下の通りに実行すれば、./dist 以下に生成されます。(yarn build:production を実行した場合と同様に生成されます。)

$ ./prepare.sh
$ ./production-build.sh

docker を使用しない場合

yarn が必要です。Dockerを使用した場合と同様に、./dist 以下に生成されます。

$ cd reikai-kouza
$ yarn install
$ yarn prepare
$ yarn build              # または、yarn build:production

🎨 フォーマット

$ # ビルドの手順は済んでいるものとします
$ yarn fix

🐎 実行

事前に secret/keys.json を設定する。 secret/keys.example.json に設定例がある。

additionalAssignTask.js

追加の割り当てを行う。

実行例

$ node additionalAssignTask.js $(date +"%Y%m%d")

assignTask.js

割り当てを行う。

実行例

$ node assignTask.js $(date +"%Y%m%d")

background.js

サーバー側の処理

実行例

$ node background.js

publicAnnounce.js

担当者を全体に告知する。

実行例

$ node publicAnnounce.js $(date +"%Y%m%d")

registerExistingMembers.js

部員の情報を登録する。(稼働開始時のみ)

実行例

$ node registerExistingMembers.js $(date +"%Y%m%d")

send2AllMembers.js

部員全員にメッセージを送信する。

実行例

$ node send2AllMembers.js

updateMembers.js

新規部員の登録と凍結された部員の処理を行う。

実行例

$ node updateMembers.js $(date +"%Y%m%d")

updateStatus.js

割り当てが1周したらリセットする。

実行例

$ node updateStatus.js $(date +"%Y%m%d")

⏳ 運用

稼働時に一度だけ実行

• registerExistingMembers.js
• send2AllMembers.js

1日1回実行

• additionalAssignTask.js
• updateStatus.js
• assignTask.js
• publicAnnounce.js
• updateMembers.js

※ assignTask.js は、2回実行される

以下のようなシェルスクリプトを用意し、定期実行する。

#!/bin/bash

cd $(dirname $0)

/usr/local/bin/node ./additionalAssignTask.js $1
sleep 1m
/usr/local/bin/node ./updateStatus.js $1
sleep 1m
/usr/local/bin/node ./assignTask.js $1
sleep 1m
/usr/local/bin/node ./assignTask.js $1
sleep 1m
/usr/local/bin/node ./publicAnnounce.js $1
sleep 1m
/usr/local/bin/node ./updateMembers.js $1

🚦 テスト

DBに手動追加した上で運用させる

以下のファイルを1回ずつ順に引数を変えながら実行

• additionalAssignTask.js
• updateStatus.js
• assignTask.js
• publicAnnounce.js

※ assignTask.js は、2回実行される

以下のようなシェルスクリプトを用意し、定期実行する。 稼働テストの詳細は、稼働テストのログにある。

#!/bin/bash

cd $(dirname $0)

/usr/local/bin/node ./additionalAssignTask.js $1
sleep 1m
/usr/local/bin/node ./updateStatus.js $1
sleep 1m
/usr/local/bin/node ./assignTask.js $1
sleep 1m
/usr/local/bin/node ./assignTask.js $1
sleep 1m
/usr/local/bin/node ./publicAnnounce.js $1

reikai-kouza's Issues

blocksを使用したログ出力の表示が崩れる

起こっている問題

blocksを使用して#reikai-kouza-ownerおよび#reikai-kouza-logに出力されたログの表示が崩れる。

スクリーンショット

Slack APIのモックを書く

概要

使っている全てのAPIのモックを書く

lint-stagedも入れる

概要

久しぶりに入れてみる

担当日を後から延期する

概要

直前に延期する機能が欲しい

テスト環境を環境変数で分離

概要

#128 あたりの実装、あんまり良くなかったので。

テストの追加

概要

(できるところには) テストを入れる

• #87
• #88

自動デプロイ

概要

リリースを検知して自動でデプロイします

Ownerチャンネルに流すログを減らす

概要

Ownerチャンネルにログが流れすぎていて分かりづらい、かつログチャンネルと見分けがつかない。

変更点

ログとしての意味しか持っていないものはログチャンネルにのみ流すようにする。

システムの稼働時、入部したての部員も対象となってしまう

起こっている問題

システムの稼働時には、入部から3ヶ月以上経過していない部員も割り当ての対象となる。

補足等

影響範囲が限定的かつ自由に断れるので、大きな問題にはならないと思われる。

例会の開催がない日にも割り当てが行われる

起こっている問題

例会の開催がない日にも割り当てが行われる。

期待される挙動

例会の開催がない日には割り当てが行われない。

部員情報の登録時エラー

起こっている問題

登録時にエラーが出る

スクリーンショット

期待される挙動

エラーが出ず登録が完了する

補足等

INSERT の処理で、message_ts が不足している

Express Routerを使う

概要

サーバーの実装が汚すぎるのでリファクタ

バッジを足す

あった方が見栄えが良い気がする

講座管理の二分化を解消する

起こっている問題

内部WikiとこのBotの2箇所で例会講座が管理されていて、講座を担当したいときにどこをどうするべきか分からない

[調査中] ビルドが通らない

起こっている問題

ビルドが通らない

テストのワークフローが落ちる

起こっている問題

https://github.com/kmc-jp/reikai-kouza/runs/5864246053?check_suite_focus=true

secret/keys.json がないのでテストに失敗する。

期待される挙動

テストが通る

例会講座の担当者数上限を1人にする

概要

例会講座の担当者数上限を、現在の2人/日から1人/日に変更する。併せて、確定までの有効時間を72時間から48時間に変更する。

経緯

当初はちょっと長いLT (長くても10分〜15分程度) を想定していたが、嬉しいことに長い講座が多いようなので、運営への負担も考慮した上で上限人数を引き下げる。ただし、講座に空きが増えることを抑止する目的で、有効時間を調整することとした。

console出力を自動削除

概要

消したと思ったら残っていたので自動化する

通知のテキストが表示されるようにする

概要

送られてきたメッセージはほぼ全て This content can't be displayed と通知されるが、text フィールドを埋めることで解決したい。

例会の時間を変更

起こっている問題

例会の時間が19:00からとなっている

期待される挙動

21:00から

補足

ついでに、#reikai-kouza に誘導しておく

死活監視を入れる

概要

気付かぬ間に落ちているという事態に対処する

関連

#225

テスト: src/modules/date.ts

概要

src/modules/date.ts に対するコードテスト

各所のリファクタリング

概要

各所のリファクタリング

• src/slash/check - prettierのものと名前が被っており、かつ抽象的で分かりにくい
• src/slash/cancel - 上記のものにあわせる
• src/modules/slack - 似たようなものが多い上に、名前が分かりにくい

テスト: src/modules/verify.ts

概要

src/modules/verify.ts に対するコードテスト

DMのログが冗長過ぎる

#61 の直接的な原因となったのは、DMのログが著しく冗長であったことであり、そもそも冗長なログは解析の際に邪魔になる。

読みやすさと情報量の両立したログを流したい。

関連: #61

ログの充実

• 周回更新時もログを流す

tsconfig/basesを入れる

概要

https://zenn.dev/yuta_ura/articles/introduce-tsconfig-bases

• @typescript-eslint/consistent-type-imports も入れる

2人以上が同日に被らない範囲で延期できるように

Slackへの投稿ができていない

起こっている問題

#62 における変更により、chat.postMessageが動作しなくなった。(チャンネルにメッセージが投稿されなくなった)

期待される挙動

チャンネルに正しくメッセージが投稿される。

補足等

関連: #62

botが連絡を72時間待ってくれない

起こっている問題

reikai-kouza botとのやりとりで、例会の担当選択のDMを着信してから72時間経過する前に「72時間以内に返信がなかったため、自動的にスキップします。」というメッセージに更新される。

スクリーンショット

期待される挙動

12/17の15時台に通知が来たので、12/20の15時に更新が行われる。

問題の再現手段

前回のメッセージが12/15に来ていて今日が12/18なので、直近の記録が残っているのではないかと思いました。

補足等

reikai-kouza/src/additionalAssignTask.ts

Line 50 in 7de3f3a

case projectConstants.values.announcementStatus.NoReply:

の処理で該当の未返信の記録をDBから削除するか完了済のフラグを立てる必要があったりしそうな気がします。

担当者の告知が #reikai-kouza に流れていない

起こっている問題

担当者の告知が、owner チャンネルと log チャンネルにのみ流れている。

期待される挙動

メンバーチャンネルにも告知が流れる。

補足等

直近の変更により新たに発生したものであると思われる。

Dockerを使ったテスト

概要

Dockerで適当なサーバーを立てれば良い。
#221 でDocker周りが修正されるので、それと同時にやるのが良さそう。

tsconfig.json により厳格なコンパイルオプションを入れる

概要

厳格な方がいいので

• noImplicitReturns
• noUnusedLocals
• noUnusedParameters
• noFallthroughCasesInSwitch
• noUncheckedIndexedAccess

あたりですかね

#204 で対応しました

告知を日付でソート

k8sにのせる

概要

コンテナにする

関連

• #221
• #222

App Home の整備

全てのDMを取得できていない

起こっている問題

DMのIDを取得する際、next_cursor を正しく処理できていない。
現状では人数が少ないため問題なく動作しているが、人数が増えると間違いなく動作しなくなる。

期待される挙動

全てのDMを取得できる

告知場所を #reikai-kouza から #active に変更

なぜ

チャンネルの9割がログで埋め尽くされているので告知場所として機能していない

スラッシュコマンドが動かない

起こっている問題

スラッシュコマンドが実行できない

/reikai-kouza-check を実行した例

/reikai-kouza-check failed with the error "dispatch_failed"

と表示される。

スクリーンショット

期待される挙動

エラーなく実行できる

問題の再現手段

いずれかのチャンネルで、有効なスラッシュコマンド (/reikai-kouza-check または /reikai-kouza-cancel) を送信する。

動作環境

アプリ版 (Linux) およびウェブブラウザで確認

補足等

スラッシュコマンド以外でもエラーが出る可能性あり

リポジトリのpublic化

概要

アピってこ

v2アップデート (v2アップデート関連のPRはv2ブランチへ！)

API / DB

• [API] 型定義
• [API] 認証部分
• [API] 実装部分
• [DB] 型定義

v2アップデートで解消される既存のIssue

• #54
• #55
• #60
• #68
• #236

その他

• #237

Docker でどっかーんをする

概要

タイトルの通りです。

VSCode devcontainerを使えるようにする

概要

ついでにいい感じのDockerfile (or docker-compose.yml) を書く
現状のDocker build、かなり最悪な感じなので

Denoに移行

概要

全部終わればやる

429 Too Many Requests でエラー落ちする場合がある

起こっている問題

https://kmc-jp.slack.com/archives/C021LGME8F7/p1639551729157200?thread_ts=1639551729.157200&cid=C021LGME8F7

登録フォームが送られる → 何らかの理由で大量のリクエストが送信される → 当然 Too Many Requests でエラー落ちする → 実行が停止されているので、その後のDBの更新処理が行われない → DBが更新されていないので、1つ前の登録日で登録される

期待される挙動

よく分からない理由でエラー落ちしないで (切実)

問題の再現手段

不明

補足等

担当者の告知は月木のみ

講座時間の目安を記載

概要

割り当て時のメッセージに記載する

公開リポジトリへの変更

別に隠すようなものでもないので...

#67 の再発

起こっている問題

#67 が再発し、 :broom: 割り当て状態をリセットします。 と表示されている。

スクリーンショット

期待される挙動

:broom: 割り当て状態のリセットをチェックします。 と流れる。

割り当て状態のリセットに関するログメッセージを変更

起こっている問題

割り当て状態がリセットされない場合にも 割り当て状態をリセットします。 というログが流れて、分かりづらい。

期待される挙動

割り当て状態が実際にリセットされる時のみ 割り当て状態をリセットします。 と流れ、その他の場合は 割り当て状態のリセットをチェックします。 等と流れると良さそう。