Pekko HTTP Client を使って Mattermost botを作る

Posted at 2025-05-27

みなさんごきげんよう。今回はPlayFrameworkに搭載されているPekko-HTTPを使って、Mattermost botを作成してみたのでそのしょうかいをしまs。

はじめに

Mattermost とは

Mattermostは、Slackに似たチャットツールです。Dockerを使ってセルフホストできるので、Synology NASを飼っている逸般の誤家庭では、Container Managerを使って無料で¹運用することができます。

Slack無料版だとメッセージが消えたりするので、メッセージを残したい場合は選択肢にあるかもです。会社でSlackを使っていて自動化のためにSlack botを作ってみたいが、家で動作確認してみたい場合、家でMattermostを立ててMattermost botを動かしてみるのも良いです。Mattermost botはSlack botとある程度互換性があるようです。

PlayFramework

PlayFrameworkはScala用Webアプリケーションフレームワークです。私が得意なので、今回はこれを使います。PlayFrameworkはApache Pekkoを基盤に作られています。

Apache Pekko

Apache Pekkoはアクターモデルを提供するライブラリです。それをベースにHTTPクライアント機能が提供されています。今回はMattermostサーバーとの通信にPekko HTTPを使います。

Bot作成

PlayFrameworkをベースに作ると、常時起動やPekkoの初期設定をせずに済むので、ロジックに集中できます。

0. PlayFrameworkを用意

ScalaをCoursierでインストールしておきます。

適当なフォルダを作ってこれらのファイルを作成します。

project/build.properties

sbt.version = 1.11.0

project/plugins.sbt

addSbtPlugin("org.playframework" % "sbt-plugin" % "3.0.7")

build.sbt

ThisBuild / version := "0.1.0-SNAPSHOT"

lazy val root =
  project.in(file("."))
    .enablePlugins(PlayScala)
    .settings(
      name := "mattermostbot", // アプリケーションの名前
      scalaVersion := "3.7.0",
      libraryDependencies ++=
        Seq(
          "net.bis5.mattermost4j" % "mattermost-models" % "0.25.0"
        ),
      dependencyOverrides ++=
        Seq(
          // jackson系のバージョンを、Playが使っているものに揃える
          "com.fasterxml.jackson.core" % "jackson-annotations" % "2.14.3",
          "com.fasterxml.jackson.core" % "jackson-core" % "2.14.3",
          "com.fasterxml.jackson.core" % "jackson-databind" % "2.14.3",
          "com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.14.3"
        )
    )

ログの設定はなんでも良いですが、とりあえず下記をコピペでもOKです。

conf/logback.xml

<?xml version="1.0" encoding="UTF-8" ?>

<!-- https://www.playframework.com/documentation/latest/SettingsLogger -->

<!DOCTYPE configuration>

<configuration>
    <import class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"/>
    <import class="ch.qos.logback.classic.AsyncAppender"/>
    <import class="ch.qos.logback.core.FileAppender"/>
    <import class="ch.qos.logback.core.ConsoleAppender"/>

    <appender name="FILE" class="FileAppender">
        <file>${application.home:-.}/logs/application.log</file>
        <encoder class="PatternLayoutEncoder">
            <pattern>%date [%level] from %logger in %thread - %message%n%xException</pattern>
        </encoder>
    </appender>

    <appender name="STDOUT" class="ConsoleAppender">
        <encoder class="PatternLayoutEncoder">
            <pattern>%highlight(%-5level) %logger{15} - %message%n%xException{10}</pattern>
        </encoder>
    </appender>

    <appender name="ASYNCFILE" class="AsyncAppender">
        <appender-ref ref="FILE"/>
    </appender>

    <appender name="ASYNCSTDOUT" class="AsyncAppender">
        <appender-ref ref="STDOUT"/>
    </appender>

    <logger name="play" level="INFO"/>
    <logger name="module" level="DEBUG"/>

    <!-- Off these ones as they are annoying, and anyway we manage configuration ourselves -->
    <logger name="com.avaje.ebean.config.PropertyMapLoader" level="OFF"/>
    <logger name="com.avaje.ebeaninternal.server.core.XmlConfigLoader" level="OFF"/>
    <logger name="com.avaje.ebeaninternal.server.lib.BackgroundThread" level="OFF"/>
    <logger name="com.gargoylesoftware.htmlunit.javascript" level="OFF"/>

    <root level="WARN">
        <appender-ref ref="ASYNCFILE"/>
        <appender-ref ref="ASYNCSTDOUT"/>
    </root>

</configuration>

今回はサーバー機能を使わないのですが、ビルドのために空の conf/routes ファイルを用意しておきます。

conf/routes

# 中身は空

最低限のアプリケーションの設定を書いておきます。

conf/application.conf

play.application.loader = BotApplicationLoader
play.filters.hosts.allowed = [ ...省略 ]
play.http.secret.key = ${?PLAY_HTTP_SECRET_KEY}
mattermost.host = ${MATTERMOST_HOST}
mattermost.token-id = ${MATTERMOST_ACCESS_TOKEN}
mattermost.bot-id = ${MATTERMOST_BOT_ID}

それぞれの設定の詳細はこちら

play.application.loader - https://www.playframework.com/documentation/latest/ScalaCompileTimeDependencyInjection#Application-entry-point
play.filters.host.allowed - https://www.playframework.com/documentation/latest/AllowedHostsFilter#Configuring-allowed-hosts
play.http.secret.key - https://www.playframework.com/documentation/latest/Deploying#The-application-secret
mattermost.host - Mattermostの MM_SERVICESETTINGS_SITEURL 環境変数 https://docs.mattermost.com/configure/environment-configuration-settings.html#site-url
mattermost.token-id - botアカウント作成時に表示されるトークンID。1回しか表示されないので注意。
mattermost.bot-id - botアカウントのユーザーID。これはMattermost上で確認できなかった。websocket接続時に表示されるので、それをメモっておく。

今回はコンパイル時DIを使うため、アプリケーションローダーを用意します。ランタイムDIでも良いですが、自分が好きなのでこっちで書きます。

app/BotApplicationLoader.scala

import play.api.ApplicationLoader.Context
import play.api.{Application, ApplicationLoader, LoggerConfigurator}

class BotApplicationLoader extends ApplicationLoader:
  def load(context: Context): Application =
    // https://www.playframework.com/documentation/latest/ScalaCompileTimeDependencyInjection#Configuring-Logging
    LoggerConfigurator(context.environment.classLoader).foreach:
      _.configure(context.environment, context.initialConfiguration, Map.empty)

    BotComponents(context).application

コンパイル時DIで用意するコンポーネントを作成します。

app/BotComponents.scala

import com.fasterxml.jackson.databind.{DeserializationFeature, ObjectMapper}
import module.{MattermostClient, MattermostClientModule}

import play.api.ApplicationLoader.Context
import play.api.BuiltInComponentsFromContext
import play.api.routing.Router
import play.filters.HttpFiltersComponents
import router.Routes

class BotComponents(context: Context)
    extends BuiltInComponentsFromContext(context)
    with HttpFiltersComponents:
  // https://www.playframework.com/documentation/latest/ScalaCompileTimeDependencyInjection#Providing-a-router
  lazy val router: Router = Routes(httpErrorHandler)

  // jacksonを使ってjsonのシリアライズ/デシリアライズを行います。
  private val objectMapper: ObjectMapper =
    ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
  // PekkoHTTPを使ってサーバーとやりとりするクライアントです。
  private val mattermostClient: MattermostClient =
    MattermostClientModule(actorSystem, objectMapper, configuration)
  mattermostClient.connect()

1. Pekko HTTP WebSocketを使って投稿されたメッセージを取得

Mattermost botでは、投稿されたメッセージをWebSocketを使って取得します。Pekko HTTPを使ってWebSocket接続してみましょう。

app/module/MattermostClient.scala

package module

trait MattermostClient:
  def connect(): Unit

いわゆるWebアプリケーションのクリーンアーキテクチャーにおける「サービス」は、Playでは「モジュール」という形で実装します。ただし、今回はコンパイル時DIなので、この実装自体は不要です。