feat!: upgrade support to node 22 and 24 (#63)

* chore: Upgrade support to node 22 and 24

We are also upgrading the minimum engine to 22,
and the dependencies we use for CodeQL to 24, as it's
going to be our baseline from now on.

* chore: use devtools toolchain on linux and upgrade macos deps

* chore: add brotli as a dependency when compiling the test

* chore: Remove unsupported flags for r/o heaps

According to a v8 commit, v8 removed the ability
to build without shared r/o heaps.

More info: https://chromium-review.googlesource.com/c/v8/v8/+/6038531

* chore: use 22 until we have 24

* chore: create parent node folder, necessary for the symlink

* chore: upgrade node-gyp to the latest

* chore: upgrade test template to node 24 and std=c++20

* chore: remove assert(CanUseCustomSnapshotPerIsolate)

We only use one EmbedderSnapshotData and one Isolate, so we are
not hitting the corner case of having isolates with different
snapshots.

* chore: forgot to remove the test skip

* chore: unregister isolate *after* disposing isolate

Refs: nodejs/node@9aa1afb
Refs: nodejs/node@5d3e1b5

* feat!: remove support code for older Node.js versions

* chore: add evergreen task for testing dchecks

* chore: use ubuntu instead of amazon for dcheck runs

* fixup: use fixed version of weak-napi

* chore: upgrade to vs2022 to test

* chore: upgrade host so it has msvc 2022

* chore: typo in the evergreen distro

* chore(ci): use llvm from homebrew on evergreen macOS

* chore: Use python3.11 in windows host

* chore: make sure python 3.11 is used everywhere, also when compiling

* chore: make sure that the hash is updated so it uses the proper python version

* chore: also setup python and python3 env vars for node-gyp

* chore: use NODE_GYP_FORCE_PYTHON

* chore: use windows path and simplify

* chore: normalise to spaces

* chore: untabify, use spaces always

* chore: setup VC environment and upgrade command args for vcbuild

* chore: stub APPDATA env var

* chore: adapt it to use CMD properly

* chore: fix order of parameters

* chore: we still need to projgen

* chore: do not use $TEMP because files there can be deleted

* chore: typo :(

* chore: upgrade to node 24 (the LTS) and increase timeout

The build in Windows is slower, so we increase the timeout
to avoid issues related to slow compilation

* chore: use the same base in all machines (22.17.0)

* chore: setup windows tests also in GHA for faster feedback

This also adds a baseline: if the tests without special setup
work here, it should work also in evergreen hosts if properly
configured.

* chore: remove unused deps and remove setup of MSVC DevTools

In theory vcbuild.bat should detect where the MSVC DevTools
are located (using vswhere.exe) and setup them correctly. We
are going to verify this behaviour.

* chore: support all architecture flags

* chore: increase timeout (default is 6h, builds can take more time)

* chore: fix linter issues

* chore: use DEBUG, as it's faster, and it's good enough for a safety check

* chore: split each test in it's own job to avoid disk space issues

* chore: we can't use cache: npm because we don't have a package-lock

* chore: delete precompiled headers on windows and node24>

Compiling with a snapshot requires compiling twice: a base image
and the image with the snapshot embedded. In that situation, clang-cl
complains that there are precompiled headers that changed between
compilations and does not refresh them, but kills the compilation
process with an error. Due to this, before attempting the second
compilation, we will delete all pch files.

* chore: Remove test, now the behaviour is tested by the compiler

This test was written so we could speed up the feedback loop.

* chore: use rimraf instead of custom code, it should be easier to maintain

* chore: Generate the GHA workflow from a template

Because we can keep adding more tests, maintaining the GHA workflow
can become a bit cumbersome. This script generates the GHA file
from a template, and adds all the test cases in a matrix. We do this
because each test is expensive in time and disk space, so we do
sometimes hit the GHA limit of 6h or the we fill the disk.

* chore: Fix linter issues (spacing and unused deps)

* chore: use -f instead of -g for the test runner

It seems that -g expects a regular expression, and
if the regular expression is invalid, mocha just fails
with Error: null. Using -f, uses a substring comparison,
which is what we need.

* chore: Remove pch files from compilation artifacts in tmp directory

* chore: Print the folder where we are deleting pchs from

* chore: attempt to upgrade rimraf to latest version

* chore: Use follow: true, so it follows symlinks and junctions

* chore: resolve the realpath of nodeSourcePath before deleting pchs

nodeSourcePath in Windows refers to a user directory that contains
an alias. For example, something like C:\Users\RUNNER~1 (in GHA) while
MSVC uses the full name like C:\Users\runneradmin. This can make
rimraf not delete the pch files properly. By resolving first, we make
sure that both paths are absolute and unambiguous.

* chore: Remove all directories that can contain compilation outputs

clang-cl does not properly handle pch refresh when a source header
changed after the pch file was generated

* chore: try to delete the whole out directory for a fresh compilation

* chore: Simplify naming, we now wipe out the whole out directory

This will force Node.js to compile from scratch. It's slower, but
it will only happens on Windows and it will be safer and more
reliable there.

* chore: ensure that any output directory is cleaned up before compiling

Right now it's failing on the first compilation of the second test, as
we are not doing any clean up. To ensure that we are in a consistent
state in Windows, before attempting compiling, we will make sure we
don't have any old compilation artifact.

This might slow down Windows compilations as they can't reuse cached
files.

---------

Co-authored-by: Anna Henningsen <anna@addaleax.net>

Author: kmruiz

.evergreen.yml

@@ -14,8 +14,13 @@ functions:
           set -e
           set -x
 
-          export NODE_VERSION=20.13.0
-          bash .evergreen/install-node.sh
+          if [ "$OS" == "Windows_NT" ]; then
+            export NODE_GYP_FORCE_PYTHON="C:\python\Python311\python.exe"
+            export PATH="/cygdrive/c/python/Python311/Scripts:/cygdrive/c/python/Python311:$PATH"
+          fi
+
+          export NODE_VERSION=22.17.0
+          . .evergreen/install-node.sh
   install:
     - command: shell.exec
       params:
@@ -25,17 +30,29 @@ functions:
           set -e
           set -x
 
+          if [ "$OS" == "Windows_NT" ]; then
+            export NODE_GYP_FORCE_PYTHON="C:\python\Python311\python.exe"
+            export PATH="/cygdrive/c/python/Python311/Scripts:/cygdrive/c/python/Python311:$PATH"
+          fi
+          
           . .evergreen/use-node.sh
           npm install
   check:
     - command: shell.exec
       params:
         working_dir: src
         shell: bash
+        env:
+          NODE_VERSION: ${node_version}
         script: |
           set -e
           set -x
 
+          if [ "$OS" == "Windows_NT" ]; then
+            export NODE_GYP_FORCE_PYTHON="C:\python\Python311\python.exe"
+            export PATH="/cygdrive/c/python/Python311/Scripts:/cygdrive/c/python/Python311:$PATH"
+          fi
+          
           . .evergreen/use-node.sh
           npm run build
           npm run lint
@@ -51,10 +68,29 @@ functions:
           AZURE_TEST_CONFIG: ${azure_test_config}
           AZURE_TEST_CREDENTIALS: ${azure_test_credentials}
           DISTRO_ID: ${distro_id}
+          BOXEDNODE_DCHECKS_ENABLED: ${dchecks_enabled}
         script: |
           set -e
           set -x
 
+          if [ `uname` == "Darwin" ]; then
+            # the CI macOS machines have an outdated Clang that
+            # cannot build recent Node.js versions, so we use
+            # the LLVM version installed via Homebrew
+            # (both on arm64 and x64)
+
+            LLVM_PREFIX="$(brew --prefix llvm)"
+            export PATH="$LLVM_PREFIX/bin:$PATH"
+            export CC="$LLVM_PREFIX/bin/clang"
+            export CXX="$LLVM_PREFIX/bin/clang++"
+            export LDFLAGS="-L$LLVM_PREFIX/lib -L$LLVM_PREFIX/lib/c++ -L$LLVM_PREFIX/lib/unwind"
+            export CPPFLAGS="-I$LLVM_PREFIX/include"
+            export CMAKE_PREFIX_PATH="$LLVM_PREFIX"
+
+            $CC --version
+            $CXX --version
+          fi
+
           rm -rf /tmp/m && mkdir -pv /tmp/m # Node.js compilation can fail on long path prefixes
           trap "rm -rf /tmp/m" EXIT
           export TMP=/tmp/m
@@ -64,49 +100,81 @@ functions:
           # able to compile OpenSSL with assembly support,
           # so we revert back to the slower version.
           if [ "$OS" == "Windows_NT" ]; then
-            export PATH="/cygdrive/c/python/Python310/Scripts:/cygdrive/c/python/Python310:/cygdrive/c/Python310/Scripts:/cygdrive/c/Python310:$PATH"
+            export NODE_GYP_FORCE_PYTHON="C:\python\Python311\python.exe"
+            export PATH="/cygdrive/c/python/Python311/Scripts:/cygdrive/c/python/Python311:$PATH"
             export BOXEDNODE_CONFIGURE_ARGS='openssl-no-asm'
           elif uname -a | grep -q 'Darwin.*x86_64'; then
             export BOXEDNODE_CONFIGURE_ARGS='--openssl-no-asm'
           fi
 
           . .evergreen/use-node.sh
-          npm run build
-          TEST_NODE_VERSION="$TEST_NODE_VERSION" npm run test-ci
+          export TEST_NODE_VERSION="$TEST_NODE_VERSION"
+          if [ "$OS" == "Windows_NT" ]; then
+            # The CI machines we have for Windows don't have a working
+            # installation of VS2022, (vswhere.exe can't find the correct path)
+            # So we run the scripts to set up the environment manually, and they
+            # only work properly in CMD
+            WIN_PATH=$(cygpath -aw .evergreen/test-in-vcdev-env.bat)
+            cmd.exe /c "$WIN_PATH"
+          else
+            npm run build
+            npm run test-ci
+          fi
 
 tasks:
-  - name: test_n14
+  - name: test_n20
     commands:
       - func: checkout
       - func: install_node
       - func: install
       - func: test
         vars:
-          node_version: "14.21.3"
-  - name: test_n16
+          node_version: "20.19.5"
+  - name: test_n22
     commands:
       - func: checkout
       - func: install_node
       - func: install
       - func: test
         vars:
-          node_version: "16.20.1"
-  - name: test_n18
+          node_version: "22.21.0"
+  - name: test_n24
     commands:
       - func: checkout
       - func: install_node
       - func: install
       - func: test
         vars:
-          node_version: "18.17.0"
-  - name: test_n20
+          node_version: "24.10.0"
+
+  - name: test_n20_dchecks
+    commands:
+      - func: checkout
+      - func: install_node
+      - func: install
+      - func: test
+        vars:
+          node_version: "20.19.5"
+          dchecks_enabled: 1
+  - name: test_n22_dchecks
     commands:
       - func: checkout
       - func: install_node
       - func: install
       - func: test
         vars:
-          node_version: "20.13.0"
+          node_version: "22.21.0"
+          dchecks_enabled: 1
+  - name: test_n24_dchecks
+    commands:
+      - func: checkout
+      - func: install_node
+      - func: install
+      - func: test
+        vars:
+          node_version: "24.10.0"
+          dchecks_enabled: 1
+
   - name: check
     commands:
       - func: checkout
@@ -119,32 +187,35 @@ buildvariants:
     display_name: 'Ubuntu 20.04 x64'
     run_on: ubuntu2004-large
     tasks:
-      - test_n14
-      - test_n16
-      - test_n18
       - test_n20
+      - test_n22
+      - test_n24
       - check
+  - name: ubuntu_arm64_dchecks
+    display_name: 'Ubuntu 24.04 arm64 (Node.js/V8 DCHECKs)'
+    run_on: ubuntu2404-arm64-latest-xlarge
+    tasks:
+      - test_n20_dchecks
+      - test_n22_dchecks
+      - test_n24_dchecks
   - name: macos_x64_test
-    display_name: 'macOS 11.00 x64'
-    run_on: macos-1100
+    display_name: 'macOS 14.00 x64'
+    run_on: macos-14
     tasks:
-      - test_n14
-      - test_n16
-      - test_n18
       - test_n20
+      - test_n22
+      - test_n24
   - name: macos_arm64_test
-    display_name: 'macOS 11.00 arm64'
-    run_on: macos-1100-arm64
+    display_name: 'macOS 14.00 arm64'
+    run_on: macos-14-arm64
     tasks:
-      - test_n14
-      - test_n16
-      - test_n18
       - test_n20
+      - test_n22
+      - test_n24
   - name: windows_x64_test
     display_name: 'Windows x64'
-    run_on: windows-vsCurrent-xlarge
+    run_on: windows-2022-xlarge
     tasks:
-      - test_n14
-      - test_n16
-      - test_n18
       - test_n20
+      - test_n22
+      - test_n24

.evergreen/install-node.sh

@@ -3,11 +3,14 @@
 set -e
 set -x
 
+# so we use the devtools binaries first (for gcc/g++)
+export PATH="/opt/devtools/bin:$PATH"
+
 export BASEDIR="$PWD"
 mkdir -p .deps
 cd .deps
 
-NVM_URL="https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh"
+NVM_URL="https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh"
 
 # this needs to be explicitly exported for the nvm install below
 export NVM_DIR="$PWD/nvm"
@@ -21,12 +24,18 @@ if [[ "$OS" == "Windows_NT" ]]; then
   mv -v node-v$NODE_VERSION-win-x64/* node/bin
   chmod a+x node/bin/*
   export PATH="$PWD/node/bin:$PATH"
-# install Node.js on Linux/MacOS
 else
-  curl -o- $NVM_URL | bash
-  set +x
-  [ -s "${NVM_DIR}/nvm.sh" ] && source "${NVM_DIR}/nvm.sh"
-  nvm install --no-progress "$NODE_VERSION"
+    if [ "$(uname -s)" == "Darwin" ] ; then # install Node.js on MacOS
+        curl -o- $NVM_URL | bash
+        set +x
+        [ -s "${NVM_DIR}/nvm.sh" ] && source "${NVM_DIR}/nvm.sh"
+        nvm install --no-progress "$NODE_VERSION"
+    else # Linux already has its own toolchain in evergreen
+        mkdir -p node
+        NODE_MAJOR=$(echo $NODE_VERSION | awk -F . '{print $1}')
+        ln -s "/opt/devtools/node$NODE_MAJOR/bin/" "$PWD/node/bin"
+        export PATH="$PWD/node/bin:$PATH"
+    fi
 fi
 
 which node && node -v || echo "node not found, PATH=$PATH"

.evergreen/test-in-vcdev-env.bat

@@ -0,0 +1,6 @@
+CALL "C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Auxiliary\Build\vcvars64.bat"
+REM APPDATA is empty in CMD, and npm requires it to be a valid path
+SET APPDATA="npm-cache"
+
+CALL npm run build
+CALL npm run test-ci

.evergreen/use-node.sh

@@ -1,8 +1,16 @@
 if [[ "$OS" == "Windows_NT" ]]; then
-  export PATH="$PWD/.deps/node/bin:$PATH"
+    export APPDATA="npm-cache"
+    export PATH="$PWD/.deps/node/bin:$PATH"
 else
-  export NVM_DIR="$PWD/.deps/nvm"
-  [ -s "$NVM_DIR/nvm.sh" ] && source "$NVM_DIR/nvm.sh"
+    # so we use the devtools binaries first (for gcc/g++)
+    export PATH="/opt/devtools/bin:$PATH"
+
+    if [ "$(uname -s)" == "Darwin" ] ; then # in OSX use nvm
+        export NVM_DIR="$PWD/.deps/nvm"
+        [ -s "$NVM_DIR/nvm.sh" ] && source "$NVM_DIR/nvm.sh"
+    else # In Linux, use .deps/node/bin because it was set up with symlink to an existing node in the toolchain
+        export PATH="$PWD/.deps/node/bin:$PATH"
+    fi
 fi
 
 echo "updated PATH=$PATH"

.github/workflows/codeql.yml

@@ -42,13 +42,13 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v3
 
-    - name: Use Node.js v18.x
+    - name: Use Node.js v24.x
       if: matrix.language == 'cpp'
-      uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+      uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
       with:
-        node-version: 18.x
+        node-version: 24.x
 
-    - name: Use Node.js v18.x
+    - name: Use Node.js v24.x
       if: matrix.language == 'cpp'
       run: |
         npm install

.github/workflows/nodejs.yml

@@ -1,3 +1,7 @@
+# This is a generated file. Please change .github/workflows/nodejs.yml.in
+# and run the following command to update the GHA Workflow
+# $> npm run update-gha-workflow
+# --------------------
 on: [pull_request]
 
 name: CI
@@ -13,19 +17,55 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        node-version: [14.x, 16.x, 18.x, 20.x]
+        node-version: [20.x, 22.x, 24.x]
+        test-to-run: ["works in a simple case","works with a Nan addon","works with a N-API addon","passes through env vars and runs the pre-compile hook","works with code caching support","works with snapshot support (compressBlobs = "]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v6
         with:
           check-latest: true
           node-version: ${{ matrix.node-version }}
-      - name: Install npm@8.x
-        if: ${{ matrix.node-version == '14.x' }}
-        run: npm install -g npm@8.x
       - name: Install Dependencies
         run: npm install
+      - name: Lint
+        run: npm run lint
+      - name: Build
+        run: npm run build
       - name: Test
-        run: npm test
+        run: npm run test-ci -- -f "${{ matrix.test-to-run }}"
+
+  test-windows:
+    name: Windows tests
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest]
+        node-version: [20.x, 22.x, 24.x]
+        vs-version: ['17'] # 17 => VS2022
+        test-to-run: ["works in a simple case","works with a Nan addon","works with a N-API addon","passes through env vars and runs the pre-compile hook","works with code caching support","works with snapshot support (compressBlobs = "]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v5
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          check-latest: true
+          node-version: ${{ matrix.node-version }}
+      - uses: microsoft/setup-msbuild@v2
+        name: Setup MSBuild
+        with:
+          vs-version: ${{ matrix.vs-version }}
+          msbuild-architecture: x64
+      - name: Install Dependencies
+        run: npm install
+      - name: Lint
+        run: npm run lint
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm run test-ci -- -f "${{ matrix.test-to-run }}"
+        env:
+          BOXEDNODE_MAKE_ARGS: "debug"
+