Skip to content

Latest commit

 

History

History
200 lines (145 loc) · 31.8 KB

js_binary.md

File metadata and controls

200 lines (145 loc) · 31.8 KB
Raw

Rules for running JavaScript programs under Bazel, as tools or with bazel run or bazel test.

For example, this binary references the acorn npm package which was already linked using an API like npm_link_all_packages.

load("@aspect_rules_js//js:defs.bzl", "js_binary", "js_test")

js_binary(
    name = "bin",
    # Reference the location where the acorn npm module was linked in the root Bazel package
    data = ["//:node_modules/acorn"],
    entry_point = "require_acorn.js",
)

js_binary

js_binary(name, data, chdir, copy_data_to_bin, enable_runfiles, entry_point, env, expand_args,
          expand_env, expected_exit_code, fixed_args, include_npm, include_npm_sources,
          include_sources, include_transitive_sources, include_transitive_types, include_types,
          log_level, no_copy_to_bin, node_options, node_toolchain, patch_node_fs,
          preserve_symlinks_main)

Execute a program in the Node.js runtime.

The version of Node.js is determined by Bazel's toolchain selection. In the WORKSPACE you used nodejs_register_toolchains to provide options to Bazel. Then Bazel selects from these options based on the requested target platform. Use the --toolchain_resolution_debug Bazel option to see more detail about the selection.

All common binary attributes are supported including args as the list of arguments passed Node.js.

Node.js execution is performed by a shell script that sets environment variables and runs the Node.js binary with the entry_point script. The shell script is located relative to the directory containing the js_binary at \{name\}_/\{name\} similar to other rulesets such as rules_go. See PR #1690 for more information on this naming scheme.

The following environment variables are made available to the Node.js runtime based on available Bazel Make variables:

  • JS_BINARY__BINDIR: the WORKSPACE-relative Bazel bin directory; equivalent to the $(BINDIR) Make variable of the js_binary target
  • JS_BINARY__COMPILATION_MODE: One of fastbuild, dbg, or opt as set by --compilation_mode; equivalent to $(COMPILATION_MODE) Make variable of the js_binary target
  • JS_BINARY__TARGET_CPU: the target cpu architecture; equivalent to $(TARGET_CPU) Make variable of the js_binary target

The following environment variables are made available to the Node.js runtime based on the rule context:

  • JS_BINARY__BUILD_FILE_PATH: the WORKSPACE-relative path to the BUILD file of the Bazel target being run; equivalent to ctx.build_file_path of the js_binary target's rule context
  • JS_BINARY__PACKAGE: the package of the Bazel target being run; equivalent to ctx.label.package of the js_binary target's rule context
  • JS_BINARY__TARGET: the full label of the Bazel target being run; a stringified version of ctx.label of the js_binary target's rule context
  • JS_BINARY__TARGET_NAME: the name of the Bazel target being run; equivalent to ctx.label.name of the js_binary target's rule context
  • JS_BINARY__WORKSPACE: the Bazel workspace name; equivalent to ctx.workspace_name of the js_binary target's rule context

The following environment variables are made available to the Node.js runtime based the runtime environment:

  • JS_BINARY__NODE_BINARY: the Node.js binary path run by the js_binary target
  • JS_BINARY__NPM_BINARY: the npm binary path; this is available when include_npm is True on the js_binary target
  • JS_BINARY__NODE_WRAPPER: the Node.js wrapper script used to run Node.js which is available as node on the PATH at runtime
  • JS_BINARY__RUNFILES: the absolute path to the Bazel runfiles directory
  • JS_BINARY__EXECROOT: the absolute path to the root of the execution root for the action; if in the sandbox, this path absolute path to the root of the execution root within the sandbox

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
data Runtime dependencies of the program.

The transitive closure of the data dependencies will be available in the .runfiles folder for this binary/test.

NB: data files are copied to the Bazel output tree before being passed as inputs to runfiles. See copy_data_to_bin docstring for more info.		 List of labels optional []
chdir Working directory to run the binary or test in, relative to the workspace.

By default, js_binary runs in the root of the output tree.

To run in the directory containing the js_binary use

chdir = package_name()

(or if you're in a macro, use native.package_name())

WARNING: this will affect other paths passed to the program, either as arguments or in configuration files, which are workspace-relative.

You may need ../../ segments to re-relativize such paths to the new working directory. In a BUILD file you could do something like this to point to the output path:

js_binary(
    ...
    chdir = package_name(),
    # ../.. segments to re-relative paths from the chdir back to workspace;
    # add an additional 3 segments to account for running js_binary running
    # in the root of the output tree
    args = ["/".join([".."] * len(package_name().split("/"))) + "$(rootpath //path/to/some:file)"],
)
 String optional ""
copy_data_to_bin When True, data files and the entry_point file are copied to the Bazel output tree before being passed as inputs to runfiles.

Defaults to True so that a js_binary with the default value is compatible with js_run_binary with use_execroot_entry_point set to True, the default there.

Setting this to False is more optimal in terms of inputs, but there is a yet unresolved issue of ESM imports skirting the node fs patches and escaping the sandbox: #362. This is hit in some popular test runners such as mocha, which use native import() statements (#353). When set to False, a program such as mocha that uses ESM imports may escape the execroot by following symlinks into the source tree. When set to True, such a program would escape the sandbox but will end up in the output tree where node_modules and other inputs required will be available.		 Boolean optional True
enable_runfiles Whether runfiles are enabled in the current build configuration.

Typical usage of this rule is via a macro which automatically sets this attribute based on a config_setting rule.		 Boolean required
entry_point The main script which is evaluated by node.js.

This is the module referenced by the require.main property in the runtime.

This must be a target that provides a single file or a DirectoryPathInfo from @aspect_bazel_lib//lib::directory_path.bzl.

See https://github.com/bazel-contrib/bazel-lib/blob/main/docs/directory_path.md for more info on creating a target that provides a DirectoryPathInfo.		 Label required
env Environment variables of the action.

Subject to $(location) and "Make variable" substitution if expand_env is set to True.		 Dictionary: String -> String optional {}
expand_args Enables $(location) and "Make variable" substitution for fixed_args.

This comes at some analysis-time cost even for a set of args that does not have any expansions.		 Boolean optional True
expand_env Enables $(location) and "Make variable" substitution for env.

This comes at some analysis-time cost even for a set of envs that does not have any expansions.		 Boolean optional True
expected_exit_code The expected exit code.

Can be used to write tests that are expected to fail.		 Integer optional 0
fixed_args Fixed command line arguments to pass to the Node.js when this binary target is executed.

Subject to $(location) and "Make variable" substitution if expand_args is set to True.

Unlike the built-in args, which are only passed to the target when it is executed either by the bazel run command or as a test, fixed_args are baked into the generated launcher script so are always passed even when the binary target is run outside of Bazel directly from the launcher script.

fixed_args are passed before the ones specified in args and before ones that are specified on the bazel run or bazel test command line.

See https://bazel.build/reference/be/common-definitions#common-attributes-binaries for more info on the built-in args attribute.		 List of strings optional []
include_npm When True, npm is included in the runfiles of the target.

An npm binary is also added on the PATH so tools can spawn npm processes. This is a bash script on Linux and MacOS and a batch script on Windows.

A minimum of rules_nodejs version 5.7.0 is required which contains the Node.js toolchain changes to use npm.		 Boolean optional False
include_npm_sources When True, files in npm_sources from JsInfo providers in data targets are included in the runfiles of the target.

transitive_files from NpmPackageStoreInfo providers in data targets are also included in the runfiles of the target.		 Boolean optional True
include_sources When True, sources from JsInfo providers in data targets are included in the runfiles of the target. Boolean optional True
include_transitive_sources When True, transitive_sources from JsInfo providers in data targets are included in the runfiles of the target. Boolean optional True
include_transitive_types When True, transitive_types from JsInfo providers in data targets are included in the runfiles of the target.

Defaults to False since types are generally not needed at runtime and introducing them could slow down developer round trip time due to having to generate typings on source file changes.		 Boolean optional False
include_types When True, types from JsInfo providers in data targets are included in the runfiles of the target.

Defaults to False since types are generally not needed at runtime and introducing them could slow down developer round trip time due to having to generate typings on source file changes.

NB: These are types from direct data dependencies only. You may also need to set include_transitive_types to True.		 Boolean optional False
log_level Set the logging level.

Log from are written to stderr. They will be supressed on success when running as the tool of a js_run_binary when silent_on_success is True. In that case, they will be shown only on a build failure along with the stdout & stderr of the node tool being run.

Log levels: fatal, error, warn, info, debug		 String optional "error"
no_copy_to_bin List of files to not copy to the Bazel output tree when copy_data_to_bin is True.

This is useful for exceptional cases where a copy_to_bin is not possible or not suitable for an input file such as a file in an external repository. In most cases, this option is not needed. See copy_data_to_bin docstring for more info.		 List of labels optional []
node_options Options to pass to the node invocation on the command line.

https://nodejs.org/api/cli.html

These options are passed directly to the node invocation on the command line. Options passed here will take precendence over options passed via the NODE_OPTIONS environment variable. Options passed here are not added to the NODE_OPTIONS environment variable so will not be automatically picked up by child processes that inherit that enviroment variable.		 List of strings optional []
node_toolchain The Node.js toolchain to use for this target.

See https://bazel-contrib.github.io/rules_nodejs/Toolchains.html

Typically this is left unset so that Bazel automatically selects the right Node.js toolchain for the target platform. See https://bazel.build/extending/toolchains#toolchain-resolution for more information.		 Label optional None
patch_node_fs Patch the to Node.js fs API (https://nodejs.org/api/fs.html) for this node program to prevent the program from following symlinks out of the execroot, runfiles and the sandbox.

When enabled, js_binary patches the Node.js sync and async fs API functions lstat, readlink, realpath, readdir and opendir so that the node program being run cannot resolve symlinks out of the execroot and the runfiles tree. When in the sandbox, these patches prevent the program being run from resolving symlinks out of the sandbox.

When disabled, node programs can leave the execroot, runfiles and sandbox by following symlinks which can lead to non-hermetic behavior.		 Boolean optional True
preserve_symlinks_main When True, the --preserve-symlinks-main flag is passed to node.

This prevents node from following an ESM entry script out of runfiles and the sandbox. This can happen for .mjs ESM entry points where the fs node patches, which guard the runfiles and sandbox, are not applied. See #362 for more information. Once #362 is resolved, the default for this attribute can be set to False.

This flag was added in Node.js v10.2.0 (released 2018-05-23). If your node toolchain is configured to use a Node.js version older than this you'll need to set this attribute to False.

See https://nodejs.org/api/cli.html#--preserve-symlinks-main for more information.		 Boolean optional True

js_test

js_test(name, data, chdir, copy_data_to_bin, enable_runfiles, entry_point, env, expand_args,
        expand_env, expected_exit_code, fixed_args, include_npm, include_npm_sources, include_sources,
        include_transitive_sources, include_transitive_types, include_types, log_level,
        no_copy_to_bin, node_options, node_toolchain, patch_node_fs, preserve_symlinks_main)

Identical to js_binary, but usable under bazel test.

All common test attributes are supported including args as the list of arguments passed Node.js.

Bazel will set environment variables when a test target is run under bazel test and bazel run that a test runner can use.

A runner can write arbitrary outputs files it wants Bazel to pickup and save with the test logs to TEST_UNDECLARED_OUTPUTS_DIR. These get zipped up and saved along with the test logs.

JUnit XML reports can be written to XML_OUTPUT_FILE for Bazel to consume.

TEST_TMPDIR is an absolute path to a private writeable directory that the test runner can use for creating temporary files.

LCOV coverage reports can be written to COVERAGE_OUTPUT_FILE when running under bazel coverage or if the --coverage flag is set.

See the Bazel Test encyclopedia for details on the contract between Bazel and a test runner.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
data Runtime dependencies of the program.

The transitive closure of the data dependencies will be available in the .runfiles folder for this binary/test.

NB: data files are copied to the Bazel output tree before being passed as inputs to runfiles. See copy_data_to_bin docstring for more info.		 List of labels optional []
chdir Working directory to run the binary or test in, relative to the workspace.

By default, js_binary runs in the root of the output tree.

To run in the directory containing the js_binary use

chdir = package_name()

(or if you're in a macro, use native.package_name())

WARNING: this will affect other paths passed to the program, either as arguments or in configuration files, which are workspace-relative.

You may need ../../ segments to re-relativize such paths to the new working directory. In a BUILD file you could do something like this to point to the output path:

js_binary(
    ...
    chdir = package_name(),
    # ../.. segments to re-relative paths from the chdir back to workspace;
    # add an additional 3 segments to account for running js_binary running
    # in the root of the output tree
    args = ["/".join([".."] * len(package_name().split("/"))) + "$(rootpath //path/to/some:file)"],
)
 String optional ""
copy_data_to_bin When True, data files and the entry_point file are copied to the Bazel output tree before being passed as inputs to runfiles.

Defaults to True so that a js_binary with the default value is compatible with js_run_binary with use_execroot_entry_point set to True, the default there.

Setting this to False is more optimal in terms of inputs, but there is a yet unresolved issue of ESM imports skirting the node fs patches and escaping the sandbox: #362. This is hit in some popular test runners such as mocha, which use native import() statements (#353). When set to False, a program such as mocha that uses ESM imports may escape the execroot by following symlinks into the source tree. When set to True, such a program would escape the sandbox but will end up in the output tree where node_modules and other inputs required will be available.		 Boolean optional True
enable_runfiles Whether runfiles are enabled in the current build configuration.

Typical usage of this rule is via a macro which automatically sets this attribute based on a config_setting rule.		 Boolean required
entry_point The main script which is evaluated by node.js.

This is the module referenced by the require.main property in the runtime.

This must be a target that provides a single file or a DirectoryPathInfo from @aspect_bazel_lib//lib::directory_path.bzl.

See https://github.com/bazel-contrib/bazel-lib/blob/main/docs/directory_path.md for more info on creating a target that provides a DirectoryPathInfo.		 Label required
env Environment variables of the action.

Subject to $(location) and "Make variable" substitution if expand_env is set to True.		 Dictionary: String -> String optional {}
expand_args Enables $(location) and "Make variable" substitution for fixed_args.

This comes at some analysis-time cost even for a set of args that does not have any expansions.		 Boolean optional True
expand_env Enables $(location) and "Make variable" substitution for env.

This comes at some analysis-time cost even for a set of envs that does not have any expansions.		 Boolean optional True
expected_exit_code The expected exit code.

Can be used to write tests that are expected to fail.		 Integer optional 0
fixed_args Fixed command line arguments to pass to the Node.js when this binary target is executed.

Subject to $(location) and "Make variable" substitution if expand_args is set to True.

Unlike the built-in args, which are only passed to the target when it is executed either by the bazel run command or as a test, fixed_args are baked into the generated launcher script so are always passed even when the binary target is run outside of Bazel directly from the launcher script.

fixed_args are passed before the ones specified in args and before ones that are specified on the bazel run or bazel test command line.

See https://bazel.build/reference/be/common-definitions#common-attributes-binaries for more info on the built-in args attribute.		 List of strings optional []
include_npm When True, npm is included in the runfiles of the target.

An npm binary is also added on the PATH so tools can spawn npm processes. This is a bash script on Linux and MacOS and a batch script on Windows.

A minimum of rules_nodejs version 5.7.0 is required which contains the Node.js toolchain changes to use npm.		 Boolean optional False
include_npm_sources When True, files in npm_sources from JsInfo providers in data targets are included in the runfiles of the target.

transitive_files from NpmPackageStoreInfo providers in data targets are also included in the runfiles of the target.		 Boolean optional True
include_sources When True, sources from JsInfo providers in data targets are included in the runfiles of the target. Boolean optional True
include_transitive_sources When True, transitive_sources from JsInfo providers in data targets are included in the runfiles of the target. Boolean optional True
include_transitive_types When True, transitive_types from JsInfo providers in data targets are included in the runfiles of the target.

Defaults to False since types are generally not needed at runtime and introducing them could slow down developer round trip time due to having to generate typings on source file changes.		 Boolean optional False
include_types When True, types from JsInfo providers in data targets are included in the runfiles of the target.

Defaults to False since types are generally not needed at runtime and introducing them could slow down developer round trip time due to having to generate typings on source file changes.

NB: These are types from direct data dependencies only. You may also need to set include_transitive_types to True.		 Boolean optional False
log_level Set the logging level.

Log from are written to stderr. They will be supressed on success when running as the tool of a js_run_binary when silent_on_success is True. In that case, they will be shown only on a build failure along with the stdout & stderr of the node tool being run.

Log levels: fatal, error, warn, info, debug		 String optional "error"
no_copy_to_bin List of files to not copy to the Bazel output tree when copy_data_to_bin is True.

This is useful for exceptional cases where a copy_to_bin is not possible or not suitable for an input file such as a file in an external repository. In most cases, this option is not needed. See copy_data_to_bin docstring for more info.		 List of labels optional []
node_options Options to pass to the node invocation on the command line.

https://nodejs.org/api/cli.html

These options are passed directly to the node invocation on the command line. Options passed here will take precendence over options passed via the NODE_OPTIONS environment variable. Options passed here are not added to the NODE_OPTIONS environment variable so will not be automatically picked up by child processes that inherit that enviroment variable.		 List of strings optional []
node_toolchain The Node.js toolchain to use for this target.

See https://bazel-contrib.github.io/rules_nodejs/Toolchains.html

Typically this is left unset so that Bazel automatically selects the right Node.js toolchain for the target platform. See https://bazel.build/extending/toolchains#toolchain-resolution for more information.		 Label optional None
patch_node_fs Patch the to Node.js fs API (https://nodejs.org/api/fs.html) for this node program to prevent the program from following symlinks out of the execroot, runfiles and the sandbox.

When enabled, js_binary patches the Node.js sync and async fs API functions lstat, readlink, realpath, readdir and opendir so that the node program being run cannot resolve symlinks out of the execroot and the runfiles tree. When in the sandbox, these patches prevent the program being run from resolving symlinks out of the sandbox.

When disabled, node programs can leave the execroot, runfiles and sandbox by following symlinks which can lead to non-hermetic behavior.		 Boolean optional True
preserve_symlinks_main When True, the --preserve-symlinks-main flag is passed to node.

This prevents node from following an ESM entry script out of runfiles and the sandbox. This can happen for .mjs ESM entry points where the fs node patches, which guard the runfiles and sandbox, are not applied. See #362 for more information. Once #362 is resolved, the default for this attribute can be set to False.

This flag was added in Node.js v10.2.0 (released 2018-05-23). If your node toolchain is configured to use a Node.js version older than this you'll need to set this attribute to False.

See https://nodejs.org/api/cli.html#--preserve-symlinks-main for more information.		 Boolean optional True

js_binary_lib.create_launcher

js_binary_lib.create_launcher(ctx, log_prefix_rule_set, log_prefix_rule, fixed_args, fixed_env)

PARAMETERS

Name Description Default Value
ctx

-

none
log_prefix_rule_set

-

none
log_prefix_rule

-

none
fixed_args

-

[]
fixed_env

-

{}

js_binary_lib.implementation

js_binary_lib.implementation(ctx)

PARAMETERS

Name Description Default Value
ctx

-

none