使用Jest测试Redis后测试无法自动退出的问题排查

你的推测完全正确——问题出在模块导入阶段创建的Redis客户端（哪怕是redis-mock的实例）会在事件循环中保留活跃的连接/资源，导致Jest无法自动退出，因为它在等待事件循环完全清空。

直接解决方案：在测试结束后关闭Redis连接 #

因为你的Redis客户端是在模块级别初始化的，我们需要在测试的清理阶段手动关闭它。这里有两种可行的实现方式：

方式1：导出Redis客户端并在测试中关闭

修改redis.js，把客户端实例导出：

import redis from 'redis'
export const client = redis.createClient() // 导出客户端实例
export function set(key, value) {
  // 你的set方法实现
}

然后在测试文件中导入该实例，在afterAll钩子中关闭连接：

import redis from 'redis'
import redis_mock from 'redis-mock'
jest.spyOn(redis, 'createClient').mockImplementation(redis_mock.createClient)
import fileUsingRedis from './index'
import { client } from './redis'

describe('index', () => {
  // 所有测试结束后关闭Redis连接
  afterAll(async () => {
    await client.quit()
  })

  it('should pass', () => expect(true).toBeTruthy())
})

方式2：在Mock时捕获客户端实例

如果不想修改redis.js，可以在mockcreateClient时把实例存下来，之后统一关闭：

import redis from 'redis'
import redis_mock from 'redis-mock'
let mockRedisClient

// mock时捕获创建的客户端实例
jest.spyOn(redis, 'createClient').mockImplementation(() => {
  mockRedisClient = redis_mock.createClient()
  return mockRedisClient
})

import fileUsingRedis from './index'

describe('index', () => {
  afterAll(async () => {
    await mockRedisClient.quit()
  })

  it('should pass', () => expect(true).toBeTruthy())
})

最佳实践：避免模块级别的客户端初始化 #

模块级别创建客户端虽然简单，但会导致测试时的生命周期难以控制，更优雅的方式是采用依赖注入或工厂函数：

重构为工厂函数模式

修改redis.js，把客户端的创建和操作逻辑分离：

import redis from 'redis'

// 工厂函数负责创建客户端
export function createRedisClient() {
  return redis.createClient()
}

// 操作函数接收客户端作为参数，实现解耦
export function set(client, key, value) {
  return new Promise((resolve, reject) => {
    client.set(key, value, (err) => {
      if (err) reject(err)
      else resolve()
    })
  })
}

业务代码中按需创建客户端：

import { createRedisClient, set } from './redis'
const client = createRedisClient()

export default function someBusinessLogic() {
  return set(client, 'key', 'value')
}

测试时可以轻松注入mock客户端，并精准控制其生命周期：

import redis_mock from 'redis-mock'
import { set } from './redis'

describe('index', () => {
  let mockClient

  // 每个测试前创建新的mock客户端
  beforeEach(() => {
    mockClient = redis_mock.createClient()
  })

  // 每个测试后关闭连接，避免资源泄漏
  afterEach(async () => {
    await mockClient.quit()
  })

  it('should handle set operation correctly', async () => {
    await set(mockClient, 'test-key', 'test-val')
    // 还可以添加对mock客户端的调用断言
    expect(mockClient.set).toHaveBeenCalledWith('test-key', 'test-val', expect.any(Function))
  })
})

注意：不要依赖--forceExit #

Jest提供了--forceExit参数可以强制退出进程，但这是治标不治本的方案——它会掩盖真正的资源泄漏问题，不推荐作为长期解决方案。

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