Rewrite in N-API for Electron 30+ compatibility

.github/workflows/ci.yml

@@ -15,13 +15,9 @@ jobs:
           - macos-latest
           - windows-latest
         node_version:
-          - 14
           - 16
-        exclude:
-          - os: windows-latest
-            node_version: 14
-          - os: macos-latest
-            node_version: 14
+          - 18
+          - 20
         include:
           - os: windows-2019
             node_version: 14
@@ -60,10 +56,7 @@ jobs:
         # are incompatible with Python 3.12+, which no-longer ships 'distutils'
         # out of the box. 'setuptools' package provides 'distutils'.
         if: ${{ runner.os != 'Windows' }}
-        run: |
-          python3 -m venv CI_venv
-          source CI_venv/bin/activate
-          python3 -m pip install setuptools
+        run: python3 -m pip install --break-system-packages setuptools
 
       - name: Install Python setuptools (Windows)
         # This is needed for Python 3.12+, since many versions of node-gyp
@@ -78,8 +71,6 @@ jobs:
       - name: Install dependencies (Unix-likes)
         if: ${{ runner.os != 'Windows' }}
         run: |
-          source CI_venv/bin/activate
-          npm config set python "$(which python3)"
           npm install
 
       - name: Install dependencies (Windows)

.gitignore

@@ -8,3 +8,7 @@ ext
 emsdk-portable
 
 vendor/libiconv
+.vscode
+.atom
+.cache
+/bin/

binding.gyp

@@ -3,7 +3,7 @@
         {
             "target_name": "superstring",
             "dependencies": [
-                "superstring_core"
+                "superstring_core",
             ],
             "sources": [
                 "src/bindings/bindings.cc",
@@ -18,8 +18,12 @@
                 "src/bindings/text-writer.cc",
             ],
             "include_dirs": [
-              "src/core",
-              "<!(node -e \"require('nan')\")"
+                "src/core",
+                "<!(node -p \"require('node-addon-api').include_dir\")",
+            ],
+            "defines": [
+                "NAPI_VERSION=<(napi_build_version)",
+                "NAPI_DISABLE_CPP_EXCEPTIONS",
             ],
             "conditions": [
                 ['OS=="mac"', {
@@ -101,7 +105,8 @@
     ],
 
     "variables": {
-        "tests": 0
+        "tests": 0,
+        "node_version_major%": "<!(node -p \"process.versions.node.split('.')[0]\")"
     },
 
     "conditions": [
@@ -148,11 +153,9 @@
             "targets": [{
                 "target_name": "tests",
                 "type": "executable",
-                "cflags_cc": ["-std=c++17"],
-                "cflags_cc!": ["-fno-exceptions"],
+                "cflags_cc!": ["-fno-exceptions", "-std=c++17"],
                 "defines": [
-                    "CATCH_CONFIG_CPP11_NO_IS_ENUM",
-                    "CATCH_CONFIG_CPP17_STRING_VIEW"
+                    "CATCH_CONFIG_CPP11_NO_IS_ENUM"
                 ],
                 'xcode_settings': {
                     'CLANG_CXX_LIBRARY': 'libc++',
@@ -176,25 +179,57 @@
                     "superstring_core"
                 ],
                 "conditions": [
+                    ['node_version_major>=18', {
+                        "defines+": ["CATCH_CONFIG_CPP17_STRING_VIEW"]
+                    }],
                     ['OS=="mac"', {
+                        'dependencies+': [
+                            'build_libiconv'
+                        ],
                         'cflags': [
                             '-mmacosx-version-min=10.8'
                         ],
                         "xcode_settings": {
                             "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
                             'MACOSX_DEPLOYMENT_TARGET': '10.12',
-                        }
+                        },
+                        "postbuilds": [
+                            {
+                                'postbuild_name': 'Adjust vendored libiconv install name',
+                                'action': [
+                                  'install_name_tool',
+                                  "-change",
+                                  "libiconv.2.dylib",
+                                  "@executable_path/../../ext/lib/libiconv.2.dylib",
+                                  "<(PRODUCT_DIR)/tests"
+                                ]
+
+                                # NOTE: This version of the post-build action
+                                # should be used if we find it necessary to avoid
+                                # changing the `dylib`’s install name in an earlier
+                                # step.
+                                #
+                                # 'action': [
+                                #     'bash',
+                                #     '<(module_root_dir)/script/adjust-install-name.sh',
+                                #     '<(PRODUCT_DIR)'
+                                # ]
+                            }
+                        ]
                     }]
                 ]
             }]
         }]
     ],
 
     "target_defaults": {
-        "cflags_cc": ["-std=c++11"],
+        "cflags_cc": ["-std=c++17"],
         "conditions": [
             ['OS=="mac"', {
+                'cflags+': ['-fvisibility=hidden'],
+                'cflags_cc+': ['-fvisibility=hidden'],
                 "xcode_settings": {
+                    'MACOSX_DEPLOYMENT_TARGET': '10.8',
                     'CLANG_CXX_LIBRARY': 'libc++',
                     'CLANG_CXX_LANGUAGE_STANDARD': 'c++17',
                     'GCC_SYMBOLS_PRIVATE_EXTERN': 'YES',  # -fvisibility=hidden

package.json

@@ -9,7 +9,8 @@
     "build:browser": "script/build-browser-version.sh",
     "build": "npm run build:node && npm run build:browser",
     "test:native": "node ./script/test-native.js",
-    "test:node": "mocha test/js/*.js",
+    "test:node": "mocha test/js/*.test.js",
+    "test:threads": "node ./test/js/threads-outer.js",
     "test:browser": "SUPERSTRING_USE_BROWSER_VERSION=1 mocha test/js/*.js",
     "test": "npm run test:node && npm run test:browser",
     "benchmark": "node benchmark/marker-index.benchmark.js",
@@ -23,18 +24,19 @@
     "text",
     "data-structure"
   ],
+  "engines": {
+    "node": ">=16"
+  },
   "author": "Nathan Sobo <[email protected]>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/atom/superstring/issues"
   },
   "homepage": "https://github.com/atom/superstring",
-  "dependencies": {
-    "nan": "^2.14.2"
-  },
   "devDependencies": {
     "chai": "^2.0.0",
     "mocha": "^2.3.4",
+    "node-addon-api": "^8.3.1",
     "random-seed": "^0.2.0",
     "standard": "^4.5.4",
     "temp": "^0.8.3",

src/bindings/addon-data.h

@@ -0,0 +1,32 @@
+#include <napi.h>
+
+#ifndef SUPERSTRING_ADDON_DATA_H_
+#define SUPERSTRING_ADDON_DATA_H_
+
+class AddonData final {
+public:
+  explicit AddonData(Napi::Env _env) {}
+
+  // MarkerIndexWrapper
+  Napi::FunctionReference marker_index_wrapper_constructor;
+
+  // PatchWrapper
+  Napi::FunctionReference patch_wrapper_constructor;
+  Napi::FunctionReference change_wrapper_constructor;
+
+  // TextBufferSnapshotWrapper
+  Napi::FunctionReference text_buffer_snapshot_wrapper_constructor;
+
+  // TextBufferWrapper
+  Napi::FunctionReference text_buffer_wrapper_constructor;
+  Napi::FunctionReference regex_constructor;
+  Napi::FunctionReference subsequence_match_constructor;
+
+  // TextReader
+  Napi::FunctionReference text_reader_constructor;
+
+  // TextWriter
+  Napi::FunctionReference text_writer_constructor;
+};
+
+#endif // SUPERSTRING_ADDON_DATA_H_

src/bindings/bindings.cc

@@ -1,24 +1,25 @@
+#include "addon-data.h"
 #include "marker-index-wrapper.h"
-#include "nan.h"
 #include "patch-wrapper.h"
 #include "range-wrapper.h"
-#include "point-wrapper.h"
 #include "text-writer.h"
 #include "text-reader.h"
 #include "text-buffer-wrapper.h"
 #include "text-buffer-snapshot-wrapper.h"
 
-using namespace v8;
+using namespace Napi;
 
-void Init(Local<Object> exports) {
-  PointWrapper::init();
-  RangeWrapper::init();
-  PatchWrapper::init(exports);
-  MarkerIndexWrapper::init(exports);
-  TextBufferWrapper::init(exports);
-  TextWriter::init(exports);
-  TextReader::init(exports);
-  TextBufferSnapshotWrapper::init();
+Object Init(Env env, Object exports) {
+  auto* data = new AddonData(env);
+  env.SetInstanceData(data);
+
+  PatchWrapper::init(env, exports);
+  MarkerIndexWrapper::init(env, exports);
+  TextBufferWrapper::init(env, exports);
+  TextWriter::init(env, exports);
+  TextReader::init(env, exports);
+  TextBufferSnapshotWrapper::init(env);
+  return exports;
 }
 
-NODE_MODULE(superstring, Init)
+NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)