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

maeda-m · 2023-02-08T05:49:40Z

Issue

[分報]入会時に分報チャンネルを自動で作りたい。 #6103

概要

Discord周りで最終的にやりたい状態としては下記があります。

入会時に自動で分報チャンネルを作る
退会時に自動で分報チャンネルを消す
退会時に自動でkickする

このプルリクエストでは 1 の入会時に自動で分報チャンネルを作成し、
2 の動作に向けて分報チャンネルのIDをDB（ users.times_id ）に保存するまでの範囲となります。
つまり、2から3の動作はこのプルリクエストの範囲外です。

また分報チャンネルの作成方針としては次の規則があります。

分報チャンネル名はフィヨルドブートキャンプアカウントだけにする
- https://bootcamp.fjord.jp/pages/times では例として独り言などありますがこちらで確認済みです
分報チャンネルのカテゴリーはIDを環境変数で指定できること
- 技術的にはカテゴリー名で指定可能ですが、カテゴリー名が変更された場合を考慮しています

変更確認方法

feature/auto-create-of-times-channel-when-joined をローカルに取り込みます
bundle exec rails db:drop を実行します
bin/setup を実行します
後述の「注意・伝達事項」にある3つの環境変数を設定します
bin/rails s でサーバーを立ち上げます
http://localhost:3000 にアクセスして未ログインであることを確認します
http://localhost:3000/users/new にアクセスし現役生として会員登録をします
- カード番号についてはテスト | Stripe のドキュメントをご利用ください
http://localhost:3000/users/new?company_id=636488896&role=trainee&token=token にアクセスし研修生として会員登録をします
http://localhost:3000/users/new?company_id=636488896&role=adviser&token=token にアクセスしアドバイザー登録をします
7 と 8 で会員登録したアカウント名の分報チャンネルが作成されていることを確認します

Screenshot

画面上の変更はありません。

注意・伝達事項

Discord Bot を参加させる Discord サーバーのIDを取得する

Note

確認用の Discord サーバーを作成する場合は #5454 ようにサーバーを新規作成してください（webhookURLの取得は不要です）。

アイコンを右クリックして、コンテキストメニュー「IDをコピー」をクリックして控えます。

分報チャンネルのカテゴリーのIDを取得する

Note

確認用のカテゴリーを作成する場合は、Discord サーバー名の右側にあるボタン「∨」をクリックすると作成メニューが表示されます。

ユーザー設定 > 詳細設定 > 開発者モード をONにしてから
カテゴリーを右クリックして、コンテキストメニュー「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 サーバーを選びます	チャンネルの管理とメンバーをキックにチェックが入っていることを確認します

3つの環境変数を設定する

前述の手順で発行された各キーを環境変数を設定する必要があります。

DISCORD_GUILD_ID
- 前述の「Discord Bot を参加させる Discord サーバーのIDを取得する」で控えた値です
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

参考情報

Discord の開発者向けドキュメントでは guild をサーバーと呼んでいます
- Discord Developer Portal — Documentation — Gateway
チャットを使えるようになる | FBC
shardlab/discordrb: Discord API for Ruby

maeda-m · 2023-02-13T07:20:56Z

Gemfile

@@ -28,6 +28,7 @@ gem 'commonmarker'
 gem 'data_migrate'
 gem 'diffy'
 gem 'discord-notifier'
+gem 'discordrb', github: 'shardlab/discordrb'


discordrb の最新リリースは v3.4.0 です。しかし、使用している Discord Web API の Version が古いです。
Discord としては v9 または v10 が利用可能となっていますが、discordrb の v3.4.0 は Discord Web API v6 が使われています。
しかしながら、GitHub の main では Discord Web API v9 が使われているため、開発版ではありますが使用しています。

maeda-m · 2023-02-13T07:24:33Z

app/controllers/users_controller.rb

@@ -83,6 +83,7 @@ def create_free_user!
      UserMailer.welcome(@user).deliver_now
      notify_to_mentors(@user)
      notify_to_chat(@user)
+      Newspaper.publish(:student_or_trainee_create, @user) if @user.trainee?


#6103 (comment) にて現役生と研修生が対象となりました。

maeda-m · 2023-02-13T07:28:55Z

app/models/discord/server.rb

+module Discord
+  class Server
+    class << self
+      class_attribute :guild_id, :authorize_token, instance_reader: false


テストがしやすいように外部から値を設定できるようにしています。

maeda-m · 2023-02-13T07:31:30Z

app/models/discord/server.rb

+      class_attribute :guild_id, :authorize_token, instance_reader: false
+
+      def create_text_channel(name:, parent: nil)
+        guild = Discord::Server.find_by(id: guild_id, token: authorize_token)


名前が紛らわしいのですが、内部的にサーバーのことをギルドと呼んでいます。
これは Discord の開発者向けドキュメントでギルドと呼ばれているためです。

maeda-m · 2023-02-13T07:40:54Z

app/models/discord/times_channel.rb

+
+    class << self
+      def to_channel_name(username)
+        username.downcase


テキストチャンネル名には大文字の英字が使えないため、小文字に変換しています。

maeda-m · 2023-02-13T07:44:51Z

app/models/discord/times_channel.rb

+      end
+
+      def category_id
+        @category_id || ENV['DISCORD_TIMES_CHANNEL_CATEGORY_ID'].presence


テキストチャンネルのカテゴリを指定する際に、空文字を指定すると shardlab/discordrb にて 0 に変換されるため
環境変数においては presence を使用しています。

app/models/times_channel_creator.rb

maeda-m · 2023-02-13T08:08:44Z

config/boot.rb

+
+# NOTE: ボイス機能を使用しない設定です。
+#       https://github.com/shardlab/discordrb/wiki/Installing-libopus
+ENV['DISCORDRB_NONACL'] = 'true'


環境変数を設定しないとメッセージが表示されるため、あらかじめ設定しています。

なお boot.rb に記述している理由は bin/rails コマンドや config/application.rb で読み込まれ、必ず Bundler.require の前に環境変数を設定するためです。

@maeda-m これって他に困っている人いないんですかね？
その辺りちょっと調べてみるといい気がしました。

maeda-m · 2023-02-13T08:11:30Z

db/migrate/20230208073717_add_times_id_to_users.rb

@@ -0,0 +1,6 @@
+class AddTimesIdToUsers < ActiveRecord::Migration[6.1]
+  def change
+    # NOTE: Snowflake ID


Snowflakes という書式の ID になります。
整数のオーバーフローを防止するために、HTTP API では常に文字列で扱われるため、DBにおいても文字列で扱うようにしています。

migrationからでもDBのカラムのコメントを付けられた気がするのでそれを利用するといいかもと思いました〜

maeda-m · 2023-02-13T08:15:21Z

db/schema.rb

@@ -655,6 +655,7 @@
    t.string "profile_job"
    t.text "profile_text"
    t.string "feed_url"
+    t.string "times_id"


usersテーブルにあるDiscord関連のカラムを移動する提案は別議題（ #6215 ）として作成しています。

maeda-m · 2023-02-13T08:18:21Z

test/integration/discord/users_controller_test.rb

+require 'test_helper'
+
+module Discord
+  class UsersControllerTest < ActionDispatch::IntegrationTest


test/system/sign_up_test.rb ではクレジットカード決済等の動作があるため
stub を使って機能的なテストをしやすい IntegrationTest で分報チャンネルの自動生成の挙動を確認しています。

Note
コントローラーに関するテストなので test/controllers の配下がふさわしいかと思いましたが、
意図としてはコントローラー経由で TimesChannelCreator > Discord::TimesChannel の結合を確認しているため
test/integration/discord 配下にファイルを作成しています。

maeda-m · 2023-02-13T09:02:41Z

app/models/discord/server.rb

+        #       - Maximum number of server channels reached (500)
+        #       - Maximum number of channels in category reached (50)
+        #       - The bot doesn't have the required permission to do this!
+        Rails.logger.error "[Discord API] #{exception.full_message.chomp}"


Discord API のエラーは致命的でブートキャンプアプリ側では回復できないため、エラーログを出力しています。

app/models/discord/server.rb

maeda-m · 2023-02-13T12:44:08Z

@siso25 こちらのプルリクエストのレビューをお願いしたいのですが、ご都合いかがでしょうか～？

不明点や疑問点あれば遠慮なくコメントください😀

siso25 · 2023-02-14T06:14:34Z

@maeda-m
了解しました！
今日明日くらいで確認させていただこうと思いますが、よろしいでしょうか？

maeda-m · 2023-02-14T07:47:59Z

@siso25 はい🙏 急ぎませんのでよろしくお願いします～

siso25 · 2023-02-15T04:32:32Z

@maeda-m
レビューの途中ではあるのですが、一点お聞きしたいことがあります。

discordrbについて、どなたか（komagataさんやmachidaさんなど）に相談された結果、開発中のバージョンを使うことになったのでしょうか？リリースされていないバージョンのgemを、稼働中のアプリケーションに入れることに不安を覚えたのでお聞きしました。

もし、相談の結果「gemに問題があったらその都度解決しよう」ということになったのであれば問題ないと思います！

maeda-m · 2023-02-15T05:07:24Z

@siso25 質問ありがとうございます🙏

discordrbについて、どなたか（komagataさんやmachidaさんなど）に相談された結果、開発中のバージョンを使うことになったのでしょうか？リリースされていないバージョンのgemを、稼働中のアプリケーションに入れることに不安を覚えたのでお聞きしました。

別の調査 issue（ #1996 (comment) ）で Discord については Gem や npm を使った方がいいという方針になったのですが
discordrb でよいか？については未確認でした🙋‍♂️ ありがとうございます💡

本日のふりかえり・計画ミーティングにて確認してみますね💡

siso25 · 2023-02-15T05:37:41Z

@maeda-m
お手数ですが、よろしくお願いします！

maeda-m · 2023-02-15T06:55:25Z

@siso25 ご質問いただいている件、開発中バージョンの discordrb のままで進めることとなりました。

本日のふりかえり・計画ミーティングにて次の説明を行いました。

discordrb の最新リリースは Discord が非推奨としている API v6 が使われている
discordrb の開発中バージョンは Discord が利用可能としている API v9 が使われている
Discord が非推奨としている API v6 は使えないことはないが、といっても非推奨である

@siso25 ご質問いただいたおかげで、確認の機会ができました。大変ありがとうございます🙏

siso25

@maeda-m
お手数おかけしました。承知しました！

動作とコードを確認しました。問題ないと思いますので、Approveさせていただきます。

maeda-m · 2023-02-15T22:41:15Z

@siso25 確認ありがとうございました🙏

maeda-m · 2023-02-15T22:42:02Z

@komagata メンバーレビューで Approve いただきました～
レビューをお願いします🙏

komagata · 2023-02-18T02:28:28Z

app/models/discord/server.rb

+      end
+
+      def guild_id
+        @guild_id || ENV['DISCORD_GUILD_ID'].presence


この辺りも環境変数は極力外部から注入するようにした方がいいかもです〜

komagata · 2023-02-18T02:30:16Z

db/migrate/20230208073717_add_times_id_to_users.rb

@@ -0,0 +1,6 @@
+class AddTimesIdToUsers < ActiveRecord::Migration[6.1]
+  def change
+    # NOTE: Snowflake ID


migrationからでもDBのカラムのコメントを付けられた気がするのでそれを利用するといいかもと思いました〜

maeda-m · 2023-02-18T08:22:50Z

config/initializers/discord.rb

@@ -0,0 +1,9 @@
+Rails.application.reloader.to_prepare do


Rails.application.reloader.to_prepare のブロックを記述しないと
DEPRECATION WARNING: Initialization autoloaded the constants Discord::Server and Discord::TimesChannel. と非推奨である旨のメッセージと Rails.application.reloader.to_prepare のブロック内に記述するようにメッセージが出力されます。

maeda-m · 2023-02-18T08:35:47Z

@komagata コメントありがとうございます🙏
コメントいただいた点、次のとおり修正しましたので再度レビューをお願いしたいです🙋‍♂️

ActiveSupport::Configurable を利用して外部から環境変数を注入できるようにしました💡
DBのカラムのコメントについてはマイグレーションファイルを修正し、コメント（列「Description」）を psql で確認しました💡

$ psql -d bootcamp_development
psql (14.7 (Debian 14.7-1.pgdg110+1))
Type "help" for help.

bootcamp_development=# \d+ users
Table "public.users"
             Column              |            Type             | Collation | Nullable |              Default              | Storage  | Compression | Stats target | Description
---------------------------------+-----------------------------+-----------+----------+-----------------------------------+----------+-------------+--------------+--------------
 id                              | integer                     |           | not null | nextval('users_id_seq'::regclass) | plain    |             |              |
 login_name                      | character varying(255)      |           | not null |                                   | extended |             |              |
### 省略
 feed_url                        | character varying           |           |          |                                   | extended |             |              |
 times_id                        | character varying           |           |          |                                   | extended |             |              | Snowflake ID

komagata · 2023-02-23T04:06:09Z

app/models/discord/server.rb

+module Discord
+  class Server
+    include ActiveSupport::Configurable
+    config_accessor :guild_id, :authorize_token, instance_accessor: false


便利ですね！

komagata · 2023-02-23T04:16:58Z

config/boot.rb

+
+# NOTE: ボイス機能を使用しない設定です。
+#       https://github.com/shardlab/discordrb/wiki/Installing-libopus
+ENV['DISCORDRB_NONACL'] = 'true'


@maeda-m これって他に困っている人いないんですかね？
その辺りちょっと調べてみるといい気がしました。

maeda-m · 2023-03-01T08:13:50Z

config/initializers/discord.rb

@@ -0,0 +1,14 @@
+# NOTE: ボイス機能を使用しない設定です。
+#       https://github.com/shardlab/discordrb/wiki/Installing-libopus
+ENV['DISCORDRB_NONACL'] = 'true'


Gemfileの宣言に require: false を追記することで Bundler.require にて読み込み対象外とした。

maeda-m · 2023-03-01T08:17:16Z

@komagata コメントいただいていた件、次のように修正しましたので再度レビューをお願いします🙏

config/boot.rb に書いていたGem読込み前の環境変数設定をinitializersに移動しました💡
具体的にはこちらのコミットでGemfileの宣言に require: false を追記し
実際の require は initializers でおこなうことで、初期化処理としてまとまるようにしました。

komagata

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

komagata · 2023-03-11T13:50:52Z

config/initializers/discord.rb

+# NOTE: ボイス機能を使用しない設定です。
+#       https://github.com/shardlab/discordrb/wiki/Installing-libopus
+ENV['DISCORDRB_NONACL'] = 'true'
+require 'discordrb'


maeda-m · 2023-03-11T22:45:48Z

確認ありがとうございました🙏

maeda-m self-assigned this Feb 8, 2023

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch 2 times, most recently from 514c017 to 0dbc389 Compare February 12, 2023 04:03

maeda-m changed the title ~~受講生（現役生および研修生）が入会したときに分報チャンネルを自動で作成する~~ 受講生（現役生または研修生）が入会したときに分報チャンネルを自動で作成する Feb 12, 2023

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch 3 times, most recently from 4f4e0f9 to 07bb779 Compare February 12, 2023 12:58

maeda-m marked this pull request as ready for review February 13, 2023 07:16

maeda-m commented Feb 13, 2023

View reviewed changes

app/models/times_channel_creator.rb Outdated Show resolved Hide resolved

maeda-m commented Feb 13, 2023

View reviewed changes

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch from 07bb779 to e8b26dc Compare February 13, 2023 09:00

maeda-m commented Feb 13, 2023

View reviewed changes

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch from e8b26dc to 7d253bb Compare February 13, 2023 12:06

maeda-m commented Feb 13, 2023

View reviewed changes

app/models/discord/server.rb Outdated Show resolved Hide resolved

maeda-m requested a review from siso25 February 13, 2023 12:43

siso25 approved these changes Feb 15, 2023

View reviewed changes

maeda-m requested a review from komagata February 15, 2023 22:41

komagata reviewed Feb 18, 2023

View reviewed changes

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch 2 times, most recently from 245bf8f to 44c4c9e Compare February 18, 2023 07:39

maeda-m commented Feb 18, 2023

View reviewed changes

komagata reviewed Feb 23, 2023

View reviewed changes

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch 2 times, most recently from b122e61 to 47ca9b2 Compare March 1, 2023 07:46

maeda-m commented Mar 1, 2023

View reviewed changes

maeda-m mentioned this pull request Mar 1, 2023

[分報]入会時に分報チャンネルを自動で作りたい。 #6103

Closed

maeda-m added 4 commits March 6, 2023 15:02

discordrbを導入して分報チャンネル作成APIを利用可能にした

4a7d646

現役生または研修生が入会したときに分報チャンネルを自動で作成されるように実装した

3822095

Configurable によって外部から環境変数を注入可能にした

ea5d404

Gem読込み前の環境変数設定を適切なinitializersに移動した

18db80d

maeda-m force-pushed the feature/auto-create-of-times-channel-when-joined branch from 47ca9b2 to 18db80d Compare March 6, 2023 06:03

komagata approved these changes Mar 11, 2023

View reviewed changes

komagata merged commit 702b2c6 into main Mar 11, 2023

komagata deleted the feature/auto-create-of-times-channel-when-joined branch March 11, 2023 13:54

github-actions bot mentioned this pull request Mar 11, 2023

Release 2023-03-16 21:55:48 #6315

Merged

11 tasks

ymmtd0x0b mentioned this pull request May 16, 2023

分報チャンネルがアカウントIDの頭文字のグループ内で自動作成されるようにする #6522

Merged

ogawa-tomo mentioned this pull request Jun 10, 2023

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

Merged

This was referenced Jan 2, 2024

newspaperの引数をハッシュで受け渡しするように統一した #7173

Draft

newspaperの引数をハッシュでの受け渡しに統一 2/2 #7174

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

maeda-m commented Feb 8, 2023 •

edited

Loading

maeda-m Feb 13, 2023 •

edited

Loading

maeda-m Feb 13, 2023

maeda-m Feb 13, 2023

maeda-m Feb 13, 2023

maeda-m Feb 13, 2023

maeda-m Feb 13, 2023

maeda-m Feb 13, 2023

komagata Feb 23, 2023

maeda-m Feb 13, 2023

komagata Feb 18, 2023

maeda-m Feb 13, 2023

maeda-m Feb 13, 2023 •

edited

Loading

maeda-m Feb 13, 2023

maeda-m commented Feb 13, 2023

siso25 commented Feb 14, 2023

maeda-m commented Feb 14, 2023

siso25 commented Feb 15, 2023

maeda-m commented Feb 15, 2023 •

edited

Loading

siso25 commented Feb 15, 2023

maeda-m commented Feb 15, 2023

siso25 left a comment

maeda-m commented Feb 15, 2023

maeda-m commented Feb 15, 2023

komagata Feb 18, 2023

komagata Feb 18, 2023

maeda-m Feb 18, 2023

maeda-m commented Feb 18, 2023

komagata Feb 23, 2023

komagata Feb 23, 2023

maeda-m Mar 1, 2023

maeda-m commented Mar 1, 2023 •

edited

Loading

komagata left a comment

komagata Mar 11, 2023

maeda-m commented Mar 11, 2023

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

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

Conversation

maeda-m commented Feb 8, 2023 • edited Loading

Issue

概要

変更確認方法

Screenshot

注意・伝達事項

Discord Bot を参加させる Discord サーバーのIDを取得する

分報チャンネルのカテゴリーのIDを取得する

Discord Bot のトークン情報を取得する

3つの環境変数を設定する

参考情報

maeda-m Feb 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maeda-m Feb 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maeda-m commented Feb 13, 2023

siso25 commented Feb 14, 2023

maeda-m commented Feb 14, 2023

siso25 commented Feb 15, 2023

maeda-m commented Feb 15, 2023 • edited Loading

siso25 commented Feb 15, 2023

maeda-m commented Feb 15, 2023

siso25 left a comment

Choose a reason for hiding this comment

maeda-m commented Feb 15, 2023

maeda-m commented Feb 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maeda-m commented Feb 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maeda-m commented Mar 1, 2023 • edited Loading

komagata left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maeda-m commented Mar 11, 2023

maeda-m commented Feb 8, 2023 •

edited

Loading

maeda-m Feb 13, 2023 •

edited

Loading

maeda-m Feb 13, 2023 •

edited

Loading

maeda-m commented Feb 15, 2023 •

edited

Loading

maeda-m commented Mar 1, 2023 •

edited

Loading