Slackアプリの開発が楽しい最近。
こんなアプリを開発してみました。
TASUKARU-TaskAll- Task Manager for Slack
Slack用のタスクマネージャーアプリです。
私自身がスレッドやメンション画面で依頼されたタスクを探すことが多いのですが、既存の画面では処理が終わったスレッドをアーカイブすることは出来ません。
加えて、処理したあとにコメントをスレッドに追加すると、スレッドタブの上位にソートされるので、未処理タスクが下へ下へと埋もれていってしまいます。
このアプリでは、やり取りのあったスレッドをリストするに加えて、アーカイブ機能を付けました。アプリの画面だけみていれば必要なやり取り全てが把握できるという状態を目指して作られたアプリです。
細かい仕様については上記のリンク先に譲るのですが、こちらのアプリの開発中に困った出来事がありました。
TASUKARUでは、発言者とメンション先の人との間の情報を蓄積するアプリです。
一つのワークスペースで使っている段階では気付かなかった難点が、Slack Connect時に発生しました。
具体的な内容の前に、処理方法についての簡単な説明をします。
TASUKARUでのデータ処理方法について
TASUKARUでは、上述の通り、メンション付きpost及び、それに付随したスレッド内容をトラッキングするアプリになっています。
history系SCOPEを取得することで、message eventを取得するようにしています。
@bolt_app.event("message")
def handle_message_events(client, event, body, logger, view, payload):
print('---------------------------')
print('event message--------------')
print('---------------------------')
SCOPEが正しく設定されていれば、こんな風に書いておくことでメッセージイベントを取得して処理することができるようになります。
問題になった挙動は、Slack Connect時の挙動です。
SlackConnectで共有されたチャンネルの双方のワークスペースでTASUKARUをインストールしていると、こんな状態になります。
TASUKARUが2つはいっていることが分かります。
bot_id としては別物ですので当然そのようになります。
次に、課題がなんだったのかについて。
2つアプリが入っていた場合に想定する挙動
開発者として想定していた挙動は、botが2つはいっているので何かしらのpostがあった場合にはmessageイベントが2回発火するという挙動です。
しかし、どうやらSlackの仕様で、あとに入れたアプリ側でしか反応してくれないようなのです。
そうなると、情報の取得という意味では、片方のワークスペースにしか対応しないという状態になってしまいます。
この仕様に気付くまでにかなり時間を要しました。そうだったのか!
解決策
TASUKARUで必要な情報は、そのチャンネルにコネクトしているワークスペースのIDです。これさえあれば、各ワークスペース用のレコードとして保存が可能になります。
そこで利用できるAPI methodがapps.event.authorizations.listです。
今まで知らなかったのですが、App-level tokenというものを使う必要があるAPIです。
SCOPEもauthorizations:readというものを使います。
設定画面はアプリ画面のBasic Information画面の中です。
from slack_sdk import WebClient
response = client.apps_event_authorizations_list(
token="xapp-1-A111-111-xxx",
event_context="4-eyJldCI6Im1lc3NhZ2UiLCJ0aWQiOiJUSktSOEg5TDIiLCJhaWQiOiJBMDJQMlNRSzRLQiIsImNpZCI6IkMwMTYwSFI4TTZGIn0",
)
こんな形で呼び出すと、authorizationsが返ってきます。詳細については12/2の @seratch さんの記事を参照ください。
該当部分はこちらです
event_contextはmessage eventのどこにあるかと言うとbody["event_context"]で取得できます。
こんな感じの処理で、Slackコネクトで接続しているワークスペースIDをリストで取得できます。
環境変数にTOKENを入れておいてください
export APP_LEVEL_TOKEN=xxxxxxxxxxxxx
from slack_sdk import WebClient
@bolt_app.event("message")
def handle_message_events(client, event, body, logger, view, payload):
print('---------------------------')
print('event message--------------')
print('---------------------------')
slack_ws_id_list = get_authorization_ws(body['event_context'])
def get_authorization_ws(event_context):
APP_LEVEL_TOKEN = os.environ["APP_LEVEL_TOKEN"]
app_client = WebClient(token=APP_LEVEL_TOKEN)
authorizations_list = []
try:
authorizations_list = app_client.apps_event_authorizations_list(
event_context=event_context
)
except SlackApiError as e:
print("Error fetching authorizations_list: {}".format(e))
authorizations = authorizations_list.get("authorizations")
slack_ws_id_list = []
for auth in authorizations:
slack_ws_id_list.append(auth.get("team_id"))
return slack_ws_id_list
これを利用することで、課題を解決することができました🎉🎉🎉🎉
苦心作のTASUKARU。是非これを期にお試しください。
TASUKARU-TaskAll- Task Manager for Slack