打ち合わせ みんな多忙で 草生えるwww

Dec 21, 2017 13:49 · 3583 words · 8 minute read Node.js ChatOps 会議 Mattermost ews

字(草)余り。


この記事はFUJITSU Advent Calendar 2017 - Qiita 22日目の記事です。 記事の内容は全て個人の見解であり、執筆内容は執筆者自身の責任です。所属する組織は関係ありません。

はじめに

打ち合わせの調整を依頼されて、みんな多忙で入れる隙間も無いと草生えますよね。

生やしましょう。

Mattermostでスケジュール可視化&調整

去年に引き続きMattermostネタです。 (去年は技術記事じゃなかったことを反省しながら)

MattermostはMattermost Inc.社が開発しているSlack AlternativeなOSSのチャットツールです。 https://about.mattermost.com/ https://github.com/mattermost


MattermostのInteractive Message Button使って何か作りたくて、スケジュール可視化&チャットから会議予約なモノを作りかけました。

kaakaa/matter-meeting: [PoC] Sending meeting request to Exchange from Mattermost

実用的なところまで行き着けなかったので表現弱めに。コンセプト実装とお受け取りください。

概要

こんな感じで動きます。

user_genarated_image.gif

Mattermostから打ち合わせ参加者のメアドを指定すると、現在から1週間後までの参加者全員のスケジュールをGitHubの草風に表示。さらにはInteractive Message Buttonから会議予約を飛ばすこともできたりします。

Exchangeから予定を取得にはEWSのGetUserAvailabilityというAPIを利用しており、このAPIが全員の予定の中から空いている時間をqualityというフィールド付きで返してくれます。SuggestionQuality | Ews JavaScript Apiqualityはどうも0~3までの整数で表されるようなので、その値をそのまま草の濃淡として表示しています。

草の色は白に近いほど皆の予定が空いており、緑が濃いほど予定が詰まっていることを示しています。

つまり、みんな忙しいと草生えるwww (深夜帯が草だらけなのは実装の都合上です。要検討事項。)

構成

ざっくりこんな構成で動いてます。

Architecture.png

Slash Commandからリクエストを受けると、Exchange Serverへ問い合わせをし、そのレスポンスからMattermostへのBot投稿と草用のSVG画像を生成。 Bot投稿のボタンを押すと、Exchangeへ会議予約のリクエストが送られるという感じ。

Exchangeサーバーに繋ぐ部分にews-javascript-apiを使ってるのに引きずられて、慣れないNode.js使ってるのでPromiseの使い方がとても怪しい。 (そして型がない言語だからか、コード書いててもmodelが生えない…草は生えるのに…)

要素技術の紹介

Mattermost

Custom Slash Command

Mattermostでは自作のSlash Commandsを登録できます。 少し前にこれを使って投票機能みたいなのも作ってました。

今回は自作Slash CommandsサーバーのレスポンスにMesssage Attachmentsを使用し、ちょっとリッチなフォーマットで反応できるようにしています。

Message Attachmentsは、Slash Commandsのレスポンスとして下記のようなJSONをMattermostに返すと

{
  "attachments": [
    {
      "fallback": "test",
      "color": "#FF8000",
      "pretext": "This is optional pretext that shows above the attachment.",
      "text": "This is the text of the attachment. It should appear just above an image of the Mattermost logo. The left border of the attachment should be colored orange, and below the image it should include additional fields that are formatted in columns. At the top of the attachment, there should be an author name followed by a bolded title. Both the author name and the title should be hyperlinks.",
      "author_name": "Mattermost",
      "author_icon": "http://www.mattermost.org/wp-content/uploads/2016/04/icon_WS.png",
      "author_link": "http://www.mattermost.org/",
      "title": "Example Attachment",
      "title_link": "http://docs.mattermost.com/developer/message-attachments.html",
      "fields": [
        {
          "short": false,
          "title":"Long Field",
          "value":"Testing with a very long piece of text that will take up the whole width of the table. And then some more text to make it extra long."
        },
        {
          "short":true,
          "title":"Column One",
          "value":"Testing"
        },
        {
          "short":true,
          "title":"Column Two",
          "value":"Testing"
        },
        {
        "short":false,
        "title":"Another Field",
        "value":"Testing"
        }
      ],
      "image_url": "http://www.mattermost.org/wp-content/uploads/2016/03/logoHorizontal_WS.png"
    }
  ]
}

こんな感じの投稿を作ってくれます。

(参考: Message Attachments — Mattermost 4.5 documentation)

メッセージが5行以上の時は省略表示もしてくれるのも良い感じです。 最近、Mattermostのコアチームを真似てGHEのアクティビティをMattermostに流したりしてるのですが、コレを使うと長いIssueでも良い感じに表示してくれるので気に入ってます。

Interactive Message Button

ChatOps黎明期のBotはメッセージを投稿するだけでしたが、最近のBotはメッセージに選択肢を付けてくれます。 Slackには昔からある機能みたいで、GolangでSlack Interactive Messageを使ったBotを書く - Mercari Engineering Blogを見ながら面白そうだな~なんて思ってたら、Mattermostにもやってきました。(PLT-6403: Interactive messages by ccbrown)。 Mattermostでは今のところボタンのみの対応ですが。

poll.gif (参考: Interactive Message Buttons (Beta) — Mattermost 4.5 documentation

今回は、調整した予定の中でもっとも参加可能人数が多い時間をInteractive Message Buttonとして表示しています。多すぎると訳分からなくなりそうだったので最大10個まで表示。 ボタンを押すと会議出席依頼が飛ばせるというアレ。べんり。

meeting2_0.png

Interactive Message Buttonの作り方は、先述のMessage Attachmentsのレスポンスの中にintegrationというフィールドとして指定することで作れます。

んで、ボタンを押すとhttpリクエストが飛ばされるというアレ。夢が広がりますね。はい。

ボタンだけでも十分遊べそうですが、セレクトボックスとかチェックボックスなんかも加わると更に夢が広がりそうだなぁ。まとまった時間とってコントリビュートしたいなぁ。

Exchange

予定の取得や会議予約を飛ばしたりするのはews-javascript-apiを使っています。 昔はews-java-apiを使って遊んでいましたが、歳のせいかJavaを書くのが辛くなってきました。

ews-javascript-apiはユースケース情報が転がってない気がするので、こんな感じで増やしていけると良いですね。

ただ、これ便利なんですが、気を許すと全社員宛のリクエストを飛ばすことになりかねなかったりするので、指定できるメアドにはホワイトリスト方式を採用しています。マジでここだけ注意な。

一応設定ファイルで正規表現指定できるけど、仲間内のメアドだけリストで指定しておくのが安全です。ews-javascript-api使って自分の部門だけに制限するとかも出来る…のかな?

草生やす

サーバー側でnunchucks テンプレートにスケジュール情報を流し込み、SVG作ってOSSのS3互換オブジェクトストレージであるMinioに投げてます。 ここで生成した草画像はMattermostのMessage Attachmentsのimage_urlに指定して表示させてます。

最初はsvg2png使って画像ファイル化してたけど、Message Attachmentsで指定したURLはimgタグで読み込んでるようなので、SVGのままでも行けるじゃん、と後で気づきました。

Minio

生成したSVGは、上述のようにMinioに格納してURL指定で取得できるようにしています。 スラッシュコマンドを実行するごとにshortidでユニークIDらしき物を作って、そのIDをファイル名としてSVGを保存してます。

SVGはローカルファイルとして格納しても良いかとも思ったのですが、なんとなくMinioを使ってみたかったので。 一定時間経ったSVGは削除するソリューションも欲しくなってます。

Minioだと少しヘビーな気がするのと、ランダム文字列とはいえ誰でも見えるところに調整結果の画像を置くのは少し忍びない気もしていますが、まぁとりあえず。

テストは?

まだ無い

コード品質は?

嘲笑するならパッチくれ

問題

実用に向けた最大の課題は、ews-javascript-api使うために指定したアカウントからしか会議出席依頼を飛ばせないところ。みんなで使うと私のスケジュールが凄いことになりそう。 Bot社員が求められている。

あと細々した改善点もたくさん。

  • 30分間の予定しか想定されてない
  • 現在から1週間後までの間しか調べてない(日時指定できるようにするとコマンドが複雑になるのがアレ)
  • メアド毎回入力するのが面倒 (Mattermostの@channel使うとチャンネル内全員対象にする、とか出来ると理想)

などなど。 今回用のネタとして開発したものなので突き詰めるつもりもないですが(たぶん)

Mattermostについて

最近、UberがSlack/HipChatを諦めてMattermostベースのコミュニケーションプラットフォームであるuChauというのを作り始めているというニュースがあり。まだまだユーザー数を伸ばしていきそうな感じがします。 The Road to uChat: Building Uber’s Internal Chat Solution

機能的にも、この記事でも取り扱ったInteractive Message Buttonや、Plugins機能なんかも追加されてきているので、まだまだいろいろ遊べるようになっていく予感。

開発も活発なのでこれからも期待しています。

おわりに

お仕事ではみんなで大草原回避しましょう。

tweet Share