firestore rulesのテストでPERMISSION_DENIED

Question

Firebaseのrulesをテストしようとしていたのですが、エミュレータを起動して、npm testを実行すると、以下のエラーが発生しました。

FirebaseError: 7 PERMISSION_DENIED: false for 'create' @ L71

@ L71がline 71のことだとしたら、firestore.rulesファイルの71行目は
allow create: if isUserAuthenticated(userId) && isValidUserCreate(request.resource.data, userId);
です。(下記にコードを記載しています。)

参考しにた記事はこちらです。

そして、以下がテストコードになります。

import * as firebase from "@firebase/rules-unit-testing";
import { TokenOptions } from "@firebase/rules-unit-testing/dist/src/api";
import { readFileSync } from "fs";

const projectId = "rule-test";
process.env.FIRESTORE_EMULATOR_HOST = "localhost:8080";

function getAuthFirestore(auth: TokenOptions) {
  return firebase.initializeTestApp({ projectId, auth }).firestore();
}

describe("firestore security test", () => {
  beforeAll(async () => {
    await firebase.loadFirestoreRules({
      projectId,
      rules: readFileSync("firestore.rules", "utf8"),
    });
  });

  afterEach(async () => {
    await firebase.clearFirestoreData({ projectId });
  });

  afterAll(async () => {
    await Promise.all(firebase.apps().map((app) => app.delete()));
  });

  describe("ユーザー読み書きテスト", () => {
    it("usersのデータは、ユーザ本人のみ書き込み可能", async () => {
      const firestore = getAuthFirestore({ uid: "user" });
      const ref = firestore.collection("users").doc("user");
      await firebase.assertSucceeds(ref.set({ username: "サンプル" }));

      const otherUserRef = firestore.collection("users").doc("userB");
      await firebase.assertFails(otherUserRef.set({ username: "サンプル" }));
    });
  });
});

また、以下はruleのコードになります。

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {

    function isAnyAuthenticated() { 
      return request.auth != null;
    }

    function isUserAuthenticated(userId) { 
      return isAnyAuthenticated() && userId == request.auth.uid;
    }

    function isValidUserCreate(user, targetUserId) {
      return user.size() == 3
      && 'email' in user && user.email is string
      && 'username' in user && user.username is string
      && 'uid' in user && user.uid is string && user.uid == targetUserId;
    }

    function isValidUserUpdate(user, targetUserId) {
      return user.size() == 3
      && 'email' in user && user.email is string
      && 'username' in user && user.username is string
      && 'uid' in user && user.uid is string && user.uid == targetUserId;
    }

    function isValidBookmarkAdd(bookmark) {
      return bookmark.size() == 6
      && 'authorName' in bookmark && bookmark.authorName is string && bookmark.authorName.size() > 0
      && 'content' in bookmark && bookmark.content is string && bookmark.content.size() > 0
      && 'createdAt' in bookmark && bookmark.createdAt is string
      && 'id' in bookmark && bookmark.id is string
      && 'saveId' in bookmark && bookmark.saveId is string
      && 'title' in bookmark && bookmark.title is string && bookmark.title.size() > 0
    }

    function isValidBookmarkUpdate(bookmark) {
      return bookmark.size() == 6
      && 'authorName' in bookmark && bookmark.authorName is string && bookmark.authorName.size() > 0
      && 'content' in bookmark && bookmark.content is string && bookmark.content.size() > 0
      && 'createdAt' in bookmark && bookmark.createdAt is string
      && bookmark.createdAt == resource.data.createdAt
      && 'id' in bookmark && bookmark.id is string
      && 'saveId' in bookmark && bookmark.saveId is string
      && 'title' in bookmark && bookmark.title is string && bookmark.title.size() > 0
    }

    function isValidPostCreate(post) {
      return post.size() == 6
      && 'authorName' in post && post.authorName is string && post.authorName.size() > 0
      && 'content' in post && post.content is string && post.content.size() > 0
      && 'createdAt' in post && post.createdAt is timestamp
      && 'category' in post && post.category is string
      && 'uid' in post && post.uid is string
      && 'title' in post && post.title is string && post.title.size() > 0 && post.title.size() <= 42
    }

    function isValidPostUpdate(post) {
      return post.size() == 7
      && 'authorName' in post && post.authorName is string && post.authorName.size() > 0
      && 'content' in post && post.content is string && post.content.size() > 0
      && 'createdAt' in post && post.createdAt is timestamp
      && 'category' in post && post.category is string
      && 'id' in post && post.id is string
      && 'uid' in post && post.uid is string
      && 'title' in post && post.title is string && post.title.size() > 0 && post.title.size() <= 42
    }

    match /users/{userId} {  
      allow get: if isUserAuthenticated(userId) || isAnyAuthenticated();
      allow create: if isUserAuthenticated(userId) && isValidUserCreate(request.resource.data, userId); 
      allow update: if isUserAuthenticated(userId) && isValidUserUpdate(request.resource.data, userId);

      match /bookmarks/{bookmarkId} {
        allow read: if isUserAuthenticated(userId);
        allow create: if isUserAuthenticated(userId) && isValidBookmarkAdd(request.resource.data);
        allow update: if isUserAuthenticated(userId) && isValidBookmarkUpdate(request.resource.data);
        allow delete: if isUserAuthenticated(userId);
      }
    }

    match /posts/{postId} {
      allow read: if isUserAuthenticated(request.auth.uid);
      allow create: if isUserAuthenticated(request.auth.uid) && isValidPostCreate(request.resource.data);
      allow update: if isUserAuthenticated(request.auth.uid) && isValidPostUpdate(request.resource.data);
      allow delete: if isUserAuthenticated(request.auth.uid);
    }
  }
}

実現したいこと

・エラーを解消する
・testをpassすること

です。

auth関連のところで何かうまくいってなさそうなのはわかるのですが、調べてもいい感じの答えに辿り着けず、質問させていただきました。

環境

テストに使っているツールは、@firebase/rules-unit-testingです。

Answer 1

コードとルールを読む限り、

allow create: if isUserAuthenticated(userId) && isValidUserCreate(request.resource.data, userId);

の後半にあるisValidUserCreateに違反しているように見えます。

ルール

    function isValidUserCreate(user, targetUserId) {
      return user.size() == 3
      && 'email' in user && user.email is string
      && 'username' in user && user.username is string
      && 'uid' in user && user.uid is string && user.uid == targetUserId;
    }

コード

await firebase.assertSucceeds(ref.set({ username: "サンプル" }));

データの要素数が3であることをルール上で要求しているので、少なくともテストコード上でも要素数を揃えないとダメなのではないでしょうか。

Comments

[kobaryo04ysh]

できました！！ありがとうございます！！