From ce7dc2be92499f15b4b0315bfca3ee9d61fc3c5e Mon Sep 17 00:00:00 2001
From: Nathan Whitaker <17734409+nathanwhit@users.noreply.github.com>
Date: Tue, 9 Jul 2024 20:06:08 -0700
Subject: feat(node): Support executing npm package lifecycle scripts
 (preinstall/install/postinstall) (#24487)

Adds support for running npm package lifecycle scripts, opted into via a
new `--allow-scripts` flag.

With this PR, when running `deno cache` (or `DENO_FUTURE=1 deno
install`) you can specify the `--allow-scripts=pkg1,pkg2` flag to run
lifecycle scripts attached to the given packages.

Note at the moment this only works when `nodeModulesDir` is true (using
the local resolver).

When a package with un-run lifecycle scripts is encountered, we emit a
warning suggesting things may not work and to try running lifecycle
scripts. Additionally, if a package script implicitly requires
`node-gyp` and it's not found on the system, we emit a warning.

Extra things in this PR:
- Extracted out bits of `task.rs` into a separate module for reuse
- Added a couple fields to `process.config` in order to support
`node-gyp` (it relies on a few variables being there)
- Drive by fix to downloading new npm packages to test registry

---

TODO:
- [x] validation for allow-scripts args (make sure it looks like an npm
package)
- [x] make allow-scripts matching smarter
- [ ] figure out what issues this closes

---
Review notes:
- This adds a bunch of deps to our test registry due to using
`node-gyp`, so it's pretty noisy
---
 tests/specs/npm/lifecycle_scripts/__test__.jsonc | 92 ++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 tests/specs/npm/lifecycle_scripts/__test__.jsonc

(limited to 'tests/specs/npm/lifecycle_scripts/__test__.jsonc')

diff --git a/tests/specs/npm/lifecycle_scripts/__test__.jsonc b/tests/specs/npm/lifecycle_scripts/__test__.jsonc
new file mode 100644
index 000000000..fa60e7963
--- /dev/null
+++ b/tests/specs/npm/lifecycle_scripts/__test__.jsonc
@@ -0,0 +1,92 @@
+{
+  "tests": {
+    "node_gyp": {
+      "tempDir": true,
+      "steps": [
+        {
+          "args": "cache --allow-scripts=npm:@denotest/node-addon main.js",
+          "output": "[WILDCARD]gyp info ok \n"
+        },
+        {
+          "args": "run -A main.js",
+          "output": "world\n"
+        }
+      ]
+    },
+    "run_without_scripts": {
+      "tempDir": true,
+      "steps": [
+        {
+          "args": "run -A main.js",
+          "output": "node_gyp_not_run.out",
+          "exitCode": 1
+        }
+      ]
+    },
+    "implicit_node_gyp": {
+      "tempDir": true,
+      "steps": [
+        {
+          "envs": {
+            // I don't think this will work on windows
+            "PATH": ""
+          },
+          "args": "cache --allow-scripts implicit_node_gyp.js",
+          "output": "node_gyp_not_found.out",
+          "exitCode": 1
+        }
+      ]
+    },
+    "lifecycle_scripts": {
+      "tempDir": true,
+      "steps": [
+        {
+          // without running scripts (should warn)
+          "args": "cache all_lifecycles.js",
+          "output": "all_lifecycles_not_run.out"
+        },
+        {
+          // now run scripts
+          "args": "cache --allow-scripts all_lifecycles.js",
+          // this test package covers running preinstall, install, and postinstall scripts
+          // it also exercises running bin packages (esbuild in this case), using `node` in a script
+          // (with and without node-only CLI flags), and using `npx` in a script
+          "output": "all_lifecycles.out"
+        }
+      ]
+    },
+    "future_install_lifecycle_scripts": {
+      "tempDir": true,
+      "envs": {
+        "DENO_FUTURE": "1"
+      },
+      "steps": [
+        {
+          "args": [
+            "eval",
+            "Deno.writeTextFileSync('package.json', '{\"dependencies\":{ \"@denotest/node-lifecycle-scripts\": \"*\" } }')"
+          ],
+          "output": ""
+        },
+        {
+          "args": "install",
+          "output": "future_install_all_lifecycles_not_run.out"
+        }
+      ]
+    },
+    "lifecycle_scripts_conflicting_bin": {
+      "tempDir": true,
+      "steps": [
+        {
+          // we import @denotest/says-hello-on-install, which executes `say-hello` from `@denotest/say-hello` in its
+          // install script. we also import `@denotest/better-say-hello`, which provides a
+          // bin called `say-hello` as well. `@denotest/says-hello-on-install` wins (gets put into
+          // node_modules/.bin/say-hello) because it's closer in the dependency tree, but when
+          // we run the install script, we should use the correct binary (relative to the package)
+          "args": "cache --allow-scripts conflicting_bin.js",
+          "output": "conflicting_bin.out"
+        }
+      ]
+    }
+  }
+}
-- 
cgit v1.2.3