使用Jest+Supertest测试Express后端时持续超时问题求助

常见原因及排查步骤 #

1. Express服务器未正确关闭 #

Supertest会自动启动服务器，但如果你的服务器代码存在未关闭的资源（比如数据库连接、WebSocket、定时器），测试结束后进程无法正常退出，直接导致Jest超时。

• 调整Express入口文件，确保测试环境下能主动关闭所有资源：

  // server.js
  const app = require('express')();
  // ... 路由、中间件逻辑
  
  // 仅直接运行文件时启动服务器，测试时由Supertest接管
  if (require.main === module) {
    app.listen();
  }
  
  // 导出app供测试调用，同时添加资源关闭方法
  module.exports = {
    app,
    close: async () => {
      // 关闭数据库连接：比如mongoose.connection.close()
      // 清除定时器/轮询：clearInterval(intervalId)
    }
  };
  

• 在测试用例中，用afterAll执行资源清理：

  const { app, close } = require('../server');
  const request = require('supertest');
  
  afterAll(async () => {
    await close();
  });
  
  test('测试基础接口', async () => {
    const res = await request(app).get('/api/health');
    expect(res.statusCode).toBe(200);
  });
  

2. Webpack相关代码污染测试环境 #

作为Universal App，后端代码如果意外引入了前端打包逻辑、Webpack配置或前端模块，这些代码在测试环境下可能触发未处理的异步操作，导致进程阻塞。

• 检查测试文件是否误引入前端入口或Webpack相关文件：

  // 错误示例：测试文件引入了前端打包入口
  require('../src/client/index');
  

• 在Jest配置中明确区分前后端测试环境：

  // jest.config.js
  module.exports = {
    projects: [
      {
        displayName: 'client',
        testEnvironment: 'jsdom',
        testMatch: ['<rootDir>/src/client/**/*.test.js']
      },
      {
        displayName: 'server',
        testEnvironment: 'node',
        testMatch: ['<rootDir>/src/server/**/*.test.js'],
        modulePathIgnorePatterns: ['<rootDir>/src/client/']
      }
    ]
  };
  

3. 异步中间件/路由未正确处理Promise #

如果Express路由或中间件使用了async/await但未捕获错误，或者异步操作未正确返回响应，会导致请求挂起超时。

• 检查路由处理逻辑：

  // 错误示例：async函数未返回响应或处理错误
  app.get('/api/data', async (req, res) => {
    const data = await fetchData();
    // 遗漏res.send(data)
  });
  
  // 正确写法
  app.get('/api/data', async (req, res, next) => {
    try {
      const data = await fetchData();
      res.send(data);
    } catch (err) {
      next(err); // 传递错误给全局错误处理中间件
    }
  });
  

4. Jest全局配置干扰测试环境 #

如果项目中存在全局Jest setup文件，可能无意中注入了前端相关的polyfill或全局变量，导致后端测试环境异常。

• 检查后端测试的setup文件，确保只添加后端测试需要的配置：

  // server/testSetup.js
  process.env.NODE_ENV = 'test';
  // 避免引入前端polyfill，比如react-dom/test-utils
  

5. 外部依赖服务未就绪 #

如果后端测试依赖数据库、Redis等外部服务，而测试时这些服务未启动，会导致接口请求挂起超时。

• 测试前确保依赖服务运行，或用Mock替代真实服务：

  // 用jest.mock模拟数据库模块
  jest.mock('../src/server/db', () => ({
    fetchData: jest.fn().mockResolvedValue({ code: 200, data: 'mock data' })
  }));
  

快速定位问题的方法 #

先编写一个极简测试用例，排除复杂业务逻辑的干扰：

// 极简测试
const express = require('express');
const request = require('supertest');

const app = express();
app.get('/test', (req, res) => res.send('success'));

test('极简接口测试', async () => {
  const res = await request(app).get('/test');
  expect(res.text).toBe('success');
});

如果这个测试能通过，说明问题出在项目代码中。逐步添加项目中的中间件、路由，直到复现超时，即可定位到具体问题模块。

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