Cucumber.js API 使用中的步骤定义丢失问题解析

问题现象

在使用 Cucumber.js 的 API 方式进行测试时，开发者可能会遇到一个奇怪的现象：当连续运行多个测试场景时，只有第一个场景能够正常执行，后续场景会出现步骤定义未找到的问题。具体表现为 support 对象中的 stepDefinitions 属性在第一次运行后变为空。

问题根源

这个问题的本质在于 Cucumber.js 的模块加载机制。当通过 loadSupport 函数加载支持代码时，Cucumber.js 会执行所有步骤定义文件。然而，Node.js 的模块系统有一个特性：一旦模块被加载，它会被缓存起来，后续的 require 调用会直接返回缓存的内容而不会重新执行模块代码。

因此，当第二次调用 loadSupport 时：

1. 步骤定义文件不会再次执行
2. 新的 support 对象无法获取到步骤定义
3. 导致后续测试场景无法找到匹配的步骤实现

解决方案

方案一：预先加载支持代码

最直接的解决方案是在所有测试运行前一次性加载支持代码，然后在每次运行时复用这个 support 对象：

import { runCucumber, loadConfiguration, loadSupport } from '@cucumber/cucumber/api'

async function init() {
  const { runConfiguration } = await loadConfiguration({ file: './config/add.json' })
  const env = {
    cwd: process.cwd(),
    stdout: process.stdout,
    stderr: process.stderr,
    debug: false
  }
  return { support: await loadSupport(runConfiguration, env), env }
}

async function run(name, { support, env }) {
  const { runConfiguration } = await loadConfiguration({ file: `./config/${name}.json` })
  await runCucumber({ ...runConfiguration, support }, env)
}

init().then((context) => {
  run("add", context).then(() => run("sub", context))
})

方案二：重置模块缓存

对于需要完全隔离测试场景的情况，可以手动清除 Node.js 的模块缓存：

async function run(name) {
  // 清除步骤定义模块的缓存
  Object.keys(require.cache).forEach(key => {
    if (key.includes('step-definitions')) {
      delete require.cache[key]
    }
  })
  
  // 其余代码保持不变
  const { runConfiguration } = await loadConfiguration({ file: `./config/${name}.json` })
  // ...
}

不过这种方法需要谨慎使用，因为它可能会影响性能并带来副作用。

最佳实践建议

1. 共享支持代码：对于大多数情况，推荐方案一的做法，即在测试开始前加载所有支持代码并复用。

2. 环境隔离：如果确实需要完全隔离测试场景，考虑使用子进程来运行每个测试场景。

3. 配置管理：确保配置文件中的 requireModule 和 require 选项正确设置，避免重复加载带来的问题。

4. 性能考量：频繁加载支持代码会影响测试性能，在设计测试架构时应权衡隔离需求和执行效率。

总结

理解 Cucumber.js 与 Node.js 模块系统的交互方式是解决这类问题的关键。通过合理设计测试生命周期管理，可以避免步骤定义丢失的问题，同时保证测试的可靠性和执行效率。在实际项目中，应根据具体需求选择最适合的解决方案。