ユーザーが休会した時にメンターと管理者にサイト内通知とメール通知が行くようにした

[keiz1213]

issue

• [休会] ユーザーが休会したら、管理者、メンターに通知が欲しい #5377

概要

ユーザーが休会した時に管理者、メンターにサイト内通知とメール通知が行われるようにしました。

備考

• 完全な休会機能はまだmainブランチにmergeされていません。なので当ブランチは休会からの復帰機能を追加 #5369 から作成したものであり、PRはそこへのPRとなります。
• Discordへの通知は既に実装済みとのことなので、今回追加した通知はサイト内通知とメール通知になります。
  • ※(注)「実装済み」とのことですが今回の変更に伴い、DiscordNotifierの呼び出し方法を変更しました。またテストも無かったのでテストを追加しました。

DiscordNotifierの呼び出し方法について

実装済みのDiscord通知では同じ通知が複数回通知されてしまうため、DiscordNotifierの呼び出しをNotificationFacadeから独立させました。

# hibernation_controller

  def notify_to_mentors_and_admins
    User.admins_and_mentors.each do |admin_or_mentor|
     # 管理者とメンターの数だけ呼びだされる
      NotificationFacade.hibernated(current_user, admin_or_mentor)
    end
  end

# 変更前のNotificationFacade

  def self.hibernated(sender, receiver)
    ActivityNotifier.with(sender: sender, receiver: receiver).hibernated.notify_now
    # このDiscordNotifierを独立させた
    DiscordNotifier.with(sender: sender, receiver: receiver).hibernated.notify_now
    return unless receiver.mail_notification?

    NotificationMailer.with(
      sender: sender,
      receiver: receiver
    ).hibernated.deliver_later(wait: 5)
  end

Discordへの通知を確認するための準備

Discordへの通知を確認するために自身のDiscordアカウントで

• 確認用のサーバーの作成
• チャンネルのwebhook_urlの取得

をお願いいたします。

確認用のサーバーの作成とwebhookURLの取得方法

1. サーバーの新規作成
   
2. オリジナルの作成
   
3. 自分と友達のためを選択
   
4. 適当な名前を入力
   
5. 編集をクリック
   
6. 連携サービスをクリック
   
7. webフックを作成
   
8. webフックをコピー
   

取得したwebhookURLをローカルのマシンの環境変数に設定をお願いします。

# 自分は.zshrcに設定しました
export DISCORD_ADMIN_WEBHOOK_URL='作成したサーバー内チャンネルのwebhook_url'

$ source .zshrc

変更確認方法

1. feature/notification-of-hibernationをローカルに取り込む。
2. rails sでサーバーを立ち上げる
3. komagata、machida、 mentormentaro、 adminonly、 unadmentor、でログインする
4. ヘッダーの通知をクリックし、休会通知が来ていないことを確認する。(mentormentaroの場合、hatsunoが休会しました。という通知がありますが無視してください)
5. kimuraでログインし、ヘッダーのユーザーメニューから休会手続きを行う。
6. 2のユーザーで再度ログインし、ヘッダーの通知をクリックし、kimuraの休会通知が来ていることを確認する。
7. http://localhost:3000/letter_opener にアクセスし2のユーザーにメールが送信されていることを確認する。
8. discordにkimuraの休会通知が来ているか確認する。

[keiz1213]

今回のissueとは関係がありませんが、テストを通すため修正しました

[keiz1213]

@yuma-matsui
お疲れさまです！以前レビューさせていただいた時のissueと似ているissueだったのでレビュー依頼させていただきました。DiscordNotifierが複数回呼び出される問題について僕の方では独立させて実装することにしました💡
全然急いでないので、お時間があるときにでもよろしくお願いいたします🙏

[yuma-matsui]

@keiz1213
レビュー依頼ありがとうございます！！
本日中に確認させていただきます〜

[yuma-matsui]

ダイアログの確認についてはCapybaraのaccept_confirmメソッドを使った方が良さそうです。

Capybaraで確認ダイアログを操作する場合は page.accept_confirm を使う

accept_confirm do
 click_button '休会する'
end

[keiz1213]

確かにこちらのほうがスッキリ書けてわかりやすいです！スッキリ書けるだけではなく他にも色々メリットがあるのですね💡勉強になります。こちら修正しました。

[yuma-matsui]

text: ' kimuraさんが休会しました。'
こちら余計なspaceが含まれてしまっているかもです。

[keiz1213]

全然気づきませんでした😅こちら修正しました。

[yuma-matsui]

同上です。

[yuma-matsui]

同上です。

[yuma-matsui]

同上です。

[yuma-matsui]

同上です。

[yuma-matsui]

@keiz1213
お疲れ様です。
いくつかコメントしました！

ご確認をお願いします。

[keiz1213]

@yuma-matsui
確認ありがとうございます！指摘頂いた点を修正しました。ご確認お願いいたします🙏

[yuma-matsui]

修正ありがとうございます！！
LGTMです🙆‍♂️

[keiz1213]

@komagata
こちらメンバーの方からapproveいただきましたので確認お願いいたします🙏

[komagata]

確認させて頂きました。OKです〜🙆‍♂️