Fix travis.yml

.travis.yml

@@ -7,14 +7,20 @@ git:
 sudo: required
 dist: trusty
 
+nodejs:
+    - "4"
+
 notifications:
   email: false
 
 branches:
   only:
     - master
+    # enable building tags
+    - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
 
 cache:
+  yarn: true
   ccache: true
   apt: true
   directories:
@@ -22,6 +28,8 @@ cache:
 
 env:
   global:
+   - secure: "hk+32aXXF5t1ApaM2Wjqooz3dx1si907L87WRMkO47WlpJmUUU/Ye+MJk9sViH8MdhOcceocVAmdYl5/WFWOIbDWNlBya9QvXDZyIu2KIre/0QyOCTZbrsif8paBXKIO5O/R4OTvIZ8rvWZsadBdmAT9GSbDhih6FzqXAEgeIYQ="
+   - secure: "VE+cFkseFwW4jK6XwkP0yW3h4DixPJ8+Eb3yKcchGZ5iIJxlZ/8i1vKHYxadgPRwSYwPSB14tF70xj2OmiT2keGzZUfphmPXinBaLEhYk+Bde+GZZkoSl5ND109I/LcyNr0nG9dDgtV6pkvFchgchpyP9JnVOOS0+crEZlAz0RE="
    - CCACHE_TEMPDIR=/tmp/.ccache-temp
    - CCACHE_COMPRESS=1
    - CASHER_TIME_OUT=599 # one second less than 10m to avoid 10m timeout error: https://github.com/Project-OSRM/osrm-backend/issues/2742
@@ -138,11 +146,12 @@ before_install:
     if [[ "${TRAVIS_OS_NAME}" == "osx" ]]; then
       export JOBS=$((`sysctl -n hw.ncpu` + 1))
       sudo mdutil -i off /
+      npm install -g yarn
     fi
+  - export PACKAGE_JSON_VERSION=$(node -e "console.log(require('./package.json').version)")
+  - export PUBLISH=$([[ "${TRAVIS_TAG:-}" == "v${PACKAGE_JSON_VERSION}" ]] && echo "On" || echo "Off")
   - echo "Using ${JOBS} jobs"
-  - source ./scripts/install_node.sh 4
+  - yarn install --ignore-scripts
-  - npm install -g "npm@>=3" # Upgrade to npm >v2 to reduce size of downloaded dependencies
-  - npm install --ignore-scripts
     # Bootstrap cmake to be able to run mason
   - CMAKE_URL="https://mason-binaries.s3.amazonaws.com/${TRAVIS_OS_NAME}-x86_64/cmake/${CMAKE_VERSION}.tar.gz"
   - CMAKE_DIR="mason_packages/${TRAVIS_OS_NAME}-x86_64/cmake/${CMAKE_VERSION}"
@@ -173,7 +182,16 @@ install:
   - export OSRM_BUILD_DIR="$(pwd)/build-osrm"
   - mkdir ${OSRM_BUILD_DIR} && pushd ${OSRM_BUILD_DIR}
   - export CC=${CCOMPILER} CXX=${CXXCOMPILER}
-  - cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DENABLE_MASON=${ENABLE_MASON:-OFF} -DENABLE_ASSERTIONS=${ENABLE_ASSERTIONS:-OFF} -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS:-OFF} -DENABLE_COVERAGE=${ENABLE_COVERAGE:-OFF} -DENABLE_SANITIZER=${ENABLE_SANITIZER:-OFF} -DBUILD_TOOLS=ON -DENABLE_CCACHE=ON -DENABLE_NODE_BINDINGS=${ENABLE_NODE_BINDINGS:-OFF}
+  - |
+    cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
+             -DENABLE_MASON=${ENABLE_MASON:-OFF} \
+             -DENABLE_ASSERTIONS=${ENABLE_ASSERTIONS:-OFF} \
+             -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS:-OFF} \
+             -DENABLE_COVERAGE=${ENABLE_COVERAGE:-OFF} \
+             -DENABLE_NODE_BINDINGS=${ENABLE_NODE_BINDINGS:-OFF} \
+             -DENABLE_SANITIZER=${ENABLE_SANITIZER:-OFF} \
+             -DBUILD_TOOLS=ON \
+             -DENABLE_CCACHE=ON
   - echo "travis_fold:start:MAKE"
   - make --jobs=${JOBS}
   - make tests --jobs=${JOBS}
@@ -190,7 +208,8 @@ install:
   - cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE}
   - make --jobs=${JOBS}
   - popd
-  - npm run build-api-docs
+  # building docs only works with npm3+ not with yarn or npm2
+  #- yarn run docs
 
 script:
   - if [[ $TARGET_ARCH == armhf ]] ; then echo "Skip tests for $TARGET_ARCH" && exit 0 ; fi
@@ -205,7 +224,7 @@ script:
   - ./unit_tests/server-tests
   - ./unit_tests/partition-tests
   - popd
-  - npm test
+  - yarn test
 
 after_success:
   - |
@@ -215,8 +234,5 @@ after_success:
 
   - |
     if [ -n "${ENABLE_NODE_BINDINGS}" ]; then
-      nvm install 4
-      nvm use 4
-      source ./scripts/travis/build.sh
       ./scripts/travis/publish.sh
     fi

cloudformation/ci.template

@@ -0,0 +1,75 @@
+{
+    "AWSTemplateFormatVersion": "2010-09-09",
+    "Description": "user for publishing to s3://mapbox-node-binary/osrm",
+    "Resources": {
+        "User": {
+            "Type": "AWS::IAM::User",
+            "Properties": {
+                "Policies": [
+                    {
+                        "PolicyName": "list",
+                        "PolicyDocument": {
+                            "Statement": [
+                                {
+                                    "Action": [
+                                        "s3:ListBucket"
+                                    ],
+                                    "Effect": "Allow",
+                                    "Resource": "arn:aws:s3:::mapbox-node-binary",
+                                    "Condition": {
+                                        "StringLike": {
+                                            "s3:prefix": [
+                                                "osrm/*"
+                                            ]
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    {
+                        "PolicyName": "publish",
+                        "PolicyDocument": {
+                            "Statement": [
+                                {
+                                    "Action": [
+                                        "s3:DeleteObject",
+                                        "s3:GetObject",
+                                        "s3:GetObjectAcl",
+                                        "s3:PutObject",
+                                        "s3:PutObjectAcl"
+                                    ],
+                                    "Effect": "Allow",
+                                    "Resource": "arn:aws:s3:::mapbox-node-binary/osrm/*"
+                                }
+                            ]
+                        }
+                    }
+                ]
+            }
+        },
+        "AccessKey": {
+            "Type": "AWS::IAM::AccessKey",
+            "Properties": {
+                "UserName": {
+                    "Ref": "User"
+                }
+            }
+        }
+    },
+    "Outputs": {
+        "AccessKeyId": {
+            "Value": {
+                "Ref": "AccessKey"
+            }
+        },
+        "SecretAccessKey": {
+            "Value": {
+                "Fn::GetAtt": [
+                    "AccessKey",
+                    "SecretAccessKey"
+                ]
+            }
+        }
+    }
+}

cloudformation/ci.template.js

@@ -0,0 +1,59 @@
+var cf = require('@mapbox/cloudfriend');
+var package_json = require('../package.json')
+
+module.exports = {
+  AWSTemplateFormatVersion: '2010-09-09',
+  Description: 'user for publishing to s3://mapbox-node-binary/' + package_json.name,
+  Resources: {
+    User: {
+      Type: 'AWS::IAM::User',
+      Properties: {
+        Policies: [
+          {
+            PolicyName: 'list',
+            PolicyDocument: {
+              Statement: [
+                {
+                  Action: ['s3:ListBucket'],
+                  Effect: 'Allow',
+                  Resource: 'arn:aws:s3:::mapbox-node-binary',
+                  Condition : {
+                    StringLike : {
+                      "s3:prefix": [ package_json.name + "/*"]
+                    }
+                  }
+                }
+              ]
+            }
+          },
+          {
+            PolicyName: 'publish',
+            PolicyDocument: {
+              Statement: [
+                {
+                  Action: ['s3:DeleteObject', 's3:GetObject', 's3:GetObjectAcl', 's3:PutObject', 's3:PutObjectAcl'],
+                  Effect: 'Allow',
+                  Resource: 'arn:aws:s3:::mapbox-node-binary/' + package_json.name + '/*'
+                }
+              ]
+            }
+          }
+        ]
+      }
+    },
+    AccessKey: {
+      Type: 'AWS::IAM::AccessKey',
+      Properties: {
+        UserName: cf.ref('User')
+      }
+    }
+  },
+  Outputs: {
+    AccessKeyId: {
+      Value: cf.ref('AccessKey')
+    },
+    SecretAccessKey: {
+      Value: cf.getAtt('AccessKey', 'SecretAccessKey')
+    }
+  }
+};

include/nodejs/node_osrm_support.hpp

@@ -117,6 +117,7 @@ inline engine_config_ptr argumentsToEngineConfig(const Nan::FunctionCallbackInfo
     {
         engine_config->storage_config =
             osrm::StorageConfig(*v8::String::Utf8Value(Nan::To<v8::String>(path).ToLocalChecked()));
+        engine_config->use_shared_memory = false;
     }
     if (!shared_memory->IsUndefined())
     {
@@ -138,6 +139,34 @@ inline engine_config_ptr argumentsToEngineConfig(const Nan::FunctionCallbackInfo
         return engine_config_ptr();
     }
 
+    auto algorithm = params->Get(Nan::New("algorithm").ToLocalChecked());
+    if (algorithm->IsString())
+    {
+        auto algorithm_str = Nan::To<v8::String>(algorithm).ToLocalChecked();
+        if (*v8::String::Utf8Value(algorithm_str) == std::string("CH"))
+        {
+            engine_config->algorithm = osrm::EngineConfig::Algorithm::CH;
+        }
+        else if (*v8::String::Utf8Value(algorithm_str) == std::string("CoreCH"))
+        {
+            engine_config->algorithm = osrm::EngineConfig::Algorithm::CoreCH;
+        }
+        else if (*v8::String::Utf8Value(algorithm_str) == std::string("MLD"))
+        {
+            engine_config->algorithm = osrm::EngineConfig::Algorithm::MLD;
+        }
+        else
+        {
+            Nan::ThrowError("algorithm option must be one of 'CH', 'CoreCH', or 'MLD'.");
+            return engine_config_ptr();
+        }
+    }
+    else if (!algorithm->IsUndefined())
+    {
+        Nan::ThrowError("algorithm option must be a string and one of 'CH', 'CoreCH', or 'MLD'.");
+        return engine_config_ptr();
+    }
+
     return engine_config;
 }
 

package.json

@@ -1,25 +1,12 @@
 {
   "name": "osrm",
-  "version": "5.7.0",
+  "version": "5.7.0-latest.1",
-  "private": true,
+  "private": false,
   "description": "The Open Source Routing Machine is a high performance routing engine written in C++14 designed to run on OpenStreetMap data.",
   "dependencies": {
-    "chalk": "^1.1.3",
-    "cucumber": "^1.2.1",
-    "d3-queue": "^2.0.3",
-    "mkdirp": "^0.5.1",
-    "node-timeout": "0.0.4",
-    "polyline": "^0.2.0",
-    "request": "^2.69.0",
-    "rimraf": "^2.5.4",
-    "xmlbuilder": "^4.2.1",
-
     "nan": "^2.1.0",
     "node-cmake": "^1.2.1",
-    "node-pre-gyp": "~0.6.30"
+    "node-pre-gyp": "^0.6.34"
-  },
-  "bin": {
-    "cucumber": "./node_modules/cucumber/bin/cucumber.js"
   },
   "browserify": {
     "transform": [
@@ -30,19 +17,16 @@
   "scripts": {
     "lint": "eslint -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 mld",
-    "clean-test": "rm -rf test/cache",
+    "clean": "rm -rf test/cache",
-    "cucumber": "./node_modules/cucumber/bin/cucumber.js",
+    "docs": "./scripts/build_api_docs.sh",
-    "build-api-docs": "./scripts/build_api_docs.sh",
-
-    "preinstall": "npm install node-pre-gyp",
     "install": "node-pre-gyp install --fallback-to-build=false"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/Project-OSRM/osrm-backend.git"
   },
-  "author": "",
+  "author": "Project OSRM Team",
-  "license": "ISC",
+  "license": "BSD 2-Clause",
   "bugs": {
     "url": "https://github.com/Project-OSRM/osrm-backend/issues"
   },
@@ -51,12 +35,24 @@
     "node": ">=4.0.0"
   },
   "devDependencies": {
-    "docbox": "^1.0.2",
+    "docbox": "^1.0.5",
+    "documentation": "^4.0.0-beta.18",
     "eslint": "^2.4.0",
-
+    "chalk": "^1.1.3",
+    "cucumber": "^1.2.1",
+    "d3-queue": "^2.0.3",
+    "mkdirp": "^0.5.1",
     "aws-sdk": "~2.0.31",
-    "tape": "^4.2.2"
+    "tape": "^4.2.2",
+    "node-timeout": "0.0.4",
+    "polyline": "^0.2.0",
+    "request": "^2.69.0",
+    "rimraf": "^2.5.4",
+    "xmlbuilder": "^4.2.1"
   },
+  "bundleDependencies": [
+    "node-pre-gyp"
+  ],
   "main": "lib/index.js",
   "binary": {
     "module_name": "node-osrm",

scripts/build_api_docs.sh

@@ -14,6 +14,8 @@ babel -V >/dev/null 2>&1 || { echo >&2 "Can't find babel.  Add node_modules/.bin
 browserify --help >/dev/null 2>&1 || { echo >&2 "Can't find browserify.  Add node_modules/.bin to your path, or run via \"npm run\""; exit 1; }
 uglifyjs -V >/dev/null 2>&1 || { echo >&2 "Can't find uglifyjs.  Add node_modules/.bin to your path, or run via \"npm run\""; exit 1; }
 
+#documentation build src/nodejs/node_osrm.cpp --polyglot -f md -o docs/nodejs/api.md
+
 # Clean up previous version
 rm -rf build/docs
 

scripts/travis/build.sh

@@ -1,99 +0,0 @@
-#!/usr/bin/env bash
-
-set -eu
-set -o pipefail
-
-# defaults
-export ENABLE_COVERAGE=${ENABLE_COVERAGE:-"Off"}
-export BUILD_TYPE=${BUILD_TYPE:-"Release"}
-export NODE=${NODE:-4}
-
-export CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-
-export DEPS_DIR="$(pwd)/deps"
-export PATH=${DEPS_DIR}/bin:${PATH}
-mkdir -p ${DEPS_DIR}
-
-export CLANG_VERSION="${CLANG_VERSION:-4.0.0}"
-export CCACHE_VERSION=3.3.1
-export CMAKE_VERSION=3.7.2
-
-source ${CURRENT_DIR}/travis_helper.sh
-
-# ensure we start inside the root directory (two level up)
-cd ${CURRENT_DIR}/../../
-
-if [[ ! $(which wget) ]]; then
-    echo "echo wget must be installed";
-    exit 1;
-fi;
-
-SYSTEM_NAME=$(uname -s)
-if [[ "${SYSTEM_NAME}" == "Darwin" ]]; then
-    OS_NAME="osx"
-elif [[ "${SYSTEM_NAME}" == "Linux" ]]; then
-    OS_NAME="linux"
-fi
-
-# FIXME This should be replaced by proper calls to mason but we currently have a chicken-egg problem
-# since we rely on osrm-backend to ship mason for us. Once we merged this into osrm-backend this will not be needed.
-CMAKE_URL="https://s3.amazonaws.com/mason-binaries/${OS_NAME}-x86_64/cmake/${CMAKE_VERSION}.tar.gz"
-echo "Downloading cmake from ${CMAKE_URL} ..."
-wget --quiet -O - ${CMAKE_URL} | tar --strip-components=1 -xz -C ${DEPS_DIR} || exit 1
-CCACHE_URL="https://s3.amazonaws.com/mason-binaries/${OS_NAME}-x86_64/ccache/${CCACHE_VERSION}.tar.gz"
-echo "Downloading ccache from ${CCACHE_URL} ..."
-wget --quiet -O - ${CCACHE_URL} | tar --strip-components=1 -xz -C ${DEPS_DIR} || exit 1
-# install clang for linux but use the xcode version on OSX
-if [[ "${OS_NAME}" != "osx" ]]; then
-    CLANG_URL="https://s3.amazonaws.com/mason-binaries/${OS_NAME}-x86_64/clang++/${CLANG_VERSION}.tar.gz"
-    echo "Downloading clang from ${CLANG_URL} ..."
-    wget --quiet -O - ${CLANG_URL} | tar --strip-components=1 -xz -C ${DEPS_DIR} || exit 1
-    export CCOMPILER='clang'
-    export CXXCOMPILER='clang++'
-    export CC='clang'
-    export CXX='clang++'
-fi
-
-if [[ "${OS_NAME}" == "osx" ]]; then
-    if [[ -f /etc/sysctl.conf ]] && [[ $(grep shmmax /etc/sysctl.conf) ]]; then
-        echo "Note: found shmmax setting in /etc/sysctl.conf, not modifying"
-    else
-        echo "WARNING: Did not find shmmax setting in /etc/sysctl.conf, adding now (requires sudo and restarting)..."
-        sudo sysctl -w kern.sysv.shmmax=4294967296
-        sudo sysctl -w kern.sysv.shmall=1048576
-        sudo sysctl -w kern.sysv.shmseg=128
-    fi
-fi
-
-
-echo "Now build node-osrm and dependencies"
-export VERBOSE=1
-if [[ "${ENABLE_COVERAGE}" == "On" ]]; then
-    mapbox_time "make" make -j4 coverage
-else
-    mkdir -p build
-    pushd build
-    cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DENABLE_NODE_BINDINGS=On -DENABLE_MASON=On
-    mapbox_time "make" make -j4
-    popd
-fi
-
-## run tests, with backtrace support
-#if [[ "${OS_NAME}" == "linux" ]]; then
-#    ulimit -c unlimited -S
-#    RESULT=0
-#    mapbox_time "make-test" make tests || RESULT=$?
-#    for i in $(find ./ -maxdepth 1 -name 'core*' -print);
-#      do gdb $(which node) $i -ex "thread apply all bt" -ex "set pagination 0" -batch;
-#    done;
-#    if [[ ${RESULT} != 0 ]]; then exit $RESULT; fi
-#else
-#    # todo: coredump support on OS X
-#    RESULT=0
-#    mapbox_time "make-test" make tests || RESULT=$?
-#    if [[ ${RESULT} != 0 ]]; then exit $RESULT; fi
-#fi
-
-
-set +eu
-set +o pipefail

scripts/travis/publish.sh

@@ -3,19 +3,19 @@
 set -eu
 set -o pipefail
 
-# should be set for debug builds
+if [[ ${PUBLISH} == 'On' ]]; then
-export NPM_FLAGS=${NPM_FLAGS:-}
+    echo "PUBLISH is set to '${PUBLISH}', publishing!"
 
-echo "node version is:"
+    echo "node version is:"
-which node
+    which node
-node -v
+    node -v
 
-echo "dumping binary meta..."
+    echo "dumping binary meta..."
-./node_modules/.bin/node-pre-gyp reveal ${NPM_FLAGS}
+    ./node_modules/.bin/node-pre-gyp reveal
 
-# enforce that binary has proper ORIGIN flags so that
+    # enforce that binary has proper ORIGIN flags so that
-# it can portably find libtbb.so in the same directory
+    # it can portably find libtbb.so in the same directory
-if [[ $(uname -s) == 'Linux' ]]; then
+    if [[ $(uname -s) == 'Linux' ]]; then
         readelf -d ./lib/binding/node-osrm.node > readelf-output.txt
         if grep -q 'Flags: ORIGIN' readelf-output.txt; then
             echo "Found ORIGIN flag in readelf output"
@@ -25,27 +25,9 @@ if [[ $(uname -s) == 'Linux' ]]; then
             cat readelf-output.txt
             exit 1
         fi
-fi
+    fi
 
-echo "determining publishing status..."
+    ./node_modules/.bin/node-pre-gyp package publish info
-
-if [[ $(./scripts/travis/is_pr_merge.sh) ]]; then
-    echo "Skipping publishing because this is a PR merge commit"
 else
-    echo "This is a push commit, continuing to package..."
+    echo "PUBLISH is set to '${PUBLISH}', skipping."
-    ./node_modules/.bin/node-pre-gyp package ${NPM_FLAGS}
-
-    export COMMIT_MESSAGE=$(git log --format=%B --no-merges | head -n 1 | tr -d '\n')
-    echo "Commit message: ${COMMIT_MESSAGE}"
-
-    if [[ ${COMMIT_MESSAGE} =~ "[publish binary]" ]]; then
-        echo "Publishing"
-        ./node_modules/.bin/node-pre-gyp publish ${NPM_FLAGS}
-    elif [[ ${COMMIT_MESSAGE} =~ "[republish binary]" ]]; then
-        echo "*** Error: Republishing is disallowed for this repository"
-        exit 1
-        #./node_modules/.bin/node-pre-gyp unpublish publish ${NPM_FLAGS}
-    else
-        echo "Skipping publishing"
-    fi;
 fi

src/nodejs/CMakeLists.txt

@@ -20,7 +20,7 @@ target_link_libraries(node-osrm osrm)
 # node-osrm artifacts in ${BINDING_DIR} to depend targets on
 set(ARTIFACTS "")
 
-set(OSRM_BINARIES osrm-extract osrm-contract osrm-routed osrm-datastore osrm-components)
+set(OSRM_BINARIES osrm-extract osrm-contract osrm-routed osrm-datastore osrm-components osrm-partition osrm-customize)
 foreach(binary ${OSRM_BINARIES})
   add_custom_command(OUTPUT ${BINDING_DIR}/${binary}
                      COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:${binary}> ${BINDING_DIR}

src/nodejs/node_osrm.cpp

@@ -48,15 +48,14 @@ NAN_MODULE_INIT(Engine::Init)
     Nan::Set(target, whoami, fn);
 }
 
+// clang-format off
 /**
  *
- * The `OSRM` method is the main constructor for creating an OSRM instance. An OSRM instance
+ * The `OSRM` method is the main constructor for creating an OSRM instance.
- * requires a `.osrm` network,
+ * An OSRM instance requires a `.osrm` dataset, which is prepared by the OSRM toolchain.
- * which is prepared by the OSRM Backend C++ library. Once you have a complete `network.osrm` file,
+ * The documentation on `osrm-extract` and `osrm-contract` for more information.
- * you can calculate
+ * Once you have a complete `network.osrm` file, you can calculate routes in javascript with this library using the methods below.
- * networks in javascript with this library using the methods below. To create an OSRM instance with
+ * To create an OSRM instance with your network you need to construct an instance like this:
- * your network
- * you need to construct an instance like this:
  *
  * ```javascript
  * var osrm = new OSRM('network.osrm');
@@ -78,27 +77,18 @@ NAN_MODULE_INIT(Engine::Init)
  * Each OSRM method (except for `OSRM.tile()`) has set of general options as well as unique options,
  * outlined below.
  *
- * | Option      | Values                                                  | Description
+ * | Option      | Values           | Description  | Format |
- * | Format                                                                         |
+ * | ----------- | -----------------| ------------ | -------|
- * | ----------- | ------------------------------------------------------- |
+ * | coordinates | `array` of `coordinate` elements: `[{coordinate}, ...]` | The coordinates this request will use. | `array` with `[{lon},{lat}]` values, in decimal degrees  |
- * ------------------------------------------------------------------------------------------------------
+ * | bearings    | `array` of `bearing` elements: `[{bearing}, ...]`       | Limits the search to segments with given bearing in degrees towards true north in clockwise direction. | `null` or `array` with `[{value},{range}]` `integer 0 .. 360,integer 0 .. 180` |
- * | ------------------------------------------------------------------------------ |
+ * | radiuses    | `array` of `radius` elements: `[{radius}, ...]`         | Limits the search to given radius in meters. | `null` or `double >= 0` or `unlimited` (default) |
- * | coordinates | `array` of `coordinate` elements: `[{coordinate}, ...]` | The coordinates this
+ * | hints       | `array` of `hint` elements: `[{hint}, ...]`             | Hint to derive position in street network. | Base64 `string` |
- * request will use.                                                                 | `array` with
- * `[{lon},{lat}]` values, in decimal degrees                        |
- * | bearings    | `array` of `bearing` elements: `[{bearing}, ...]`       | Limits the search to
- * segments with given bearing in degrees towards true north in clockwise direction. | `null` or
- * `array` with `[{value},{range}]` `integer 0 .. 360,integer 0 .. 180` |
- * | radiuses    | `array` of `radius` elements: `[{radius}, ...]`         | Limits the search to
- * given radius in meters.                                                           | `null` or
- * `double >= 0` or `unlimited` (default)                               |
- * | hints       | `array` of `hint` elements: `[{hint}, ...]`             | Hint to derive position
- * in street network.                                                             | Base64 `string`
- * |
  *
  * @class OSRM
  *
+ *
  */
+// clang-format on
 NAN_METHOD(Engine::New)
 {
     if (info.IsConstructCall())
@@ -195,6 +185,7 @@ inline void async(const Nan::FunctionCallbackInfo<v8::Value> &info,
     Nan::AsyncQueueWorker(new Worker{self->this_, std::move(params), service, callback});
 }
 
+// clang-format off
 /**
  * Returns the fastest route between two or more coordinates while visiting the waypoints in order.
  *
@@ -205,19 +196,14 @@ inline void async(const Nan::FunctionCallbackInfo<v8::Value> &info,
  * *Please note that even if an alternative route is requested, a result cannot be guaranteed.*
  * @param {Boolean} [options.steps=false] Return route steps for each route leg.
  * @param {Boolean} or {Array} [options.annotations=false] Return annotations for each route leg.
- * Can be `false`, `true` or an array with strings of `duration`, `nodes`, `distance`, `weight`,
+ *        Can be `false`, `true` or an array with strings of `duration`, `nodes`, `distance`, `weight`, `datasources`, `speed`.
- * `datasources`, `speed`.
+ * @param {String} [options.geometries=polyline] Returned route geometry format (influences overview and per step). Can also be `geojson`.
- * @param {String} [options.geometries=polyline] Returned route geometry format (influences overview
+ * @param {String} [options.overview=simplified] Add overview geometry either `full`, `simplified` according to highest zoom level it could be display on, or not at all (`false`).
- * and per step). Can also be `geojson`.
+ * @param {Boolean} [options.continue_straight] Forces the route to keep going straight at waypoints and don't do a uturn even if it would be faster. Default value depends on the profile.
- * @param {String} [options.overview=simplified] Add overview geometry either `full`, `simplified`
- * according to highest zoom level it could be display on, or not at all (`false`).
- * @param {Boolean} [options.continue_straight] Forces the route to keep going straight at waypoints
- * and don't do a uturn even if it would be faster. Default value depends on the profile.
  *                  `null`/`true`/`false`
  * @param {Function} callback
  *
- * @returns {Object} An array of [Waypoint](#waypoint) objects representing all waypoints in order
+ * @returns {Object} An array of [Waypoint](#waypoint) objects representing all waypoints in order AND an array of [`Route`](#route) objects ordered by descending recommendation rank.
- * AND an array of [`Route`](#route) objects ordered by descending recommendation rank.
  *
  * @example
  * var osrm = new OSRM("berlin-latest.osrm");
@@ -227,11 +213,13 @@ inline void async(const Nan::FunctionCallbackInfo<v8::Value> &info,
  *   console.log(result.routes); // array of Route objects ordered by descending recommendation rank
  * });
  */
+// clang-format on
 NAN_METHOD(Engine::route) //
 {
     async(info, &argumentsToRouteParameter, &osrm::OSRM::Route, true);
 }
 
+// clang-format off
 /**
  * Snaps a coordinate to the street network and returns the nearest n matches.
  *
@@ -245,11 +233,8 @@ NAN_METHOD(Engine::route) //
  * @param {Function} callback
  *
  * @returns {Object} containing `waypoints`.
- * **`waypoints`**: array of [`Ẁaypoint`](#waypoint) objects sorted by distance to the input
+ * **`waypoints`**: array of [`Ẁaypoint`](#waypoint) objects sorted by distance to the input coordinate.
- * coordinate.
+ *                  Each object has an additional `distance` property, which is the distance in meters to the supplied input coordinate.
- * Each object has an additional `distance` property, which is the distance in meters to the
- * supplied
- * input coordinate.
  *
  * @example
  * var osrm = new OSRM('network.osrm');
@@ -262,11 +247,13 @@ NAN_METHOD(Engine::route) //
  *   console.log(response.waypoints); // array of Waypoint objects
  * });
  */
+// clang-format on
 NAN_METHOD(Engine::nearest) //
 {
     async(info, &argumentsToNearestParameter, &osrm::OSRM::Nearest, false);
 }
 
+// clang-format off
 /**
  * Computes duration tables for the given locations. Allows for both symmetric and asymmetric
  * tables.
@@ -282,11 +269,10 @@ NAN_METHOD(Engine::nearest) //
  * @param {Function} callback
  *
  * @returns {Object} containing `durations`, `sources`, and `destinations`.
- * **`durations`**: array of arrays that stores the matrix in row-major order. `durations[i][j]`
+ * **`durations`**: array of arrays that stores the matrix in row-major order. `durations[i][j]` gives the travel time from the i-th waypoint to the j-th waypoint.
- * gives the travel time from the i-th waypoint to the j-th waypoint. Values are given in seconds.
+ *                  Values are given in seconds.
  * **`sources`**: array of [`Ẁaypoint`](#waypoint) objects describing all sources in order.
- * **`destinations`**: array of [`Ẁaypoint`](#waypoint) objects describing all destinations in
+ * **`destinations`**: array of [`Ẁaypoint`](#waypoint) objects describing all destinations in order.
- * order.
  *
  * @example
  * var osrm = new OSRM('network.osrm');
@@ -303,11 +289,13 @@ NAN_METHOD(Engine::nearest) //
  *   console.log(response.destinations); // array of Waypoint objects
  * });
  */
+// clang-format on
 NAN_METHOD(Engine::table) //
 {
     async(info, &argumentsToTableParameter, &osrm::OSRM::Table, true);
 }
 
+// clang-format off
 /**
  * This generates [Mapbox Vector Tiles](https://mapbox.com/vector-tiles) that can be viewed with a
  * vector-tile capable slippy-map viewer. The tiles contain road geometries and metadata that can
@@ -318,11 +306,9 @@ NAN_METHOD(Engine::table) //
  *
  * @name tile
  * @memberof OSRM
- * @param {Array} ZXY - an array consisting of `x`, `y`, and `z` values representing tile
+ * @param {Array} ZXY - an array consisting of `x`, `y`, and `z` values representing tile coordinates like
- * coordinates like
  *        [wiki.openstreetmap.org/wiki/Slippy_map_tilenames](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames)
- * and are supported by vector tile viewers like [Mapbox GL
+ *        and are supported by vector tile viewers like [Mapbox GL JS](https://www.mapbox.com/mapbox-gl-js/api/).
- * JS](https://www.mapbox.com/mapbox-gl-js/api/.
  * @param {Function} callback
  *
  * @returns {Buffer} contains a Protocol Buffer encoded vector tile.
@@ -334,11 +320,13 @@ NAN_METHOD(Engine::table) //
  *   fs.writeFileSync('./tile.vector.pbf', response); // write the buffer to a file
  * });
  */
+// clang-format on
 NAN_METHOD(Engine::tile)
 {
     async(info, &argumentsToTileParameters, &osrm::OSRM::Tile, {/*unused*/});
 }
 
+// clang-format off
 /**
  * Map matching matches given GPS points to the road network in the most plausible way.
  * Please note the request might result multiple sub-traces. Large jumps in the timestamps
@@ -351,31 +339,21 @@ NAN_METHOD(Engine::tile)
  * @param {Object} options - Object literal containing parameters for the match query.
  * @param {Boolean} [options.steps=false] Return route steps for each route.
  * @param {Boolean} or {Array} [options.annotations=false] Return annotations for each route leg.
- * Can be `false`, `true` or an array with strings of `duration`, `nodes`, `distance`, `weight`,
+ *        Can be `false`, `true` or an array with strings of `duration`, `nodes`, `distance`, `weight`, `datasources`, `speed`.
- * `datasources`, `speed`.
+ * @param {String} [options.geometries=polyline] Returned route geometry format (influences overview and per step). Can also be `geojson`.
- * @param {String} [options.geometries=polyline] Returned route geometry format (influences overview
+ * @param {String} [options.overview=simplified] Add overview geometry either `full`, `simplified` according to highest zoom level it could be display on, or not at all (`false`).
- * and per step). Can also be `geojson`.
+ * @param {Array<Number>} [options.timestamps] Timestamp of the input location (integers, UNIX-like timestamp).
- * @param {String} [options.overview=simplified] Add overview geometry either `full`, `simplified`
+ * @param {Array} [options.radiuses] Standard deviation of GPS precision used for map matching. If applicable use GPS accuracy (`double >= 0`, default `5m`).
- * according to highest zoom level it could be display on, or not at all (`false`).
- * @param {Array<Number>} [options.timestamps] Timestamp of the input location (integers, UNIX-like
- * timestamp).
- * @param {Array} [options.radiuses] Standard deviation of GPS precision used for map matching.
- * If applicable use GPS accuracy (`double >= 0`, default `5m`).
  * @param {Function} callback
  *
  * @returns {Object} containing `tracepoints` and `matchings`.
- * **`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace
+ * **`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace in order.
- * in order.
  *                   If the trace point was ommited by map matching because it is an outlier, the entry will be null.
- * Each
+ *                   Each `Waypoint` object includes two additional properties, 1) `matchings_index`: Index to the
- * `Waypoint` object includes two additional properties, 1) `matchings_index`: Index to the
  *                   [`Route`](#route) object in matchings the sub-trace was matched to, 2) `waypoint_index`: Index of
  *                   the waypoint inside the matched route.
- * **`matchings`** is an array of [`Route`](#route) objects that
+ * **`matchings`** is an array of [`Route`](#route) objects that assemble the trace. Each `Route` object has an additional `confidence` property,
- * assemble the trace. Each `Route` object has an additional `confidence` property, which is the
+ *                 which is the confidence of the matching. float value between `0` and `1`. `1` is very confident that the matching is correct.
- * confidence of
- * the matching. float value between `0` and `1`. `1` is very confident that the matching is
- * correct.
  *
  * @example
  * var osrm = new OSRM('network.osrm');
@@ -390,11 +368,13 @@ NAN_METHOD(Engine::tile)
  * });
  *
  */
+// clang-format on
 NAN_METHOD(Engine::match) //
 {
     async(info, &argumentsToMatchParameter, &osrm::OSRM::Match, true);
 }
 
+// clang-format off
 /**
  * The trip plugin solves the Traveling Salesman Problem using a greedy heuristic
  * (farthest-insertion algorithm) for 10 or * more waypoints and uses brute force for less than 10
@@ -406,11 +386,9 @@ NAN_METHOD(Engine::match) //
  * @memberof OSRM
  * @param {Object} options - Object literal containing parameters for the trip query.
  * @param {Boolean} [options.steps=false] Return route steps for each route.
- * @param {Boolean} or {Array} [options.annotations=false] Return annotations for each route leg.
+ * @param {Boolean} or {Array} [options.annotations=false] Return annotations for each route leg.  Can be `false`,
- * Can be `false`, `true` or an array with strings of `duration`, `nodes`, `distance`, `weight`,
+ *        `true` or an array with strings of `duration`, `nodes`, `distance`, `weight`, `datasources`, `speed`.
- * `datasources`, `speed`.
+ * @param {String} [options.geometries=polyline] Returned route geometry format (influences overview and per step). Can also be `geojson`.
- * @param {String} [options.geometries=polyline] Returned route geometry format (influences overview
- * and per step). Can also be `geojson`.
  * @param {String} [options.overview=simplified] Add overview geometry either `full`, `simplified`
  * @param {Function} callback
  * @param {Boolean} [options.roundtrip=true] Return route is a roundtrip.
@@ -418,11 +396,10 @@ NAN_METHOD(Engine::match) //
  * @param {String} [options.destination=any] Return route ends at `any` or `last` coordinate.
  *
  * @returns {Object} containing `waypoints` and `trips`.
- * **`waypoints`**: an array of [`Waypoint`](#waypoint) objects representing all waypoints in input
+ * **`waypoints`**: an array of [`Waypoint`](#waypoint) objects representing all waypoints in input order.
- * order.
+ *                  Each Waypoint object has the following additional properties,
- * Each Waypoint object has the following additional properties, 1) `trips_index`: index to trips of
+ *                  1) `trips_index`: index to trips of the sub-trip the point was matched to,
- * the
+ *                  and 2) `waypoint_index`: index of the point in the trip.
- * sub-trip the point was matched to, and 2) `waypoint_index`: index of the point in the trip.
  * **`trips`**: an array of [`Route`](#route) objects that assemble the trace.
  *
  * @example
@@ -439,6 +416,7 @@ NAN_METHOD(Engine::match) //
  *   console.log(response.trips); // array of Route objects
  * });
  */
+// clang-format on
 NAN_METHOD(Engine::trip) //
 {
     async(info, &argumentsToTripParameter, &osrm::OSRM::Trip, true);
@@ -456,7 +434,7 @@ NAN_METHOD(Engine::trip) //
  * @memberof Responses
  *
  * @param {documentation} exteral in
- * [`osrm-backend`](https://github.com/Project-OSRM/osrm-backend/blob/master/docs/http.md#route)
+ * [`osrm-backend`](../http.md#route)
  *
  */
 
@@ -467,7 +445,7 @@ NAN_METHOD(Engine::trip) //
  * @memberof Responses
  *
  * @param {documentation} exteral in
- * [`osrm-backend`](https://github.com/Project-OSRM/osrm-backend/blob/master/docs/http.md#routeleg)
+ * [`osrm-backend`](../http.md#routeleg)
  *
  */
 

test/nodejs/index.js

@@ -1,6 +1,8 @@
 var OSRM = require('../../');
 var test = require('tape');
 var berlin_path = require('./osrm-data-path').data_path;
+var berlin_mld_path = require('./osrm-data-path').mld_data_path;
+var berlin_corech_path = require('./osrm-data-path').corech_data_path;
 
 test('constructor: throws if new keyword is not used', function(assert) {
     assert.plan(1);
@@ -23,7 +25,7 @@ test('constructor: does not accept more than one parameter', function(assert) {
 test('constructor: throws if necessary files do not exist', function(assert) {
     assert.plan(1);
     assert.throws(function() { new OSRM("missing.osrm"); },
-        /Invalid file paths/);
+        /Error opening missing.osrm.names/);
 });
 
 test('constructor: takes a shared memory argument', function(assert) {
@@ -34,22 +36,52 @@ test('constructor: takes a shared memory argument', function(assert) {
 
 test('constructor: throws if shared_memory==false with no path defined', function(assert) {
     assert.plan(1);
-    assert.throws(function() { var osrm = new OSRM({shared_memory: false}); },
+    assert.throws(function() { new OSRM({shared_memory: false}); },
         /Shared_memory must be enabled if no path is specified/);
 });
 
 test('constructor: throws if given a non-bool shared_memory option', function(assert) {
     assert.plan(1);
-    assert.throws(function() { var osrm = new OSRM({path: berlin_path, shared_memory: "a"}); },
+    assert.throws(function() { new OSRM({path: berlin_path, shared_memory: 'a'}); },
         /Shared_memory option must be a boolean/);
 });
 
 test('constructor: throws if given a non-string/obj argument', function(assert) {
     assert.plan(1);
-    assert.throws(function() { var osrm = new OSRM(true); },
+    assert.throws(function() { new OSRM(true); },
         /Parameter must be a path or options object/);
 });
 
+test('constructor: throws if given an unkown algorithm', function(assert) {
+    assert.plan(1);
+    assert.throws(function() { new OSRM({algorithm: 'Foo', shared_memory: true}); },
+        /algorithm option must be one of 'CH', 'CoreCH', or 'MLD'/);
+});
+
+test('constructor: throws if given an invalid algorithm', function(assert) {
+    assert.plan(1);
+    assert.throws(function() { new OSRM({algorithm: 3, shared_memory: true}); },
+        /algorithm option must be a string and one of 'CH', 'CoreCH', or 'MLD'/);
+});
+
+test('constructor: loads MLD if given as algorithm', function(assert) {
+    assert.plan(1);
+    var osrm = new OSRM({algorithm: 'MLD', path: berlin_mld_path});
+    assert.ok(osrm);
+});
+
+test('constructor: loads CH if given as algorithm', function(assert) {
+    assert.plan(1);
+    var osrm = new OSRM({algorithm: 'CH', path: berlin_path});
+    assert.ok(osrm);
+});
+
+test('constructor: loads CoreCH if given as algorithm', function(assert) {
+    assert.plan(1);
+    var osrm = new OSRM({algorithm: 'CoreCH', path: berlin_corech_path});
+    assert.ok(osrm);
+});
+
 require('./route.js');
 require('./trip.js');
 require('./match.js');

test/nodejs/osrm-data-path.js

@@ -2,7 +2,11 @@ var path = require('path');
 
 if (process.env.OSRM_DATA_PATH !== undefined) {
     exports.data_path = path.join(path.resolve(process.env.OSRM_DATA_PATH), "ch/berlin.osrm");
+    exports.mld_data_path = path.join(path.resolve(process.env.OSRM_DATA_PATH), "mld/berlin.osrm");
+    exports.corech_data_path = path.join(path.resolve(process.env.OSRM_DATA_PATH), "corech/berlin.osrm");
     console.log('Setting custom data path to ' + exports.data_path);
 } else {
     exports.data_path = path.resolve(path.join(__dirname, "../data/ch/berlin.osrm"));
+    exports.mld_data_path = path.resolve(path.join(__dirname, "../data/mld/berlin.osrm"));
+    exports.corech_data_path = path.resolve(path.join(__dirname, "../data/corech/berlin.osrm"));
 }

test/nodejs/route.js

@@ -1,6 +1,8 @@
 var OSRM = require('../../');
 var test = require('tape');
 var berlin_path = require('./osrm-data-path').data_path;
+var berlin_mld_path = require('./osrm-data-path').mld_data_path;
+var berlin_corech_path = require('./osrm-data-path').corech_data_path;
 
 test('route: routes Berlin', function(assert) {
     assert.plan(5);
@@ -14,6 +16,30 @@ test('route: routes Berlin', function(assert) {
     });
 });
 
+test('route: routes Berlin on MLD', function(assert) {
+    assert.plan(5);
+    var osrm = new OSRM({path: berlin_mld_path, algorithm: 'MLD'});
+    osrm.route({coordinates: [[13.43864,52.51993],[13.415852,52.513191]]}, function(err, route) {
+        assert.ifError(err);
+        assert.ok(route.waypoints);
+        assert.ok(route.routes);
+        assert.ok(route.routes.length);
+        assert.ok(route.routes[0].geometry);
+    });
+});
+
+test('route: routes Berlin on CoreCH', function(assert) {
+    assert.plan(5);
+    var osrm = new OSRM({path: berlin_corech_path, algorithm: 'CoreCH'});
+    osrm.route({coordinates: [[13.43864,52.51993],[13.415852,52.513191]]}, function(err, route) {
+        assert.ifError(err);
+        assert.ok(route.waypoints);
+        assert.ok(route.routes);
+        assert.ok(route.routes.length);
+        assert.ok(route.routes[0].geometry);
+    });
+});
+
 test('route: throws with too few or invalid args', function(assert) {
     assert.plan(3);
     var osrm = new OSRM(berlin_path);