tools: run CI with shared libs on GHA

Author: aduh95

.github/workflows/test-shared.yml

@@ -0,0 +1,83 @@
+name: Test Shared librairies
+
+on:
+  pull_request:
+    paths-ignore:
+      - .mailmap
+      - README.md
+      - .github/**
+      - '!.github/workflows/test-shared.yml'
+    types: [opened, synchronize, reopened, ready_for_review]
+  push:
+    branches:
+      - main
+      - canary
+      - v[0-9]+.x-staging
+      - v[0-9]+.x
+    paths-ignore:
+      - .mailmap
+      - README.md
+      - .github/**
+      - '!.github/workflows/test-shared.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  FLAKY_TESTS: keep_retrying
+  NIXPKGS_REPO: https://github.com/NixOS/nixpkgs
+  NIXPKGS_PIN: d74de548348c46cf25cb1fcc4b74f38103a4590d
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - runner: ubuntu-24.04
+            system: x86_64-linux
+          - runner: ubuntu-24.04-arm
+            system: aarch64-linux
+          - runner: macos-13
+            system: x86_64-darwin
+          - runner: macos-14
+            system: aarch64-darwin
+    name: '${{ matrix.system }}: with shared libraries'
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - uses: cachix/install-nix-action@f0fe604f8a612776892427721526b4c7cfb23aba # v31
+        with:
+          extra_nix_config: sandbox = true
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+          nix_path: nixpkgs=${{ env.NIXPKGS_REPO }}/archive/${{ env.NIXPKGS_PIN }}.tar.gz
+
+      - uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
+        with:
+          name: nodejs
+          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+
+      - name: Configure sccache
+        run: echo "SCCACHE_DIR=$RUNNER_TEMP/sscache" >> "$GITHUB_ENV"
+
+      - uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
+        with:
+          key: nixpkgs-sscache-${{ runner.os }}-${{ runner.arch }}
+          path: ${{ env.SCCACHE_DIR }}
+
+      - name: Build Node.js and run tests
+        run: |
+          nix-shell \
+            --pure \
+            --arg loadJSBuiltinsDynamically false \
+            --arg ccache '(import <nixpkgs> {}).sccache' \
+            --arg devTools '[]' \
+            --arg benchmarkTools '[]' \
+            --run '
+                make run-ci -j4 V=1 TEST_CI_ARGS="-p actions --measure-flakiness 9 --skip-tests=$CI_SKIP_TESTS"
+            '

.github/workflows/tools.yml

@@ -30,6 +30,7 @@ on:
           - llhttp
           - minimatch
           - nbytes
+          - nixpkgs-unstable
           - nghttp2
           - nghttp3
           - ngtcp2
@@ -198,6 +199,14 @@ jobs:
               cat temp-output
               tail -n1 temp-output | grep "NEW_VERSION=" >> "$GITHUB_ENV" || true
               rm temp-output
+          - id: nixpkgs-unstable
+            subsystem: tools
+            label: tools
+            run: |
+              ./tools/dep_updaters/update-nixpkgs-pin.sh > temp-output
+              cat temp-output
+              tail -n1 temp-output | grep "NEW_VERSION=" >> "$GITHUB_ENV" || true
+              rm temp-output
           - id: nghttp2
             subsystem: deps
             label: dependencies

BUILDING.md

@@ -239,6 +239,7 @@ Consult previous versions of this document for older versions of Node.js:
 
 Installation via Linux package manager can be achieved with:
 
+* Nix, NixOS: `nix-shell`
 * Ubuntu, Debian: `sudo apt-get install python3 g++-12 gcc-12 make python3-pip`
 * Fedora: `sudo dnf install python3 gcc-c++ make python3-pip`
 * CentOS and RHEL: `sudo yum install python3 gcc-c++ make python3-pip`
@@ -259,6 +260,75 @@ installed, you can find them under the menu `Xcode -> Open Developer Tool ->
 More Developer Tools...`. This step will install `clang`, `clang++`, and
 `make`.
 
+#### Nix integration
+
+If you are using Nix and direnv, you can use the following to get started:
+
+```bash
+echo 'use_nix --arg sharedLibDeps {} --argstr icu small' > .envrc
+direnv allow .
+make build-ci -j12
+```
+
+The use of `make build-ci` is to ensure you are using the `CONFIG_FLAGS`
+environment variable. You can also specify it manually:
+
+```sh
+./configure $CONFIG_FLAGS
+make -j12
+```
+
+Passing the `--arg sharedLibDeps {}` instructs direnv and Nix to generate an
+environment that uses the vendored-in native dependencies. Using the vendored-in
+dependencies result in a result closer to the official binaries, the tradeoff
+being the build will take longer to complete as you'd have to build those
+dependencies instead of using the cached ones from the Nix cache. You can omit
+that flag to use all the shared dependencies, or specify only some dependencies:
+
+```bash
+cat -> .envrc <<'EOF'
+use nix --arg sharedLibDeps '{
+  inherit (import <nixpkgs> {})
+    openssl
+    zlib
+  ;
+}'
+EOF
+```
+
+Passing the `--argstr icu small` instructs direnv and Nix to pass `--with-intl=small` in
+the `CONFIG_FLAGS` environment variable. If you omit this, the prebuilt ICU from Nix cache
+will be used, which should speed up greatly compilation time.
+
+The use of `direnv` is completely optional, you can also use `nix-shell` directly,
+e.g. here's a command you can use to build a binary for benchmarking purposes:
+
+```bash
+# Passing `--arg loadJSBuiltinsDynamically false` to instruct the compiler to
+# embed the JS core files so it is no longer affected by local changes
+# (necessary for getting useful benchmark results).
+# Passing `--arg devTools '[]' --arg benchmarkTools '[]'` since we don't need
+# those to build node.
+nix-shell \
+  --arg loadJSBuiltinsDynamically false \
+  --arg devTools '[]' --arg benchmarkTools '[]' \
+  --run 'make build-ci -j12'
+
+mv out/Release/node ./node_old
+
+# ...
+# Make your local changes, and re-build node
+
+nix-shell \
+  --arg loadJSBuiltinsDynamically false \
+  --arg devTools '[]' --arg benchmarkTools '[]' \
+  --run 'make build-ci -j12'
+
+nix-shell --pure --run './node benchmark/compare.js --old ./node_old  --new ./node http | Rscript benchmark/compare.R'
+```
+
+There are additional attributes you can pass, see `shell.nix` file for more details.
+
 #### Building Node.js
 
 If the path to your build directory contains a space, the build will likely
@@ -267,7 +337,6 @@ fail.
 To build Node.js:
 
 ```bash
-export CXX=g++-12
 ./configure
 make -j4
 ```

deps/npm/node_modules/node-gyp/gyp/pylib/gyp/xcode_emulation.py

@@ -26,6 +26,10 @@ Basic Unix tools are required for some benchmarks.
 [Git for Windows][git-for-windows] includes Git Bash and the necessary tools,
 which need to be included in the global Windows `PATH`.
 
+If you are using Nix, all the required tools are already listed in the
+`benchmarkTools` argument of the `shell.nix` file, so you can skip those
+prerequesites.
+
 ### HTTP benchmark requirements
 
 Most of the HTTP benchmarks require a benchmarker to be installed. This can be

doc/contributing/writing-and-running-benchmarks.md

@@ -848,6 +848,7 @@
         'deps/googletest/googletest.gyp:gtest_prod',
         'deps/histogram/histogram.gyp:histogram',
         'deps/nbytes/nbytes.gyp:nbytes',
+        'deps/uvwasi/uvwasi.gyp:uvwasi',
         'tools/v8_gypfiles/abseil.gyp:abseil',
         'node_js2c#host',
       ],

node.gyp

@@ -0,0 +1,117 @@
+{
+  pkgs ? import <nixpkgs> {},
+  loadJSBuiltinsDynamically ? true, # Load `lib/**.js` from disk instead of embedding
+  ncu-path ? null, # Provide this if you want to use a local version of NCU
+  icu ? pkgs.icu,
+  sharedLibDeps ? {
+    inherit (pkgs)
+      ada
+      brotli
+      c-ares
+      libuv
+      nghttp2
+      nghttp3
+      ngtcp2
+      openssl
+      simdjson
+      sqlite
+      zlib
+      zstd
+    ;
+    http-parser = pkgs.llhttp;
+    simdutf = pkgs.simdutf.overrideAttrs {
+      version = "6.5.0";
+
+      src = pkgs.fetchFromGitHub {
+        owner = "simdutf";
+        repo = "simdutf";
+        tag = "v6.5.0";
+        hash = "sha256-bZ4r62GMz2Dkd3fKTJhelitaA8jUBaDjG6jOysEg8Nk=";
+      };
+    };
+    uvwasi = pkgs.uvwasi.overrideAttrs {
+      version = "0.0.22";
+
+      src = pkgs.fetchFromGitHub {
+        owner = "nodejs";
+        repo = "uvwasi";
+        rev = "refs/heads/v0.0.22-proposal";
+        hash = "sha256-vrtL9HDzbbbx3QmRsifRzNTYilC4zgo9JmJoA9haUFQ=";
+      };
+      postPatch = "";
+    };
+  },
+  ccache ? pkgs.ccache,
+  ninja ? pkgs.ninja,
+  devTools ? [
+    pkgs.curl
+    pkgs.gh
+    pkgs.git
+    pkgs.jq
+    pkgs.shellcheck
+  ] ++ (if (ncu-path == null) then [
+      pkgs.node-core-utils
+    ] else [
+      (pkgs.writeShellScriptBin "git-node" "exec \"${ncu-path}/bin/git-node.js\" \"$@\"")
+      (pkgs.writeShellScriptBin "ncu-ci" "exec \"${ncu-path}/bin/ncu-ci.js\" \"$@\"")
+      (pkgs.writeShellScriptBin "ncu-config" "exec \"${ncu-path}/bin/ncu-config.js\" \"$@\"")
+    ]),
+  benchmarkTools ? [
+    pkgs.R
+    pkgs.rPackages.ggplot2
+    pkgs.rPackages.plyr
+    pkgs.wrk
+  ],
+  extraConfigFlags ? [
+    "--without-npm"
+    "--debug-node"
+  ],
+}:
+
+let
+  useSharedICU = if builtins.isString icu then icu == "system" else icu != null;
+  useSharedAda = builtins.hasAttr "ada" sharedLibDeps;
+  useSharedOpenSSL = builtins.hasAttr "openssl" sharedLibDeps;
+in
+pkgs.mkShell {
+  inherit (pkgs.nodejs_latest) nativeBuildInputs;
+
+  buildInputs = builtins.attrValues sharedLibDeps ++ pkgs.lib.optionals useSharedICU [ icu ];
+
+  packages = [
+    ccache
+  ] ++ devTools ++ benchmarkTools;
+
+  shellHook = if (ccache != null) then ''
+    export CC="${pkgs.lib.getExe ccache} $CC"
+    export CXX="${pkgs.lib.getExe ccache} $CXX"
+  '' else "";
+
+  BUILD_WITH = if (ninja != null) then "ninja" else "make";
+  NINJA = if (ninja != null) then "${pkgs.lib.getExe ninja}" else "";
+  CI_SKIP_TESTS = pkgs.lib.concatStringsSep "," ([
+    ] ++ pkgs.lib.optionals useSharedAda [
+      # Different versions of Ada affect the WPT tests
+      "test-url"
+    ] ++ pkgs.lib.optionals useSharedOpenSSL [
+      # Path to the openssl.cnf is different from the expected one
+      "test-strace-openat-openssl"
+    ]);
+  CONFIG_FLAGS = builtins.toString ([
+    (if icu == null
+      then "--without-intl"
+      else "--with-intl=${if useSharedICU then "system" else icu}-icu")
+  ] ++ extraConfigFlags ++ pkgs.lib.optionals (ninja != null) [
+    "--ninja"
+  ] ++ pkgs.lib.optionals loadJSBuiltinsDynamically [
+    "--node-builtin-modules-path=${builtins.toString ./.}"
+  ] ++ pkgs.lib.concatMap (name: [
+    "--shared-${builtins.replaceStrings [ "c-ares" ] [ "cares" ] name}"
+    "--shared-${builtins.replaceStrings [ "c-ares" ] [ "cares" ] name}-libpath=${
+      pkgs.lib.getLib sharedLibDeps.${name}
+    }/lib"
+    "--shared-${builtins.replaceStrings [ "c-ares" ] [ "cares" ] name}-include=${
+      pkgs.lib.getInclude sharedLibDeps.${name}
+    }/include"
+  ]) (builtins.attrNames sharedLibDeps));
+}