相談部屋のコメントをDiscordチャットに通知する

[garammasala29]

Issue

• [相談部屋] 相談部屋に受講生（その相談部屋の主）からコメントがあったら、チャットの運営のチャンネルに通知が来るようにしたい #4093

概要

相談部屋に受講生（その相談部屋の主）からコメントがあったら、Discordの運営のチャンネルに通知が来るようにしました。

• Discordの運営のチャンネルは管理者のユーザーが見れるプライベートチャンネルのようです。
• adminのユーザーがコメントした場合は通知されないようにしています。

運営チャンネルのウェブフックはDISCORD_ADMIN_WEBHOOK_URLに統一されているようなので、それに沿う形にしました。
通知内容に関しては、町田さんより本文とURLを含めてほしいとのコメントをいただきましたので、そのような仕様しました。

前提

Discordへの通知に関しては #3471 を参考にして書いています。
今回のIssueはDiscord通知において開発環境と本番環境で実装する内容が変わってくるため、変更分をそのままマージすることができません。
なのでレビューで動作確認をする際は下でまとめた確認方法の手順を行っていただく必要があります。

ローカルでの動作確認方法にお手間を取らせてしまいますが、ご確認のほどよろしくお願いします🙏

確認方法

1. ブランチ feature/notify-admin-chat-of-talkroom-commentをローカルに取り込む

2. dotenv-railsというgemをGemfileに追記(Gemfile82行目)し、インストール

# Gemfile
group :development do 
# not default
gem 'view_source_map'
+ gem 'dotenv-rails' # view_source_mapの下に追加して下さい

• 参考：Railsで使える環境変数を管理できるgem(dotenv-rails)や.envの導入方法 - Qiita

% bundle install

3. .envファイルをbootcampディレクトリ配下に作成する

% touch .env

4. 自分用のDiscordサーバーを作成する

• 参考：Discord – サーバーの作り方と削除する方法 | 設定Lab

5. 4で作成したサーバーのウェブフックURLを こちらの手順に従ってコピーしておく
   日本語版ではサーバー設定＞連携サービス＞ウェブフックを作成＞ウェブフックURLをコピー

6. コピーしたウェブフックURLを環境変数として使いたいので、作成した.envファイルには下の内容を追記する

DISCORD_ADMIN_WEBHOOK_URL = コピーしたウェブフックURL

7. app/model/chat_norifier.rbのmessageメソッドの記述を変更する

# app/model/chat_norifier.rb
class ChatNotifier
  def self.message(
    message,
    username: 'ピヨルド',
    webhook_url: ENV['DISCORD_NOTICE_WEBHOOK_URL']
  )

-   if Rails.env.production?
+   if Rails.env.development?
      Discord::Notifier.message(message, username: username, url: webhook_url)
    else
      Rails.logger.info 'Message to Discord.'
    end
  end
..

Rails.env.development?にすることでtrueの分岐を実行することができます。
参考：【Rails】 envメソッドで環境を確認する方法と各コマンドの指定方法 - Pikawaka

8. 動作確認をする
   (1) admin以外のユーザーでログイン(kimuraでログインしました)
   (2) 自身の相談部屋からコメントします。
   (3) 自分で作成したDiscordチャンネルに通知がきます。
   
   (4) adminのユーザーで同じ相談部屋にコメントすると通知は来ません(komagataで確認)

以上となっております。
お困りのことなどありましたら、何なりとお申し付けください🙏

[garammasala29]

テストが落ちてしまいますが、今回PRで追加したものは通過しており、下記問題に起因しているようです。
#4201

[garammasala29]

@maeda-seina さん
お疲れ様です。お手隙の際にこちらのレビューをお願いしたいです🙏
動作確認がやや複雑なため、不明な点がありましたらDiscord等で気兼ねなく連絡ください

[maeda-seina]

@garammasala29 さん
お疲れ様です！
レビュー遅れてすみません💦
動作確認について、問題ありませんでした！（adminでコメントした際にDiscordの方に通知が来ないことも確認できました！）

また、全体的に説明が細かく書かれていてとてもわかりやすかったです。（動作確認方法も丁寧に記載していただき、ありがとうございます😄）

[garammasala29]

@maeda-seina さん
お忙しい中、レビューいただきありがとうございました！
今後ともよろしくお願いします😊

[garammasala29]

@komagata
お疲れ様です。お手隙の際にこちらのレビューをお願いいたします🙏

[komagata]

@garammasala29 最新のmainを取り込んでテストが通るようにしてみてください〜

[garammasala29]

@komagata さん
お疲れ様です。テストが通ったことを確認できました。よろしくお願いします！

[komagata]

確認しました、OKですー🙆‍♂️