Implement NodeJS based server replicating osrm-routed

.github/workflows/osrm-backend.yml

@@ -96,6 +96,29 @@ jobs:
  node ./scripts/validate_changelog.js
  npm run docs && ./scripts/error_on_dirty.sh
 
+ routed-js:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v2
+ - name: Use Node.js
+ uses: actions/setup-node@v3
+ with:
+ node-version: 14
+ - name: Enable Node.js cache
+ uses: actions/cache@v2
+ with:
+ path: ~/.npm
+ key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+ restore-keys: |
+ ${{ runner.os }}-node-
+ - name: Compile routed-js
+ run: |
+ pushd routed-js 
+ npm ci
+ npx tsc
+ popd
+ ./scripts/error_on_dirty.sh
+
  docker-image:
  needs: format-taginfo-docs
  runs-on: ubuntu-22.04
@@ -203,7 +226,7 @@ jobs:
 
  - name: conan-linux-release
  continue-on-error: false
- node: 12
+ node: 14
  runs-on: ubuntu-20.04
  BUILD_TOOLS: ON
  BUILD_TYPE: Release
@@ -252,7 +275,7 @@ jobs:
  CXXFLAGS: "-m32 -msse2 -mfpmath=sse"
  TARGET_ARCH: i686
  ENABLE_CONAN: ON
-
+ 
  - name: gcc-8-release
  continue-on-error: false
  node: 12
@@ -460,7 +483,7 @@ jobs:
  CUCUMBER_TIMEOUT: 60000
  ENABLE_ASSERTIONS: ON
  ENABLE_CONAN: ON
-
+ 
  - name: conan-macos-arm64-release-node-lts
  build_node_package: true
  continue-on-error: true
@@ -675,6 +698,9 @@ jobs:
  cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE}
  make --jobs=${JOBS}
  popd
+ - name: Install osrm-routed-js dependencies
+ if: ${{ matrix.node != 12 }}
+ run: cd routed-js && npm ci && npm link && osrm-routed-js --version
  - name: Run all tests
  if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY != 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
  run: |
@@ -757,6 +783,6 @@ jobs:
 
  ci-complete:
  runs-on: ubuntu-22.04
- needs: [build-test-publish, docker-image, windows]
+ needs: [build-test-publish, docker-image, routed-js, windows]
  steps:
  - run: echo "CI complete"

cucumber.js

@@ -3,5 +3,7 @@ module.exports = {
  verify: '--strict --tags ~@stress --tags ~@todo --tags ~@mld-only -f progress --require features/support --require features/step_definitions',
  todo: '--strict --tags @todo --require features/support --require features/step_definitions',
  all: '--strict --require features/support --require features/step_definitions',
- mld: '--strict --tags ~@stress --tags ~@todo --tags ~@ch --require features/support --require features/step_definitions -f progress'
+ mld: '--strict --tags ~@stress --tags ~@todo --tags ~@ch --require features/support --require features/step_definitions -f progress',
+ verify_routed_js: '--strict --tags ~@skip_on_routed_js --tags ~@stress --tags ~@todo --tags ~@mld-only -f progress --require features/support --require features/step_definitions',
+ mld_routed_js: '--strict --tags ~@skip_on_routed_js --tags ~@stress --tags ~@todo --tags ~@ch --require features/support --require features/step_definitions -f progress',
 };

features/lib/osrm_loader.js

@@ -185,11 +185,16 @@ class OSRMLoader {
  this.loader = {shutdown: (cb) => cb() };
  }
  if (this.method === 'datastore') {
- this.loader.shutdown((err) => {
- if (err) return callback(err);
- this.loader = this.sharedLoader;
- this.sharedLoader.load(inputFile, callback);
- });
+ // shutdown only if we are switching from another loader type
+ if (this.loader !== this.sharedLoader) {
+ this.loader.shutdown((err) => {
+ if (err) return callback(err);
+ this.loader = this.sharedLoader;
+ this.sharedLoader.load(inputFile, callback);
+ });
+ } else {
+ this.sharedLoader.load(inputFile, callback);
+ }
  } else if (this.method === 'directly') {
  this.loader.shutdown((err) => {
  if (err) return callback(err);
@@ -198,12 +203,12 @@ class OSRMLoader {
  });
  } else if (this.method === 'mmap') {
  this.loader.shutdown((err) => {
- if (err) return callback(err);
- this.loader = this.mmapLoader;
- this.mmapLoader.load(inputFile, callback);
+  if (err) return callback(err);
+  this.loader = this.mmapLoader;
+  this.mmapLoader.load(inputFile, callback);
  });
  } else {
- callback(new Error('*** Unknown load method ' + method));
+ callback(new Error('*** Unknown load method ' + this.method));
  }
  }
 

features/options/routed/help.feature

@@ -4,6 +4,7 @@ Feature: osrm-routed command line options: help
  Background:
  Given the profile "testbot"
 
+ @skip_on_routed_js
  Scenario: osrm-routed - Help should be shown when no options are passed
  When I run "osrm-routed"
  Then stderr should be empty
@@ -24,6 +25,7 @@ Feature: osrm-routed command line options: help
  And stdout should contain "--max-matching-size"
  And it should exit successfully
 
+ @skip_on_routed_js
  Scenario: osrm-routed - Help, short
  When I run "osrm-routed -h"
  Then stderr should be empty
@@ -44,6 +46,8 @@ Feature: osrm-routed command line options: help
  And stdout should contain "--max-matching-size"
  And it should exit successfully
 
+
+ @skip_on_routed_js
  Scenario: osrm-routed - Help, long
  When I run "osrm-routed --help"
  Then stderr should be empty

features/options/routed/invalid.feature

@@ -4,6 +4,7 @@ Feature: osrm-routed command line options: invalid options
  Background:
  Given the profile "testbot"
 
+ @skip_on_routed_js
  Scenario: osrm-routed - Non-existing option
  When I try to run "osrm-routed --fly-me-to-the-moon"
  Then stdout should be empty

features/step_definitions/requests.js

@@ -33,6 +33,11 @@ module.exports = function () {
  callback();
  });
 
+ this.Then(/^HTTP code should be (\d+)$/, (code, callback) => {
+ assert(this.response.statusCode, parseInt(code));
+ callback();
+ });
+
  this.Then(/^status message should be "(.*?)"$/, (message, callback) => {
  try {
  this.json = JSON.parse(this.response.body);

features/support/env.js

@@ -15,6 +15,8 @@ module.exports = function () {
  this.setDefaultTimeout(this.TIMEOUT);
  this.ROOT_PATH = process.cwd();
 
+ this.USE_ROUTED_JS = process.env.OSRM_USE_ROUTED_JS || false;
+
  this.TEST_PATH = path.resolve(this.ROOT_PATH, 'test');
  this.CACHE_PATH = path.resolve(this.TEST_PATH, 'cache');
  this.LOGS_PATH = path.resolve(this.TEST_PATH, 'logs');
@@ -40,7 +42,7 @@ module.exports = function () {
 
  this.OSRM_PORT = process.env.OSRM_PORT && parseInt(process.env.OSRM_PORT) || 5000;
  this.OSRM_IP = process.env.OSRM_IP || '127.0.0.1';
- this.OSRM_CONNECTION_RETRIES = process.env.OSRM_CONNECTION_RETRIES && parseInt(process.env.OSRM_CONNECTION_RETRIES) || 10;
+ this.OSRM_CONNECTION_RETRIES = process.env.OSRM_CONNECTION_RETRIES && parseInt(process.env.OSRM_CONNECTION_RETRIES) || 100;
  this.OSRM_CONNECTION_EXP_BACKOFF_COEF = process.env.OSRM_CONNECTION_EXP_BACKOFF_COEF && parseFloat(process.env.OSRM_CONNECTION_EXP_BACKOFF_COEF) || 1.0;
 
  this.HOST = `http://${this.OSRM_IP}:${this.OSRM_PORT}`;

features/support/run.js

@@ -39,7 +39,11 @@ module.exports = function () {
 
  this.runBin = (bin, options, env, callback) => {
  let cmd = path.resolve(util.format('%s/%s%s', this.BIN_PATH, bin, this.EXE));
+ if (this.USE_ROUTED_JS && bin === 'osrm-routed') {
+ cmd = 'osrm-routed-js';
+ }
  let opts = options.split(' ').filter((x) => { return x && x.length > 0; });
+
  let log = fs.createWriteStream(this.scenarioLogFile, {'flags': 'a'});
  log.write(util.format('*** running %s %s\n', cmd, options));
  // we need to set a large maxbuffer here because we have long running processes like osrm-routed

features/testbot/annotations.feature

@@ -115,4 +115,4 @@ Feature: Annotations
 
  When I route I should get
  | from | to | route | a:speed | a:distance | a:duration | a:nodes |
- | a | c | abc,abc | 10:10 | 249.987618946:299.962882039 | 25:30 | 1:2:3 |
+ | a | c | abc,abc | 10:10 | 249.987618946:299.962882039 +- 1e-7 | 25:30 | 1:2:3 |

features/testbot/exclude.feature

@@ -80,15 +80,15 @@ Feature: Testbot - Exclude flags
  | a | c | |
  | a | f | |
  | f | d | fg,gd,gd |
-
+ @skip_on_routed_js
  Scenario: Testbot - exclude with unsupported exclude combination
  Given the query options
  | exclude | TwoWords2 |
 
  When I route I should get
  | from | to | status | message |
  | a | d | 400 | Exclude flag combination is not supported. |
-
+ @skip_on_routed_js
  Scenario: Testbot - exclude with invalid exclude class name
  Given the query options
  | exclude | foo |

features/testbot/load.feature

@@ -32,6 +32,7 @@ Feature: Ways of loading data
  Then stderr should be empty
  And it should exit successfully
 
+ @skip_on_routed_js
  Scenario: osrm-datastore - Fail if no shared memory blocks are loaded
  When I run "osrm-datastore --spring-clean" with input "Y"
  And I try to run "osrm-routed --shared-memory=1"

features/testbot/matching.feature

@@ -563,6 +563,7 @@ Feature: Basic Map Matching
  | trace | timestamps | code |
  | abcd | 0 1 62 63 | NoMatch |
 
+ @skip_on_routed_js
  Scenario: Testbot - Map matching invalid waypoints
  Given the node map
  """
@@ -580,6 +581,7 @@ Feature: Basic Map Matching
  | trace | code |
  | abcd | InvalidOptions |
 
+ @skip_on_routed_js
  Scenario: Matching fail with waypoints param missing start/end
  Given the node map
  """
@@ -788,7 +790,7 @@ Feature: Basic Map Matching
  | 1234 | 1.000135,1,1.000225,1,1.000404,1,1.000449,1 | 1:2:0.4 | 1:2:0.4 | 3.4 |
  | 4321 | 1.000449,1,1.000404,1,1.000225,1,1.000135,1 | 0.4:2:1 | 0.4:2:1 | 3.4 |
 
- @match @testbot
+ @match @testbot @skip_on_routed_js
  Scenario: Regression test - add source phantom properly (two phantoms on one edge)
  Given the profile "testbot"
  Given a grid size of 10 meters
@@ -809,7 +811,7 @@ Feature: Basic Map Matching
 
  # These should have the same weights/duration in either direction
  When I match I should get
- | trace | geometry | a:distance  | a:duration | a:weight | duration |
- | 2345 | 1.00018,1,1.000314,1 | 14.914666491  | 1.4 | 1.4 | 1.4 |
- | 4321 | 1.00027,1,1.000135,1 | 15.025969972  | 1.5 | 1.5 | 1.5 |
+ | trace | geometry | a:distance | a:duration | a:weight | duration |
+ | 2345 | 1.00018,1,1.000314,1 | 14.914666491 | 1.4 | 1.4 | 1.4 |
+ | 4321 | 1.00027,1,1.000135,1 | 15.025969972 | 1.5 | 1.5 | 1.5 |
 

features/testbot/snap_intersection.feature

@@ -570,7 +570,7 @@ Feature: Snapping at intersections
  | a,f,k | ac,cf,cf,fj,kj,kj | 132.8s | 132.8 |
  | k,f | ik,fi,fi | 54.3s | 54.3 |
  | f,a | ef,ae,ae | 66.6s | 66.6 |
- | k,f,a | kj,fj,fj,ef,ae,ae | 141.399999999s | 141.399999999 |
+ | k,f,a | kj,fj,fj,ef,ae,ae | 141.399999999s +- 1e-7 | 141.399999999 +- 1e-7 |
 
  When I request a travel time matrix I should get
  | | a | f | k |
@@ -626,4 +626,4 @@ Feature: Snapping at intersections
  | a,f,k | ad,df,df,fj,kj,kj | 105.6s | 105.6 |
  | k,f | ik,fi,fi | 54.3s | 54.3 |
  | f,a | ef,ae,ae | 66.6s | 66.6 |
- | k,f,a | ik,fi,fi,ef,ae,ae | 120.899999999s | 120.899999999 |
+ | k,f,a | ik,fi,fi,ef,ae,ae | 120.899999999s +- 1e-7 | 120.899999999 +- 1e-7 |

features/testbot/status.feature

@@ -18,7 +18,7 @@ Feature: Status messages
  | from | to | route | status | message |
  | a | b | ab,ab | 200 | |
  | b | a | ab,ab | 200 | |
-
+ @skip_on_routed_js
  Scenario: No route found
  Given the node map
  """
@@ -39,6 +39,7 @@ Feature: Status messages
  | a | c | | 400 | Impossible route between points |
  | b | d | | 400 | Impossible route between points |
 
+ @skip_on_routed_js
  Scenario: Malformed requests
  Given the node locations
  | node | lat | lon |

features/testbot/trip.feature

@@ -4,7 +4,8 @@ Feature: Basic trip planning
  Background:
  Given the profile "testbot"
  Given a grid size of 10 meters
-
+
+ @skip_on_routed_js
  Scenario: Testbot - Trip: Invalid options (like was in test suite for a long time)
  Given the node map
  """
@@ -222,7 +223,7 @@ Feature: Basic trip planning
  | waypoints | trips | roundtrip | durations |
  | a,b,c,d,e,f,g,h,i,j,k,l | lkjihgfedcbal | true | 22 |
  | a,b,c,d,e,f,g,h,i,j,k,l | cbakjihgfedl | false | 19 |
-
+ @skip_on_routed_js
  Scenario: Testbot - Trip: Unroutable roundtrip with waypoints (less than 10)
  Given the node map
  """
@@ -240,7 +241,7 @@ Feature: Basic trip planning
  | waypoints | status | message |
  | a,b,c,d | NoTrips | No trip visiting all destinations possible. |
 
-
+ @skip_on_routed_js
  Scenario: Testbot - Trip: Unroutable roundtrip with waypoints (more than 10)
  Given the node map
  """
@@ -278,6 +279,7 @@ Feature: Basic trip planning
  | a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p | NoTrips | No trip visiting all destinations possible. |
 
 # Test TFSE
+ @skip_on_routed_js
  Scenario: Testbot - Trip: TFSE with errors
  Given the node map
  """
@@ -371,7 +373,7 @@ Feature: Basic trip planning
  | waypoints | source | destination | roundtrip | trips |
  | a,b,d,e,c | first | last | true | abedca |
 
-
+ @skip_on_routed_js
  Scenario: Testbot - Trip: midway points in isolated roads should return no trips
  Given the node map
  """

features/testbot/weight.feature

@@ -52,11 +52,11 @@ Feature: Weight tests
  | abc |
 
  When I route I should get
- | waypoints | route | distances | weights | times | a:distance | a:duration | a:weight | a:speed |
- | s,t | abc,abc | 20m,0m | 2,0 | 2s,0s | 20.034626629 | 2 | 2 | 10 |
- | t,s | abc,abc | 20m,0m | 2,0 | 2s,0s | 20.034626629 | 2 | 2 | 10 |
- | s,e | abc,abc | 40m,0m | 3.9,0 | 3.9s,0s | 29.940636463:10.017313314 | 3:0.9 | 3:0.9 | 10:11.1 |
- | e,s | abc,abc | 40m,0m | 3.9,0 | 3.9s,0s | 10.017313314:29.940636463 | 0.9:3 | 0.9:3 | 11.1:10 |
+ | waypoints | route | distances | weights | times | a:distance  | a:duration | a:weight | a:speed |
+ | s,t | abc,abc | 20m,0m | 2,0 | 2s,0s | 20.034626629 +- 1e-7  | 2 | 2 | 10 |
+ | t,s | abc,abc | 20m,0m | 2,0 | 2s,0s | 20.034626629 +- 1e-7  | 2 | 2 | 10 |
+ | s,e | abc,abc | 40m,0m | 3.9,0 | 3.9s,0s | 29.940636463:10.017313314 +- 1e-7 | 3:0.9 | 3:0.9 | 10:11.1 |
+ | e,s | abc,abc | 40m,0m | 3.9,0 | 3.9s,0s | 10.017313314:29.940636463 +- 1e-7 | 0.9:3 | 0.9:3 | 11.1:10 |
 
 
  Scenario: Step weights -- way_function: fail if no weight or weight_per_meter property

features/tile/tile.feature

@@ -0,0 +1,14 @@
+Feature: Tile service
+ Background:
+ Given the profile "testbot"
+ Scenario: Smoke test
+ Given the origin 52.5212,13.3919
+ Given the node map
+ """
+ a b
+ """
+ And the ways
+ | nodes |
+ | ab |
+ When I request /tile/v1/testbot/tile(8800,5373,14).mvt
+ Then HTTP code should be 200

package.json

@@ -19,7 +19,7 @@
  },
  "scripts": {
  "lint": "node ./node_modules/eslint/bin/eslint.js -c ./.eslintrc features/step_definitions/ features/support/",
- "test": "npm run lint && node ./node_modules/cucumber/bin/cucumber.js features/ -p verify && node ./node_modules/cucumber/bin/cucumber.js features/ -p verify -m mmap && node ./node_modules/cucumber/bin/cucumber.js features/ -p mld && node ./node_modules/cucumber/bin/cucumber.js features/ -p mld -m mmap",
+ "test": "npm run lint && ./scripts/run_cucumber_tests.sh",
  "clean": "rm -rf test/cache",
  "docs": "./scripts/build_api_docs.sh",
  "install": "node-pre-gyp install --fallback-to-build=false || ./scripts/node_install.sh",

routed-js/Format.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Format = void 0;
+var Format;
+(function (Format) {
+ Format["Json"] = "json";
+ Format["Flatbuffers"] = "flatbuffers";
+})(Format = exports.Format || (exports.Format = {}));

routed-js/Format.ts

@@ -0,0 +1,4 @@
+export enum Format {
+ Json = 'json',
+ Flatbuffers = 'flatbuffers'
+}