退会時に分報チャンネルを自動で削除する #6626

ogawa-tomo · 2023-06-10T00:38:38Z

Issue

[分報]退会したら自動で分報が削除されてほしい #6102

概要

退会時に分報チャンネルを自動で削除します。

変更確認方法

ブランチをfeature/delete-times-chennel-when-retireに切り替えておく。
下記の通り、準備としてテスト用Discordサーバーの作成、Discord Botの作成、環境変数の設定とサーバーの起動を行い、以下の3パターンの退会動線で動作確認をする。

ユーザーが自ら退会するとき
休会6ヵ月後に自動退会するとき
管理ページから退会させるとき

準備

テスト用Discordサーバーの作成

Discordのホーム画面左下の「ユーザー設定」から「詳細設定」へ遷移し、「開発者モード」をONにしておく

Discordのホーム画面で「＋」ボタンをクリックしてテスト用のDiscordサーバーを追加する

作成したサーバーのアイコンを右クリックし、コンテキストメニュー「サーバーIDをコピー」をクリックして控える

Discord サーバー名の右側にあるボタン「∨」をクリックし、作成メニューから「カテゴリーを作成」を選択し、適当な名前（「分報」など）でカテゴリーを作成する

カテゴリーを右クリックし、「チャンネルIDをコピー」をクリックしてカテゴリーIDを控える（画面表示は「カテゴリーIDをコピー」の誤りだと思われる）

Discord Botの作成

https://discord.com/developers/applications にアクセスして右上のボタン「New Application」からアプリケーションを登録し、ボットを使えるように設定する。

次の項目を入力・チェックしてアプリケーションを作成する
- NAME: Bootcamp
- By clicking Create, you agree to the Discord Developer Terms of Service and Developer Policy（利用規約や開発者ポリシーへの同意）: チェックを入れる
左のメニューからBotをクリックし、ボタン「Add Bot」からボットを追加する
Bot のトークン情報の更新と各種設定をします
- ボタン「Copy」をクリックし、トークンをコピーして控える
- Authorization Flow > PUBLIC BOT のトグルボタンを OFF にする
- Privileged Gateway Intents > SERVER MEMBERS INTENT のトグルボタンを ON にする
- ボタン「Save Changes」をクリックする

OAuth2 > URL Generator をクリックし、Discord サーバーへ参加させるためのリンクを発行する
- SCOPES
  - bot: チェックを入れる
- BOT PERMISSIONS
  - Manage Channels: チェックを入れる
  - Kick Members: チェックを入れる
- GENERATED URL
  - ボタン「Copy」をクリックし、コピーして控える

4でコピーしたリンクを開いて Bot を Discord サーバーへ参加させる

ボタン「認証」をクリックして画面の指示に従えばOK

Bot を参加させる Discord サーバーを選ぶ	チャンネルの管理とメンバーをキックにチェックが入っていることを確認する

環境変数の設定とサーバーの起動

前述の手順で発行された各キーを環境変数として設定する

DISCORD_GUILD_ID
- 前述のサーバーIDの値（Discord の開発者向けドキュメントでは guild をサーバーと呼んでいる）
DISCORD_TIMES_CHANNEL_CATEGORY_ID
- 前述のカテゴリーIDの値
DISCORD_BOT_TOKEN
- 前述の「Discord Bot のトークン情報を取得する」の3.で控えた値

開発環境での例として、次のコマンドをターミナルで実行する

export DISCORD_GUILD_ID=nnnnnnnnnnnnnnnnnnn
export DISCORD_TIMES_CHANNEL_CATEGORY_ID=mmmmmmmmmmmmmmmmmmm
export DISCORD_BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

そのままbin/rails sでサーバーを立ち上げる

ユーザーが自ら退会するときの動作確認

ログアウトした状態で参加登録ページから適当な名前で参加登録する
- クレジットカード番号にはテスト用の番号を入れる
  - https://stripe.com/docs/testing?locale=ja-JP#cards
テスト用のDiscordサーバーに分報チャンネルが作られていることを確認する
先ほど登録したユーザーでログインし、画面右上のユーザーメニューから「退会手続き」を選択して退会する
Discordから分報チャンネルが削除されていることを確認する

休会6ヵ月後に自動退会するときの動作確認

ログアウトした状態で参加登録ページから適当な名前で参加登録する
- クレジットカード番号にはテスト用の番号を入れる
  - https://stripe.com/docs/testing?locale=ja-JP#cards
テスト用のDiscordサーバーに分報チャンネルが作られていることを確認する
登録したユーザーでログイン
画面右上の休会手続きページから休会する
Railsコンソールで操作し、ユーザーの退会日を6ヵ月前にする

> user = User.find_by(login_name: 'jidoutaikaihunhousakujo')
> user.update!(hibernated_at: 6.months.ago)

komagataでログイン
管理ページの休会ユーザー一覧ページ（/admin/users?target=hibernatedに遷移し、そこに先ほど登録したユーザーとkyuukai（Kyu Kai)ユーザーがいるのを確認（kyuukaiユーザーがいなければ次のステップに進んでOK）
Railsコンソールを操作し、kyuukai（Kyu Kai)ユーザーを削除しておく
- ※このユーザーにはダミーのサブスクリプション番号が登録されており、このユーザーを退会させようとすると定期支払い削除処理でエラーになるため

> user = User.find_by(login_name: 'kyuukai')
> user.destroy!

ブラウザでhttp://localhost:3000/scheduler/daily/auto_retireにアクセス（画面は表示されないが、処理が走る）
管理ページをリロードし、先ほどのユーザーが休会ユーザー一覧に表示されておらず、退会ユーザー一覧に表示されることを確認
Discordから分報チャンネルが削除されていることを確認

管理ページから退会させるときの動作確認

ログアウトした状態で参加登録ページから適当な名前で参加登録する
- クレジットカード番号にはテスト用の番号を入れる
  - https://stripe.com/docs/testing?locale=ja-JP#cards
テスト用のDiscordサーバーに分報チャンネルが作られていることを確認する
komagata（管理者）でログインしなおす
右上のユーザーメニューから管理ページに遷移し、ユーザー一覧ページから先ほど作成したユーザーを探し、表右端の「操作」からユーザー登録情報変更画面に遷移する
ユーザーステータスを「退会済」に変更して「更新する」
Discordから分報チャンネルが削除されていることを確認する

次にやりたいこと

退会の導線は複数あるため、下記のイシューで処理を共通化したい

退会に付随して必要な処理とその共通化を検討したい #6519

関連PR

受講生（現役生または研修生）が入会したときに分報チャンネルを自動で作成する #6185

ogawa-tomo · 2023-06-10T02:50:14Z

app/models/unfinished_data_destroyer.rb

@@ -2,8 +2,6 @@

 class UnfinishedDataDestroyer
  def call(user)
-    return unless user.saved_change_to_retired_on?


今回、チャンネル削除処理をNewspaper経由で呼ぶことにしましたが、その際に一緒に呼ばれるのがこのクラスです。ユーザーの未確認提出物の削除・WIP日報の削除・就職活動フラグOFFの操作をしています。
この箇所では「ユーザーの退会フラグに変更があったか」を判断しそのときのみ処理を実行するようになっていますが、その判断は呼び出し側で行うべき（このクラスの責務ではない）と考え、処理を移しています。

この処理を呼んでいるのは以下の3箇所であり、いずれも退会処理を行うときに呼んでいます。（ユーザーが自ら退会するとき、管理画面から退会させるとき、休会六ヶ月で自動退会するとき）

bootcamp/app/controllers/retirement_controller.rb

Line 15 in 1bcded6

Newspaper.publish(:retirement_create, user)

bootcamp/app/controllers/admin/users_controller.rb

Line 25 in 1bcded6

Newspaper.publish(:retirement_create, @user) if @user.saved_change_to_retired_on?

bootcamp/app/controllers/scheduler/daily/auto_retire_controller.rb

Line 18 in 1bcded6

Newspaper.publish(:retirement_create, user)

ご説明ありがとうございます〜
そうですね、確かにUnfinishedDataDestroyerではなく呼び出し側でフラグOFFの操作を行った方が良いと思います。

ogawa-tomo · 2023-09-17T13:03:15Z

@fuwa-syugyo こちら、よろしければレビューお願いできますでしょうか？

fuwa-syugyo · 2023-09-18T01:32:43Z

@ogawa-tomo
お疲れ様です！
レビュー依頼ありがとうございます〜対応させていただきます！
水曜日を目処に対応させていただけたらと思います。
(遅かったら遠慮なくつついていただけると！)

fuwa-syugyo · 2023-09-18T06:41:54Z

@ogawa-tomo
お疲れ様です。
チェックのためDiscord botを作成したいのですが、Discord Botの作成の2にて「Add Bot」ボタンが見当たりません。

お手数ですが、どこにあるか教えていただけますでしょうか🙇‍♀️
(調べたところBuild-A-Bot の右あたりにボタンがある画像を発見したのですが、私の環境では表示されていません)

ogawa-tomo · 2023-09-18T10:37:14Z

@fuwa-syugyo 私の環境でももう一度試してみましたが無いですね…。ちょっと画面が変わったのかも…。「Build-A-Bot」と書いてあるので、おそらく正しい画面に遷移していそうな気がします。いったん無視してそのまま3以降の手順に進んでいただけますでしょうか？

fuwa-syugyo · 2023-09-18T13:09:17Z

@ogawa-tomo
Bot作れました！ご確認いただきありがとうございます。

一連の動作確認が終わりましたので、コードの方を見ていこうかと思います。
Discord周り触るの初めてでして申し訳ありませんが少し時間をいただくかもしれません🙇‍♀️

fuwa-syugyo · 2023-09-20T06:48:08Z

@ogawa-tomo
お疲れ様です。
すみませんが、所用などありましてレビューに着手できるのが週末あたりになりそうです。
もしお急ぎでしたら他の方にレビュー依頼をお願いできますでしょうか…？
申し訳ございません🙏

ogawa-tomo · 2023-09-20T09:48:59Z

@fuwa-syugyo ご連絡ありがとうございます。とくに急ぎではありませんので、ほかに問題なければ引き続きレビューお願いできますでしょうか？（来週末くらいまでにコメント返ってくるといいかな、くらいのイメージです）

fuwa-syugyo

@ogawa-tomo
遅くなり申し訳ございません。
確認させていただきました。
内容について問題ないと思いますが、念の為1点だけ確認させてください。

退会の動線は3パターンのみ、というのはどこかで確認できますでしょうか？
(気になっただけなのですが、たとえばお金の引き落としができなくなったケースでは管理者が手動で退会させるのでしょうか？3パターン以外思いつかないですが念の為、という感じです)
他に動線がなく3パターンのみということでしたらApproveさせていただきます〜
お手数ですがよろしくお願いいたします。

fuwa-syugyo · 2023-09-27T12:11:07Z

app/models/unfinished_data_destroyer.rb

@@ -2,8 +2,6 @@

 class UnfinishedDataDestroyer
  def call(user)
-    return unless user.saved_change_to_retired_on?


ご説明ありがとうございます〜
そうですね、確かにUnfinishedDataDestroyerではなく呼び出し側でフラグOFFの操作を行った方が良いと思います。

ogawa-tomo · 2023-09-30T00:10:30Z

@fuwa-syugyo

退会の動線は3パターンのみ、というのはどこかで確認できますでしょうか？

退会にまつわるIssueをたくさん担当したので自然とそういうものだと思いこんでいたのですが、コード上で確認するとすれば、Newspaperの:retirement_createコールバックが呼ばれている箇所を探すのが一番分かりやすいと思います。このコールバックは名前の通り、退会が行われるときに必ず呼び出されると推測することができます（中身としては、未確認提出物の削除などの処理と、今回の分報削除の処理を呼び出しています）。
grepで検索すると以下の3箇所で、今回挙げたパターンと一致します。

❯ git grep 'Newspaper.publish(:retirement_create'
app/controllers/admin/users_controller.rb:      Newspaper.publish(:retirement_create, @user) if @user.saved_change_to_retired_on?
app/controllers/retirement_controller.rb:      Newspaper.publish(:retirement_create, user)
app/controllers/scheduler/daily/auto_retire_controller.rb:      Newspaper.publish(:retirement_create, user)

たとえばお金の引き落としができなくなったケースでは管理者が手動で退会させるのでしょうか？

気になったのでざっと調べてみましたが、お金の引き落としができなくなったことを検知して何らかの処理を行うコードは見つかりませんでした。一応、カードが無効になったときは管理ページのユーザー一覧で表示されるみたいです。

bootcamp/app/views/admin/users/_table.html.slim

Lines 98 to 105 in 1bcded6

    
                     td.admin-table__item-value.is-text-align-center 
        
                       - if user.subscription_id? 
        
                         = link_to user.subscription_url, 
        
                           class: 'subscription-status', 
        
                           target: '_blank', 
        
                           rel: 'noopener', 
        
                           data: { 'subscription-id': user.subscription_id } do 
        
                           i.fa-solid.fa-spinner.fa-pulse

ログイン時にカードの情報を見るメソッドも用意されているようですが、現在はどこからも呼ばれていないようです。

bootcamp/app/controllers/concerns/authentication.rb

Lines 44 to 46 in 1bcded6

    
           def paid_login? 
        
             logged_in? && current_user.paid? 
        
           end

いずれにせよ、支払いができなくなったからといって即退会ということはないとは思います。引き落としができなくなった場合は、おそらくですが手動で対応しているのではないかと思います。

fuwa-syugyo

@ogawa-tomo
ご確認いただきありがとうございます！
退会の動線が3つ、ということで承知いたしました。
Approveさせていただきます〜

ogawa-tomo · 2023-09-30T09:24:53Z

@fuwa-syugyo レビューありがとうございました！

@komagata メンバーのレビューが通りましたので、レビューをお願いします:bow:

komagata

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

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from 31dff7e to 0ccc7be Compare June 10, 2023 02:38

ogawa-tomo commented Jun 10, 2023

View reviewed changes

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from d7932e3 to d1760f1 Compare June 11, 2023 08:19

ogawa-tomo changed the base branch from main to feature/update-user-status-to-retired-after-3months-hibernation June 11, 2023 08:19

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from d1760f1 to a5c7566 Compare June 11, 2023 08:26

ogawa-tomo mentioned this pull request Jun 11, 2023

退会に付随して必要な処理とその共通化を検討したい #6519

Open

machida assigned ogawa-tomo Jun 20, 2023

ogawa-tomo force-pushed the feature/update-user-status-to-retired-after-3months-hibernation branch 4 times, most recently from 386d0ae to a38be14 Compare June 30, 2023 23:45

ogawa-tomo force-pushed the feature/update-user-status-to-retired-after-3months-hibernation branch from f8f8c54 to c084005 Compare August 4, 2023 11:50

ogawa-tomo force-pushed the feature/update-user-status-to-retired-after-3months-hibernation branch 3 times, most recently from c9058d9 to b4a06b3 Compare August 30, 2023 12:34

Base automatically changed from feature/update-user-status-to-retired-after-3months-hibernation to main September 4, 2023 11:40

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from a5c7566 to 6659fdd Compare September 5, 2023 12:11

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from 1724804 to 3a31a33 Compare September 16, 2023 11:21

ogawa-tomo added 12 commits September 17, 2023 21:27

休会三ヶ月で自動退会しないフラグを追加

11f9ad1

休会三ヶ月で自動退会しないフラグを管理者ページから操作できるようにする

08670ab

休会三ヶ月で自動退会のテスト

9f9b998

休会三ヶ月で退会しないフラグの名前を変更

5a3598e

余分な差分をもとに戻す

e06002c

退会時に分報チャンネルを自動で削除する

5208192

server testの追加

21c373d

times_channel_destroyer_testを追加

943d81a

system testを追加

5cd4b43

不要なマイグレーションファイルを削除

3268bc1

不要なファイルを削除

f9b34fc

discord_profileのデータ形式に対応

a74e406

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from 2353c10 to 756d208 Compare September 17, 2023 12:27

管理者が退会させるときも分報が削除されるように修正

1bcded6

ogawa-tomo force-pushed the feature/delete-times-chennel-when-retire branch from 756d208 to 1bcded6 Compare September 17, 2023 12:30

ogawa-tomo requested a review from fuwa-syugyo September 17, 2023 13:03

ogawa-tomo marked this pull request as ready for review September 17, 2023 13:04

fuwa-syugyo reviewed Sep 27, 2023

View reviewed changes

ogawa-tomo requested a review from fuwa-syugyo September 30, 2023 00:10

fuwa-syugyo approved these changes Sep 30, 2023

View reviewed changes

ogawa-tomo requested a review from komagata September 30, 2023 09:25

komagata approved these changes Oct 1, 2023

View reviewed changes

komagata merged commit 6a45345 into main Oct 1, 2023
9 checks passed

komagata deleted the feature/delete-times-chennel-when-retire branch October 1, 2023 17:24

github-actions bot mentioned this pull request Oct 1, 2023

Release 2023-10-05 18:55:04 #6947

Merged

4 tasks

ogawa-tomo mentioned this pull request Mar 11, 2024

Discordアカウント名が不正だと退会時にエラーが発生する不具合を修正 #7515

Merged

Takuya-Sakai91 mentioned this pull request Mar 24, 2024

分報チャンネル作成後、生成されたチャンネルのURLをユーザーのプロフィールに自動で設定 #7564

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

退会時に分報チャンネルを自動で削除する #6626

退会時に分報チャンネルを自動で削除する #6626

ogawa-tomo commented Jun 10, 2023 •

edited

Loading

ogawa-tomo Jun 10, 2023 •

edited

Loading

fuwa-syugyo Sep 27, 2023

ogawa-tomo commented Sep 17, 2023

fuwa-syugyo commented Sep 18, 2023

fuwa-syugyo commented Sep 18, 2023

ogawa-tomo commented Sep 18, 2023

fuwa-syugyo commented Sep 18, 2023

fuwa-syugyo commented Sep 20, 2023

ogawa-tomo commented Sep 20, 2023

fuwa-syugyo left a comment •

edited

Loading

fuwa-syugyo Sep 27, 2023

ogawa-tomo commented Sep 30, 2023

fuwa-syugyo left a comment

ogawa-tomo commented Sep 30, 2023

komagata left a comment

退会時に分報チャンネルを自動で削除する #6626

退会時に分報チャンネルを自動で削除する #6626

Conversation

ogawa-tomo commented Jun 10, 2023 • edited Loading

Issue

概要

変更確認方法

準備

テスト用Discordサーバーの作成

Discord Botの作成

環境変数の設定とサーバーの起動

ユーザーが自ら退会するときの動作確認

休会6ヵ月後に自動退会するときの動作確認

管理ページから退会させるときの動作確認

次にやりたいこと

関連PR

ogawa-tomo Jun 10, 2023 • edited Loading

Choose a reason for hiding this comment

fuwa-syugyo Sep 27, 2023

Choose a reason for hiding this comment

ogawa-tomo commented Sep 17, 2023

fuwa-syugyo commented Sep 18, 2023

fuwa-syugyo commented Sep 18, 2023

ogawa-tomo commented Sep 18, 2023

fuwa-syugyo commented Sep 18, 2023

fuwa-syugyo commented Sep 20, 2023

ogawa-tomo commented Sep 20, 2023

fuwa-syugyo left a comment • edited Loading

Choose a reason for hiding this comment

fuwa-syugyo Sep 27, 2023

Choose a reason for hiding this comment

ogawa-tomo commented Sep 30, 2023

fuwa-syugyo left a comment

Choose a reason for hiding this comment

ogawa-tomo commented Sep 30, 2023

komagata left a comment

Choose a reason for hiding this comment

ogawa-tomo commented Jun 10, 2023 •

edited

Loading

ogawa-tomo Jun 10, 2023 •

edited

Loading

fuwa-syugyo left a comment •

edited

Loading