#7180: Upgrade Cucumber-js to v12 (#7221)

Author: afarber

.github/workflows/osrm-backend.yml

@@ -34,7 +34,7 @@ jobs:
     - run: cmake --version
     - uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
     - run: node --version
     - run: npm --version
     - name: Prepare environment
@@ -100,7 +100,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
     - name: Enable Node.js cache
       uses: actions/cache@v4
       with:
@@ -116,7 +116,7 @@ jobs:
       run: |
         ./scripts/check_taginfo.py taginfo.json profiles/car.lua
         ./scripts/format.sh && ./scripts/error_on_dirty.sh
-        node ./scripts/validate_changelog.js
+        node ./scripts/validate_changelog.cjs
         npm run docs && ./scripts/error_on_dirty.sh
         npm audit --production
 
@@ -215,7 +215,7 @@ jobs:
 
           - name: clang-18-debug-clang-tidy
             continue-on-error: false
-            node: 18
+            node: 20
             runs-on: ubuntu-24.04
             BUILD_TYPE: Debug
             CCOMPILER: clang-18
@@ -227,7 +227,7 @@ jobs:
 
           - name: clang-17-release
             continue-on-error: false
-            node: 18
+            node: 20
             runs-on: ubuntu-24.04
             BUILD_TYPE: Release
             CCOMPILER: clang-17
@@ -237,7 +237,7 @@ jobs:
 
           - name: clang-16-release
             continue-on-error: false
-            node: 18
+            node: 20
             runs-on: ubuntu-24.04
             BUILD_TYPE: Release
             CCOMPILER: clang-16
@@ -247,7 +247,7 @@ jobs:
 
           - name: conan-linux-debug-asan-ubsan
             continue-on-error: false
-            node: 18
+            node: 20
             runs-on: ubuntu-24.04
             BUILD_TYPE: Release
             CCOMPILER: clang-18
@@ -258,7 +258,7 @@ jobs:
 
           - name: conan-linux-release
             continue-on-error: false
-            node: 18
+            node: 20
             runs-on: ubuntu-24.04
             BUILD_TYPE: Release
             CCOMPILER: clang-18
@@ -542,12 +542,12 @@ jobs:
         popd
         npm test
 
-    - name: Use Node 18
+    - name: Use Node 20
       if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' }}
       uses: actions/setup-node@v4
       with:
-        node-version: 18
-    - name: Run Node package tests on Node 18
+        node-version: 20
+    - name: Run Node package tests on Node 20
       if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' }}
       run: |
         node --version

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "singleQuote": true,
+  "semi": true,
+  "endOfLine": "lf"
+}

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
   - Changes from 6.0.0
     - Misc:
+      - CHANGED: Upgrade Cucumber-js to v12 [#7221](https://github.com/Project-OSRM/osrm-backend/pull/7221)
       - FIXED: Minor misspellings found in source code, comments and documents [#7215](https://github.com/Project-OSRM/osrm-backend/pull/7215)
 
 # 6.0.0

cucumber.js

@@ -0,0 +1,32 @@
+// Default profile
+export default {
+  strict: true,
+  tags: 'not @stress and not @todo and not @mld',
+  import: ['features/support', 'features/step_definitions'],
+};
+
+// Additional profiles  
+export const ch = {
+  strict: true,
+  tags: 'not @stress and not @todo and not @mld',
+  format: ['progress'],
+  import: ['features/support', 'features/step_definitions'],
+};
+
+export const todo = {
+  strict: true,
+  tags: '@todo',
+  import: ['features/support', 'features/step_definitions'],
+};
+
+export const all = {
+  strict: true,
+  import: ['features/support', 'features/step_definitions'],
+};
+
+export const mld = {
+  strict: true,
+  tags: 'not @stress and not @todo and not @ch',
+  format: ['progress'],
+  import: ['features/support', 'features/step_definitions'],
+};

cucumber.mjs

@@ -1,28 +1,23 @@
-const { Linter } = require("eslint");
+import { Linter } from 'eslint';
 
 /** @type {Linter.Config} */
 const config = [
-    {
-        rules: {
-            indent: ["error", 2],
-            quotes: ["warn", "single"],
-            "linebreak-style": ["error", "unix"],
-            semi: ["error", "always"],
-            "no-console": ["warn"]
-        },
-        languageOptions: {
-            globals: {
-                es6: true,
-                node: true
-            }
-        },
-        ignores: [
-            "node_modules/",
-            "build/",
-            "dist/",
-            "coverage/"
-        ]
-    }
+  {
+    rules: {
+      indent: ['error', 2],
+      quotes: ['warn', 'single'],
+      'linebreak-style': ['error', 'unix'],
+      semi: ['error', 'always'],
+      'no-console': ['warn'],
+    },
+    languageOptions: {
+      globals: {
+        es6: true,
+        node: true,
+      },
+    },
+    ignores: ['node_modules/', 'build/', 'dist/', 'coverage/'],
+  },
 ];
 
-module.exports = config;
+export default config;

eslint.config.js

@@ -1,31 +1,32 @@
-'use strict';
+// File content hashing utilities for cache invalidation and content verification
+import fs from 'fs';
+import crypto from 'crypto';
+import d3 from 'd3-queue';
 
-const fs = require('fs');
-const crypto = require('crypto');
-const d3 = require('d3-queue');
-
-module.exports =  {
-    hashOfFiles: (paths, cb) => {
-        let queue = d3.queue();
-        for (let i = 0; i < paths.length; ++i) {
-            queue.defer(fs.readFile, paths[i]);
-        }
-        queue.awaitAll((err, results) => {
-            if (err) return cb(err);
-            let checksum = crypto.createHash('md5');
-            for (let i = 0; i < results.length; ++i) {
-                checksum.update(results[i]);
-            }
-            cb(null, checksum.digest('hex'));
-        });
-    },
-
-     hashOfFile: (path, additional_content, cb) => {
-        fs.readFile(path, (err, result) => {
-            if (err) return cb(err);
-            let checksum = crypto.createHash('md5');
-            checksum.update(result + (additional_content || "") );
-            cb(null, checksum.digest('hex'));
-        });
+// Computes MD5 hash of multiple files concatenated together
+const hashOfFiles = (paths, cb) => {
+  let queue = d3.queue();
+  for (let i = 0; i < paths.length; ++i) {
+    queue.defer(fs.readFile, paths[i]);
+  }
+  queue.awaitAll((err, results) => {
+    if (err) return cb(err);
+    let checksum = crypto.createHash('md5');
+    for (let i = 0; i < results.length; ++i) {
+      checksum.update(results[i]);
     }
+    cb(null, checksum.digest('hex'));
+  });
 };
+
+// Computes MD5 hash of single file with optional additional content
+const hashOfFile = (path, additional_content, cb) => {
+  fs.readFile(path, (err, result) => {
+    if (err) return cb(err);
+    let checksum = crypto.createHash('md5');
+    checksum.update(result + (additional_content || ''));
+    cb(null, checksum.digest('hex'));
+  });
+};
+
+export { hashOfFiles, hashOfFile };

features/lib/hash.js

@@ -1,19 +1,21 @@
-'use strict';
-
-const builder = require('xmlbuilder');
-const ensureDecimal = require('./utils').ensureDecimal;
+// OpenStreetMap data structures and XML generation utilities for synthetic test data
+import builder from 'xmlbuilder';
+import { ensureDecimal } from './utils.js';
 
+// OpenStreetMap database for storing nodes, ways, and relations
 class DB {
     constructor () {
         this.nodes = new Array();
         this.ways = new Array();
         this.relations = new Array();
     }
 
+    // Adds OSM node to database
     addNode (node) {
         this.nodes.push(node);
     }
 
+    // Adds OSM way to database
     addWay (way) {
         this.ways.push(way);
     }
@@ -28,13 +30,14 @@ class DB {
         this.relations = [];
     }
 
+    // Converts database to OSM XML format for OSRM processing
     toXML (callback) {
-        var xml = builder.create('osm', {'encoding':'UTF-8'});
+        const xml = builder.create('osm', {'encoding':'UTF-8'});
         xml.att('generator', 'osrm-test')
             .att('version', '0.6');
 
         this.nodes.forEach((n) => {
-            var node = xml.ele('node', {
+            const node = xml.ele('node', {
                 id: n.id,
                 version: 1,
                 uid: n.OSM_UID,
@@ -44,15 +47,15 @@ class DB {
                 lat: ensureDecimal(n.lat)
             });
 
-            for (var k in n.tags) {
+            for (const k in n.tags) {
                 node.ele('tag')
                     .att('k', k)
                     .att('v', n.tags[k]);
             }
         });
 
         this.ways.forEach((w) => {
-            var way = xml.ele('way', {
+            const way = xml.ele('way', {
                 id: w.id,
                 version: 1,
                 uid: w.OSM_UID,
@@ -70,31 +73,31 @@ class DB {
                 }
             });
 
-            for (var k in w.tags) {
+            for (const k in w.tags) {
                 way.ele('tag')
                     .att('k', k)
                     .att('v', w.tags[k]);
             }
         });
 
         this.relations.forEach((r) => {
-            var relation = xml.ele('relation', {
+            const relation = xml.ele('relation', {
                 id: r.id,
                 user: r.OSM_USER,
                 timestamp: r.OSM_TIMESTAMP,
                 uid: r.OSM_UID
             });
 
             r.members.forEach((m) => {
-                var d = {
+                const d = {
                     type: m.type,
                     ref: m.id
                 };
                 if (m.role) d.role = m.role;
                 relation.ele('member', d);
             });
 
-            for (var k in r.tags) {
+            for (const k in r.tags) {
                 relation.ele('tag')
                     .att('k', k)
                     .att('v', r.tags[k]);
@@ -164,9 +167,4 @@ class Relation {
     }
 }
 
-module.exports = {
-    DB: DB,
-    Node: Node,
-    Way: Way,
-    Relation: Relation
-};
+export { DB, Node, Way, Relation };