使用Supertest测试Express应用时Jest在404及动态路由测试中超时

问题背景 #

开发一款支持传入自定义路由数组的Express npm包时，遇到以下测试异常：

• 默认/health路由测试可正常通过
• 404路由、自定义动态路由测试触发Jest超时失败
• Jest监听模式（--watch）与非监听模式下终端输出不一致
• 已尝试增加Jest超时配置，但问题未解决

排查方向与修复方案 #

1. 检查测试用例的服务器资源清理 #

测试后未关闭Express服务器会导致端口占用，后续测试请求无法正常发起，最终触发超时。

• 必须在每个测试用例结束后通过钩子关闭服务器：

let server;

beforeEach(() => {
  server = app.listen(3000);
});

afterEach(async () => {
  // 用Promise包裹close，确保服务器完全关闭再执行下一个测试
  await new Promise(resolve => server.close(resolve));
});

2. 排查404中间件的响应逻辑 #

若404中间件存在未处理的异步操作，会导致请求挂起无响应：

• 确保404中间件同步响应，或异步逻辑处理完全：

app.use((req, res) => {
  res.status(404).json({ msg: 'Route not found' });
});

3. 验证动态路由的参数处理 #

自定义动态路由若存在参数解析错误、异步查询未正常结束，会导致请求挂起：

• 比如/users/:id这类路由，需确保内部数据库查询、数据处理的Promise都能正确resolve/reject，避免出现无限pending的情况。

4. 修正测试用例的异步写法 #

多数超时问题源于测试用例未等待请求完成就结束：

• 错误写法（未等待响应）：

test('test 404 route', () => {
  request(app).get('/non-existent').expect(404);
});

• 正确写法（用async/await等待请求完成）：

test('test 404 route', async () => {
  await request(app).get('/non-existent').expect(404);
});

5. 处理Jest监听模式的缓存问题 #

Jest监听模式会缓存模块，可能导致Express应用实例重复创建未销毁：

• 在jest.config.js中添加resetMocks: true，确保每次测试重新初始化应用；或在测试前手动重置应用实例。

验证方法 #

1. 单独运行404或动态路由测试，确认是否为单个测试的问题
2. 使用jest --runInBand --watchAll=false运行测试，查看详细执行日志定位阻塞点
3. 在路由处理函数、测试钩子中添加console.log，输出关键步骤排查问题

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