feat(node): use multiple versions of node, can run old and new toolchains and default behaviour is not broken (#3125)

Author: Dylan

WORKSPACE

@@ -167,3 +167,28 @@ load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries
 
 # Depend on the Bazel binaries
 bazel_binaries(versions = SUPPORTED_BAZEL_VERSIONS)
+
+# Importing rules_nodejs to use with nodejs_binary and nodejs_test as they transition to using toolchains
+# provided by these rules
+
+local_repository(
+    name = "rules_nodejs",
+    path = ".",
+)
+
+load("@rules_nodejs//nodejs:repositories.bzl", "nodejs_register_toolchains", "rules_nodejs_dependencies")
+
+# This just gives us bazel-skylib
+rules_nodejs_dependencies()
+
+# The order matters because Bazel will provide the first registered toolchain when a rule asks Bazel to select it
+# This applies to the resolved_toolchain
+nodejs_register_toolchains(
+    name = "node15",
+    node_version = "15.14.0",
+)
+
+nodejs_register_toolchains(
+    name = "node16",
+    node_version = "16.9.0",
+)

docs/Built-ins.md

@@ -263,7 +263,7 @@ Defaults to `"1.22.11"`
 
 <pre>
 nodejs_binary(<a href="#nodejs_binary-name">name</a>, <a href="#nodejs_binary-chdir">chdir</a>, <a href="#nodejs_binary-configuration_env_vars">configuration_env_vars</a>, <a href="#nodejs_binary-data">data</a>, <a href="#nodejs_binary-default_env_vars">default_env_vars</a>, <a href="#nodejs_binary-entry_point">entry_point</a>, <a href="#nodejs_binary-env">env</a>,
-              <a href="#nodejs_binary-link_workspace_root">link_workspace_root</a>, <a href="#nodejs_binary-templated_args">templated_args</a>)
+              <a href="#nodejs_binary-link_workspace_root">link_workspace_root</a>, <a href="#nodejs_binary-node">node</a>, <a href="#nodejs_binary-templated_args">templated_args</a>)
 </pre>
 
 Runs some JavaScript code in NodeJS.
@@ -397,6 +397,12 @@ If source files need to be required then they can be copied to the bin_dir with
 
 Defaults to `False`
 
+<h4 id="nodejs_binary-node">node</h4>
+
+(*<a href="https://bazel.build/docs/build-ref.html#labels">Label</a>*)
+
+Defaults to `@nodejs//:node_bin`
+
 <h4 id="nodejs_binary-templated_args">templated_args</h4>
 
 (*List of strings*): Arguments which are passed to every execution of the program.
@@ -485,7 +491,7 @@ Defaults to `[]`
 
 <pre>
 nodejs_test(<a href="#nodejs_test-name">name</a>, <a href="#nodejs_test-chdir">chdir</a>, <a href="#nodejs_test-configuration_env_vars">configuration_env_vars</a>, <a href="#nodejs_test-data">data</a>, <a href="#nodejs_test-default_env_vars">default_env_vars</a>, <a href="#nodejs_test-entry_point">entry_point</a>, <a href="#nodejs_test-env">env</a>,
-            <a href="#nodejs_test-expected_exit_code">expected_exit_code</a>, <a href="#nodejs_test-link_workspace_root">link_workspace_root</a>, <a href="#nodejs_test-templated_args">templated_args</a>)
+            <a href="#nodejs_test-expected_exit_code">expected_exit_code</a>, <a href="#nodejs_test-link_workspace_root">link_workspace_root</a>, <a href="#nodejs_test-node">node</a>, <a href="#nodejs_test-templated_args">templated_args</a>)
 </pre>
 
 
@@ -651,6 +657,12 @@ If source files need to be required then they can be copied to the bin_dir with
 
 Defaults to `False`
 
+<h4 id="nodejs_test-node">node</h4>
+
+(*<a href="https://bazel.build/docs/build-ref.html#labels">Label</a>*)
+
+Defaults to `@nodejs//:node_bin`
+
 <h4 id="nodejs_test-templated_args">templated_args</h4>
 
 (*List of strings*): Arguments which are passed to every execution of the program.

docs/Cypress.md

@@ -125,7 +125,7 @@ Defaults to `None`
 
 <pre>
 cypress_web_test(<a href="#cypress_web_test-name">name</a>, <a href="#cypress_web_test-chdir">chdir</a>, <a href="#cypress_web_test-config_file">config_file</a>, <a href="#cypress_web_test-configuration_env_vars">configuration_env_vars</a>, <a href="#cypress_web_test-cypress_npm_package">cypress_npm_package</a>, <a href="#cypress_web_test-data">data</a>,
-                 <a href="#cypress_web_test-default_env_vars">default_env_vars</a>, <a href="#cypress_web_test-entry_point">entry_point</a>, <a href="#cypress_web_test-env">env</a>, <a href="#cypress_web_test-expected_exit_code">expected_exit_code</a>, <a href="#cypress_web_test-link_workspace_root">link_workspace_root</a>,
+                 <a href="#cypress_web_test-default_env_vars">default_env_vars</a>, <a href="#cypress_web_test-entry_point">entry_point</a>, <a href="#cypress_web_test-env">env</a>, <a href="#cypress_web_test-expected_exit_code">expected_exit_code</a>, <a href="#cypress_web_test-link_workspace_root">link_workspace_root</a>, <a href="#cypress_web_test-node">node</a>,
                  <a href="#cypress_web_test-plugin_file">plugin_file</a>, <a href="#cypress_web_test-srcs">srcs</a>, <a href="#cypress_web_test-templated_args">templated_args</a>)
 </pre>
 
@@ -250,6 +250,12 @@ If source files need to be required then they can be copied to the bin_dir with
 
 Defaults to `False`
 
+<h4 id="cypress_web_test-node">node</h4>
+
+(*<a href="https://bazel.build/docs/build-ref.html#labels">Label</a>*)
+
+Defaults to `@nodejs//:node_bin`
+
 <h4 id="cypress_web_test-plugin_file">plugin_file</h4>
 
 (*<a href="https://bazel.build/docs/build-ref.html#labels">Label</a>*): Your cypress plugin file. See https://docs.cypress.io/guides/tooling/plugins-guide

e2e/core/BUILD.bazel

@@ -158,3 +158,89 @@ diff_test(
     file1 = "actual3",
     file2 = "expected_ast.json",
 )
+
+################################################
+# Tests and setup for the toolchain changes
+
+# Create file for use in test cases later to get the version of node that is run
+write_file(
+    name = "version",
+    out = "version.js",
+    content = ["require('fs').writeFileSync(process.argv[2], process.version)"],
+)
+
+# Used in nodejs_bianry later to help see which version of node is run
+write_file(
+    name = "binary_version",
+    out = "binary_version.js",
+    content = ["console.log(process.version)"],
+)
+
+# Files used in test cases later that contain the correct nodejs version
+# that is imported into the workspace.
+write_file(
+    name = "write_node_version_15",
+    out = "expected_node_15",
+    content = ["v15.14.0"],
+)
+
+write_file(
+    name = "write_node_version_16",
+    out = "expected_node_16",
+    content = ["v16.9.0"],
+)
+
+# To see what nodejs version is used by default
+my_nodejs(
+    name = "run_no_toolchain",
+    out = "thing_no_toolchain",
+    entry_point = "version.js",
+)
+
+# this tests to make sure that the first version imported in the workspace is used as default
+diff_test(
+    name = "node_version_default_toolchain_test",
+    file1 = "write_node_version_15",
+    file2 = "thing_no_toolchain",
+)
+
+# Output contains the version number of node that is used.
+# This is used in tests later to verify the toolchain specified is resolved correctly
+my_nodejs(
+    name = "run_15",
+    out = "thing_toolchain_15",
+    entry_point = "version.js",
+    # using the select statement will download toolchains for all three platforms
+    # you can also just provide an individual toolchain if you don't want to download them all
+    toolchain = select({
+        "@bazel_tools//src/conditions:linux_x86_64": "@node15_linux_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:darwin": "@node15_darwin_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:windows": "@node15_windows_amd64//:node_toolchain",
+    }),
+)
+
+# Section of test the verify the toolchain work as expected matching node version used with expected
+diff_test(
+    name = "test_node_version_15",
+    file1 = "write_node_version_15",
+    file2 = "thing_toolchain_15",
+)
+
+my_nodejs(
+    name = "run_16",
+    out = "thing_toolchain_16",
+    entry_point = "version.js",
+    # using the select statement will download toolchains for all three platforms
+    # you can also just provide an individual toolchain if you don't want to download them all
+    toolchain = select({
+        "@bazel_tools//src/conditions:linux_x86_64": "@node16_linux_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:darwin": "@node16_darwin_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:windows": "@node16_windows_amd64//:node_toolchain",
+    }),
+)
+
+diff_test(
+    name = "test_node_version_16",
+    file1 = "write_node_version_16",
+    file2 = "thing_toolchain_16",
+)

e2e/core/WORKSPACE

@@ -4,8 +4,8 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
 http_archive(
     name = "rules_nodejs",
-    sha256 = "a54a01b883beff66da057a1a9afc3be83de566d8ba78f5139f9b370026af5868",
-    urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/4.4.0/rules_nodejs-core-4.4.0.tar.gz"],
+    sha256 = "8f4a19de1eb16b57ac03a8e9b78344b44473e0e06b0510cec14a81f6adfdfc25",
+    urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/4.4.6/rules_nodejs-core-4.4.6.tar.gz"],
 )
 
 # Note: skylib 1.1.1 has some bug on Windows with diff_test, which we use in this example
@@ -18,6 +18,13 @@ http_archive(
 
 load("@rules_nodejs//nodejs:repositories.bzl", "nodejs_register_toolchains")
 
+# The order matters because Bazel will provide the first registered toolchain when a rule asks Bazel to select it
+# This applies to the resolved_toolchain
+nodejs_register_toolchains(
+    name = "node15",
+    node_version = "15.14.0",
+)
+
 nodejs_register_toolchains(
     name = "node16",
     node_version = "16.9.0",

e2e/core/defs.bzl

@@ -1,7 +1,10 @@
 "Simple rule to test nodejs toolchain"
 
 def _my_nodejs_impl(ctx):
-    toolchain = ctx.toolchains["@rules_nodejs//nodejs:toolchain_type"].nodeinfo
+    if ctx.attr.toolchain:
+        toolchain = ctx.attr.toolchain[platform_common.ToolchainInfo].nodeinfo
+    else:
+        toolchain = ctx.toolchains["@rules_nodejs//nodejs:toolchain_type"].nodeinfo
     ctx.actions.run(
         inputs = toolchain.tool_files + [ctx.file.entry_point],
         executable = toolchain.target_tool_path,
@@ -15,6 +18,7 @@ my_nodejs = rule(
     attrs = {
         "entry_point": attr.label(allow_single_file = True),
         "out": attr.output(),
+        "toolchain": attr.label(),
     },
     toolchains = ["@rules_nodejs//nodejs:toolchain_type"],
 )

internal/node/node.bzl

@@ -248,7 +248,9 @@ fi
     #
     # Rules such as nodejs_image should use only ctx.toolchains["@build_bazel_rules_nodejs//toolchains/node:toolchain_type"].nodeinfo
     # when building the image as that will reflect the selected --platform.
-    node_tool_files = ctx.files._node[:]
+    node_tool_files = ctx.files.node[:]
+
+    # this should be resolved the same as above
     node_tool_files.extend(ctx.toolchains["@build_bazel_rules_nodejs//toolchains/node:toolchain_type"].nodeinfo.tool_files)
 
     node_tool_files.append(ctx.file._link_modules_script)
@@ -258,7 +260,7 @@ fi
     node_tool_files.append(ctx.file._lcov_merger_script)
     node_tool_files.append(node_modules_manifest)
 
-    is_builtin = ctx.attr._node.label.workspace_name in ["nodejs_%s" % p for p in BUILT_IN_NODE_PLATFORMS]
+    is_builtin = ctx.attr.node.label.workspace_name in ["nodejs_%s" % p for p in BUILT_IN_NODE_PLATFORMS]
 
     runfiles = runfiles[:]
     runfiles.extend(node_tool_files)
@@ -317,7 +319,7 @@ fi
         "TEMPLATED_repository_args": _to_manifest_path(ctx, ctx.file._repository_args),
         "TEMPLATED_require_patch_script": _to_manifest_path(ctx, ctx.outputs.require_patch_script),
         "TEMPLATED_runfiles_helper_script": _to_manifest_path(ctx, ctx.file._runfile_helpers_main),
-        "TEMPLATED_vendored_node": "" if is_builtin else strip_external(ctx.file._node.path),
+        "TEMPLATED_vendored_node": "" if is_builtin else strip_external(ctx.file.node.path),
     }
 
     # TODO when we have "link_all_bins" we will only need to look in one place for the entry point
@@ -591,7 +593,7 @@ Predefined genrule variables are not supported in this context.
         default = Label("//internal/node:loader.js"),
         allow_single_file = True,
     ),
-    "_node": attr.label(
+    "node": attr.label(
         default = Label("@nodejs//:node_bin"),
         allow_single_file = True,
     ),

internal/node/test/BUILD.bazel

@@ -537,3 +537,70 @@ generated_file_test(
     generated = ":protractor_directory_artifacts_version.out",
     tags = ["requires-runfiles"],
 )
+
+# Targets that can help with debugging and ensuring that node versions can be specified
+# for nodejs_binary and nodejs_test
+# Used in nodejs_bianry later to help see which version of node is run
+write_file(
+    name = "binary_version",
+    out = "binary_version.js",
+    content = ["console.log(process.version)"],
+)
+
+nodejs_binary(
+    name = "main_default_toolchain",
+    entry_point = "binary_version.js",
+)
+
+nodejs_binary(
+    name = "main_toolchain_15",
+    entry_point = "binary_version.js",
+    # using the select statement will download toolchains for all three platforms
+    # you can also just provide an individual toolchain if you don't want to download them all
+    node = select({
+        "@bazel_tools//src/conditions:linux_x86_64": "@node15_linux_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:darwin": "@node15_darwin_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:windows": "@node15_windows_amd64//:node_toolchain",
+    }),
+)
+
+nodejs_binary(
+    name = "main_toolchain_16",
+    entry_point = "binary_version.js",
+    # using the select statement will download toolchains for all three platforms
+    # you can also just provide an individual toolchain if you don't want to download them all
+    node = select({
+        "@bazel_tools//src/conditions:linux_x86_64": "@node16_linux_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:darwin": "@node16_darwin_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:windows": "@node16_windows_amd64//:node_toolchain",
+    }),
+)
+
+nodejs_test(
+    name = "main_default_toolchain_test",
+    entry_point = "toolchain_test_default.js",
+)
+
+nodejs_test(
+    name = "main_toolchain_15_test",
+    entry_point = "toolchain_test_v15.14.0.js",
+    # using the select statement will download toolchains for all three platforms
+    # you can also just provide an individual toolchain if you don't want to download them all
+    node = select({
+        "@bazel_tools//src/conditions:linux_x86_64": "@node15_linux_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:darwin": "@node15_darwin_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:windows": "@node15_windows_amd64//:node_toolchain",
+    }),
+)
+
+nodejs_test(
+    name = "main_toolchain_16_test",
+    entry_point = "toolchain_test_v16.js",
+    # using the select statement will download toolchains for all three platforms
+    # you can also just provide an individual toolchain if you don't want to download them all
+    node = select({
+        "@bazel_tools//src/conditions:linux_x86_64": "@node16_linux_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:darwin": "@node16_darwin_amd64//:node_toolchain",
+        "@bazel_tools//src/conditions:windows": "@node16_windows_amd64//:node_toolchain",
+    }),
+)

internal/node/test/toolchain_test_default.js

@@ -0,0 +1,5 @@
+const version = 'v16.5.0';
+if (version !== process.version) {
+  console.error(`there is a mismatch with the nodejs toolchain called and used for nodejs_binary: expected: ${version}, found: ${process.version}`);
+  process.exitCode = 1;
+}

internal/node/test/toolchain_test_v15.14.0.js

@@ -0,0 +1,5 @@
+const version = 'v15.14.0';
+if (version !== process.version) {
+  console.error(`there is a mismatch with the nodejs toolchain called and used for nodejs_binary: expected: ${version}, found: ${process.version}`);
+  process.exitCode = 1;
+}