1. HOME
  2. ブログ
  3. IT技術
  4. Firestoreエミュレータ+Jestでセキュリティルールをテストする!

Firestoreエミュレータ+Jestでセキュリティルールをテストする!

Firestore(ファイアストア)とは?

「Firestore」は、Google製のスケーラブルなドキュメントデータベースです。

他の Firebase サービス群と同様に、サーバやスケーリングの管理が不要なため、開発者はフロントエンドの開発に集中することができます。

また、従来のデータベースは、サーバプログラムを通して「データの取得・更新」を行うのが一般的です。

それに対して「Firestore」では、サーバを介さず、フロントエンドから直接、データを取得・更新するかのように扱う事ができるのです。

セキュリティルールが肝

Firestore では、「セキュリティルール(データの読み書きの許可・拒否ルール)」を記述したファイルを設置する事で、データへのアクセス制限を設定することができます。

非常に有能かつ便利な Firestore ですが、セキュリティルールの設定には細心の注意を払う必要があります。

Firestore の利点

クライアントコードに直接、データの「取得・更新」処理を書くことが出来るのが、Firestore の大きな利点の1つです。

ですが、同時に Firestore への接続情報を、クライアントコードに記述する事が必要となります。

例えば、ウェブクライアントから Firestore を利用する場合、記述された接続情報は、知識のある訪問者であれば容易に確認することができます。

データを悪用・破壊される恐れ

セキュリティルールの設定に不備がある場合、取得した接続情報を使用して、データの「取得」や「改ざん・削除」が可能となります。

なので、訪問者が悪意のあるユーザであった場合、データを悪用されたり、破壊される恐れがあります。

データの悪用や破壊を防ぐためには、セキュリティルールの設定に細心の注意を払う必要があります。

つまり、データへのアクセスを適切に制限する事が重要となります。

セキュリティルールを作成する

今回は、肝となるセキュリティルールを、「Firestoreエミュレータ」とFacebook製のテストフレームワーク「Jest」を使って、テストする方法を解説していきたいと思います。

まずは、「Jest」と「Firestoreエミュレータ」をセットアップします。

その後、実際にサンプルテストとセキュリティルールを作成していきたいと思います。

Jest(ジェスト)のセットアップ

必要な環境

Node.jsv8.0.0 以上

Jest環境の構築

まず最初に、「Jest」を使うために必要なパッケージをインストールします。

デモ用のプロジェクトディレクトリを作成して、プロジェクトルートで以下のコマンドを実行してください。

項目の追加・調整

生成された package.json に、以下の項目を、追加・調整してください。

scripts フィールドには、テストに使用するコマンドを追加しています。

test コマンドは「Jest」によるテストの実施に使用。

test-watch コマンドはファイル監視&自動再テストに使用します。

jest フィールドでは、「Jest」の設定を行っています。

moduleFileExtensions では、テスト対象となる拡張子を指定しています。

また、 rules 拡張子を追加しています。

これは、 test-watch コマンドを使用する際に、テスト対象であるセキュリティルールの設定ファイルを監視するためです。

Jestの動作チェック

プロジェクトルートに sample.test.js を作成し、以下のように記述してください。

テストファイルを追加したら、実際にテストしてみましょう!

テストの実行

以下のコマンドを入力し、テストを実行してください。

環境や「Jest」のバージョンにもよりますが、おおよそ以下のように結果が表示されれば、テストは成功です!

Firestoreエミュレータのセットアップ

Firebase CLIのインストール

エミュレータをセットアップするには、Firebase CLI が必要となります。

以下のコマンドを実行して Firebase CLI をインストールしてください。

エミュレータをインストール

以下のコマンドを実行して、エミュレータをインストールしてください。

エミュレータの起動設定

プロジェクトルートに firebase.json を追加して、以下のように記述してください。

firestore.rules プロパティは、エミュレータ起動時に読み込む「セキュリティルールファイル」を指定しています。

emulators.firestore.port プロパティは、起動するエミュレータのポートを指定しています。

エミュレータは、デフォルトでは 8080 ポートで起動します。

ですが、 8080 ポートは、他のサービスのポートと衝突する事が多いので、今回はポートを 58080 に変更しています。

エミュレータの起動

以下のコマンドを実行して、エミュレータを起動してください。

以上で、Firestoreエミュレータのセットアップは完了です。

次は、セットアップした「Firestoreエミュレータ」と「Jest」を使って、実際にセキュリティルールのテストをしていきます。

Firestoreセキュリティルールをテスト

ついに、セキュリティルールをテストする環境が整いました。

では、いよいよ、セキュリティルールをテストしていきます!

今回は、折角なので、テスト可能な環境を活かします。

テスト駆動開発ライクなスタイルで、

  1. 1、テスト作成
  2. 2、エラー確認
  3. 3、コードの調整
  4. 4、テストパス

という流れで解説を進めていきたいと思います。

目標

以下のアクセス環境を目標に、テストとセキュリティルールの実装を進めて行きます。

  1. 認証されているユーザは、  fruits コレクションのドキュメントを読み書きできる。
  2. 認証されていないユーザは、  fruits コレクションのドキュメントを読み書きでない。
  3. fruites 以外のコレクションは、認証の有無にかかわらず、全てのユーザが読み書きできない。

必要なパッケージのインストール

プロジェクトルートで、以下のコマンドを実行して、テストに必要なパッケージをインストールしてください。

テストコードの作成

まずは、目標に沿ってテストを作成します。

プロジェクトルートに、テストファイル firestore.rules.test.js を追加して、以下のように記述してください。

テストコードで使用した変数やメソッドの解説

process.env.FIRESTORE_EMULATOR_HOST

アクセス先のFirestoreエミュレータのホストは FIRESTORE_EMULATOR_HOST で指定します。

今回は、Firestoreエミュレータの起動ポートを 58080 に変更しているので、localhost:58080 をホストに指定しています。

デフォルトポートの 8080 で起動している場合は変更は必要ありません。

firebase.initializeTestApp({projectId: <projectId>, auth: <auth>})

エミュレータにセキュリティルールをロードするメソッドです。

テストコードではテスト対象のセキュリティルールの読み込みを行っています。

firebase.loadFirestoreRules({ projectId: <projectId>, rules: <rules> })

初期化されたFirebaseアプリを返します。

auth を指定すると、指定ユーザとして認証されたアプリが返されます。

auth を指定しない場合は認証なしのアプリが返されます。

テストコードでは、テスト対象のセキュリティルールをロードした projectIdloadFirestoreRulesauth で指定した projectId )を指定して、Firebaseアプリを取得しています。

async/await

セキュリティルールのロードや、データの保存・取得は非同期処理であるため、await表記により、非同期処理の完了を待機しています。

関連記事

テストの実行

テスト駆動のスタイルにならって、とりあえずテストを実行し、エラーさせてみます。

以下のコマンドを実行して、作成したテストを実行してください。

ENOENT: no such file or directory, open '...firerules.rules' のようなエラーメッセージが表示されます。

firestore.rules ファイルがないという事なので、エラーメッセージに従って、 firestore.rules ファイルを追加します。

アクセス拒否の設定

まずは安全運転で、全てのアクセスを拒否する設定を追加します。

firestore.rules ファイルを追加して、以下のように記述してください。

firestore.rules を追加すると、自動でテストが再実施され、以下のようなテスト結果が表示されます。

全てのアクセスをブロックしているため、 fruits コレクションへの認証付きでのアクセスも拒否されています。

アクセスを許可する設定

fruits コレクションへの認証付きアクセスを許可する設定を追加します。

以下のように、 firestore.rules を調整してください。

テスト結果

再び、テストが自動で実施され、以下のようなテスト結果が表示されます。

全てのテストが成功しました。

これで「 fruits コレクションに認証付きのユーザだけが読み書きできるセキュリティルール」を作成することができました。

まとめ

以上、Firestoreエミュレータにも「Jest」を使って、セキュリティルールをテストしてみました。

簡単に、今回の内容をまとめてみたいと思います。

  1. 「Firestore」はとても便利
  2. 便利さゆえのリスクもあり
  3. セキュリティルールが肝
  4. Firestoreエミュレータを使えば、セキュリティルールをローカルでテスト可能

なお、作成したテストは、CI(継続的インティグレーション) に組み込む事で、継続的にアクセス制限の漏れをチェックすることができます。

ぜひ、セキュリティルールテストの、CI への組み込みも検討してみてください。

ライトコードよりお知らせ

にゃんこ師匠にゃんこ師匠
システム開発のご相談やご依頼はこちら
ミツオカミツオカ
ライトコードの採用募集はこちら
にゃんこ師匠にゃんこ師匠
社長と一杯飲みながらお話してみたい方はこちら
ミツオカミツオカ
フリーランスエンジニア様の募集はこちら
にゃんこ師匠にゃんこ師匠
その他、お問い合わせはこちら
ミツオカミツオカ
   
お気軽にお問い合わせください!せっかくなので、別の記事もぜひ読んでいって下さいね!

一緒に働いてくれる仲間を募集しております!

ライトコードでは、仲間を募集しております!

当社のモットーは「好きなことを仕事にするエンジニア集団」「エンジニアによるエンジニアのための会社」。エンジニアであるあなたの「やってみたいこと」を全力で応援する会社です。

また、ライトコードは現在、急成長中!だからこそ、あなたにお任せしたいやりがいのあるお仕事は沢山あります。「コアメンバー」として活躍してくれる、あなたからのご応募をお待ちしております!

なお、ご応募の前に、「話しだけ聞いてみたい」「社内の雰囲気を知りたい」という方はこちらをご覧ください。

ライトコードでは一緒に働いていただける方を募集しております!

採用情報はこちら

関連記事