#7180: Upgrade Cucumber-js to v12 by afarber · Pull Request #7221 · Project-OSRM/osrm-backend

afarber · 2025-08-17T20:19:25Z

Issue

Fix the issue #7180 by

Upgrade to Cucumber-js v12.1.0 and convert to modern ESM classes
Rename remaining CommonJS files to *.cjs
Use flatbuffers 24.3.25 npm package, matching third_party/flatbuffers
Use function instead of arrow syntax for step definitions
Convert the cucumber config file to the new format
Each scenario gets new World object, adjust for that
Use After instead of process hooks
Add 1 line comments to ./feature/lib/.js ./feature/support/.js ./feature/step_definitions/*.js files
Add features/testbot/hello.feature and features/step_definitions/hello.js to test Cucumber-js
Add .prettierrc matching the eslint.config.js

Please read our documentation on release and version management.
If your PR is still work in progress please attach the relevant label.

Tasklist

CHANGELOG.md entry (How to write a changelog entry)
update relevant Wiki pages
add tests (see testing documentation)
review
adjust for comments

Requirements / Relations

…g.js, use fs.constants.F_OK to avoid warnings

….js files

…syntax to have the access to this object

Fix line numbers in getScenarioID

…Output

…ly initialized

…hich are already covered by #copyMethodsFromServices()

DennisOSRM · 2025-08-25T13:34:23Z

nice！let me know when this is ready for review

afarber · 2025-08-25T14:38:28Z

Hi @DennisOSRM yes, it is ready for review, please tell me what to improve.

It is difficult to upgrade the 9 years old code cleanly...

But I think it would be good to merge this PR now, because all tests pass: osrm-npm-test.txt

And then clean up more in subsequent PRs (for example in this PR I have copied fbresult_generated.js to fbresult_generated.cjs, but in subsequent PR we could convert all remaining *.cjs files to *.js, from CommonJS to ESM)

DennisOSRM · 2025-08-25T18:07:55Z

Sounds good. Would you mind opening tickets after the merge s.t. we have it in the backlog.

DennisOSRM

Looks ready to me. Only minor comments

DennisOSRM · 2025-08-25T19:45:42Z

    - uses: actions/setup-node@v4
      with:
-        node-version: 18
+        node-version: 20


nitpick: is it necessary to bump the node version for these changes?

Node.js 18 has reached end-of-life 30 Apr 2025: https://endoflife.date/nodejs

And also I was getting the warnings from the CI, that cucumber js needs Node.js 20+

DennisOSRM · 2025-08-25T19:53:38Z

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,


Should this be part of the PR or is it unrelated?

This file could be omitted, but in my VS Code I use prettier extension (which is popular with frontend devs) and it was annoyingly reformatting the file on each save and then lint was not happy.

With this .prettierrc which matches the eslint.config.js I did not have the annoyance.

Let's keep it in the PR if you don't mind?

afarber · 2025-08-25T20:27:06Z

Yes, I will create new tickets on further cleanup/improvements during this week

afarber added 30 commits August 16, 2025 18:28

Upgrade cucumber js to v12, add .prettierrc matching the eslint.confi…

8a6b5a6

…g.js, use fs.constants.F_OK to avoid warnings

Add new OSRMWorld class, convert hooks.js

f206198

Remove worlds.js

e2d4b16

Add comments to features/step_definitions/*.js and features/support/*…

0ae3acb

….js files

Add comments to features/lib/*.js files

90b8788

Update hooks for Cucumber v12 compatibility

4d77baf

Use the new Given call, with regexes

1f4a25e

Use the new Given call, with regexes. Use functions instead of arrow …

67f09e2

…syntax to have the access to this object

Convert cucumber.js to new format

1358ae6

Fix tags format in cucumber.js, add hello world feature

afbdb9a

Rename param to testCase

9f9c77b

Fix line numbers in getScenarioID

Add manual feature cache initialization

a72554c

Convert options.js, add temporary logs

6af74b2

Changed arrow functions to regular functions to fix this.resetOptions…

06028dd

…Output

Convert arrow syntax to functions to preserve this. object

e087beb

Remove globalInitialized var and ensure every World instance gets ful…

49588c6

…ly initialized

Use After hook to shutdown osrm-routed

dd0011e

Convert the safe When, Then calls, which are not using this. object

135d40d

Remove debug logs and the obsolete check for Node 4

ed876e2

Remove process listeners, because After is used now

a68b301

Fix indentation issues by running "npm run lint -- --fix"

84b0e02

Add missing mld tags setting

e1dbd52

Convert this.When to new calls

488ae96

Convert this.When to new calls

5f52756

Convert this.When to new calls

89fac60

Remove empty module.exports and add features/support/options.js

4b2ea0a

Add features/support/world.js

799bfca

Call setDefaultTimeout

f870795

Fix access to this.FuzzyMatch.match() by calling bind()

68f8e55

Fix this.findNodeByName(n) by calling bind()

8bc9df9

afarber added 3 commits August 20, 2025 12:27

Add OSRMWorld parame to all service constructors

7195161

Revert unnecessary .bind(this) calls and arrow syntax converstions, w…

2da2efe

…hich are already covered by #copyMethodsFromServices()

Let execFile capture output directly, fix regex parameter handling

a3ae5c4

afarber marked this pull request as ready for review August 23, 2025 18:50

afarber added 17 commits August 23, 2025 20:50

Fix the last test

0108b2c

Use CommonJS for scripts/validate_changelog.js

efec40f

Rename all CommonJS scripts to *.cjs

d33e865

Upgrade node version

c77c313

Fix nodejs-tests by renaming to *.cjs

c5d99a4

Fix refs to the renamed files

1c45735

Rename to *.cjs

93625b5

Fix refs to the renamed files

7df9a09

Revert the features/support/flatbuffers.js and rename it to *.cjs

4f0cc15

Copy the features/support/fbresult_generated.js to *.cjs

031de2c

Fix the export

d980ff9

Update the node-version

54b26b5

Update the node

90ffd54

Clean up parseInt/parseFloat expressions, convert var to let/const

91b687d

Add line to CHANGELOG.md

97d485c

Fix formatting issues

a9571fe

Replace var by let/const

b8e9a6c

DennisOSRM approved these changes Aug 25, 2025

View reviewed changes

DennisOSRM merged commit 14e1713 into Project-OSRM:master Aug 26, 2025
21 checks passed

afarber deleted the 7180-upgrade-cucumber-js branch August 26, 2025 10:50

This was referenced Aug 27, 2025

Complete CommonJS to ESM migration for remaining scripts #7226

Closed

Add husky pre-commit hooks for linting and formatting #7228

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

#7180: Upgrade Cucumber-js to v12#7221

#7180: Upgrade Cucumber-js to v12#7221
DennisOSRM merged 60 commits intoProject-OSRM:masterfrom
afarber:7180-upgrade-cucumber-js

afarber commented Aug 17, 2025 •

edited

Loading

Uh oh!

DennisOSRM commented Aug 25, 2025

Uh oh!

afarber commented Aug 25, 2025 •

edited

Loading

Uh oh!

DennisOSRM commented Aug 25, 2025

Uh oh!

DennisOSRM left a comment

Uh oh!

DennisOSRM Aug 25, 2025

Uh oh!

afarber Aug 25, 2025

Uh oh!

DennisOSRM Aug 25, 2025

Uh oh!

afarber Aug 25, 2025

Uh oh!

afarber commented Aug 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

afarber commented Aug 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Tasklist

Requirements / Relations

Uh oh!

DennisOSRM commented Aug 25, 2025

Uh oh!

afarber commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DennisOSRM commented Aug 25, 2025

Uh oh!

DennisOSRM left a comment

Choose a reason for hiding this comment

Uh oh!

DennisOSRM Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

afarber Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

DennisOSRM Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

afarber Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

afarber commented Aug 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

afarber commented Aug 17, 2025 •

edited

Loading

afarber commented Aug 25, 2025 •

edited

Loading