node/tools/nix/v8.nix

# Derivation for Node.js CI (not officially supported for regular applications)
{
  stdenv,
  lib,
  patchutils,
  validatePkgConfig,
  icu,

  buildInputs ? lib.optional (icu != null) icu,
  configureFlags ? [
    (
      if icu == null then
        "--without-intl"
      else
        "--with-intl=${if builtins.isString icu then icu else "system"}-icu"
    )
  ],

  nodejs-slim_latest ? null,
  configureScript ? nodejs-slim_latest.configureScript,
  nativeBuildInputs ? nodejs-slim_latest.nativeBuildInputs,
  patches ? nodejs-slim_latest.patches,
}:

let
  src =
    let
      inherit (lib) fileset;
      root = ../../.;
      files = [
        ../../common.gypi
        ../../configure.py
        ../../deps/v8
        ../../node.gyp
        ../../node.gypi
        ../../tools/gyp/pylib
        ../../tools/gyp_node.py
        ../../tools/v8_gypfiles/abseil.gyp
        ../../tools/v8_gypfiles/features.gypi
        ../../tools/v8_gypfiles/ForEachFormat.py
        ../../tools/v8_gypfiles/ForEachReplace.py
        ../../tools/v8_gypfiles/GN-scraper.py
        ../../tools/v8_gypfiles/inspector.gypi
        ../../tools/v8_gypfiles/toolchain.gypi
        ../../tools/v8_gypfiles/v8.gyp
      ]
      ++ lib.optionals (icu != null) [
        ../../tools/icu/icu_versions.json
        ../../tools/icu/icu-system.gyp
      ]
      ++ lib.optionals (icu == "small") [
        ../../deps/icu-small
        ../../tools/icu/current_ver.dep
        ../../tools/icu/icu_small.json
        ../../tools/icu/icu-generic.gyp
        ../../tools/icu/iculslocs.cc
        ../../tools/icu/icutrim.py
        ../../tools/icu/no-op.cc
      ];
      potentiallyAlreadyRemovedFiles =
        # Files that are removed in the release tarball (see Makefile $(TARBALL) target)
        [ (fileset.difference ../../deps/v8/test ../../deps/v8/test/torque) ]
        ++ (builtins.filter builtins.pathExists [
          ../../deps/v8/samples
          ../../deps/v8/tools/profviz
          ../../deps/v8/tools/run-tests.py
          ../../deps/v8/third_party/ittapi
        ]);
      trackedFiles =
        ({
          # This line is being modified by Makefile $(TARBALL) target, any change to it should be sync
          fileset = fileset.intersection (fileset.gitTracked root) (fileset.unions files);
        }).fileset;
    in
    fileset.toSource {
      inherit root;
      fileset = fileset.difference trackedFiles (fileset.unions potentiallyAlreadyRemovedFiles);
    };
  v8Dir = "${src}/deps/v8";
in
stdenv.mkDerivation (finalAttrs: {
  pname = "v8";
  version =
    let
      v8Version = builtins.match (
        ".*#define V8_MAJOR_VERSION ([0-9]+).*"
        + "#define V8_MINOR_VERSION ([0-9]+).*"
        + "#define V8_BUILD_NUMBER ([0-9]+).*"
        + "#define V8_PATCH_LEVEL ([0-9]+).*"
      ) (builtins.readFile "${v8Dir}/include/v8-version.h");
      v8_embedder_string = builtins.match ".*'v8_embedder_string': '-(node.[0-9]+)'.*" (
        builtins.readFile "${src}/common.gypi"
      );
    in
    if v8Version == null || v8_embedder_string == null then
      throw "V8 version not found"
    else
      "${builtins.elemAt v8Version 0}.${builtins.elemAt v8Version 1}.${builtins.elemAt v8Version 2}.${builtins.elemAt v8Version 3}-${builtins.elemAt v8_embedder_string 0}";

  patches = lib.optional (
    # V8 accesses internal ICU headers and methods in the Temporal files.
    !(builtins.isString icu) && builtins.elem "--v8-enable-temporal-support" configureFlags
  ) ./temporal-no-vendored-icu.patch;

  # We need to patch tools/gyp/ to work from within Nix sandbox
  prePatch = ''
    ${lib.optionalString (builtins.length finalAttrs.patches == 0) "patches=()"}
    for patch in ${lib.concatStringsSep " " patches}; do
      filtered=$(mktemp)
      filterdiff -p1 -i 'tools/gyp/pylib/*' "$patch" > "$filtered"
      if [ -s "$filtered" ]; then
        patches+=("$filtered")
      fi
    done
  ''
  # We also need to mock some Python util files that are not used to configure Python.
  # Mocking lets us avoid rebuilding the whole derivation if there's a unrelated
  # change in one of those files.
  + ''
    mkdir -p tools/configure.d
    cat -> tools/configure.d/nodedownload.py <<'EOF'
    def parse(opt):
      return {}
    def help():
      return ""
    EOF
    cat -> tools/getmoduleversion.py <<'EOF'
    def get_version():
      return "99"
    EOF
    cat -> tools/getnapibuildversion.py <<'EOF'
    def get_napi_version():
      return "9"
    EOF
    cat -> tools/utils.py <<'EOF'
    def SearchFiles(dir, ext):
      return []
    EOF
  '';
  # We need to remove the node_inspector.gypi ref so GYP does not search for it.
  postPatch = ''
    substituteInPlace node.gyp --replace-fail "'includes' : [ 'src/inspector/node_inspector.gypi' ]" "'includes' : []"
  ''
  + lib.optionalString (icu == null) ''
    substituteInPlace configure.py \
      --replace-fail \
        "icu_versions = json.loads((tools_path / 'icu' / 'icu_versions.json').read_text(encoding='utf-8'))" \
        "icu_versions = { 'minimum_icu': 1 }"
  '';

  inherit
    src
    configureScript
    configureFlags
    buildInputs
    ;

  nativeBuildInputs = nativeBuildInputs ++ [
    patchutils
    validatePkgConfig
  ];

  buildPhase = ''
    runHook preBuild
    ninja -v -C out/Release v8_snapshot v8_libplatform
    runHook postBuild
  '';
  installPhase = ''
    runHook preInstall

    ${
      if stdenv.hostPlatform.isDarwin then
        # Darwin is excluded from creating thin archive in tools/gyp/pylib/gyp/generator/ninja.py:2488
        "install -Dm644 out/Release/lib* -t $out/lib"
      else
        # On other platforms, we need to create non-thin archive.
        ''
          mkdir -p $out/lib
          for a in out/Release/obj/tools/v8_gypfiles/lib*; do
            base=$(basename "$a")
            dir=$(dirname "$a")

            (
              cd "$dir"
              "$AR" rc "$out/lib/$base" $("$AR" t "$base")
            )

            "$RANLIB" "$out/lib/$base"
          done
        ''
    }

    install -Dm644 deps/v8/third_party/simdutf/simdutf.h -t $out/include
    find deps/v8/include -name '*.h' -print0 | while read -r -d "" file; do
      install -Dm644 "$file" -T "$out/include/''${file#deps/v8/include/}"
    done
    find deps/v8/third_party/abseil-cpp/absl -name '*.h' -print0 | while read -r -d "" file; do
      install -Dm644 "$file" -T "$out/include/''${file#deps/v8/third_party/abseil-cpp/}"
    done

    mkdir -p $out/lib/pkgconfig
    cat -> $out/lib/pkgconfig/v8.pc << EOF
    prefix=$out
    exec_prefix=\''${prefix}
    libdir=\''${exec_prefix}/lib
    includedir=\''${prefix}/include

    Name: v8
    Description: V8 JavaScript Engine build for Node.js CI
    Version: ${finalAttrs.version}
    Libs: -L\''${libdir} $(for f in $out/lib/lib*.a; do
      b=$(basename "$f" .a)
      printf " -l%s" "''${b#lib}"
    done) -lstdc++
    Cflags: -I\''${includedir}
    EOF

    runHook postInstall
  '';
})