如何使用 Firebase 模拟器从单元测试中调用 firebase 函数？

Question

我正在运行 firebase 模拟器。

如果允许用户（取决于数据库中的值），我的应用程序可以调用可以创建自定义用户声明的 firebase 云函数

我正在尝试调用该函数：

import * as firebase from '@firebase/testing';
import * as fs from 'fs';

const app = firebase.initializeTestApp({
  databaseName: 'mydb',
  auth: {
    uid: 'useruid'
  },
});

describe('Firebase Functions', () => {
  beforeEach(async () => {
    await firebase.loadDatabaseRules({
      databaseName: 'mydb',
      rules: fs.readFileSync('database.rules.json', 'utf8'),
    });
  });

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

  const cloudfunction = app.functions().httpsCallable('cloudfunction')

  it('throws error if user is not authenticated', async () => {
    await firebase.assertFail(cloudfunction())
  })
});

这是抛出一个错误：

错误：错误：预检响应包含无效的 HTTP 状态代码 404

Answer 1

为此存在firebase-functions-test。这允许您包装您的云函数并直接调用它们，以及为文档更新创建存根。在模拟器的上下文中运行时，firebase-admin SDK 仍然与模拟器交互。基本设置可能如下所示（假设是打字稿）：

// functions/src/test/functions.test.ts
import {expect} from "chai";
import "mocha";

import firebaseFunctionTest from "firebase-functions-test";
import * as cf from "../index";

const projectId = "demo-project";
const test = firebaseFunctionTest({
  projectId,
});

after(() => test.cleanup());

describe("cloud functions", () => {
  afterEach(async () => {
    await test.firestore.clearFirestoreData(projectId);
  });

  describe("myFunction", () => {
      const myFunction = test.wrap(cf.myFunction);
      // Create mock data with the admin SDK and test function.
  }
}

在你的package.json你可以放一个类似的脚本。

"scripts": {
  "test:unit": "mocha -r ts-node/register --timeout 5000 --exit src/**/*.test.ts",
  "test": "npm run build && npx firebase -P demo-project emulators:exec 'npm run test:unit'",
  ...
}  

您可能还想看看https://github.com/firebase/quickstart-testing/tree/master/unit-test-cloud-functions 和https://firebase.google.com/docs/functions/unit-testing。

Answer 2

在我看来，您不需要从单元测试中调用 firebase，因为 firebase 是否正常工作不是您的业务，您需要测试您的业务逻辑，这意味着您将模拟该方法调用 firebase 并测试此方法的预期返回值，例如，您可以编写 2 种情况，通知将在没有错误的情况下发送，第二种情况，如果 firebase 服务将返回失败，对于这 2 种情况，您的代码应该具有适当的行为。 测试 firebase 服务将由开发 firebase 的团队完成