Express-Rate-Limit 在 Jest 测试中的异步连接问题解决方案

问题背景

在使用 express-rate-limit 中间件进行 API 限流时，开发者常常会遇到 Jest 测试结束后异步操作未完全关闭的问题。特别是在结合 MongoDB 存储限流数据时，这个问题尤为常见。

问题现象

当使用 express-rate-limit 配合 MongoStore 进行 API 限流测试时，Jest 测试结束后会报出警告："Jest did not exit one second after the test run has completed"。这表明测试中存在未正确关闭的异步操作。

根本原因分析

这个问题的主要根源在于 MongoStore 内部维护了一个到 MongoDB 的持久连接。在测试结束后，这个连接没有被显式关闭，导致 Jest 检测到未完成的异步操作。

解决方案

方案一：模拟限流中间件

在测试环境中，最简单的解决方案是直接模拟 rateLimit 中间件。这种方法避免了真实数据库连接的开销和复杂性，特别适合单元测试场景。

jest.mock('../path/to/rateLimitMiddleware', () => 
  jest.fn((req, res, next) => next())
);

方案二：正确管理 MongoDB 连接

如果测试需要真实的限流功能，可以按照以下步骤正确处理 MongoDB 连接：

1. 在测试前创建 MongoStore 实例并获取客户端引用
2. 在测试完成后显式关闭连接

const MongoStore = require('rate-limit-mongo');
const { MongoClient } = require('mongodb');

describe('API tests', () => {
  let mongoStore;
  let mongoClient;
  
  beforeAll(async () => {
    mongoStore = new MongoStore({
      uri: 'mongodb://localhost:27017/test',
      collectionName: 'rate_limit_logs'
    });
    mongoClient = await mongoStore.getClient();
  });
  
  afterAll(async () => {
    await mongoClient.close();
  });
  
  // 测试用例...
});

方案三：重用现有数据库连接

如果应用已经使用了 Mongoose 等 ORM 工具建立了 MongoDB 连接，可以修改 rate-limit-mongo 的配置，复用现有连接：

const mongoose = require('mongoose');
const MongoStore = require('rate-limit-mongo');

// 假设已经建立了mongoose连接
const mongoStore = new MongoStore({
  client: mongoose.connection.getClient(),
  collectionName: 'rate_limit_logs'
});

最佳实践建议

1. 单元测试：建议使用模拟方案，避免真实数据库依赖
2. 集成测试：如果需要测试真实限流逻辑，确保正确处理数据库连接生命周期
3. 连接管理：考虑在应用层面统一管理所有数据库连接
4. 测试配置：可以在测试配置中使用内存存储替代真实数据库存储

总结

express-rate-limit 与 MongoDB 结合使用时，在 Jest 测试中出现的异步操作未关闭问题，主要是由于数据库连接管理不当造成的。通过合理选择模拟策略或正确管理数据库连接生命周期，可以有效解决这个问题。根据测试需求选择合适的方案，既能保证测试质量，又能提高测试执行效率。