msgpackr-extract 1.1.0-napi → 1.1.0

package/binding.gyp

@@ -1,8 +1,22 @@
 {
   "variables": {
       "os_linux_compiler%": "gcc",
+      "enable_v8%": "true",
+      "enable_pointer_compression%": "false",
       "build_v8_with_gn": "false"
   },
+  "conditions": [
+    ['OS=="win"', {
+      "variables": {
+        "enable_v8%": "<!(echo %ENABLE_V8_FUNCTIONS%)",
+      }
+    }],
+    ['OS!="win"', {
+      "variables": {
+        "enable_v8%": "<!(echo $ENABLE_V8_FUNCTIONS)",
+      }
+    }]
+  ],
   "targets": [
     {
       "target_name": "msgpackr-extract",
@@ -11,8 +25,6 @@
         "src/extract.cpp",
       ],
       "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
-      "include_dirs" : ["<!(node -p \"require('node-addon-api').include_dir\")"],
-      "dependencies": ["<!(node -p \"require('node-addon-api').gyp\")"],
       "conditions": [
         ["OS=='linux'", {
           "variables": {
@@ -40,6 +52,12 @@
             "-O3"
           ],
         }],
+        ["enable_v8!='false'", {
+          "defines": ["ENABLE_V8_API=1"]
+        }],
+        ["enable_pointer_compression=='true'", {
+          "defines": ["V8_COMPRESS_POINTERS", "V8_COMPRESS_POINTERS_IN_ISOLATE_CAGE"],
+        }],
       ],
     }
   ]

package/index.js

@@ -1 +1 @@
-module.exports = require('node-gyp-build')(__dirname)
+module.exports = require('node-gyp-build')(__dirname);

package/package.json

@@ -1,29 +1,43 @@
-{
-  "name": "msgpackr-extract",
-  "author": "Kris Zyp",
-  "version": "1.1.0-napi",
-  "description": "Node addon for string extraction for msgpackr",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "http://github.com/kriszyp/msgpackr-extract"
-  },
-  "scripts": {
-    "install": "node-gyp-build",
-    "recompile": "node-gyp build",
-    "before-publish": "prebuildify-ci download && prebuildify --napi --target 12.22.7",
-    "prebuild": "prebuildify --napi --target 12.22.7",
-    "prebuild-musl": "prebuildify --napi --libc musl --tag-libc --target 12.22.7",
-    "prebuild-arm64": "prebuildify --napi --arch=arm64 --tag-libc --target 12.22.7",    "test": ""
-  },
-  "main": "./index.js",
-  "gypfile": true,
-  "dependencies": {
-    "node-addon-api": "^4.3.0",
-    "node-gyp-build": "^4.2.3"
-  },
-  "devDependencies": {
-    "prebuildify": "^5.0.0",
-    "prebuildify-ci": "^1.0.5"
-  }
-}
+{
+  "name": "msgpackr-extract",
+  "author": "Kris Zyp",
+  "version": "1.1.0",
+  "description": "Node addon for string extraction for msgpackr",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/kriszyp/msgpackr-extract"
+  },
+  "scripts": {
+    "install": "node-gyp-build",
+    "recompile": "node-gyp build",
+    "before-publish": "prebuildify-ci download && prebuildify --target 16.14.2 && set ENABLE_V8_FUNCTIONS=false&& prebuildify --optional-packages --napi --target 16.14.2 && node set-optional-deps.cjs",
+    "prebuild": "prebuildify --target 16.14.2",
+    "prebuild-libc": "prebuildify --tag-libc --target 16.14.2 && ENABLE_V8_FUNCTIONS=false prebuildify --optional-packages --napi --tag-libc --target 16.14.2",
+    "prepublishOnly": "node set-optional-deps.cjs",
+    "publish-all": "cd prebuilds/win32-x64 && npm publish --otp %OTP% && cd ../darwin-x64 && npm publish --otp %OTP% && cd ../darwin-arm64 && npm publish --otp %OTP% && cd ../linux-x64 && npm publish --otp %OTP% && cd ../linux-arm64 && npm publish --otp %OTP%  && cd ../linux-arm && npm publish --otp %OTP% && cd ../.. && npm publish --otp %OTP%",
+    "test": "node ./index.js"
+  },
+  "main": "./index.js",
+  "gypfile": true,
+  "dependencies": {
+    "node-gyp-build": "kriszyp/node-gyp-build#optional-packages"
+  },
+  "files": [
+    "index.js",
+    "/src",
+    "/*.gyp"
+  ],
+  "optionalDependencies": {
+    "msgpackr-extract-darwin-arm64": "1.1.0",
+    "msgpackr-extract-darwin-x64": "1.1.0",
+    "msgpackr-extract-linux-arm": "1.1.0",
+    "msgpackr-extract-linux-arm64": "1.1.0",
+    "msgpackr-extract-linux-x64": "1.1.0",
+    "msgpackr-extract-win32-x64": "1.1.0"
+  },
+  "devDependencies": {
+    "prebuildify": "kriszyp/prebuildify#optional-packages",
+    "prebuildify-ci": "^1.0.5"
+  }
+}

package/src/extract.cpp

@@ -5,10 +5,10 @@ provides much better performance. This will parse and produce up to 256 strings
 times as necessary to get more strings. This must be partially capable of parsing MessagePack so it can know where to
 find the string tokens and determine their position and length. All strings are decoded as UTF-8.
 */
-#include <napi.h>
 #include <node_api.h>
-
-using namespace Napi;
+#if ENABLE_V8_API
+#include <v8.h>
+#endif
 
 #ifndef thread_local
 #ifdef __GNUC__
@@ -25,17 +25,25 @@ using namespace Napi;
 const int MAX_TARGET_SIZE = 255;
 typedef int (*token_handler)(uint8_t* source, int position, int size);
 token_handler tokenTable[256] = {};
+napi_value unexpectedEnd(napi_env env) {
+	napi_value returnValue;
+	napi_get_undefined(env, &returnValue);
+	napi_throw_type_error(env, NULL, "Unexpected end of buffer reading string");
+	return returnValue;
+}
+
 class Extractor {
 public:
 	napi_value target[MAX_TARGET_SIZE + 1]; // leave one for the queued string
-
+	// napi_ref targetArray; // could consider reenabling this optimization for napi
+	bool hasTargetArray = false;
 	uint8_t* source;
 	int position = 0;
 	int writePosition = 0;
 	int stringStart = 0;
 	int lastStringEnd = 0;
 
-	void readString(Env env, int length, bool allowStringBlocks) {
+	void readString(napi_env env, int length, bool allowStringBlocks) {
 		int start = position;
 		int end = position + length;
 		if (allowStringBlocks) { // for larger strings, we don't bother to check every character for being latin, and just go right to creating a new string
@@ -76,7 +84,7 @@ public:
 		lastStringEnd = end;
 	}
 
-	napi_value extractStrings(Env env, int startingPosition, int size, uint8_t* inputSource) {
+	napi_value extractStrings(napi_env env, int startingPosition, int size, uint8_t* inputSource) {
 		writePosition = 0;
 		lastStringEnd = 0;
 		position = startingPosition;
@@ -89,8 +97,7 @@ public:
 				// fixstr, we want to convert this
 				token -= 0xa0;
 				if (token + position > size) {
-					TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-					return env.Null();
+					return unexpectedEnd(env);
 				}
 				readString(env,token, true);
 				if (writePosition >= MAX_TARGET_SIZE)
@@ -98,39 +105,33 @@ public:
 			} else if (token <= 0xdb && token >= 0xd9) {
 				if (token == 0xd9) { //str 8
 					if (position >= size) {
-						TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 					int length = source[position++];
 					if (length + position > size) {
-						TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 					readString(env,length, true);
 				} else if (token == 0xda) { //str 16
 					if (2 + position > size) {
-						TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 					int length = source[position++] << 8;
 					length += source[position++];
 					if (length + position > size) {
-						TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 					readString(env,length, false);
 				} else { //str 32
 					if (4 + position > size) {
-						TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 					int length = source[position++] << 24;
 					length += source[position++] << 16;
 					length += source[position++] << 8;
 					length += source[position++];
 					if (length + position > size) {
-						TypeError::New(env, "Unexpected end of buffer reading string").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 					readString(env, length, false);
 				}
@@ -143,8 +144,7 @@ public:
 				} else {
 					position = tokenTable[token](source, position, size);
 					if (position < 0) {
-						TypeError::New(env, "Unexpected end of buffer").ThrowAsJavaScriptException();
-						return env.Null();
+						return unexpectedEnd(env);
 					}
 				}
 			}
@@ -154,19 +154,38 @@ public:
 			napi_value value;
 			napi_create_string_latin1(env, (const char*) source + stringStart, lastStringEnd - stringStart, &value);
 			if (writePosition == 0) {
+				/*if (!hasTargetArray) {
+					hasTargetArray = true;
+					napi_create_reference(env, array, 1, &targetArray);
+				}*/
 				return value;
 			}
 			target[writePosition++] = value;
 		} else if (writePosition == 1) {
+			/*if (!hasTargetArray) {
+				hasTargetArray = true;
+				napi_create_reference(env, array, 1, &targetArray);
+			}*/
 			return target[0];
 		}
 		napi_value array;
+		#if ENABLE_V8_API
+		v8::Local<v8::Array> v8Array = v8::Array::New(v8::Isolate::GetCurrent(), (v8::Local<v8::Value>*) target, writePosition);
+		memcpy(&array, &v8Array, sizeof(array));
+		#else
 		napi_create_array_with_length(env, writePosition, &array);
-		//Array array = Array::New(env, writePosition);
+		/*if (hasTargetArray) {
+			napi_get_reference_value(env, targetArray, &array);
+			hasTargetArray = false;
+		}*/
 		for (int i = 0; i < writePosition; i++) {
 			napi_set_element(env, array, i, target[i]);
-			//array.Set(i, target[i]);
-		}
+		}/*
+		napi_value length;
+		napi_create_int32(env, i, &length);
+		return length;
+		napi_set_element(env, array, i, undefined); */
+		#endif
 		return array;
 	}
 };
@@ -247,29 +266,25 @@ void setupTokenTable() {
 		return position + length;
 	});
 }
-
 static thread_local Extractor* extractor;
-
-napi_value extractStrings(const CallbackInfo& info) {
-  Env env = info.Env();
-	int position = info[0].As<Number>();
-	int size = info[1].As<Number>();
-	if (info[2].IsTypedArray()) {
-		TypedArray typedArray = info[2].As<TypedArray>();
-    	uint8_t* source = ((uint8_t*) typedArray.ArrayBuffer().Data()) + typedArray.ByteOffset();
-		return extractor->extractStrings(env, position, size, source);
-	}
-  return env.Undefined();
+napi_value extractStrings(napi_env env, napi_callback_info info) {
+	size_t argc = 3;
+	napi_value args[3];
+	napi_get_cb_info(env, info, &argc, args, NULL, NULL);
+	uint32_t position;
+	uint32_t size;
+	napi_get_value_uint32(env, args[0], &position);
+	napi_get_value_uint32(env, args[1], &size);
+	uint8_t* source;
+	napi_get_typedarray_info(env, args[2], NULL, NULL, (void**) &source, NULL, NULL);
+	return extractor->extractStrings(env, position, size, source);
 }
-
-Object Init(Env env, Object exports) {
+#define EXPORT_NAPI_FUNCTION(name, func) { napi_property_descriptor desc = { name, 0, func, 0, 0, 0, (napi_property_attributes) (napi_writable | napi_configurable), 0 }; napi_define_properties(env, exports, 1, &desc); }
+napi_value Init(napi_env env, napi_value exports) {
 	extractor = new Extractor(); // create our thread-local extractor
 	setupTokenTable();
-	exports.Set(
-    String::New(env, "extractStrings"),
-    Function::New(env, extractStrings)
-  );
+	EXPORT_NAPI_FUNCTION("extractStrings", extractStrings);
 	return exports;
 }
 
-NODE_API_MODULE(extractor, Init)
+NAPI_MODULE(extractor, Init)

package/.circleci/config.yml

@@ -1,19 +0,0 @@
-name: Test and Prebuild
-jobs:
-  build:
-    executor: my-ubuntu-exec
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: 12
-      - run: npm install
-      - run: npm run prebuild
-      - run: zip -r prebuild-darwin.zip prebuilds
-      - run: hexdump "prebuilds/darwin-x64/node.abi93.node" | head -10
-      - name: Prebuild
-        uses: softprops/action-gh-release@v1
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          files: prebuild-darwin.zip

package/.github/workflows/prebuild.yml

@@ -1,87 +0,0 @@
-name: Prebuild
-on: [push]
-jobs:
-  build-test-macos:
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: macos-11
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: 12
-      - run: npm install
-      - run: npm test
-      - run: npm run prebuild
-        if: startsWith(github.ref, 'refs/tags/')
-      - run: npm run prebuild-arm64
-        if: startsWith(github.ref, 'refs/tags/')
-      - run: tar --create --format ustar --verbose --file=prebuild-darwin.tar -C prebuilds .
-        if: startsWith(github.ref, 'refs/tags/')
-      - name: Prebuild
-        uses: softprops/action-gh-release@v1
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          files: prebuild-darwin.tar
-  build-centos-7:
-    #if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-18.04
-    container: quay.io/pypa/manylinux2014_x86_64
-    steps:
-      - run: ldd --version ldd
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: 12
-      - run: npm install
-      - run: npm run prebuild
-      - run: npm test
-      - run: tar --create --verbose --file=prebuild-linux.tar -C prebuilds .
-      - name: Prebuild
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: softprops/action-gh-release@v1
-        with:
-          files: prebuild-linux.tar
-  build-alpine:
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-18.04
-    container: node:12-alpine
-    steps:
-      - run: apk add python3 py3-pip build-base
-      - uses: actions/checkout@v2
-      - run: npm install
-      - run: npm run prebuild-musl
-      - run: npm test
-      - run: tar --create --verbose --file=prebuild-alpine.tar -C prebuilds .
-      - name: Prebuild
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: softprops/action-gh-release@v1
-        with:
-          files: prebuild-alpine.tar
-  build-linux-arm64:
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-18.04
-    container: quay.io/pypa/manylinux_2_24_x86_64
-    steps:
-      - run: apt-get update
-      - run: apt-get install -y gcc-aarch64-linux-gnu
-      - run: apt-get install -y g++-aarch64-linux-gnu
-      - run: ldd --version ldd
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: 12
-      - run: npm install
-      - run: npm run prebuild-arm64
-        if: startsWith(github.ref, 'refs/tags/')
-        env:
-          CC: aarch64-linux-gnu-gcc
-          CXX: aarch64-linux-gnu-g++
-      - run: tar --create --verbose --file=prebuild-linux-arm64.tar -C prebuilds .
-      - name: Prebuild
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: softprops/action-gh-release@v1
-        with:
-          files: prebuild-linux-arm64.tar

package/.travis.yml

@@ -1,30 +0,0 @@
-sudo: false
-language: node_js
-node_js:
-- node
-addons:
-  apt:
-    sources:
-    - ubuntu-toolchain-r-test
-arch:
-- amd64
-- arm64
-os:
-- osx
-- linux
-osx_image: xcode12.5
-before_deploy:
-- ARCHIVE_NAME="${TRAVIS_TAG:-latest}-$TRAVIS_OS_NAME-`uname -m`.tar"
-- npm run prebuild
-- tar --create --verbose --file="$ARCHIVE_NAME" --directory "$TRAVIS_BUILD_DIR/prebuilds"
-  .
-deploy:
-  provider: releases
-  draft: false
-  prerelease: true
-  file: "$ARCHIVE_NAME"
-  skip_cleanup: true
-  on:
-    tags: true
-    node: node
-  api_key:  '$GITHUB_API_KEY'

package/.vscode/launch.json

@@ -1,15 +0,0 @@
-{
-	// Use IntelliSense to learn about possible attributes.
-	// Hover to view descriptions of existing attributes.
-	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-	"version": "0.2.0",
-	"configurations": [
-    {
-        "name": "(Windows) Attach",
-        "type": "cppvsdbg",
-        "request": "attach",
-        "processId": "${command:pickProcess}",
-        "internalConsoleOptions": "neverOpen"
-    },
-	]
-}