Add node 18 to release (#107)

coltfred · leeroy-travis · cjyar · web-flow · commit 34ae623b9120 · 2022-11-11T17:04:11.000-07:00
* Add node 18 to release

* Add 18 to ci, too. Also, nix

* Add 18 to arm list

* Run the patch

* Update workflows from templates.

* Try prepending ~/bin instead of appending.

* Update workflows from templates.

* Explicitly use tools from $HOME/bin.

* Update workflows from templates.

* Remove 12, and rust 1.56

* Update workflows from templates.

* Update readme

* Fix benchmarks and flake.nix

* Fix link to neon

* Add toolchain

* Fix toolchain and readme

Co-authored-by: Leeroy Travis &lt;ops@ironcorelabs.com&gt;
Co-authored-by: Chris Jones &lt;chris.jones@ironcorelabs.com&gt;
diff --git a/.envrc b/.envrc
@@ -0,0 +1 @@
+use flake
diff --git a/.github/typescript-ci-patch.yaml b/.github/typescript-ci-patch.yaml
@@ -2,41 +2,47 @@
 - op: replace
   path: /jobs/test/strategy/matrix
   value:
-    rust_version: 
-      - 1.56.0
+    rust_version:
       - stable
       - beta
     node_version:
-      - 12
       - 14
       - 16
+      - 18
     system:
       - os: macos-12
         target: x86_64-apple-darwin
       - os: ubuntu-22.04
         target: x86_64-unknown-linux-gnu
       - os: windows-2019
         target: x86_64-pc-windows-msvc
-    arch: 
+    arch:
       - x64
     include:
       # only node 15+ supports arm64 natively, so we only need to build 16 for now
       - system:
           os: [self-hosted, macOS, ARM64]
           target: aarch64-apple-darwin
         node_version: 16
-        rust_version: 1.56.0
+        rust_version: stable
         arch: arm64
       - system:
           os: [self-hosted, macOS, ARM64]
           target: aarch64-apple-darwin
         node_version: 16
+        rust_version: beta
+        arch: arm64
+      #Node 18
+      - system:
+          os: [self-hosted, macOS, ARM64]
+          target: aarch64-apple-darwin
+        node_version: 18
         rust_version: stable
         arch: arm64
       - system:
           os: [self-hosted, macOS, ARM64]
           target: aarch64-apple-darwin
-        node_version: 16
+        node_version: 18
         rust_version: beta
         arch: arm64
 - op: add
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -21,9 +21,9 @@ jobs:
       fail-fast: false
       matrix:
         node_version:
-          - 12
           - 14
           - 16
+          - 18
         system:
           - os: macos-12
             target: x86_64-apple-darwin
@@ -37,6 +37,10 @@ jobs:
               os: [self-hosted, macOS, ARM64]
               target: aarch64-apple-darwin
             node_version: 16
+          - system:
+              os: [self-hosted, macOS, ARM64]
+              target: aarch64-apple-darwin
+            node_version: 18
     steps:
       - uses: actions/checkout@v2
         with:
@@ -78,9 +82,9 @@ jobs:
       fail-fast: false
       matrix:
         node_version:
-          - '12'
           - '14'
           - '16'
+          - '18'
     steps:
       - run: apk add build-base git python3 wget github-cli
       - uses: actions/checkout@v2
diff --git a/.github/workflows/typescript-ci.yaml b/.github/workflows/typescript-ci.yaml
@@ -15,13 +15,12 @@ jobs:
     strategy:
       matrix:
         rust_version:
-        - 1.56.0
         - stable
         - beta
         node_version:
-        - 12
         - 14
         - 16
+        - 18
         system:
         - os: macos-12
           target: x86_64-apple-darwin
@@ -39,7 +38,7 @@ jobs:
             - ARM64
             target: aarch64-apple-darwin
           node_version: 16
-          rust_version: 1.56.0
+          rust_version: stable
           arch: arm64
         - system:
             os:
@@ -48,6 +47,15 @@ jobs:
             - ARM64
             target: aarch64-apple-darwin
           node_version: 16
+          rust_version: beta
+          arch: arm64
+        - system:
+            os:
+            - self-hosted
+            - macOS
+            - ARM64
+            target: aarch64-apple-darwin
+          node_version: 18
           rust_version: stable
           arch: arm64
         - system:
@@ -56,7 +64,7 @@ jobs:
             - macOS
             - ARM64
             target: aarch64-apple-darwin
-          node_version: 16
+          node_version: 18
           rust_version: beta
           arch: arm64
       fail-fast: false
@@ -91,13 +99,12 @@ jobs:
     strategy:
       matrix:
         rust_version:
-        - 1.56.0
         - stable
         - beta
         node_version:
-        - 12
         - 14
         - 16
+        - 18
         arch:
         - x64
         os:
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,5 @@ artifacts.json
 dist/*
 bin-package/*
 build/*
-.idea/*
+.idea/*
+.direnv
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ This library uses the [Neon Bindings](https://www.neon-bindings.com) toolchain t
 
 ## Supported Platforms
 
-|                       | Node 12 | Node 14 | Node 16 |
+|                       | Node 14 | Node 16 | Node 18 |
 | --------------------- | ------- | ------- | ------- |
 | Linux x64 - glibc     | ✓       | ✓       | ✓       |
 | Linux x64 - musl-libc | ✓       | ✓       | ✓       |
@@ -96,7 +96,7 @@ assert.equal(decryptedValue, plaintext);
 
 ## Local Development
 
-In order to build the binary Node file for Recrypt, you'll need the dependencies specified on the [Neon Bindings site](https://guides.neon-bindings.com/getting-started/). Follow their getting started directions and install Rust and the Node Build Tools. The Neon CLI is already installed as a dependency of this project so you don't have to install that as a global dependency.
+In order to build the binary Node file for Recrypt, you'll need the dependencies specified on the [Neon Bindings site](https://neon-bindings.com/docs/quick-start/). Follow their getting started directions and install Rust and the Node Build Tools. The Neon CLI is already installed as a dependency of this project so you don't have to install that as a global dependency.
 
 Once all of those dependencies are installed, the following can be run.
 
@@ -110,22 +110,22 @@ or
 yarn compile
 ```
 
-This will produce an `index.node` file within the `native` directory. This file can then be included within a NodeJS file by simply requiring the file, e.g.
+This will produce an `index.node` file within the `bin-package` directory. This file can be used directly, or via index.js:
 
 ```
-const recrypt = require('index.node');
+const recrypt = require('index.js');
 ```
 
 ### Benchmarks
 
 -   From this repos root, run `npm i` or `yarn`.
--   Run `npm/yarn run compile` to compile the Rust source into a `native/index.node` module.
+-   Run `npm/yarn run compile` to compile the Rust source into a `bin-package/index.node` module.
 -   Run `npm/yarn run benchmark`.
 
 ### Unit Tests
 
 -   From this repos root, run `npm i` or `yarn`.
--   Run `npm/yarn run compile` to compile the Rust source into a `native/index.node` module.
+-   Run `npm/yarn run compile` to compile the Rust source into a `bin-package/index.node` module.
 -   Run `npm/yarn run test`.
 
 Copyright (c) 2021 IronCore Labs, Inc.
diff --git a/benchmark/computePublicKey.js b/benchmark/computePublicKey.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const api = new recrypt.Api256();
 
diff --git a/benchmark/decryptLevelOne.js b/benchmark/decryptLevelOne.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 
diff --git a/benchmark/decryptLevelTwo.js b/benchmark/decryptLevelTwo.js
@@ -1,6 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
-//Randomly generated legit ED25519 keypair
+const recrypt = require("../index.js");//Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 
 const api = new recrypt.Api256();
diff --git a/benchmark/decryptLevelZero.js b/benchmark/decryptLevelZero.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 
diff --git a/benchmark/deriveSymmetricKey.js b/benchmark/deriveSymmetricKey.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const api = new recrypt.Api256();
 
diff --git a/benchmark/encrypt.js b/benchmark/encrypt.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 
diff --git a/benchmark/generateEd25519KeyPair.js b/benchmark/generateEd25519KeyPair.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const api = new recrypt.Api256();
 
diff --git a/benchmark/generateKeyPair.js b/benchmark/generateKeyPair.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const api = new recrypt.Api256();
 
diff --git a/benchmark/generatePlaintext.js b/benchmark/generatePlaintext.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const api = new recrypt.Api256();
 
diff --git a/benchmark/generateTransformKey.js b/benchmark/generateTransformKey.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 
 const api = new recrypt.Api256();
 
diff --git a/benchmark/transformLevelOne.js b/benchmark/transformLevelOne.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 
diff --git a/benchmark/transformLevelTwo.js b/benchmark/transformLevelTwo.js
@@ -1,5 +1,5 @@
 const Benchmark = require("benchmark");
-const recrypt = require("../index.node");
+const recrypt = require("../index.js");
 //Randomly generated legit ED25519 keypair
 const privateSigningKey = Buffer.from("O7f2FYsabKOFj3enK+HQ+cBmTMbAG6aCesd1nLcFM1wtA9XHg0+rFIVA7+nomADjEbJ1R/Gd+xHBO79UnLqxDQ==", "base64");
 
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix

-Original file line number
+Diff line change
 dist/*
 bin-package/*
 build/*
 -.idea/*
 +.idea/*
 +.direnv