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

[komagata]

チャンネルのIDみたいなものを保存しておいて、退会時にチャンネルを削除できるようにしておいてほしい。

Web APIだけで行けるのか、Botを立ち上げないといけないのかはまだ不明なので調査お願いしたい。

[maeda-m]

@komagata 調査結果を共有します。
次の事前準備・設定が必要ですが、Discord の Web API を使っただけで”入会時に分報チャンネルを自動で作成”を実現できそうです。
後述の検証コードをもとに詳細を実装しようと考えています。

事前準備・設定

1. Discord Developer Portal で Bot を登録する
2. Discord Developer Portal で Bot の認証トークンを発行する
3. Discord Developer Portal で Bot への権限の認可（Discord サーバーへの参加）リンクを取得する
4. Discord サーバーへ参加させる
5. Discord サーバーのIDをコピーする
6. 2 と 5 の値を環境変数に設定する

Note
上記の事前準備・設定は #6099 で注意・伝達事項として記載していた内容と同様になります。

具体的には次のコードで検証しました。
※ 1ファイルで実行できるコードですが、説明のため分割しています。

Discord の Web API（以下、Discord Web API と呼びます）を Ruby で利用可能にした Gem「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 が使われているため、開発版ではありますが検証に使用しています。

なお The Ruby Toolbox で Discord API と検索したところ discordrb のほかに discorb がよさそうに思いました。しかし、ドキュメント から判断するに Bot を立ち上げる方式（以下、Discord Gateway API と呼びます）のみ対応しているようです。

require 'bundler/inline'

gemfile do
  source 'https://rubygems.org'
  git_source(:github) { |repo| "https://github.com/#{repo}.git" }

  ruby '3.1.0'

  # NOTE: v3.4.2 は https://discord.com/api/v6 を使用しており Discord としては非推奨
  #       GitHub の main では https://discord.com/api/v9 を使用している
  gem 'discordrb', github: 'shardlab/discordrb'
end

Discord Web API を使用するために Bot と Guild を用意します

Discord Web API としては Discord サーバーをギルドと呼んでいます。

# 事前準備・設定 2 の値
token = "Bot #{ENV['DISCORD_BOT_TOKEN']}"
# 事前準備・設定 5 の値
server_id = ENV['DISCORD_GUILD_ID']

guild_response = Discordrb::API::Server.resolve(token, server_id)
guild_data = JSON.parse(guild_response.body)
bot = Discordrb::Bot.new(token: token)
guild = Discordrb::Server.new(guild_data, bot)

カテゴリ配下にテキストチャンネルを作成します

# NOTE: チャンネルにはテキストチャンネル、カテゴリ、ボイスチャンネルが含まれます
channels_response = Discordrb::API::Server.channels(token, server_id)
channels_data = JSON.parse(channels_response.body)
channels = channels_data.map do |channel_data|
  Discordrb::Channel.new(channel_data, bot)
end
categories = channels.select(&:category?)

# NOTE: Discordrb::API::Server.create_channel(bot.token, server_id, name, type, ...) を実行している
channel_name = 'maeda-mの独り言😮💨'
channel_type = Discordrb::Channel::TYPES[:text]
newbie_category = categories.find { |channel| channel.name == '新規ひとりごと(分報)' }

times_channel = guild.create_channel(channel_name, channel_type, parent: newbie_category)
# => <Channel name=maeda-mの独り言😮💨 id=テキストチャンネルのID topic="" type=0 position=4 server=ギルドID>
times_channel.send_message('フィヨルドブートキャンプへようこそ！')

実行結果

分報チャンネルの削除やメンバーをサーバーから退出させることもできます

Discord としては Discord サーバーからメンバーを退出（追放）させることキックと呼んでいます。

# NOTE: 分報チャンネルを削除する
Discordrb::API::Channel.delete(token, times_channel.id)

# NOTE: サーバーのメンバー一覧の取得
#       https://discord.com/developers/docs/resources/guild#search-guild-members は未実装でした
limit = 100
offset = nil
members_response = Discordrb::API::Server.resolve_members(token, server_id, limit, offset)
members_data = JSON.parse(members_response.body)
members = members_data.map do |member_data|
  Discordrb::Member.new(member_data, guild, bot)
end
user = members.find { |member| /maeda-m#/ =~ member.distinct }
# => <Member user=<Discordrb::User> server=<Discordrb::Server> joined_at=2023-01-27 09:55:25 +0000 roles=[] voice_channel=nil mute= deaf= self_mute= self_deaf=>

# NOTE: サーバーからメンバーを退出させる
#       Discordrb::API::Server.remove_member(token, server_id, kick_user.id) を実行している
user.kick

以上です。

[komagata]

@maeda-m 調査ありがとうございます。

Discord周りで最終的にやりたい状態としては下記があります。（この辺り、一部を東郷さんが手動で対応している）

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

これを考えた時、Botは必須ですかね？（もしくはBotにした方が簡単）

Botが必須であればBotは別リポジトリーでいいかなと思っています。（別リポジトリであればjsでも良いかも）
Botが必須でなければ同じリポジトリ内なのでrubyで行きたいと思っています。

[maeda-m]

@komagata 課題背景の共有ありがとうございます😀

これを考えた時、Botは必須ですかね？（もしくはBotにした方が簡単）

Botは必須ではありません。
Web API を使用する際にBotのトークン情報（有効期限なし？）を使用しているだけです。
だたし、Botにした方が簡単かもしれません（試し切れていないのでおそらくです）。

簡単だと思う理由としては、Web API を使用する際に使用するトークン情報はBot以外だと
OAuth2 でユーザーアカウントのリソースに対して認可されたアクセストークン を使用します。
このアクセストークンの有効期限は1週間（168時間）で、適宜リフレッシュする必要があります。
このため、適宜リフレッシュの処理が必要であるため、Botにした方が簡単だと考えます。

[maeda-m]

📝 ふりかえり・計画ミーティングで相談したい点

1. users テーブルにはカラムがたくさんあるが、Profile など別テーブルに分かれていないので気になった
   • ユーザーごとの分報チャンネルのIDを永続化させたいが、既存の users.times_url や users.discord_account が存在する
   • 既存カラムとの兼ね合いもあるので discord_profiles などのテーブルを作った方がいいのか、単純にカラムを追加する方がいいのか悩んでいる
2. 分報は受講生だけでよいか？研修生も含むか？

[maeda-m]

📝 2023年2月1日 ふりかえり・計画ミーティングよりメモ

調査結果の共有とコメントの意図について説明：
Botは必須ではないが、Botにした方がトークンの管理が簡単かもしれない。
駒形さんとしては本当に必要とであればBotを作るが、、、NextAction は相談とさせてもらった。

users テーブルにはカラムがたくさんあるが、Profile など別テーブルに分かれていないので気になった：

生徒さんの教材としては極力1つのテーブルにした方がいいため、フラグなど別テーブルに分割していない。
今回の Discord 用のテーブルについては分割した方がいいかもしれない（ただし、カラム移行・データの移行があるので大変そう）。

分報は受講生だけでよいか？研修生も含むか？：

研修生も含む。

[maeda-m]

@komagata 本日はありがとうございました😀

駒形さんとしては本当に必要とであればBotを作るが、、、NextAction は相談とさせてもらった。

下記の整理を前提として、
次の方針で実装を進めようかと思います。いかがでしょうか～

https://github.com/fjordllc/bootcamp のリポジトリ内に ruby の実装として Discord Web API を使用する方針とする。
また、Web API を使用する際にヘッダー情報に付加するトークン情報は、有効期限なしの Bot のトークンを利用する。

---

現状の整理としては次の判断基準があると認識しています。

1. 常時起動の Bot を立ち上げないといけないか？
   • 常時起動のBotが必須であればBotは別リポジトリー（別リポジトリであればjsでも良い）
   • 常時起動のBotが必須でなければ同じリポジトリ内なのでrubyとする
2. Web API を使用する際にヘッダー情報に付加するトークン情報はどうするか？
   • Discord Developer Portal で Bot を登録した際に発行する Bot のトークンを利用する（おそらく有効期限なし）
   • OAuth2 でユーザーアカウントのリソースに対して認可されたアクセストークン を利用する（有効期限は1週間でリフレッシュが必要）

１．常時起動の Bot については不要と考えます（理由は後述の語彙の説明に記載しています）。
２．Web API を使用する際にヘッダー情報に付加するトークン情報は1度発行すればOKの Bot のトークンを利用した方が管理が簡単であると考えます（流失した際には再発行する）。

また、上記で Bot を指している語彙は2つあると認識しています。それぞれ @maeda-m の認識を記載します。

1. 常時起動の Bot

アプリケーションサーバーで常時起動し、Discord 内のイベント・投稿に応答するための Bot を指します。
#6103 (comment) で示した検証コードのBotは、これに該当しません（常時起動のBotは不要です）。
#6103 (comment) で挙げた Discord Gateway API を使用するための Bot と言えます。

2. Discord Developer Portal で登録した Bot

あらかじめ決められた権限（許可させたい操作）を許可する Bot の設定を指します。
#6103 (comment) で示した検証コードのBotは、これに該当します（権限としてメッセージの送信、チャンネルの管理、メンバーの追放が必要でした）。
#6103 (comment) で挙げた Discord Web API を使用するための Bot と言えます。

以上です。

[komagata]

@maeda-m すみません、ちょっと僕が上記で理解できていないのですが、

下記は何が違うのでしょうか？

1. 常時起動の Bot
2. Discord Developer Portal で登録した Bot

[maeda-m]

@komagata bot.run をする／しないの違いがあります。
※ 月曜日の質問・雑談タイムで口頭にて補足します💡

1. 常時起動の Bot

bot.run をするものです。
https://github.com/shardlab/discordrb#usage のようにアプリケーションサーバーで常時起動させておく Bot を指します。

2. Discord Developer Portal で登録した Bot

bot.run をしないものです。
https://discord.com/developers/applications で登録した Bot の権限設定を指します。

Discord Web API を利用するだけであれば、下図のような Bot の権限設定をします。

Note
常時起動の Bot においても必要な設定でもあります。

以上です。

[maeda-m]

📝 2023-02-06 質問・雑談タイムで方針を確認した

今回の Discord Web API を使用する分報チャンネルの自動生成は、fjordllc/bootcamp に含める方針となった。
また追加で2点質問した。

1. 分報のチャンネル名の書式はどのようにすべきか？
   • 独り言などは付けなくて、名前だけにする
2. カテゴリの特定についてはどのようにすべきか？
   • 前田の想定としては名前から判断してIDを取得する想定だが、名前が変わると厄介
   • 駒形さんのアドバイスとしてはカテゴリのIDはアプリの開発者モードでわかるので、ID指定でよい

以下、上記以外のやりとりのまとめです。

---

常時起動Botについては bot.run して Discord 内のイベント・投稿に応答するための Bot を指します。
前田が伝えたかったこととしては、今回の Discord Web API については常時起動Botは不要です。

しかしながら、駒形さんとしては Discord 内のイベント・投稿に応答する Bot が必要になるような構想があるとのこと。
常時起動Botが必要になった時には、その時考えるとのこと。