feat: support pnpm.onlyBuiltDependencies (#1723)

docs/pnpm.md

@@ -260,8 +260,16 @@ npm packages have "lifecycle scripts" such as `postinstall` which are documented
 
 We refer to these as "lifecycle hooks".
 
-> You can disable this feature completely by setting all packages to have no hooks, using
-> `lifecycle_hooks = { "*": [] }` in `npm_translate_lock`.
+The lifecycle hooks of a package are determined by the `package.json` [`pnpm.onlyBuiltDependencies` attribute](https://pnpm.io/package_json#pnpmonlybuiltdependencies).
+
+If `pnpm.onlyBuiltDependencies` is unspecified `npm_translate_lock` will fallback to the legacy pnpm lockfile `requiresBuild` attribute.
+This attribute is only available in pnpm _before_ v9, see [pnpm #7707](https://github.com/pnpm/pnpm/issues/7707) for reasons why this attribute was removed.
+
+When a package has lifecycle hooks the `lifecycle_*` attributes are applied to filter which hooks are run and how they are run.
+
+For example, you can restrict lifecycle hooks across all packages to only run `postinstall`:
+
+> `lifecycle_hooks = { "*": ["postinstall"] }` in `npm_translate_lock`.
 
 Because rules_js models the execution of these hooks as build actions, rather than repository rules,
 the result can be stored in the remote cache and shared between developers.

e2e/pnpm_lockfiles/.bazelignore

@@ -1,13 +1,7 @@
 node_modules/
+projects/a/node_modules
+projects/b/node_modules
+projects/c/node_modules
 v54/node_modules/
 v60/node_modules/
 v61/node_modules/
-v54/projects/a/node_modules
-v54/projects/b/node_modules
-v54/projects/c/node_modules
-v60/projects/a/node_modules
-v60/projects/b/node_modules
-v60/projects/c/node_modules
-v61/projects/a/node_modules
-v61/projects/b/node_modules
-v61/projects/c/node_modules

e2e/pnpm_lockfiles/BUILD.bazel

@@ -1 +1 @@
-exports_files(["patched-dependencies-test.js"])
+exports_files(["base/patched-dependencies-test.js"])

e2e/pnpm_lockfiles/MODULE.bazel

@@ -30,12 +30,9 @@ npm = use_extension(
     npm.npm_translate_lock(
         name = "lock-%s" % version,
         data = [
-            "//:package.json",
+            "//%s:package.json" % version,
             "//%s:patches/[email protected]" % version,
-            "//:pnpm-workspace.yaml",
         ],
-        npmrc = "//:.npmrc",
-        patch_args = {"*": ["-p1"]},
         pnpm_lock = "//%s:pnpm-lock.yaml" % version,
         verify_node_modules_ignored = "//:.bazelignore",
     )

e2e/pnpm_lockfiles/WORKSPACE

@@ -17,12 +17,9 @@ load("@aspect_rules_js//npm:repositories.bzl", "npm_translate_lock")
     npm_translate_lock(
         name = "lock-%s" % version,
         data = [
-            "//:package.json",
+            "//%s:package.json" % version,
             "//%s:patches/[email protected]" % version,
-            "//:pnpm-workspace.yaml",
         ],
-        npmrc = "//:.npmrc",
-        patch_args = {"*": ["-p1"]},
         pnpm_lock = "//%s:pnpm-lock.yaml" % version,
         verify_node_modules_ignored = "//:.bazelignore",
     )

e2e/pnpm_lockfiles/base/pnpm-workspace.yaml

@@ -0,0 +1,3 @@
+packages:
+    - '.'
+    - '../projects/*'

e2e/pnpm_lockfiles/lockfile-test.bzl

@@ -2,9 +2,9 @@
 Test utils for lockfiles
 """
 
-load("@bazel_skylib//rules:build_test.bzl", "build_test")
-load("@aspect_rules_js//js:defs.bzl", "js_test")
 load("@aspect_bazel_lib//lib:copy_file.bzl", "copy_file")
+load("@aspect_rules_js//js:defs.bzl", "js_test")
+load("@bazel_skylib//rules:build_test.bzl", "build_test")
 
 def lockfile_test(name = "lockfile", node_modules = "node_modules"):
     """
@@ -15,21 +15,19 @@ def lockfile_test(name = "lockfile", node_modules = "node_modules"):
         node_modules: name of the tested 'node_modules' directory
     """
 
-    # TODO: lockfile v53 does not support patching?
-    if native.package_name() != "v53":
-        copy_file(
-            name = "copy-tests",
-            src = "//:patched-dependencies-test.js",
-            out = "patched-dependencies-test.js",
-        )
+    copy_file(
+        name = "copy-tests",
+        src = "//:base/patched-dependencies-test.js",
+        out = "patched-dependencies-test.js",
+    )
 
-        js_test(
-            name = "patch-test",
-            data = [
-                ":%s/meaning-of-life" % node_modules,
-            ],
-            entry_point = "patched-dependencies-test.js",
-        )
+    js_test(
+        name = "patch-test",
+        data = [
+            ":%s/meaning-of-life" % node_modules,
+        ],
+        entry_point = "patched-dependencies-test.js",
+    )
 
     build_test(
         name = name,

e2e/pnpm_lockfiles/setup.sh

@@ -4,9 +4,9 @@
 #   6.0 - pnpm v8.0.0 bumped the lockfile version to 6.0; this included breaking changes
 #   6.1 - pnpm v8.6.0 bumped the lockfile version to 6.1
 
-mv v54/pnpm-lock.yaml . && npx pnpm@^7.0 install --lockfile-only && mv pnpm-lock.yaml v54/
+mv v54/pnpm-lock.yaml base && pushd base && npx pnpm@^7.0 install --lockfile-only && mv pnpm-lock.yaml ../v54/ && popd
 
 # pnpm v8.0.0 bumped the lockfile version to 6.0, 8.6.0 bumped it to 6.1 which was then reverted to 6.0
 # while still presenting minor differences from <8.6.0.
-mv v60/pnpm-lock.yaml . && npx [email protected] install --lockfile-only && mv pnpm-lock.yaml v60/
-mv v61/pnpm-lock.yaml . && npx [email protected] install --lockfile-only && mv pnpm-lock.yaml v61/
+mv v60/pnpm-lock.yaml base && pushd base && npx [email protected] install --lockfile-only && mv pnpm-lock.yaml ../v60/ && popd
+mv v61/pnpm-lock.yaml base && pushd base && npx [email protected] install --lockfile-only && mv pnpm-lock.yaml ../v61/ && popd

e2e/pnpm_lockfiles/v54/package.json

@@ -0,0 +1 @@
+../base/package.json

e2e/pnpm_lockfiles/v54/patches

@@ -1 +1 @@
-../patches
+../base/patches

e2e/pnpm_lockfiles/v60/package.json

@@ -0,0 +1 @@
+../base/package.json

e2e/pnpm_lockfiles/v60/patches

@@ -1 +1 @@
-../patches
+../base/patches

e2e/pnpm_lockfiles/v61/package.json

@@ -0,0 +1 @@
+../base/package.json

e2e/pnpm_lockfiles/v61/patches

@@ -1 +1 @@
-../patches
+../base/patches

npm/extensions.bzl

@@ -120,6 +120,7 @@ WARNING: Cannot determine home directory in order to load home `.npmrc` file in
         importers = importers,
         packages = packages,
         patched_dependencies = state.patched_dependencies(),
+        only_built_dependencies = state.only_built_dependencies(),
         root_package = attr.pnpm_lock.package,
         rctx_name = attr.name,
         attr = attr,

npm/private/npm_translate_lock.bzl

@@ -132,6 +132,7 @@ See https://github.com/aspect-build/rules_js/issues/1445
         importers,
         packages,
         state.patched_dependencies(),
+        state.only_built_dependencies(),
         state.root_package(),
         state.default_registry(),
         state.npm_registries(),

npm/private/npm_translate_lock_generate.bzl

@@ -80,11 +80,11 @@ _PACKAGE_JSON_BZL_FILENAME = "package_json.bzl"
 _RESOLVED_JSON_FILENAME = "resolved.json"
 
 # buildifier: disable=function-docstring
-def generate_repository_files(rctx, pnpm_lock_label, importers, packages, patched_dependencies, root_package, default_registry, npm_registries, npm_auth, link_workspace):
+def generate_repository_files(rctx, pnpm_lock_label, importers, packages, patched_dependencies, only_built_dependencies, root_package, default_registry, npm_registries, npm_auth, link_workspace):
     # empty line after bzl docstring since buildifier expects this if this file is vendored in
     generated_by_prefix = "\"\"\"@generated by npm_translate_lock(name = \"{}\", pnpm_lock = \"{}\")\"\"\"\n".format(helpers.to_apparent_repo_name(rctx.name), str(pnpm_lock_label))
 
-    npm_imports = helpers.get_npm_imports(importers, packages, patched_dependencies, root_package, rctx.name, rctx.attr, rctx.attr.lifecycle_hooks, rctx.attr.lifecycle_hooks_execution_requirements, rctx.attr.lifecycle_hooks_use_default_shell_env, npm_registries, default_registry, npm_auth)
+    npm_imports = helpers.get_npm_imports(importers, packages, patched_dependencies, only_built_dependencies, root_package, rctx.name, rctx.attr, rctx.attr.lifecycle_hooks, rctx.attr.lifecycle_hooks_execution_requirements, rctx.attr.lifecycle_hooks_use_default_shell_env, npm_registries, default_registry, npm_auth)
 
     link_packages = [helpers.link_package(root_package, import_path) for import_path in importers.keys()]
 

npm/private/npm_translate_lock_helpers.bzl

@@ -236,7 +236,7 @@ def _select_npm_auth(url, npm_auth):
     return npm_auth_bearer, npm_auth_basic, npm_auth_username, npm_auth_password
 
 ################################################################################
-def _get_npm_imports(importers, packages, patched_dependencies, root_package, rctx_name, attr, all_lifecycle_hooks, all_lifecycle_hooks_execution_requirements, all_lifecycle_hooks_use_default_shell_env, registries, default_registry, npm_auth):
+def _get_npm_imports(importers, packages, patched_dependencies, only_built_dependencies, root_package, rctx_name, attr, all_lifecycle_hooks, all_lifecycle_hooks_execution_requirements, all_lifecycle_hooks_use_default_shell_env, registries, default_registry, npm_auth):
     "Converts packages from the lockfile to a struct of attributes for npm_import"
     if attr.prod and attr.dev:
         fail("prod and dev attributes cannot both be set to true")
@@ -393,7 +393,8 @@ ERROR: can not apply both `pnpm.patchedDependencies` and `npm_translate_lock(pat
             elif name not in link_packages[public_hoist_package]:
                 link_packages[public_hoist_package].append(name)
 
-        if requires_build:
+        run_lifecycle_hooks = name in only_built_dependencies if only_built_dependencies != None else requires_build
+        if run_lifecycle_hooks:
             lifecycle_hooks, _ = _gather_values_from_matching_names(False, all_lifecycle_hooks, "*", name, friendly_name, unfriendly_name)
             lifecycle_hooks_env, _ = _gather_values_from_matching_names(True, attr.lifecycle_hooks_envs, "*", name, friendly_name, unfriendly_name)
             lifecycle_hooks_execution_requirements, _ = _gather_values_from_matching_names(False, all_lifecycle_hooks_execution_requirements, "*", name, friendly_name, unfriendly_name)

npm/private/npm_translate_lock_state.bzl

@@ -37,8 +37,6 @@ WARNING: `update_pnpm_lock` attribute in `npm_translate_lock(name = "{rctx_name}
 
     _init_patches_labels(priv, rctx, attr, label_store)
 
-    _init_root_package(priv, rctx, attr, label_store)
-
     if _should_update_pnpm_lock(priv) or not attr.pnpm_lock:
         # labels only needed when updating or bootstrapping the pnpm lock file
         _init_pnpm_labels(priv, rctx, attr, label_store)
@@ -56,6 +54,9 @@ WARNING: `update_pnpm_lock` attribute in `npm_translate_lock(name = "{rctx_name}
         _load_lockfile(priv, rctx, attr, label_store)
         _init_patched_dependencies_labels(priv, rctx, attr, label_store)
 
+    # May depend on lockfile state
+    _init_root_package(priv, rctx, attr, label_store)
+
     if _should_update_pnpm_lock(priv):
         _init_importer_labels(priv, label_store)
 
@@ -531,6 +532,9 @@ def _packages(priv):
 def _patched_dependencies(priv):
     return priv["patched_dependencies"]
 
+def _only_built_dependencies(priv):
+    return _root_package_json(priv).get("pnpm", {}).get("onlyBuildDependencies", None)
+
 def _num_patches(priv):
     return priv["num_patches"]
 
@@ -543,6 +547,9 @@ def _npm_auth(priv):
 def _root_package(priv):
     return priv["root_package"]
 
+def _root_package_json(priv):
+    return priv["root_package_json"]
+
 ################################################################################
 def _new(rctx_name, rctx, attr, bzlmod):
     label_store = repository_label_store.new(rctx.path)
@@ -564,6 +571,7 @@ def _new(rctx_name, rctx, attr, bzlmod):
         "npm_registries": {},
         "packages": {},
         "root_package": None,
+        "root_package_json": {},
         "patched_dependencies": {},
         "should_update_pnpm_lock": should_update_pnpm_lock,
     }
@@ -578,6 +586,7 @@ def _new(rctx_name, rctx, attr, bzlmod):
         importers = lambda: _importers(priv),
         packages = lambda: _packages(priv),
         patched_dependencies = lambda: _patched_dependencies(priv),
+        only_built_dependencies = lambda: _only_built_dependencies(priv),
         npm_registries = lambda: _npm_registries(priv),
         npm_auth = lambda: _npm_auth(priv),
         num_patches = lambda: _num_patches(priv),