Use node-api instead of NAN (Project-OSRM#6452)

Author: SiarheiFedartsou

.github/workflows/osrm-backend.yml

@@ -20,7 +20,7 @@ env:
   ENABLE_NODE_BINDINGS: "ON"
 
 jobs:
-  windows:
+  windows-release-node:
     needs: format-taginfo-docs
     runs-on: windows-2022
     continue-on-error: false
@@ -264,83 +264,7 @@ jobs:
             CXXCOMPILER: g++-8
             CXXFLAGS: -Wno-cast-function-type
 
-          - name: conan-macos-x64-release-node-16
-            build_node_package: true
-            continue-on-error: false
-            node: 16
-            runs-on: macos-11
-            BUILD_TOOLS: ON
-            BUILD_TYPE: Release
-            CCOMPILER: clang
-            CXXCOMPILER: clang++
-            CUCUMBER_TIMEOUT: 60000
-            ENABLE_ASSERTIONS: ON
-            ENABLE_CONAN: ON
-
-          - name: conan-macos-arm64-release-node-16
-            build_node_package: true
-            continue-on-error: false
-            node: 16
-            runs-on: macos-11
-            BUILD_TOOLS: ON
-            BUILD_TYPE: Release
-            CCOMPILER: clang
-            CXXCOMPILER: clang++
-            CUCUMBER_TIMEOUT: 60000
-            ENABLE_ASSERTIONS: ON
-            ENABLE_CONAN: ON
-            ENABLE_APPLE_SILICON: ON
-
-          - name: conan-macos-x64-release-node-18
-            build_node_package: true
-            continue-on-error: false
-            node: 18
-            runs-on: macos-11
-            BUILD_TOOLS: ON
-            BUILD_TYPE: Release
-            CCOMPILER: clang
-            CXXCOMPILER: clang++
-            CUCUMBER_TIMEOUT: 60000
-            ENABLE_ASSERTIONS: ON
-            ENABLE_CONAN: ON
-
-          - name: conan-macos-arm64-release-node-18
-            build_node_package: true
-            continue-on-error: false
-            node: 18
-            runs-on: macos-11
-            BUILD_TOOLS: ON
-            BUILD_TYPE: Release
-            CCOMPILER: clang
-            CXXCOMPILER: clang++
-            CUCUMBER_TIMEOUT: 60000
-            ENABLE_ASSERTIONS: ON
-            ENABLE_CONAN: ON
-            ENABLE_APPLE_SILICON: ON
-
-          - name: node-16-conan-linux-release
-            build_node_package: true
-            continue-on-error: false
-            node: 16
-            runs-on: ubuntu-20.04
-            BUILD_TYPE: Release
-            CCOMPILER: clang-6.0
-            CXXCOMPILER: clang++-6.0
-            ENABLE_CONAN: ON
-            NODE_PACKAGE_TESTS_ONLY: ON
-
-          - name: node-16-conan-linux-debug
-            build_node_package: true
-            continue-on-error: false
-            node: 16
-            runs-on: ubuntu-20.04
-            BUILD_TYPE: Debug
-            CCOMPILER: clang-6.0
-            CXXCOMPILER: clang++-6.0
-            ENABLE_CONAN: ON
-            NODE_PACKAGE_TESTS_ONLY: ON
-
-          - name: node-18-conan-linux-release
+          - name: conan-linux-release-node
             build_node_package: true
             continue-on-error: false
             node: 18
@@ -351,7 +275,7 @@ jobs:
             ENABLE_CONAN: ON
             NODE_PACKAGE_TESTS_ONLY: ON
 
-          - name: node-18-conan-linux-debug
+          - name: conan-linux-debug-node
             build_node_package: true
             continue-on-error: false
             node: 18
@@ -362,10 +286,10 @@ jobs:
             ENABLE_CONAN: ON
             NODE_PACKAGE_TESTS_ONLY: ON
 
-          - name: conan-macos-x64-release-node-latest
+          - name: conan-macos-x64-release-node
             build_node_package: true
             continue-on-error: true
-            node: latest
+            node: 18
             runs-on: macos-11
             BUILD_TYPE: Release
             CCOMPILER: clang
@@ -374,10 +298,10 @@ jobs:
             ENABLE_ASSERTIONS: ON
             ENABLE_CONAN: ON
 
-          - name: conan-macos-arm64-release-node-latest
+          - name: conan-macos-arm64-release-node
             build_node_package: true
             continue-on-error: true
-            node: latest
+            node: 18
             runs-on: macos-11
             BUILD_TYPE: Release
             CCOMPILER: clang
@@ -387,28 +311,6 @@ jobs:
             ENABLE_CONAN: ON
             ENABLE_APPLE_SILICON: ON
 
-          - name: node-latest-conan-linux-release
-            build_node_package: true
-            continue-on-error: true
-            node: latest
-            runs-on: ubuntu-20.04
-            BUILD_TYPE: Release
-            CCOMPILER: clang-6.0
-            CXXCOMPILER: clang++-6.0
-            ENABLE_CONAN: ON
-            NODE_PACKAGE_TESTS_ONLY: ON
-
-          - name: node-latest-conan-linux-debug
-            build_node_package: true
-            continue-on-error: true
-            node: latest
-            runs-on: ubuntu-20.04
-            BUILD_TYPE: Debug
-            CCOMPILER: clang-6.0
-            CXXCOMPILER: clang++-6.0
-            ENABLE_CONAN: ON
-            NODE_PACKAGE_TESTS_ONLY: ON
-
     name: ${{ matrix.name}}
     continue-on-error: ${{ matrix.continue-on-error }}
     runs-on: ${{ matrix.runs-on }}
@@ -627,10 +529,38 @@ jobs:
         ./src/benchmarks/packedvector-bench
         ./src/benchmarks/rtree-bench ../test/data/monaco.osrm.ramIndex ../test/data/monaco.osrm.fileIndex ../test/data/monaco.osrm.nbg_nodes
         popd
-    - name: Run Node package tests only
+
+    - name: Use Node 16
+      if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - name: Run Node package tests on Node 16
       if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
       run: |
+        node --version
         npm run nodejs-tests
+    - name: Use Node 18
+      if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Run Node package tests on Node 18
+      if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
+      run: |
+        node --version
+        npm run nodejs-tests
+    - name: Use Node latest
+      if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: latest
+    - name: Run Node package tests on Node-latest
+      if: ${{ matrix.NODE_PACKAGE_TESTS_ONLY == 'ON' && matrix.ENABLE_APPLE_SILICON != 'ON' }}
+      run: |
+        node --version
+        npm run nodejs-tests
+
     - name: Upload test logs
       uses: actions/upload-artifact@v3
       if: failure()
@@ -681,6 +611,6 @@ jobs:
 
   ci-complete:
     runs-on: ubuntu-22.04
-    needs: [build-test-publish, docker-image, windows]
+    needs: [build-test-publish, docker-image, windows-release-node]
     steps:
     - run: echo "CI complete"

.gitignore

@@ -105,3 +105,4 @@ debug.lua
 
 # node-osrm artifacts
 lib/binding
+

CHANGELOG.md

@@ -4,6 +4,8 @@
       - CHANGED: Upgrade to clang-tidy 15. [#6439](https://github.com/Project-OSRM/osrm-backend/pull/6439)
       - CHANGED: Update actions/cache to v3. [#6420](https://github.com/Project-OSRM/osrm-backend/pull/6420)
       - REMOVED: Drop support of Node 12 & 14. [#6431](https://github.com/Project-OSRM/osrm-backend/pull/6431)
+    - NodeJS:
+      - CHANGED: Use node-api instead of NAN. [#6452](https://github.com/Project-OSRM/osrm-backend/pull/6452)
     - Misc:
       - REMOVED: Get rid of unused functions in util/json_util.hpp. [#6446](https://github.com/Project-OSRM/osrm-backend/pull/6446)
       - FIXED: Apply workaround for Conan installation issue on CI. [#6442](https://github.com/Project-OSRM/osrm-backend/pull/6442)

include/nodejs/json_v8_renderer.hpp

@@ -2,11 +2,7 @@
 #define OSRM_BINDINGS_NODE_JSON_V8_RENDERER_HPP
 
 #include "osrm/json_container.hpp"
-
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wunused-parameter"
-#include <nan.h>
-#pragma GCC diagnostic pop
+#include <napi.h>
 
 #include <functional>
 
@@ -15,52 +11,56 @@ namespace node_osrm
 
 struct V8Renderer
 {
-    explicit V8Renderer(v8::Local<v8::Value> &_out) : out(_out) {}
+    explicit V8Renderer(const Napi::Env &env, Napi::Value &out) : env(env), out(out) {}
 
     void operator()(const osrm::json::String &string) const
     {
-        out = Nan::New(std::cref(string.value)).ToLocalChecked();
+        out = Napi::String::New(env, string.value);
     }
 
-    void operator()(const osrm::json::Number &number) const { out = Nan::New(number.value); }
+    void operator()(const osrm::json::Number &number) const
+    {
+        out = Napi::Number::New(env, number.value);
+    }
 
     void operator()(const osrm::json::Object &object) const
     {
-        v8::Local<v8::Object> obj = Nan::New<v8::Object>();
+        Napi::Object obj = Napi::Object::New(env);
         for (const auto &keyValue : object.values)
         {
-            v8::Local<v8::Value> child;
-            mapbox::util::apply_visitor(V8Renderer(child), keyValue.second);
-            Nan::Set(obj, Nan::New(keyValue.first).ToLocalChecked(), child);
+            Napi::Value child;
+            mapbox::util::apply_visitor(V8Renderer(env, child), keyValue.second);
+            obj.Set(keyValue.first, child);
         }
         out = obj;
     }
 
     void operator()(const osrm::json::Array &array) const
     {
-        v8::Local<v8::Array> a = Nan::New<v8::Array>(array.values.size());
+        Napi::Array a = Napi::Array::New(env, array.values.size());
         for (auto i = 0u; i < array.values.size(); ++i)
         {
-            v8::Local<v8::Value> child;
-            mapbox::util::apply_visitor(V8Renderer(child), array.values[i]);
-            Nan::Set(a, i, child);
+            Napi::Value child;
+            mapbox::util::apply_visitor(V8Renderer(env, child), array.values[i]);
+            a.Set(i, child);
         }
         out = a;
     }
 
-    void operator()(const osrm::json::True &) const { out = Nan::New(true); }
+    void operator()(const osrm::json::True &) const { out = Napi::Boolean::New(env, true); }
 
-    void operator()(const osrm::json::False &) const { out = Nan::New(false); }
+    void operator()(const osrm::json::False &) const { out = Napi::Boolean::New(env, false); }
 
-    void operator()(const osrm::json::Null &) const { out = Nan::Null(); }
+    void operator()(const osrm::json::Null &) const { out = env.Null(); }
 
   private:
-    v8::Local<v8::Value> &out;
+    const Napi::Env &env;
+    Napi::Value &out;
 };
 
-inline void renderToV8(v8::Local<v8::Value> &out, const osrm::json::Object &object)
+inline void renderToV8(const Napi::Env &env, Napi::Value &out, const osrm::json::Object &object)
 {
-    V8Renderer renderer(out);
+    V8Renderer renderer(env, out);
     renderer(object);
 }
 } // namespace node_osrm

include/nodejs/node_osrm.hpp

@@ -3,45 +3,30 @@
 
 #include "osrm/osrm_fwd.hpp"
 
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wunused-parameter"
-#include <nan.h>
-#pragma GCC diagnostic pop
+#include <napi.h>
 
 #include <memory>
 
 namespace node_osrm
 {
 
-struct Engine final : public Nan::ObjectWrap
+class Engine final : public Napi::ObjectWrap<Engine>
 {
-    using Base = Nan::ObjectWrap;
+  public:
+    static Napi::Object Init(Napi::Env env, Napi::Object exports);
+    Engine(const Napi::CallbackInfo &info);
 
-    static NAN_MODULE_INIT(Init);
-
-    static NAN_METHOD(New);
-
-    static NAN_METHOD(route);
-    static NAN_METHOD(nearest);
-    static NAN_METHOD(table);
-    static NAN_METHOD(tile);
-    static NAN_METHOD(match);
-    static NAN_METHOD(trip);
-
-    Engine(osrm::EngineConfig &config);
-
-    // Thread-safe singleton accessor
-    static Nan::Persistent<v8::Function> &constructor();
-
-    // Ref-counted OSRM alive even after shutdown until last callback is done
     std::shared_ptr<osrm::OSRM> this_;
+
+  private:
+    Napi::Value route(const Napi::CallbackInfo &info);
+    Napi::Value nearest(const Napi::CallbackInfo &info);
+    Napi::Value table(const Napi::CallbackInfo &info);
+    Napi::Value tile(const Napi::CallbackInfo &info);
+    Napi::Value match(const Napi::CallbackInfo &info);
+    Napi::Value trip(const Napi::CallbackInfo &info);
 };
 
 } // namespace node_osrm
 
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wunused-parameter"
-NAN_MODULE_WORKER_ENABLED(osrm, node_osrm::Engine::Init)
-#pragma GCC diagnostic pop
-
 #endif