如何Mock Firestore DeltaDocumentSnapshot以测试Firebase Functions触发器

我来帮你搞定Firestore触发器函数的单元测试Mock问题！针对firebase.Event<firebase.firestore.DeltaDocumentSnapshot>这种事件类型，我们有两种实用方法，下面详细说明：

方法一：使用Firebase Functions Test SDK（推荐） #

Firebase官方提供的测试SDK专门用来处理这类场景，能帮你快速生成符合真实结构的快照和事件对象，减少手动Mock的工作量。

步骤1：安装依赖 #

先把测试工具包装到开发依赖里：

npm install --save-dev firebase-functions-test

步骤2：初始化测试环境 #

初始化时可以选择离线模式（不需要真实Firebase项目，适合纯单元测试）或在线模式（连接测试项目）。这里推荐离线模式：

const test = require('firebase-functions-test')({
  projectId: 'your-test-project-id' // 随便填一个测试用的项目ID就行
});

步骤3：构造DeltaDocumentSnapshot & Event #

用SDK提供的makeDocumentSnapshot生成新旧文档快照，再通过makeDeltaSnapshot得到Delta对象，最后用makeEvent包装成触发器需要的事件：

const admin = require('firebase-admin');
admin.initializeApp();
// 导入你要测试的触发器函数
const myFirestoreTrigger = require('../index').myFirestoreTrigger;

describe('Firestore触发器测试', () => {
  after(() => {
    test.cleanup(); // 测试结束后清理资源，避免残留
  });

  it('应该正确处理文档更新事件', async () => {
    // 构造旧文档快照
    const oldDoc = test.firestore.makeDocumentSnapshot(
      { username: 'old_user', score: 100 },
      'users/user_123' // 文档路径
    );
    // 构造新文档快照
    const newDoc = test.firestore.makeDocumentSnapshot(
      { username: 'new_user', score: 200 },
      'users/user_123'
    );
    // 生成Delta快照（包含新旧状态）
    const deltaSnap = test.makeDeltaSnapshot(oldDoc, newDoc);
    // 包装成触发器需要的Event对象
    const event = test.makeEvent(deltaSnap);

    // 调用你的触发器函数
    await myFirestoreTrigger(event);

    // 这里添加你的断言逻辑，比如检查是否执行了预期操作
    // 示例：验证某个关联文档是否被更新
    const logDoc = await admin.firestore().doc('user_logs/user_123').get();
    expect(logDoc.data().action).toBe('user_updated');
  });
});

特殊场景处理 #

• 文档创建事件：只需要传入新快照，旧快照传null：

  const deltaSnap = test.makeDeltaSnapshot(null, newDoc);
  

• 文档删除事件：只需要传入旧快照，新快照传null：

  const deltaSnap = test.makeDeltaSnapshot(oldDoc, null);
  

方法二：手动构造Mock对象（轻量场景） #

如果不想依赖官方SDK，也可以手动模拟DeltaDocumentSnapshot和Event的核心属性，满足函数的调用需求。

手动Mock示例 #

// 模拟DeltaDocumentSnapshot的核心方法和属性
const mockDeltaSnap = {
  // 新文档数据
  data: () => ({ username: 'new_user', score: 200 }),
  // 旧文档数据
  previous: {
    data: () => ({ username: 'old_user', score: 100 })
  },
  // 文档引用属性
  ref: {
    id: 'user_123',
    path: 'users/user_123',
    get: async () => ({ data: () => ({ username: 'new_user' }) })
  },
  id: 'user_123',
  exists: true
};

// 模拟Event对象
const mockEvent = {
  params: { userId: 'user_123' }, // 如果触发器路径包含参数（比如users/{userId}）
  data: () => mockDeltaSnap
};

// 测试调用
const myFirestoreTrigger = require('../index').myFirestoreTrigger;

test('处理文档更新逻辑', async () => {
  await myFirestoreTrigger(mockEvent);
  // 添加你的断言逻辑，比如检查函数是否正确处理了数据变化
});

注意事项 #

• 离线模式下，Firebase Admin会使用本地模拟的Firestore，不会影响真实项目数据。
• 如果测试涉及到Admin SDK的操作（比如读写其他文档），确保初始化Admin时使用测试配置。
• 测试后一定要调用test.cleanup()清理资源，避免内存泄漏或残留数据干扰后续测试。

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