FAQ

FAQ #

daab に関してよく寄せられるお問い合わせをまとめています。

ご質問は開発者登録後にご案内する direct のトークでもお伺いしております。ぜひご参加ください。

daab (direct agent assist bot) と daab SDK の関係は何ですか? #

daab の目的は、企業で使われている業務システムやクラウドサービスにチャットサービスの特徴 (スタンプや動画・画像、リアルタイム性、PUSH 通知等) を付与することで、ユーザの業務をより早く、より円滑にすることです。

direct においては、作成されたボットを daab、作成するためのツールや環境を daab SDK、と呼んでいます。

技術的には GitHub 社が開発している hubot を拡張したものになっています。hubot はスクリプトを差し替えることで個別のボットを作成できます。

当初は hubot と direct との接続部分 (Adapter) の提供だけを考えておりましたが、上述の目的のためには hubot 自体をカスタマイズしていくほうがシンプルであるという判断から、daab SDK という現在の提供方式をとらせていただいております。

ちなみに、daab は「ダーブ」と呼びます。弊社のマスコット、シモンくんの親友の名前と同じです。

ボットのプロフィールはどう設定すればいいですか? #

ボットのアカウントで direct にログインして、通常のユーザと同じようにプロフィールを設定してください。 また、ボットのプロフィールアイコンを公開していますので、ご活用ください。

ボットを動かすにあたって Node.js のバージョンに指定があれば教えて下さい #

LTS リリースをご利用ください。

必要な Node.js の最低バージョンは、ボットが利用している daab SDK のバージョンによって異なります。詳しくは「既存のボットを新しい daab SDK に更新するにはどうすればいいですか?」の対応表をご覧ください。

daab SDK で使われている hubot のバージョンは何でしょうか? #

https://github.com/lisb/hubot/releases をご確認ください。

今後も hubot の動向をチェックして、最新のバージョンをご提供していく予定です。

既存のボットを新しい daab SDK に更新するにはどうすればいいですか? #

ボットが利用している daab SDK のパッケージ (lisb-hubot、hubot-direct、direct-js) は、ボットのディレクトリにある package.json の dependencies に書かれたバージョン範囲にしたがって、npm install 時にインストールされます。そのため、SDK を更新するときは package.json のバージョン範囲を書き換えてから、依存パッケージをインストールし直します。

direct-js は hubot-direct が内部で利用するパッケージで、hubot-direct と一緒にインストールされます。各パッケージのバージョンの対応と、動作に必要な Node.js のバージョンは以下の通りです。

hubot-direct のバージョン範囲一緒にインストールされる direct-js必要な Node.js必要な npm
>=5 <64.x20 以上10 以上
>=4 <53.x18 以上10 以上
>=3 <42.x14 以上7 以上

lisb-hubot のバージョン範囲は、上記のいずれの場合も >=5 <6 です。

以下では、hubot-direct 4.x (direct-js 3.x) を利用しているボットを hubot-direct 5.x (direct-js 4.x) に更新する場合を例に手順を説明します。他のバージョンに更新する場合も、表の値を読み替えれば同じ手順で更新できます。バージョン範囲を変えずに、同じ範囲内の新しいバージョン (例: lisb-hubot 5.0.6 から 5.1.0) に更新するだけの場合は、Step 3 を飛ばして Step 4 から行ってください。バージョン固有の変更点は、末尾の「バージョンごとの注意点」から各パッケージのリリースノートをご覧ください。

稼働中のボットは、作業を始める前に停止してください (bin/hubot start で起動している場合は bin/hubot stop)。

daab CLI (daab コマンド) を更新しても、既存のボットの SDK は更新されません。また、既存のボットのディレクトリで daab init を実行しないでください。daab init は package.json や scripts/ などのファイルを確認なしで上書きします。

Step 1. 現在の環境を確認します #

ボットのディレクトリに移動し、現在利用している Node.js と daab SDK のバージョンを確認します。

$ cd mybot
$ daab version
node: v18.20.8
arch: arm64
platform: darwin
direct-js: 3.2.0
hubot-direct: 4.0.0
lisb-hubot: 5.0.6

daab version は node_modules ディレクトリの内容を表示するため、まだ npm install していない (node_modules ディレクトリが無い) 場合は、パッケージの行は表示されません。

daab コマンドは「初めての daab」の手順で npm install -g daab としてインストールしたものです。インストールしていない環境では npx daab version でも実行できます (初回は daab をダウンロードするかどうかの確認が表示されます)。

なお、daab --version は daab CLI 自体のバージョンを表示するコマンドで、SDK のバージョンは表示されません。

Step 2. Node.js を更新します #

更新先の SDK が必要とする Node.js のバージョン (上の表) を満たし、かつサポート期間内の LTS リリースに更新します。direct-js 4.x (hubot-direct 5.x) の場合、動作に必要な Node.js は 20 以上ですが、Node.js 20 はすでにサポートが終了しているため、22 以上の LTS リリースをご利用ください。

Node.js は 公式サイト のインストーラー、または Node.js のバージョン管理ツール (nvm など) で更新できます。npm は Node.js に同梱されているため、Node.js を更新すると一緒に更新されます。更新後、以下のコマンドでバージョンを確認します。

$ node -v
v22.23.4
$ npm -v
10.9.9

Step 3. package.json を編集します #

ボットのディレクトリにある package.json をテキストエディタで開き、以下の 2 箇所を変更します。

  • dependencies の hubot-direct を、更新先のバージョン範囲 (表の値) に変更します。lisb-hubot が >=5 <6 になっていない場合は、あわせて変更します。
  • engines の node と npm を、更新先の SDK が必要とする Node.js と npm のバージョン (表の値) に変更します。engines は Node.js や npm を実際に更新する設定ではなく、このボットが必要とする Node.js と npm のバージョンを宣言する項目です。

direct-js 4.x (hubot-direct 5.x) に更新する場合、該当部分は以下のようになります (抜粋)。

  "engines": {
    "node": ">= 20",
    "npm": ">= 10"
  },
  "dependencies": {
    "forever": "^4.0.0",
    "hubot-direct": ">=5 <6",
    "lisb-hubot": ">=5 <6",
    "lisb-hubot-redis-brain": "^1.0.0"
  },

Step 4. 依存パッケージをインストールし直します #

node_modules ディレクトリと package-lock.json を削除してから、npm install を実行します。Node.js のバージョンを変えた後は、以前の Node.js 向けにビルドされたモジュールが node_modules に残っていると起動に失敗することがあるため、削除してからインストールし直すのが確実です。package-lock.json を git などで管理している場合は、更新後に生成された package-lock.json もあわせてコミットしてください。

Linux/macOS の場合:

$ rm -rf node_modules package-lock.json
$ npm install

Windows (コマンドプロンプト) の場合:

> rmdir /s /q node_modules
> del package-lock.json
> npm install

Windows (PowerShell) の場合:

> Remove-Item -Recurse -Force node_modules, package-lock.json
> npm install

Step 5. 更新されたことを確認します #

daab version で、各パッケージが更新先のバージョン範囲に含まれるバージョンになっていることを確認します。

$ daab version
node: v22.23.4
arch: arm64
platform: darwin
direct-js: 4.0.0
hubot-direct: 5.0.0
lisb-hubot: 5.1.0

表示されるバージョンは例です。更新先の範囲に含まれるバージョン (ここでは hubot-direct が 5.x、direct-js が 4.x) になっていれば問題ありません。

Step 6. ボットを起動して動作を確認します #

ボットを起動し、普段利用している機能が動作することを確認します (daab run でも起動できます)。起動時やメッセージ受信時にエラーが出ていないか、hubot.log と hubot-err.log も確認してください。

$ npm start

更新先のバージョンで動作が変わる機能を利用している場合は、その機能もあわせて確認します。確認すべき点は「バージョンごとの注意点」をご覧ください。

Step 7. Dockerfile などの実行環境を更新します #

ボットを Docker で動かしている場合は、Dockerfile のベースイメージ (FROM node:<バージョン>) の Node.js も、Step 2 と同じ考え方で表の条件を満たす LTS リリースに変更し、イメージを作り直してから動作を確認します。

元に戻す場合 #

package.json の変更を元に戻し (git などで管理している場合は package.json と package-lock.json を更新前の状態に戻し)、Step 4 の手順で依存パッケージをインストールし直します。Node.js や Dockerfile を変更した場合は、それらも元に戻してください。direct-js 3.x 以前に戻す場合は libxmljs のネイティブモジュールが必要になるため、ビルド済みバイナリが提供されていない環境では、node-gyp が動作する環境 (Python と C++ コンパイラ) が必要です。

バージョンごとの注意点 #

更新先のバージョンにおける変更点や注意点については、各パッケージのリリースノートをご覧ください。

メールアドレスを利用しないアカウントで daab にログインする方法はありますか? #

アカウント管理グループに所属したメールアドレスを持たないユーザーで daab にログインする場合は、Email のところで "ボットのログインID" + "$" + "アカウント管理グループID" を入力します。

例えば「ボットのログイン ID」が botLoginId で「アカウント管理グループID」が accountGroupId の場合は以下のようになります。

$ daab login
Email: botLoginId$accountGroupId
Password:
logged in.

daab のアカウントを変更するにはどうすればいいですか? #

開発時は daab をテスト用のアカウントで実行していて、本番環境では別のアカウントに切り替えたい、といった場合は以下のようにしてください。

アカウント情報 (アクセストークン) は、環境変数 HUBOT_DIRECT_TOKEN に設定されます。 この環境変数をクリアしたあと、ボットを起動してください。

# linux/OSXの場合
$ unset HUBOT_DIRECT_TOKEN
$ bin/hubot
REM windowsの場合
> set HUBOT_DIRECT_TOKEN=
> bin\hubot

Redis への接続はどう指定したら良いですか? #

環境変数 REDIS_URL で指定します。REDIS_URL は lisb-hubot-redis-brain (オリジナルは hubot-redis-brain) の仕様に従います。フォーマットは以下の通りです。

redis://${hostname}:${port}/${prefix}

何も指定しない場合は下記の表に沿ったデフォルト値が使われます。

デフォルト値
hostnamelocalhost
port6379
prefixdaab を起動したディレクトリ名

この REDIS_URL を元に Redis 上のキーは ${prefix}:storage になります。

“Frame size of X bytes exceeds maximum accepted frame size” というログが出力されてボットが正常に稼働しません #

daab が内部で利用している WebSocket client の最大許容フレームサイズ (のデフォルト値) を超えてしまうとこのログが出力されます。

daab では環境変数 HUBOT_DIRECT_WS_CONFIG を指定することでこの最大値を変更することができます。

Step 1. npm ls で direct-js と hubot-direct のバージョンを確認します #

まだ npm install していない (node_modules ディレクトリが存在しない) 場合は Step 2 に進んでください。

node_modules ディレクトリが存在している場合は、依存関係に以下のバージョンが含まれていることを確認してください。

  • direct-js >=1.101.1
  • hubot-direct >=1.0.1

含まれていた場合は Step 4 へ進んでください。 含まれていなかった場合は一度 node_modules ディレクトリを削除してから Step 2 へ進んでください。

Step 2. ボットの package.json を確認します #

lisb-hubot のバージョンレンジが ^3.3.2、もしくは >=3.3.2 を参照する指定になっていれば問題ありません。 異なる場合は変更してください。

Step 3. npm install します #

これで必要なバージョンのライブラリがそろいます。

Step 4. ボット起動時の環境変数に HUBOT_DIRECT_WS_CONFIG を追加します #

まずは最大フレームサイズ (Byte) を決めてください。基本的には exceeded ログの値よりも大きくなるようにしてください。

値を決定したら以下の形式 (JSON を stringify した文字列) で環境変数に指定します。

HUBOT_DIRECT_WS_CONFIG='{"maxReceivedFrameSize":3145728}'

上記の HUBOT_DIRECT_WS_CONFIG を .env に追加する場合は、全体を囲っている ' を取り除いてください。

QUOTA_EXCEEDED_ERR というエラーが出ます #

内部で使う LocalStorage のサイズ上限を超えると出力されます。デフォルトは 5MiB (= 5 * 1024 * 1024) です。

環境変数 HUBOT_DIRECT_STORAGE_QUOTA にバイト数を指定することで上限を変更できます。 例えば上限を 10MiB に変更したい場合は以下のようにします。

HUBOT_DIRECT_STORAGE_QUOTA=10485760

ログレベルはどうすれば変更できますか? #

環境変数として HUBOT_LOG_LEVEL を指定すると変更できます。デフォルトは INFO です。

デバッグログを出力したい場合は HUBOT_LOG_LEVEL=DEBUG を指定してください。

ボットでExcelファイルを操作することは可能でしょうか? #

daab に Excel ファイルを直接操作する機能はありません。外部ライブラリを利用して実現してください。 具体的な使用方法や機能については、ご利用のライブラリのドキュメントをご参照ください。

HTTPプロキシ利用下でボットを動かすことは可能でしょうか? #

環境変数 HTTP_PROXY にプロキシサーバの URL と ポート番号 を設定することで動かすことができるようになります。

HTTP_PROXY=http://<プロキシサーバのIPもしくはURL>:<ポート番号>

プロキシサーバのIPアドレスが 192.168.0.1、ポート番号が 8080 の場合は以下のようにします。

HTTP_PROXY=http://192.168.0.1:8080