Firestore使用array-contains匹配对象查询失效问题排查

问题场景 #

执行Firestore重复数据清理操作时，代码逻辑看似正确但实际未生效。此前已知array-contains匹配对象要求完全一致（Firestore会按字母序存储对象键），因此编写了getUserRef辅助函数确保对象键顺序统一，但查询后的批量更新仍无效果。Firebase控制台显示数据已正确插入，但清理代码不起作用，而另一处逻辑类似的代码却能正常运行。

相关代码 #

类型定义与辅助函数

export type UserReference = {
  name?: string;
  uid: AppUser['uid'];
};

export const getUserRef = (user: AppUser | DbUser): UserReference => ({
  name: user.name,
  uid: user.uid,
});

失效的清理代码

const linkedGroupQuery = getFirestore()
    .collection(constants.dbCollections.groups)
    .where('owners', 'array-contains', getUserRef(user));

// ...

const querySnapshot = await linkedGroupQuery.get();

querySnapshot.forEach((doc) => {
  const linkedGroup = doc.data() as DbGroup;
  const owners = linkedGroup.owners.filter((o) => o.uid !== uid);
  batch.update(doc.ref, { owners });
});

正常运行的同类逻辑代码

const groupRef: GroupReference = getGroupRef(group);

const batch = getFirestore().batch();

const usersWithGroup = await getFirestore()
    .collection(constants.dbCollections.users)
    .where('groups', 'array-contains', groupRef)
    .get();

// Remove group from all users
usersWithGroup.forEach((userSnapshot) => {
  const userData = userSnapshot.data() as DbUser;
  const userGroups = userData.groups?.filter((g) => g.id !== group.id);
  batch.update(userSnapshot.ref, { groups: userGroups });
});

问题根源 #

经排查，问题不是array-contains查询的匹配问题，而是async/await与批量写入的配合疏漏：失效代码中只将更新操作添加到了batch对象，但遗漏了提交批量操作的关键步骤——batch.commit()，或者batch对象的作用域不正确（比如在外部作用域初始化，未在当前逻辑中正确引用）。

对比正常运行的代码，其完整实现了批量操作的闭环，而失效代码缺少了最终的提交动作，导致所有更新都没有实际写入Firestore。

修复方案 #

确保在完成所有批量更新操作的添加后，调用await batch.commit()提交变更，同时保证batch对象在当前逻辑的作用域内正确初始化：

const linkedGroupQuery = getFirestore()
    .collection(constants.dbCollections.groups)
    .where('owners', 'array-contains', getUserRef(user));

// 在当前逻辑作用域内初始化batch
const batch = getFirestore().batch();

const querySnapshot = await linkedGroupQuery.get();

querySnapshot.forEach((doc) => {
  const linkedGroup = doc.data() as DbGroup;
  const owners = linkedGroup.owners.filter((o) => o.uid !== uid);
  batch.update(doc.ref, { owners });
});

// 关键：提交所有批量更新操作
await batch.commit();

额外注意事项：

• batch对象必须在需要执行批量操作的作用域内初始化，避免因作用域问题导致操作未被正确关联
• 确保await batch.commit()被包含在async函数中，等待提交完成后再执行后续逻辑

内容的提问来源于stack exchange，提问作者Jonathan