在Node.js中获取Firestore文档hasPendingWrites状态的可行方案咨询

你提到的情况确实存在：Firebase Admin SDK（Node.js环境）目前没有直接暴露文档快照的metadata.hasPendingWrites字段——这个字段主要是为客户端SDK设计的，用于跟踪本地缓存的写入是否已同步到Firestore后端。不过针对服务端场景，我们可以通过几种方式模拟实现类似的监控需求：

方法1：手动跟踪异步写入状态 #

Node.js下的Firestore操作都是基于Promise的，我们可以自己维护一个状态映射，在写入开始时标记为pending，操作完成（成功/失败）后更新状态。这种方法简单直接，适合大多数服务端写入场景。

const admin = require('firebase-admin');
admin.initializeApp();

const db = admin.firestore();
// 用Map存储文档路径对应的pending状态
const pendingWriteTracker = new Map();

// 封装带状态跟踪的写入方法
async function writeWithPendingTracking(docRef, data, options = {}) {
  const docPath = docRef.path;
  pendingWriteTracker.set(docPath, true);
  
  try {
    await docRef.set(data, options);
    pendingWriteTracker.set(docPath, false);
    return { success: true, hasPendingWrites: false };
  } catch (error) {
    pendingWriteTracker.set(docPath, false);
    throw new Error(`Write failed: ${error.message}`);
  }
}

// 检查指定文档的pending状态
function getHasPendingWrites(docRef) {
  return pendingWriteTracker.get(docRef.path) || false;
}

// 使用示例
const userDoc = db.collection('users').doc('kk2491');
writeWithPendingTracking(userDoc, { name: 'KK' })
  .then(result => console.log(`Write done, pending state: ${result.hasPendingWrites}`))
  .catch(err => console.error(err));

// 在写入过程中检查状态（比如在另一个异步任务中）
setTimeout(() => {
  console.log(`Current pending state: ${getHasPendingWrites(userDoc)}`);
}, 500);

方法2：结合实时监听的状态跟踪 #

如果需要实时感知文档的变化并关联写入状态，可以结合Firestore的onSnapshot监听和本地状态跟踪。注意：Admin SDK的onSnapshot是长连接，在服务端使用时要注意资源占用，避免过多监听实例。

function createDocumentWithPendingListener(docRef) {
  let isPending = false;

  // 启动文档实时监听
  docRef.onSnapshot(snapshot => {
    console.log(`文档更新（本地pending状态：${isPending}）`);
    // 这里可以根据业务需求处理更新事件
  });

  // 返回封装后的写入方法
  return async function updateDocument(data) {
    isPending = true;
    try {
      await docRef.update(data);
      isPending = false;
      console.log('写入完成，pending状态重置为false');
    } catch (err) {
      isPending = false;
      throw err;
    }
  };
}

// 使用示例
const productDoc = db.collection('products').doc('item-123');
const updateProduct = createDocumentWithPendingListener(productDoc);

updateProduct({ price: 29.99 })
  .then(() => console.log('更新成功'))
  .catch(err => console.error(err));

关键注意点 #

• 手动跟踪的状态仅针对当前服务实例的写入操作，如果有其他服务、客户端或管理员修改了目标文档，本地跟踪的状态不会同步反映。
• Admin SDK的写入操作Promise resolve时，意味着写入已经成功提交到Firestore后端（服务端SDK没有本地缓存层），所以hasPendingWrites的状态在Promise pending期间为true，结束后即为false。
• 如果需要全局级别的写入pending监控，目前Firestore没有提供直接的服务端API，只能通过上述本地跟踪方式实现。

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