Firebase云函数单元测试：HTTPS函数await问题与sinon spy日志异常

1. HTTPS函数不返回Promise，如何执行await操作？ #

Firebase的HTTPS函数（functions.https.onRequest）默认是基于回调的，不会返回Promise，直接await会无效。这里有两种靠谱的解决方式：

方式一：手动封装Promise包裹函数 #

你可以自己写一个工具函数，把回调式的HTTPS函数转换成Promise，监听响应的finish或error事件来决议Promise：

// 假设你的HTTPS函数定义在src/functions.js
exports.myHttpsFunction = functions.https.onRequest((req, res) => {
  res.status(200).json({ message: 'Success' });
});

// 测试文件中的封装函数
const { myHttpsFunction } = require('../src/functions');

function promisifyHttps(func) {
  return (req, res) => new Promise((resolve, reject) => {
    func(req, res);
    res.on('finish', resolve);
    res.on('error', reject);
  });
}

// 测试用例中使用
test('测试HTTPS函数返回正确响应', async () => {
  const mockReq = { method: 'GET' };
  const mockRes = {
    status: jest.fn().mockReturnThis(),
    json: jest.fn().mockReturnThis(),
    on: jest.fn((event, cb) => {
      if (event === 'finish') cb();
    })
  };

  await promisifyHttps(myHttpsFunction)(mockReq, mockRes);
  
  expect(mockRes.status).toHaveBeenCalledWith(200);
  expect(mockRes.json).toHaveBeenCalledWith({ message: 'Success' });
});

方式二：使用SuperTest模拟真实HTTP请求（更推荐） #

SuperTest专门用来测试HTTP服务，它可以直接把Firebase的HTTPS函数当成Express app来处理，天然支持Promise和await：

const request = require('supertest');
const functions = require('../src/functions');

test('测试HTTPS函数的真实请求流程', async () => {
  const response = await request(functions.myHttpsFunction)
    .get('/')
    .send();

  expect(response.statusCode).toBe(200);
  expect(response.body).toEqual({ message: 'Success' });
});

这种方式不需要手动mockreq和res，更贴近真实场景，测试结果更可靠。

2. 未设置setTimeout时，sinon spy的控制台日志在test()调用前输出？ #

这个问题几乎都是因为被测试的模块在导入阶段就执行了控制台日志代码，而你的sinon spy是在测试用例内部才创建的，导致日志输出早于spy生效。解决思路分两种：

方案一：延迟导入模块 #

把模块导入语句移到测试用例内部，确保spy先被创建，再加载模块：

const sinon = require('sinon');

test('捕获控制台日志输出', async () => {
  // 先创建spy
  const consoleSpy = sinon.spy(console, 'log');
  
  // 再导入模块，此时模块内的顶层代码才会执行
  const myModule = require('../src/myModule');
  myModule.triggerLog(); // 如果是函数内的日志，调用函数即可

  // 断言
  expect(consoleSpy.calledWith('预期的日志内容')).toBe(true);
  
  // 恢复console.log
  consoleSpy.restore();
});

方案二：重构模块，避免顶层执行代码 #

如果模块里有顶层的console.log（比如初始化日志），建议把这部分逻辑封装成函数，不要在模块加载时自动执行：

// 重构前（不好的写法）
console.log('模块初始化完成'); // 导入时直接执行
exports.doSomething = () => {};

// 重构后（推荐写法）
exports.init = () => {
  console.log('模块初始化完成'); // 手动调用才执行
};
exports.doSomething = () => {};

这样测试时可以先设置spy，再调用myModule.init()，日志就会被spy正确捕获了。

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