Firestore 规则 - 仅允许更新文档的某些字段

Question

我的目标

我只想允许用户更新其他人的用户文档中的特定字段。

---

我的用户文档

/* BEFORE */
{
  id: 'uid1',
  profile: { /* a map of personal info */ },
  connectedUsers: {
    uid2: true,
    uid3: true,
  }
}

/* AFTER */
{
  id: 'uid1',
  profile: { /* a map of personal info */ },
  connectedUsers: {
    uid2: true,
    uid3: true,
    uid4: true, // <--- added.
  }
}

---

请求

const selfUserId = 'uid4';

db.runTransaction(function(transaction) {

    return transaction.update(userDocRef).then(function(userDoc) {

        if (!userDoc.exists) { throw "Document does not exist!"; }

        transaction.update(userDocRef, 'connectedUsers.${selfUserId}', true);
    });
}

---

我对规则如何运作的理解：

• request.resource.dara是entire目标文档after的更改。

• 对于update操作，上述仍然成立。我不太明白文档是什么意思：

对于仅修改文档字段子集的更新操作，该request.resource变量将包含操作后的待处理文档状态。

参考

---

我的规则：（见下面的更新）

function existingData() { return resource.data }
function expectedData() { return request.resource.data }

• 检查uid更新后是否添加了请求者。

function isAddingRequester() {
  return expectedData().connectedUsers[requesterId()] != null
}

• 检查更新后是否只添加了1或0项目connectedUsers。0如果请求者已经在列表中。

function isAddingOneAtMost() {
  return expectedData().connectedUsers.size() == existingData().connectedUsers.size() + 1
  || expectedData().connectedUsers.size() == existingData().connectedUsers.size()
}

• 检查更新后用户文档的所有其他字段是否未更改。

function isNotChangingOtherFields() {
  return expectedData().id == existingData().id
  && expectedData().profile == existingData().profile
}

---

我的问题

• 我对 Firestore 规则如何工作的理解正确吗？上面引用的文档是pending document state什么意思？

• 我的规则实现是否反映了我的意图？四处搜索后我很困惑，得知模拟器可能有错误。

• 在我的isNotChangingOtherFields函数中，我可以profile直接将对象与==运算符进行比较吗？

---

更新 - 2018/01/17 3PM

删除existingData()和expectedData()。

function isAddingRequester() {
  return request.resource.data.connectedUsers[requesterId()] != null
}

function isAddingOneAtMost() {
  return (request.resource.data.connectedUsers.size() == resource.data.connectedUsers.size() + 1)
  || (request.resource.data.connectedUsers.size() == resource.data.connectedUsers.size()) // NOTE: if the requester is already in the list.
}

function isNotChangingOtherFields() {
  return request.resource.data.profile == resource.data.profile
  && request.resource.data.id == resource.data.id
}

function isNotAddingOtherFields() {
  return request.resource.data.size() == resource.data.size()
}

调试结果

有趣的是，模拟器和生产中的结果并不相同。

// PASSED in simulator & production:      
allow update: if isAddingRequester();

// PASSED in simulator but NOT production:
allow update: if isNotChangingOtherFields();

// PASSED in simulator but NOT production:
allow update: if isNotAddingOtherFields();

// FAILED in both simulator AND production:
allow update: if isAddingOneAtMost();

// NOTE: inserted 2 mock data before update.
// PASSED in simulator:
allow update: if resource.data.connectedUsers.size() == 2;

// FAILED in simulator:
allow update: if request.resource.data.connectedUsers.size() == 3; 
// PASSED in simulator:
allow update: if request.resource.data.connectedUsers.size() == 1; 

---

题

如果request.resource是更新后的文档，为什么是request.resource.data.connectedUsers.size()1而不是3（2个现有的+ 1个新添加的）？

相关发现（来自模拟器）

如果我有一个功能：

expectedData() { return request.resource.data }

我得到了这样意想不到的结果：

// PASSED:
allow update: if request.resource.data.id == expectedData().id;

// FAILED if the order is changed.
allow update: if expectedData().id == request.resource.data.id;

Answer 1

看起来有一个非常有用的 MapDiff 类型可能能够简化您的规则。文档中的示例代码：

// Compare two Map objects and return whether the key "a" has been
// affected; that is, key "a" was added or removed, or its value was updated.
request.resource.data.diff(resource.data).affectedKeys().hasOnly(["a"]);

https://firebase.google.com/docs/reference/rules/rules.MapDiff