Neon packaging (#75)

Removed the native directory. Made the tests run expecting the same
structure as what we distribute. That same structure is created by
either running `yarn compile` or `node-pre-gyp install` (the second
being how and end user gets the binary).

The publish structure is the same other than the new entry point, so
that should continue working.

* Add NAPI to changelog, would be good to remember

* bump-version: Set release version 0.8.0-pre.1

* Add a comment to clarify where changes happen

Limited jest `maxWorkers` to dodge the weird GH issue tracked by
jestjs/jest#10662 but won't impact local
machine runs as much

Co-authored-by: Leeroy Travis <ops@ironcorelabs.com>

Author: skeet70

.github/rust-ci-patch.yaml

@@ -3,10 +3,3 @@
   path: /jobs/cargo-test
 - op: remove
   path: /jobs/coverage
-
-# Everything needs to run in the native directory.
-- op: add
-  path: /defaults
-  value:
-    run:
-      working-directory: native

.github/rust-daily-patch.yaml

@@ -49,6 +49,3 @@ jobs:
       with:
         command: clippy
         args: ${{ env.clippy_args }}
-defaults:
-  run:
-    working-directory: native

.github/workflows/rust-ci.yaml

@@ -52,6 +52,3 @@ jobs:
     - name: Print sccache stats
       if: steps.rust-cache.outputs.cache-hit != 'true'
       run: sccache -s
-defaults:
-  run:
-    working-directory: native

.github/workflows/rust-daily.yaml

@@ -4,9 +4,8 @@
 .babelrc
 npm-debug.log
 yarn-error.log
-native/target
-native/artifacts.json
-native/index.node
+target
+artifacts.json
 dist/*
 bin-package/*
 build/*

.gitignore

@@ -8,6 +8,7 @@
 
 -   Added support for Node 16.
 -   Upgraded Recrypt to 0.13
+-   Upgraded to Neon's NAPI interface.
 
 ## 0.7.3
 

CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "recrypt-node-binding"
-version = "0.7.4-pre.22"
+version = "0.8.0-pre.1"
 authors = ["IronCore Labs <code@ironcorelabs.com>"]
 edition = "2021"
 rust-version = "1.56.0"
@@ -13,9 +13,6 @@ crate-type = ["cdylib"]
 neon = { version = "0.9", default-features = false, features = ["napi-4"] }
 recrypt = "0.13.1"
 
-[build-dependencies]
-neon-build = "0.9"
-
 [profile.release]
 lto = true
 debug = false

native/Cargo.lock Cargo.lock

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const api = new recrypt.Api256();
 

native/Cargo.toml Cargo.toml

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 

benchmark/computePublicKey.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 

benchmark/decryptLevelOne.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 

benchmark/decryptLevelTwo.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const api = new recrypt.Api256();
 

benchmark/decryptLevelZero.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 

benchmark/deriveSymmetricKey.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const api = new recrypt.Api256();
 

benchmark/encrypt.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const api = new recrypt.Api256();
 

benchmark/generateEd25519KeyPair.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const api = new recrypt.Api256();
 

benchmark/generateKeyPair.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 
 const api = new recrypt.Api256();
 

benchmark/generatePlaintext.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 

benchmark/generateTransformKey.js

@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../native/index.node");
+const recrypt = require("../index.node");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 

benchmark/transformLevelOne.js

@@ -1,8 +1,17 @@
 "use strict";
 
-// TODO: is this even going to resolve when distributed?
-// TODO: might want to introduce a TS build process and generate the index.d.ts
-const internal = require("./native/index.node");
+/**
+ * WARNING!
+ * 
+ * This file is the bridge between the generated Rust binary and the JavaScript interface users call into.
+ * 
+ * This file is not generated. Any changes made in the Rust code will need to be propogated out here, either by adding
+ * bare functions to the export declaration at the bottom, or by adding new methods to the Api256 class.
+ * 
+ * The `index.d.ts` file is also manually maintained, add any new signatures to it.
+ */ 
+
+const internal = require("./bin-package/index.node");
 
 class Api256 {
     constructor() {

benchmark/transformLevelTwo.js

@@ -1,6 +1,6 @@
 {
     "name": "@ironcorelabs/recrypt-node-binding",
-    "version": "0.7.4-pre.22",
+    "version": "0.8.0-pre.1",
     "description": "Bindings to allow the recrypt-rs library to work via NodeJS.",
     "repository": {
         "type": "git",
@@ -9,7 +9,7 @@
     "homepage": "https://ironcorelabs.com",
     "author": "IronCore Labs",
     "license": "AGPL-3.0-only",
-    "main": "bin-package/index.node",
+    "main": "index.js",
     "types": "index.d.ts",
     "engines": {
         "node": ">=12.0.0"
@@ -23,20 +23,20 @@
         "x64"
     ],
     "scripts": {
-        "compile": "neon build -r",
-        "clean": "neon clean",
+        "compile": "cargo-cp-artifact -a cdylib recrypt_node ./bin-package/index.node -- cargo build --release --message-format=json-render-diagnostics",
+        "clean": "cargo clean && rm -rf dist && rm -rf bin-package && rm -rf build",
         "benchmark": "node benchmark/index.js",
-        "test": "jest"
+        "test": "jest --maxWorkers=50%"
     },
     "dependencies": {
         "@mapbox/node-pre-gyp": "^1.0.7"
     },
     "devDependencies": {
         "@types/node": "^16.11.11",
         "benchmark": "^2.1.4",
+        "cargo-cp-artifact": "^0.1.6",
         "jest": "^27.4.0",
         "jest-extended": "^1.2.0",
-        "neon-cli": "^0.9.1",
         "shelljs": "^0.8.4"
     },
     "prettier": {

index.js

@@ -27,31 +27,22 @@ shell.cd(rootDirectory);
 const shouldPublish = process.argv.slice(2).indexOf("--publish") !== -1;
 const isPreRelease = process.argv.slice(2).indexOf("--prerelease") !== -1;
 
-//Cleanup the previous build, if it exists
-shell.rm("-rf", "./dist");
-shell.rm("-rf", "./bin-package");
-shell.rm("-rf", "./build");
-
 // Cleanup any previous Rust builds, update deps, and compile
 shell.exec("yarn install --ignore-scripts");
-shell.exec("yarn run clean");
-shell.pushd("./native");
-shell.popd();
-shell.exec("yarn run compile");
+shell.exec("yarn clean");
+shell.exec("yarn compile");
 
 shell.exec("yarn test");
 shell.mkdir("./dist");
 
-shell.cp(["README.md", "package.json", "index.d.ts", "LICENSE"], "./dist");
+shell.cp(["README.md", "package.json", "index.d.ts", "index.js", "LICENSE"], "./dist");
 
 //Add a NPM install script to the package.json that we push to NPM so that when consumers pull it down it
 //runs the expected node-pre-gyp step.
 const npmPackageJson = require("./dist/package.json");
 npmPackageJson.scripts.install = "node-pre-gyp install";
 fs.writeFileSync("./dist/package.json", JSON.stringify(npmPackageJson, null, 2));
 
-shell.mkdir("./bin-package");
-shell.cp("./native/index.node", "./bin-package");
 //Use a fully qualified path to pre-gyp binary for Windows support
 const cwd = shell.pwd().toString();
 shell.exec(`${cwd}/node_modules/node-pre-gyp/bin/node-pre-gyp package`);

package.json

@@ -11,7 +11,6 @@ fn main(mut cx: ModuleContext) -> NeonResult<()> {
     cx.export_function("transformKeyToBytes256", api256::transform_key_to_bytes_256)?;
     cx.export_function("addPrivateKeys", api256::add_private_keys)?;
     cx.export_function("subtractPrivateKeys", api256::subtract_private_keys)?;
-    // cx.export_class::<api256::Api256>("Api256") TODO: get the class working
     // Api256 member functions
     cx.export_function("createApi256", api256::api256_create_recrypt_api_256)?;
     cx.export_function("generateKeyPair", api256::api256_generate_key_pair)?;

publish.js

@@ -52,7 +52,7 @@ pub fn bytes_to_buffer<'a, T: Context<'a>>(
 ) -> NeonResult<Handle<'a, JsBuffer>> {
     let mut buffer: Handle<JsBuffer> = cx.buffer(data.len() as u32)?;
     cx.borrow_mut(&mut buffer, |contents| {
-        contents.as_mut_slice().copy_from_slice(&data)
+        contents.as_mut_slice().copy_from_slice(data)
     });
     Ok(buffer)
 }
@@ -249,20 +249,15 @@ pub fn transform_blocks_to_js_object<'a, T: Context<'a>>(
 ) -> NeonResult<Handle<'a, JsArray>> {
     let blocks_array: Handle<JsArray> = JsArray::new(cx, transform_blocks.len() as u32);
 
-    for i in 0..transform_blocks.len() {
+    for (i, block_rs) in transform_blocks.iter().enumerate() {
         let block = cx.empty_object();
 
-        let public_key = public_key_to_js_object(cx, &transform_blocks[i].public_key())?;
-        let encrypted_temp_key =
-            bytes_to_buffer(cx, transform_blocks[i].encrypted_temp_key().bytes())?;
+        let public_key = public_key_to_js_object(cx, block_rs.public_key())?;
+        let encrypted_temp_key = bytes_to_buffer(cx, block_rs.encrypted_temp_key().bytes())?;
         let random_transform_public_key =
-            public_key_to_js_object(cx, &transform_blocks[i].random_transform_public_key())?;
-        let encrypted_random_transform_temp_key = bytes_to_buffer(
-            cx,
-            transform_blocks[i]
-                .encrypted_random_transform_temp_key()
-                .bytes(),
-        )?;
+            public_key_to_js_object(cx, block_rs.random_transform_public_key())?;
+        let encrypted_random_transform_temp_key =
+            bytes_to_buffer(cx, block_rs.encrypted_random_transform_temp_key().bytes())?;
 
         block.set(cx, "publicKey", public_key)?;
         block.set(cx, "encryptedTempKey", encrypted_temp_key)?;
@@ -314,7 +309,8 @@ pub fn js_object_to_encrypted_value<'a, T: Context<'a>>(
         .downcast::<JsArray, _>(cx)
         .unwrap();
 
-    let encrypted_value = if transform_blocks.len(cx) > 0 {
+    // create the encrypted value and return it
+    if transform_blocks.len(cx) > 0 {
         EncryptedValue::TransformedValue {
             ephemeral_public_key: js_object_to_public_key(cx, emphemeral_public_key_obj),
             encrypted_message: EncryptedMessage::new(buffer_to_fixed_384_bytes(
@@ -347,8 +343,7 @@ pub fn js_object_to_encrypted_value<'a, T: Context<'a>>(
             )),
             signature: buffer_to_ed25519_signature(cx, signature_buffer),
         }
-    };
-    encrypted_value
+    }
 }
 
 /// Convert a Recrypt EncryptedValue into a JsObbject with expeted properties and bytes converted to Buffers.