コロナ時代を生き抜く(?) Slack アプリ開発・運用 知見まとめ

Colla（コラ）というSlackアプリ開発を通して得た、プロダクトとしてのSlackアプリ開発の知見を共有します

Transcript

1. コロナ時代を⽣き抜く (?) Slack アプリ開発・運⽤ 知⾒まとめ
2. ⾃⼰紹介 @munky69rock 上原 将之 株式会社トラックレコード CTO 前職は DeNA で⼩説投稿サイトのエブリスタとか遺伝⼦検査のMYCODE とかAI 創 薬プロジェクトなどなどやってました
3. 株式会社トラックレコードって？ 以下のようなサービスを開発・運営してます エンジニアキャリア⽀援サービス 「kiitok （キイトク）」 ネクストキャリアを考えている⼈は是⾮ご相談を、エンジニアの採⽤市況は かなり詳しいです [PR] チームのエンゲージメントを向上させる Slack アプリの開発 仲間をスタンプでホメて、表彰する「ホメルくん」 仲間をコメントで褒めて表彰する「ノビルくん」 Bot が社員インタビューをしてメンバー紹介してくれる「Colla （コラ）」 → 今⽇はこの Colla の開発・運⽤周りの話をメインにします
4. ... なんですが これだけ⾒ると Slack アプリそこそこ詳しそう感ありますが 最初の 2 アプリは諸事情によりリリース後あまり追加開発・メンテできておら ず... その間(1~2 年弱) に Slack 側でめっちゃいろいろアップデートされてる...
7. ほどよい期待値でお楽しみください ( ツッコミおまちしてます)
8. Agenda 1. これまでリリースしたアプリの紹介 2. Slack アプリ開発の現状 3. 実際にあったハマりポイント 細かい開発の話などはしません (Bolt のドキュメントが⾮常に参考になります)
9. これまでリリースしたアプリの紹介
10. 過去の Slack アプリの紹介 ホメルくん Slack のリアクションでホメて、 チームの動きをもっと簡単にみんなで共有 できるアプリ 登録した絵⽂字のリアクションに反応して、メッセージを特定のチャンネ ルにリポスト 毎⽉、もっとも多くホメられた⼈を表彰 古くて参考にならないかもですがこのあたりの話は以下の記事に 初めて Slack app をつくって審査通すところまでやった知⾒を晒す - Qiita
11. 過去の Slack アプリの紹介 ノビルくん 褒めことばを贈りあうことで、チームを強くするアプリ 設定したチャンネルでメンション付きでメッセージを送るとノビルくんが 相づち 毎⽉、褒めことばをもらった⼈と贈った⼈を表彰
12. 今回新たにリリースした Slack アプリ Colla （コラ） Bot が社員インタビューをしてメンバー紹介してくれる無料 Slack アプリ 課題 コロナ禍でリモート前提の働き⽅にシフト チャットベースだとコミュニケーション減りがち ( 雑談など) 新メンバーのオンボーディングもなかなか対⾯で顔を合わせることができ ない... Colla （コラ）が解決してくれること コラさんが勝⼿にメンバーに質問、毎⽇回答を発表 雑談のきっかけ、あまり関わらなくなったメンバーのことが知れる 新メンバーが Slack に join したタイミングで質問、回答するとみんなに紹 介してくれる リモートでのオンボーディングをよりスムーズに
13. Colla （コラ） 誕⽣ストーリー コロナの猛威、緊急事態宣⾔、ステイホーム、、、 ピンチはチャンス、今のタイミングで会社としてできるとは？ タイミング的に緊急事態宣⾔終了する前に新しいチャレンジを世に出したい！ GW ⼀週間くらいでガッと企画・開発 → リリース
14. リリース直後に⽇経新聞・めざ まし⼟曜⽇などで取り上げられ る 現在多くの WS でインストー ル、問い合わせも多数 Twitter などでも好意的なコメン ト 参考 : 新型コロナ : テレワーク社員にアプリが質問 雑談共有で⼈柄理解 : ⽇本経済新聞
15. ... なんですが リリースや運⽤通していろいろとハマりポイントが... 実運⽤周りの話はなかなか検索しても出てこないツラみ
16. Slack アプリ開発の現状
17. Slack が多機能化・複雑化してきた Permissions Block Kit Surfaces Shortcuts, etc... 出来ることは増えたが、⼀⽅で開発コストも ツールやライブラリも充実してきてはいるがある程度慣れは必要 参考: 2020 年の Slack App 開発者が知るべき最新の Slack API 仕様 | PLAID engineer blog
18. プロダクトとしての Slack アプリの難しさ 安定性 さまざまなケースに対応して安定した機能提供が求められる 多様なユーザーステータス( シングルチャンネルゲストなど) や共有チャンネル での動作 etc... Enterprise Grid 対応 ( 後述) アプリの審査 Slack App Directory に登録するためには Slack の審査が必須 ≒ iOS や Android アプリ開発 審査に⼀定時間がかかるなど、⾃社でコントロールできない要素 権限のアップデートを含む更新をしたいときに意図しない挙動をすることも ( 後 述)
19. セキュリティ 情報管理体制など、企業からの問い合わせも多い 社内コミュニケーションツールとしてセンシティブな情報にアクセスできて しまう可能性 扱う情報によっては ISMS や P マークなどとの取得も要検討 ホメルくん、ノビルくんでは極⼒データの取得や保存しないように
20. Enterprise Grid ⼤企業向けに複数の WS を組織でまとめられるもの プロダクトとしてちゃんとマネタイズしようと思うと対応不可避 単に WS まとめられる以上に様々な機能 参考: What is Slack Enterprise Grid? | Slack リクルートが「乱⽴ Slack 」の社内統⼀へ、「Enterprise Grid 」に移⾏中【週刊 Slack 情報局】 - INTERNET Watch
21. Enterprise Grid の主なハードル 1. Enterprise Grid 特有の挙動 2. Enterprise Grid の動作検証
22. Enterprise Grid 特有の挙動 例 EG 内の WS 間でアカウント共通化 (WS A と WS B で同じユーザーとして扱われ る) その結果 DM が WS またいで共通化、通知は最後にいた WS に⾶んでくる これだけだとふーん、という感じだが、Slack アプリで DM 使ってる場合や やこしい問題が ( 後述) 共有チャンネルに、外部 WS との共有( is_ext_shared ) に加えて組織内での WS との共有という内部ステータスが追加( is_org_shared ) 組織外 WS と組織内 WS を同時に共有することはできない模様
23. 権限周りや EG 内の複数の WS にいる場合の挙動など、普段 EG 使ってない⼈か らすると結構想定外の挙動することが多い 少なくともドキュメントはざっくり眺めておいたほうが良い(Building apps in Enterprise Grid | Slack) Enterprise Grid を⾒越した設計が必要 そのプロダクトが Enterprise Grid 環境下でどう機能すべきか？ ホメルくんで設計考慮できておらず⼀部インストールできない問題もあった
24. Enterprise Grid の動作検証 申請することで Sandbox 環境の取得が可能 https://api.slack.com/enterprise/grid/testing ⼤体申請して 1~2 ⽇くらいでもらえた 2 つの Enterprise Grid 環境を付与される、共有チャンネルの動作検証も可能 Enterprise Grid を利⽤している企業も、Enterprise Grid の管理権限がない場合、 申請したほうが無難 昔は⼀部付与に条件あった気がしたが、現状は⽐較的気軽に付与してもらえそ う？
25. 実際にあったハマリポイント
26. Sign in with Slack 問題
27. Sign in with Slack とは？ Slack が提供する OAuth 認証 ⼀定プロダクトとして機能追加していきたい場合、Web 側の対応も不可⽋ Slack アプリとの親和性も⾼く、初期の認証機能としてはリーズナブル
28. 起きている問題 ( 現在進⾏系 ) 1. OAuth の Redirect URL はアプリの管理画⾯から登録する必要あり ( 登録されてい るもの以外はエラー) 2. Sign in with Slack ⽤にアプリのインストールとは別のエンドポイント追加したい 3. リリース後に変更を加える場合、Development copy というものが作成され、本 番とは別に設定が管理されている 4. レビューのために動作確認したいが、どうやら挙動としては本番アプリのものを 参照しまっている模様 ( おそらくバグ？) 5. 動作確認できずレビューにもだせず 6. 詰む
29. 現在問い合わせ中、権限追加して申請するようにとのことで申請 & 承認待ち ( 今 週⽔曜の話) 上記シューティングしている中で、申請前のアプリだと Permission に identity.basic がなくても動作していたが、どうやらリリース後のアプリでは その権限がないとエラーになることも判明 また、上記とは直接関係ないが、Sign in with Slack のオプションとして WS の ID を渡すことでログインできる WS を限定できるはずだが、こちらもバグでエラー になってしまう模様 参考: oauth_authorization_url_mismatch on oauth.v2.access when url includes team parameter · Issue #1017 · slackapi/node-slack-sdk
30. というわけで Sign in with Slack の導⼊を検討している場合は OAuth & Permission > Scopes > User Token Scopes に identity.basic の追加を忘れずに identity.team など必要な場合はそちらも適宜追加する ( 参考) また権限追加更新を伴うアップデートは現状だとかなりややこしいので、スケジ ュールに余裕ある場合は⼀定まで機能作りきったほうが結果早いという可能性も 問い合わせて申請にいくまで⼤体 2 週間ほどかかった そもそもアプリのアップデート⾃体どうするのがベストかムズい
31. Enterprise Grid の DM 問題
32. Enterprise Grid では WS 間でユーザーや DM は共通 ( 前述) Slack アプリで bot が BlockKit のModal でインタラクションを前提としたメッセ ージを DM に⾶ばすと次のような現象が起こる
33. 1. Enterprise Grid 内にWS 1 とWS 2 が存在 2. ユーザー A がWS 1 とWS 2 に join 3. WS 1 で Slack アプリをインストール (WS 2 には未インストール) 4. アプリからWS 1 のユーザー A に DM を送る 5. ユーザー A の Slack 上のアクティビティが最後WS 2 だった場合、WS 2 側で通知 が来る (!) 6. WS 2 でユーザーがメッセージから Modal を開く 7. Submit しようとすると認証エラーが発⽣
34. 何が起きている？ 1. WS 2 で DM から Modal を開くとき Slack からサーバーにはWS 1 のユーザー A としてイベントが送られる Actions 経由でのイベントはそのメッセージが送られたWS のもの(WS 1) として処理される模様 2. Modal から Submit しようとするとき Slack からサーバーにはWS 2 のユーザー A としてイベントが送られる Modal 経由の場合、Modal をひらいたWS のもの(WS 2) として処理される 模様 → 結果WS 2 では未インストールなので認証エラーに
35. どうやって回避するか？ ( ⼀時回避策 ) メッセージに WS 1 へのリンクを⼊れておく 参考: Reference: Deep linking into Slack | Slack 現在はこれで⼀時的に回避 WS の切り替えが多少楽にはなるのでまだまし とはいえめんどくさい...
36. どうやって回避するか？ ( 根本対応 ) Modal を開くときに view の private_metadata にWS 1 の id などを仕込んでおく ( と 解決できそう、たぶん) private_metadata は HTML の form でいうところの hidden タグ的なもの ( だと 理解) ただし Bolt for JavaScript の v2.1.0 以上かつv2.2.3 以下( 現時点での最新) で @slack/oauth での認証処理を⾏っている場合、上記パラメータ抜いてくるの⼀ ⼯夫いるので注意
38. ここまでツラみばかりあげてしまいましたが とはいえ、Slack は多くの Web 系企業を中⼼に利⽤されており、エントリーポイ ントとしては⾮常に強⼒ コロナ禍の⽂脈もあり、Slack アプリはプロダクト次第で導⼊ハードル 、利⽤ 率やエンゲージメントが する可能性 今後も Colla ( コラ) のアップデートを通じてみなさんがコロナ時代を楽しく⽣き抜 くためのサポートさせていただければと思いますので、まだ利⽤されてない⽅は ぜひぜひインストールを、利⽤されてる⽅はどしどしフィードバックください [PR]
39. 素敵な Slack アプリ開発ライフを
40. We are hiring!? 業務委託・副業でお⼿伝いいただける⽅は Welcome です お気軽にDM などでご連絡ください
41. Colla の技術スタック Node.js TypeScript Bolt for JavaScript Nest.js (not Next.js or Nuxt.js) TypeORM Bull Google App Engine PostgreSQL Redis Docker GitHub Actions: CI, Deploy Sentry
42. END