Pact JS 中 afterEach 钩子异步支持问题解析

问题背景

在 Pact JS 测试框架中，开发者发现了一个关于异步操作支持的缺陷。具体表现为当在验证测试中使用异步函数作为 afterEach 钩子时，测试执行不会等待 Promise 解析完成，导致测试无法正常退出。

问题现象

当开发者尝试在验证测试配置中设置异步的 afterEach 钩子时，例如：

afterEach: async () => {
  return new Promise((resolve) => setTimeout(resolve, 2000))
}

预期行为是测试执行会暂停约2秒钟，等待 Promise 解析完成。然而实际观察到的现象是：

1. 测试执行不会暂停
2. Jest 测试运行器无法正常退出
3. 控制台会显示关于未停止异步操作的警告信息

技术分析

通过调试日志分析，可以观察到 afterEach 钩子的执行与后续操作之间存在时序问题。核心问题在于代码实现中错误地调用了 next() 函数，导致中间件处理流程提前继续，而没有等待异步操作完成。

正确的实现应该将 next() 调用放在异步操作完成之后，确保执行顺序的正确性。当前有缺陷的代码结构如下：

logger.trace("registered 'afterEach' hook");
next();  // 错误位置：在异步操作前调用
if (req.path !== stateSetupPath) {
  logger.debug("executing 'afterEach' hook");
  try {
    await config.afterEach();  // 异步操作
  } catch (e) {
    // 错误处理
  }
}

而正确的实现应该是：

logger.trace("registered 'afterEach' hook");
if (req.path !== stateSetupPath) {
  logger.debug("executing 'afterEach' hook");
  try {
    await config.afterEach();  // 先完成异步操作
    next();  // 正确位置：在异步操作后调用
  } catch (e) {
    // 错误处理
  }
}

影响范围

这个问题主要影响以下场景：

1. 需要在验证测试后进行异步清理操作的场景
2. 使用 Jest 等测试运行器的项目
3. 依赖 afterEach 钩子进行状态重置的测试套件

值得注意的是，beforeEach 钩子已经正确支持异步操作，只有 afterEach 存在此问题。

解决方案建议

对于遇到此问题的开发者，可以采取以下临时解决方案：

1. 将异步清理逻辑移至测试用例内部，而不是依赖 afterEach 钩子
2. 使用同步方式进行状态清理
3. 等待官方修复后升级 Pact JS 版本

从框架实现角度，修复方案应包括：

1. 调整 next() 调用位置，确保在异步操作完成后执行
2. 修正日志记录位置，使其更准确地反映执行流程
3. 添加相关测试用例，验证异步钩子的正确行为

总结

Pact JS 作为契约测试的重要工具，其钩子函数的正确行为对测试流程至关重要。这个 afterEach 异步支持问题虽然看似简单，但反映了中间件处理流程中时序控制的重要性。开发者在使用时应注意此限制，而框架维护者也应尽快修复此问题，以提供更完善的异步操作支持。