はじめに

みなさん、こんにちは。
KDDIウェブコミュニケーションズのTwilio事業部エバンジェリストの高橋です。

今回はTwilio Syncを使って、Twilio上で簡易的なDB機能を実現するためのライブラリをご紹介します。

TwilioSyncLibrary for TwilioCLI

Twilio CLI Serverless で Twilio Sync を簡単に扱うためのライブラリです。
Assets 内のプライベートファイルとして利用します。

Twilio Sync とは？

• Twilio Sync
• 複数のデバイス間で情報を同期させるためのサービス
• WebSocketやSocket.ioのようなリアルタイム通信プラットフォーム
• Syncは、受け取ったデータをTwilio上に保存してから配信する
• Sync上のデータは、TTLオプションにより生存時間を設定できる
• Document / List / Map / Message Stream の4種類のデータを扱うことが可能（本ライブラリではMessage Streamには非対応）

扱えるオブジェクトタイプの種類

• Documentオブジェクト
  単一のJSON形式オブジェクト
  オブジェクト名は最大320文字
  1データのサイズは最大16KB
  単純な値のPUB/SUBに向いている
  履歴を取るような使い方には向いていない
  利用例：コールセンターでオペレータの稼働確認など
• Listオブジェクト
  格納順が保証されたJSONリスト
  オブジェクト名は最大320文字
  1データのサイズは最大16KB
  最大格納レコード数は1,000,000
  時系列で確認したい履歴を取るような使い方に向いている
  利用例：ログの保存など
• Mapオブジェクト
  格納順が保証されないKey/Value形式のJSONデータ
  オブジェクト名は最大320文字
  1データのサイズは最大16KB
  最大格納レコード数は1,000,000
  Keyで検索して、内容を記録するような使い方に向いている
  利用例：オペレータの内線番号やスキルなどの登録など

その他の制限事項については、こちらをご確認ください。

Libraryを使って実現できる機能

Twilio Functions から簡単にTwilio Sync のオブジェクトを生成したり、データを書き込んだり、更新・削除が可能です。これにより、Twilio内部でデータベースのような機能を実現することができます。

なお、本ライブラリでは、Message Streamオブジェクトについて対応していません。

必要要件

package.jsonより抜粋

"devDependencies": {
    "assert": "^2.0.0",
    "dotenv": "^8.2.0",
    "jest": "^25.4.0",
    "twilio-run": "^2.7.0"
},
"dependencies": {
  "twilio": "^3.46.0"
}

これ以外に、twilio CLI 2.1.0以降が必要です。

インストール

適当な作業ディレクトリにライブラリをCloneします。

% git clone https://github.com/mobilebiz/twiliosync-library.git
（省略）
Unpacking objects: 100% (35/35), done.
% cd twiliosync-library
% tree
.
├── README.md
├── __tests__
│   ├── TwilioSyncDoc.js
│   ├── TwilioSyncList.js
│   └── TwilioSyncMap.js
├── assets
│   └── twilioSync.private.js
├── functions
│   ├── twilioSyncDoc.js
│   ├── twilioSyncList.js
│   └── twilioSyncMap.js
├── package-lock.json
└── package.json

3 directories, 10 files

次に、別の作業ディレクトリに移動してから、Twilio CLIを使って Twilio Sync サービスを作成します。

% twilio api:sync:v1:services:create --friendly-name [サービス名]

SID                                 Unique Name  Friendly Name
ISe530cd01d9fa91a6b6e21d8e1b18e4ad  null         サービス名

作成した際に表示される SID　（ISから始まる文字列）を控えておきましょう。

つぎに、 Serverless プロジェクトを作成してください。

% twilio serverless:init --template blank [プロジェクト名]
（以下略）
% cd [プロジェクト名]
% cp .env.sample .env

次に、先程cloneしたプロジェクト内にある.env.sampleを参考に、ご自分の作業ディレクトリにある.envの内容をご自分の環境に合わせて変更します（ACCOUNT_SIDとAUTH_TOKENは自動で設定されています）。

次に、NPMパッケージをインストールします。

% npm install

最後に、先程cloneしたプロジェクトの assets フォルダ内にあるtwilioSync.private.jsをご自分の Twilio CLI Serverless 作業ディレクトリ内の assets にコピーしてください。

Usage

Documentオブジェクト

• createDocument(docName, data, ttl)：Documentオブジェクトの生成
• getDocument(docName)：Documentオブジェクトの取得
• removeDocument(docName)：Documentオブジェクトの削除
• removeDocumentById(documentId)：Documentオブジェクトの削除（ID）
• searchDocument(docName)：Documentオブジェクトの検索
• updateDocument(docName, data, ttl)：Documentオブジェクトの更新

Listオブジェクト

• createList(listName, ttl)：Listオブジェクトの生成
• getList(listName)：Listオブジェクトの取得
• searchList(listName)：Listオブジェクトの検索
• removeList(listName)：Listオブジェクトの削除
• removeListById(listId)：Listオブジェクトの削除（ID）
• addListItem(listName, data, ttl)：Listアイテムの追加
• getListItem(listName, key)：Listアイテムの取得（keyを指定しないと全アイテム）
• removeListItem(listName, key)：Listアイテムの削除

Mapオブジェクト

• createMap(mapName, ttl)：Mapオブジェクトの生成
• getMap(mapName)：Mapオブジェクトの取得
• searchMap(mapName)：Mapオブジェクトの検索
• removeMap(mapName)：Mapオブジェクトの削除
• removeMapById(mapId)：Mapオブジェクトの削除（ID）
• setMapItem(mapName, key, data, ttl)：Mapアイテムの更新（なければ追加）
• getMapItems(mapName)：すべてのMapアイテムを取得
• getMapItem(mapName, key)：keyが一致するMapアイテムの取得
• removeMapItem(mapName, key)：Mapアイテムの削除

使い方のサンプルは、本プロジェクトの functions フォルダ内にある twilioSyncDoc.js twilioSyncList.js twilioSyncMap.js をご覧ください。

Note

たとえば、電話番号をドキュメント名として作成し、電話番号に付随する情報をデータとして格納していくことで、簡易的な電話帳として使うなどの応用が可能かとおもいます。

※現在のバージョンでは、排他制御は考慮していません。

まとめ

Twilioには FaaSのFunctionsや、StorageのAssetsなどがありますが、データベース機能がないのが難点でした。
Twilio Syncを使えば、外部のDBを使わなくても簡易的なDB機能が実現できるので、ぜひ使ってみてください。

Twilio（トゥイリオ）とは

https://cloudapi.kddi-web.com
Twilioは音声通話、メッセージング（SMS/チャット）、ビデオなどの 様々なコミュニケーション手段をアプリケーションやビジネスへ容易に組み込むことのできるクラウドAPIサービスです。初期費用不要な従量課金制で、各種開発言語に対応しているため、多くのハッカソンイベントやスタートアップなどにも、ご利用いただいております。

自己紹介
	高橋克己（Katsumi Takahashi） グローバル・インターネット・ジャパン株式会社　代表取締役 株式会社KDDIウェブコミュニケーションズ　Twilio事業部エバンジェリスト 2001年より大手通信事業者の法人サービスの教育に携わり、企業における電話のしくみや重要性を研究。2016年よりTwilio事業部にジョインし、Twilioを使ったスマートコミュニケーションの普及活動を精力的に行っている。