Support Node.js 23 (#2446)

Author: davidjgoss

.github/workflows/build.yaml

@@ -20,7 +20,7 @@ jobs:
           - ubuntu-latest
           - windows-latest
         # these versions must be kept in sync with enginesTested.node in package.json
-        node-version: [18.x, 20.x, 22.6]
+        node-version: [18.x, 20.x, 22.x, 23.x]
       fail-fast: false
 
     steps:
@@ -37,7 +37,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 22.6
+          node-version: 22.x
       - run: npm install
       - run: npm run test-coverage
       - uses: coverallsapp/github-action@master
@@ -54,5 +54,5 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 22.6
+          node-version: 22.x
       - run: npm audit --groups dependencies --audit-level high

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Added
+- Add support for Node.js 23 ([#2446](https://github.com/cucumber/cucumber-js/pull/2446))
+
 ### Changed
 - Replace JUnit formatter with messages-based package ([#2445](https://github.com/cucumber/cucumber-js/pull/2445))
 

features/esm.feature

@@ -83,6 +83,7 @@ Feature: ES modules support
     Then it runs 2 scenarios
     And it passes
 
+  @without-require-esm
   Scenario: ES module invoked with --require
     Given a file named "features/a.feature" with:
       """
@@ -102,3 +103,25 @@ Feature: ES modules support
       """
         Error: Cucumber expected a CommonJS module 
       """
+
+  Scenario: ES module with top-level await invoked with --require
+    Given a file named "features/a.feature" with:
+      """
+      Feature:
+        Scenario: one
+          Given a step passes
+      """
+    And a file named "features/step_definitions/cucumber_steps.js" with:
+      """
+      import {Given} from '@cucumber/cucumber'
+
+      await Promise.resolve()
+
+      Given(/^a step passes$/, function() {});
+      """
+    When I run cucumber-js with `--require features/**/*.js`
+    Then it fails
+    And the error output contains the text:
+      """
+        Error: Cucumber expected a CommonJS module
+      """

features/support/hooks.ts

@@ -52,6 +52,14 @@ Before('@esm', function (this: World) {
   })
 })
 
+Before('@without-require-esm', function (this: World) {
+  // @ts-expect-error require_module flag not in @types/node yet
+  if (process.features.require_module) {
+    return 'skipped'
+  }
+  return undefined
+})
+
 After(async function (this: World) {
   if (this.reportServer?.started) {
     await this.reportServer.stop()

package-lock.json

@@ -208,10 +208,10 @@
   },
   "types": "./lib/index.d.ts",
   "engines": {
-    "node": "18 || 20 || >=22"
+    "node": "18 || 20 || 22 || >=23"
   },
   "enginesTested": {
-    "node": "18 || 20 || 22"
+    "node": "18 || 20 || 22 || 23"
   },
   "dependencies": {
     "@cucumber/ci-environment": "10.0.1",

package.json

@@ -14,6 +14,12 @@ export default function tryRequire(path: string) {
       Either change the file to CommonJS syntax or use the --import directive instead of --require.`,
         { cause: error }
       )
+    } else if (error.code === 'ERR_REQUIRE_ASYNC_MODULE') {
+      throw Error(
+        `Cucumber expected a CommonJS module or simple ES module at '${path}' but found an async ES module.
+      Either change the file so it can be required or use the --import directive instead of --require.`,
+        { cause: error }
+      )
     } else {
       throw error
     }