Build Node bindings on Windows (#6334)

Extends CI to build NodeJS bindings for Windows.

Author: SiarheiFedartsou

.gitattributes

@@ -13,3 +13,6 @@
 
 # Declare files that will always have LF line endings on checkout.
 *.sh text eol=lf
+
+# https://eslint.org/docs/latest/rules/linebreak-style#using-this-rule-with-version-control-systems
+*.js text eol=lf

.github/workflows/osrm-backend.yml

@@ -24,6 +24,9 @@ jobs:
     needs: format-taginfo-docs
     runs-on: windows-2022
     continue-on-error: false
+    env:
+      BUILD_TYPE: Release
+      ENABLE_APPLE_SILICON: "OFF"
     steps:
     - uses: actions/checkout@v3
     - run: pip install conan==1.51.3
@@ -34,12 +37,38 @@ jobs:
         node-version: 16
     - run: node --version
     - run: npm --version
+    - name: Prepare environment
+      shell: bash
+      run: |
+        PACKAGE_JSON_VERSION=$(node -e "console.log(require('./package.json').version)")
+        echo PUBLISH=$([[ "${GITHUB_REF:-}" == "refs/tags/v${PACKAGE_JSON_VERSION}" ]] && echo "On" || echo "Off") >> $GITHUB_ENV
     - run: npm install --ignore-scripts
     - run: npm link --ignore-scripts
     - uses: microsoft/[email protected]
     - name: Build
       run: |
         .\scripts\ci\windows-build.bat
+    - name: Run node tests
+      shell: bash
+      run: |
+        ./lib/binding/osrm-datastore.exe test/data/ch/monaco.osrm
+        node test/nodejs/index.js
+    - name: Build Node package
+      shell: bash
+      run: ./scripts/ci/node_package.sh
+    - name: Publish Node package
+      if: ${{ env.PUBLISH == 'On' }}
+      uses: ncipollo/release-action@v1
+      with:
+        allowUpdates: true
+        artifactErrorsFailBuild: true
+        artifacts: build/stage/**/*.tar.gz
+        omitBody: true
+        omitBodyDuringUpdate: true
+        omitName: true
+        omitNameDuringUpdate: true
+        replacesArtifacts: true
+        token: ${{ secrets.GITHUB_TOKEN }}
 
   format-taginfo-docs:
     runs-on: ubuntu-20.04
@@ -526,15 +555,13 @@ jobs:
         key: v3-test-${{ matrix.name }}-${{ github.sha }}
         restore-keys: |
           v3-test-${{ matrix.name }}-
-
+      
     - name: Prepare environment
       run: |
         PACKAGE_JSON_VERSION=$(node -e "console.log(require('./package.json').version)")
         echo PUBLISH=$([[ "${GITHUB_REF:-}" == "refs/tags/v${PACKAGE_JSON_VERSION}" ]] && echo "On" || echo "Off") >> $GITHUB_ENV
-
         echo "OSRM_INSTALL_DIR=${GITHUB_WORKSPACE}/install-osrm" >> $GITHUB_ENV
         echo "OSRM_BUILD_DIR=${GITHUB_WORKSPACE}/build-osrm" >> $GITHUB_ENV
-
         if [[ "$ENABLE_SANITIZER" == 'ON' ]]; then
           # We can only set this after checkout once we know the workspace directory
           echo "LSAN_OPTIONS=print_suppressions=0:suppressions=${GITHUB_WORKSPACE}/scripts/ci/leaksanitizer.conf" >> $GITHUB_ENV
@@ -549,12 +576,10 @@ jobs:
           sudo mdutil -i off /
           export MASON_OS=osx
         fi
-
         echo "MASON=${GITHUB_WORKSPACE}/scripts/mason.sh" >> $GITHUB_ENV
+
         echo "CMAKE_URL=https://mason-binaries.s3.amazonaws.com/${MASON_OS}-x86_64/cmake/${CMAKE_VERSION}.tar.gz" >> $GITHUB_ENV
         echo "CMAKE_DIR=mason_packages/${MASON_OS}-x86_64/cmake/${CMAKE_VERSION}" >> $GITHUB_ENV
-
-
     - name: Install dev dependencies
       run: |
         python3 -m pip install conan==1.51.3
@@ -634,6 +659,7 @@ jobs:
         else
           APPLE_SILICON_FLAGS=()
         fi
+
         cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
                  -DENABLE_CONAN=${ENABLE_CONAN:-OFF} \
                  -DENABLE_ASSERTIONS=${ENABLE_ASSERTIONS:-OFF} \

CHANGELOG.md

@@ -22,6 +22,7 @@
       - FIXED: Bug in bicycle profile that caused exceptions if there is a highway=bicycle in the data. [#6296](https://github.com/Project-OSRM/osrm-backend/pull/6296)
       - FIXED: Internal refactoring of identifier types used in data facade [#6044](https://github.com/Project-OSRM/osrm-backend/pull/6044)
     - Build:
+      - ADDED: Build Node bindings on Windows. [#6334](https://github.com/Project-OSRM/osrm-backend/pull/6334)
       - ADDED: Configure cross-compilation for Apple Silicon. [#6360](https://github.com/Project-OSRM/osrm-backend/pull/6360)
       - CHANGED: Use apt-get to install Clang on CI. [#6345](https://github.com/Project-OSRM/osrm-backend/pull/6345)
       - CHANGED: Fix TBB in case of Conan + NodeJS build. [#6333](https://github.com/Project-OSRM/osrm-backend/pull/6333)

CMakeLists.txt

@@ -3,6 +3,7 @@ cmake_minimum_required(VERSION 3.2)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 
+
 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR AND NOT MSVC_IDE)
   message(FATAL_ERROR "In-source builds are not allowed.
 Please create a directory and run cmake from there, passing the path to this source directory as the last argument.
@@ -883,22 +884,23 @@ if (ENABLE_FUZZING)
   add_subdirectory(fuzz)
 endif ()
 
+# add headers sanity check target that includes all headers independently	
+set(check_headers_dir "${PROJECT_BINARY_DIR}/check-headers")	
+file(GLOB_RECURSE headers_to_check	
+  ${PROJECT_BINARY_DIR}/*.hpp	
+  ${PROJECT_SOURCE_DIR}/include/*.hpp)	
+foreach(header ${headers_to_check})	
+  if ("${header}" MATCHES ".*/include/nodejs/.*")
+    # we do not check NodeJS bindings headers
+    continue()
+  endif()
+  get_filename_component(filename ${header} NAME_WE)	
+  set(filename "${check_headers_dir}/${filename}.cpp")	
+  if (NOT EXISTS ${filename})	
+    file(WRITE ${filename} "#include \"${header}\"\n")	
+  endif()	
+  list(APPEND sources ${filename})	
+endforeach()	
+add_library(check-headers STATIC EXCLUDE_FROM_ALL ${sources})	
+set_target_properties(check-headers PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${check_headers_dir})	
 
-# add headers sanity check target that includes all headers independently
-# make sure we have all deps for the nodejs sub project's includes (nan, node)
-if (ENABLE_NODE_BINDINGS)
-  set(check_headers_dir "${PROJECT_BINARY_DIR}/check-headers")
-  file(GLOB_RECURSE headers_to_check
-    ${PROJECT_BINARY_DIR}/*.hpp
-    ${PROJECT_SOURCE_DIR}/include/*.hpp)
-  foreach(header ${headers_to_check})
-    get_filename_component(filename ${header} NAME_WE)
-    set(filename "${check_headers_dir}/${filename}.cpp")
-    if (NOT EXISTS ${filename})
-      file(WRITE ${filename} "#include \"${header}\"\n")
-    endif()
-    list(APPEND sources ${filename})
-  endforeach()
-  add_library(check-headers STATIC EXCLUDE_FROM_ALL ${sources})
-  set_target_properties(check-headers PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${check_headers_dir})
-endif()

include/engine/api/route_api.hpp

@@ -28,6 +28,7 @@
 #include "util/json_util.hpp"
 
 #include <iterator>
+#include <map>
 #include <vector>
 
 namespace osrm

include/engine/guidance/assemble_leg.hpp

@@ -6,6 +6,7 @@
 #include "engine/guidance/route_leg.hpp"
 #include "engine/guidance/route_step.hpp"
 #include "engine/internal_route_result.hpp"
+#include "util/coordinate_calculation.hpp"
 #include "util/typedefs.hpp"
 
 #include <boost/algorithm/string/join.hpp>

include/extractor/geojson_debug_policies.hpp

@@ -1,14 +1,14 @@
 #ifndef OSRM_EXTRACTOR_CLASSIFICATION_DATA_HPP_
 #define OSRM_EXTRACTOR_CLASSIFICATION_DATA_HPP_
 
+#include "extractor/intersection/constants.hpp"
 #include <algorithm>
+#include <boost/assert.hpp>
 #include <cmath>
 #include <cstdint>
 #include <cstdlib>
 #include <string>
 
-#include "extractor/intersection/constants.hpp"
-
 namespace osrm
 {
 namespace extractor

include/extractor/road_classification.hpp

@@ -27,6 +27,7 @@ THE SOFTWARE.
 
 #include <assert.h>
 #include <math.h>
+#include <memory.h>
 
 #if defined(_MSC_VER)
 #include "rapidjson/msinttypes/stdint.h"