解决mongodb-memory-server与Jest测试中find查询挂起的问题

在使用mongodb-memory-server进行单元测试时，开发者可能会遇到一个棘手的问题：在测试用例中执行Mongoose的find查询时，操作会无限期挂起，而在beforeAll钩子中的相同查询却能正常工作。本文将深入分析这一问题的原因及解决方案。

问题现象

开发者在Jest测试环境中配置了mongodb-memory-server作为内存数据库，测试结构如下：

1. 使用globalSetup/globalTeardown管理内存服务器的生命周期
2. 在beforeAll中建立Mongoose连接并测试基础查询
3. 在测试用例中执行业务逻辑查询

奇怪的是，beforeAll中的SomeMongoModel.find()能够正常返回空数组，而测试用例中的相同查询却会无限挂起，没有任何错误输出。

根本原因分析

经过排查，问题的根源在于测试中使用了Jest的模拟计时器功能：

beforeEach(() => jest.useFakeTimers());
afterEach(() => jest.useRealTimers());

这些代码会替换Node.js的全局计时器API，包括setTimeout和setInterval等。Mongoose和其他数据库驱动通常依赖这些计时器API来实现连接超时、查询超时等机制。当使用假计时器时，这些异步操作无法正常完成，导致查询挂起。

解决方案

方案一：移除假计时器

如果测试不需要模拟时间功能，最简单的解决方案是移除这些计时器相关的代码：

// 删除以下代码
beforeEach(() => jest.useFakeTimers());
afterEach(() => jest.useRealTimers());

方案二：保留假计时器但正确处理异步

如果测试确实需要模拟时间，可以采用以下方式：

1. 使用现代Jest的假计时器API：

beforeEach(() => {
  jest.useFakeTimers({
    doNotFake: ['nextTick'] // 保留某些关键计时器
  });
});

2. 在需要真实计时器的测试中显式恢复：

it('需要真实计时器的测试', async () => {
  jest.useRealTimers();
  // 执行测试
});

3. 对于涉及数据库操作的测试，确保在适当的时候推进假时间：

it('使用假计时器的测试', async () => {
  const promise = SomeMongoModel.find();
  jest.runAllTimers(); // 推进所有挂起的计时器
  await promise; // 现在可以正常完成
});

最佳实践建议

1. 隔离数据库测试：将需要假计时器的测试与数据库测试分开，避免相互干扰
2. 谨慎使用全局配置：避免在全局beforeEach中配置可能影响所有测试的行为
3. 明确测试需求：评估是否真的需要模拟时间，有时简单的等待可能更可靠
4. 升级依赖：保持Jest和Mongoose等关键依赖的最新版本，以获得更好的兼容性

总结

在使用mongodb-memory-server进行测试时，任何影响Node.js核心API（如计时器）的操作都可能导致意外的行为。通过理解底层机制和谨慎配置测试环境，可以避免这类问题，确保测试的可靠性和可维护性。