ニフクラ mobile backendでは認証やデータストア（クラウドデータベース）、ファイルストア（ファイルストレージ）、プッシュ通知など様々な機能があります。そして、サーバーレスで拡張できるスクリプト機能もあります。
しかし、実際のアプリ要件は多彩で、場合によっては他にも様々な機能が望まれます。すべての需要を満たすのは困難な場合もあります。そこで、NCMBのフロントとして動作するプロキシソフトウェアを開発中です。
このプロキシを使うことによって、小さなニーズはプロキシ側で実装できるようになります。一通りの動作はできるようになったので、使い方を紹介します。
追加する機能（予定）
現状は透過的なプロキシでしかありませんが、以下のような機能を実装する予定です。
- 認証をJSON Web Tokenに
- GitHub認証
- ソーシャル認証（標準ではサーバー認証が必要ですが、プロキシだけで認証できるように）
- WebSocket（リアルタイム通信）
- Webhooks
- 署名なしでデータストア操作
- 署名なしで実行できるスクリプト
- 全リクエストログ記録
他にもデータストアの集計機能、GraphQL機能なども追加できると便利そうです。なお、Webhooksなどの機能はプロキシ経由でしか実現できませんので注意してください（管理画面で操作しても実行されません）。
インストール
NCMBMania/ncmb-proxyのリポジトリをクローンします。
git clone git@github.com:NCMBMania/ncmb-proxy.git
ライブラリをインストールします。
npm i
設定の編集
setting.example.yml をコピーして setting.yml を作成します。そして、ファイル内にあるアプリケーションキー、クライアントキーをそれぞれお持ちのものに書き換えてください。
applicationKey: YOUR_APPLICATION_KEY
clientKey: YOUR_CLIENT_KEY
サーバーを起動
サーバーを起動する際には、以下のコマンドを実行します（まだ開発中なので、開発用サーバーが立ち上がります）。
npm run dev
例えばローカルの場合、 http://localhost:3000 にてサーバーが立ち上がります。
使い方
今回はJavaScript SDKでの使い方です。実際に利用するアプリケーション側でJavaScript SDKを初期化する際に、以下のように指定します。以下の例で分かるように、認証やデータストアとスクリプトは同じプロキシサーバーで提供されます。
const ncmb = new NCMB("YOUR_APPLICATION_KEY", "YOUR_CLIENT_KEY", {
fqdn: "localhost",
scriptFqdn: "localhost",
protocol: "http",
port: 3000
});
この fqdn や protocol 、 port を実際に運用するサーバーのものに書き換えて利用できます。本番運用できるレベルになったら、 protocol や port は不要でしょう。恐らく以下のようになるはずです。
const ncmb = new NCMB("YOUR_APPLICATION_KEY", "YOUR_CLIENT_KEY", {
fqdn: "example.com",
scriptFqdn: "example.com",
});
これでJavaScript SDKは直接ニフクラ mobile backendにはリクエストせず、 example.com へリクエストするようになります。
コードについて
実際のコードは編集する必要はありません。これまでのJavaScript SDKを使ったコードがそのまま実行できます。
ファイストアへのアップロード
const data = fs.readFileSync('./test.jpg');
await ncmb.File.upload('test.jpg', data);
スクリプト
// Get
await ncmb.Script
.query({name: 'test'})
.exec("GET", "script_test_get.js");
// Post
await ncmb.Script
.data({"name": "test"})
.exec("POST", "script_test_post.js");
// Put
await ncmb.Script
.data({"name": "test2"})
.exec("PUT", "script_test_put.js");
// Delete
await ncmb.Script
.query({name: 'test'})
.exec("DELETE", "script_test_delete.js");
まとめ
ニフクラ mobile backendは便利なmBaaSですが、機能が足りなくて別サービスと組み合わせて使うこともあるでしょう。そうした場合に2つのサービスをクライアントから呼び出すのではなく、プロキシを使うことで1つのサービスであるかのように利用できます。
開発はまだまだこれからですが、ぜひご期待ください。