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
---
 .../npm/@denotest/better-say-hello/1.0.0/index.js  |  3 +++
 .../@denotest/better-say-hello/1.0.0/package.json  |  7 ++++++
 .../@denotest/better-say-hello/1.0.0/say-hello.js  |  2 ++
 .../node-addon-implicit-node-gyp/1.0.0/binding.gyp |  8 ++++++
 .../node-addon-implicit-node-gyp/1.0.0/index.js    |  1 +
 .../1.0.0/package.json                             |  7 ++++++
 .../1.0.0/src/binding.cc                           | 29 ++++++++++++++++++++++
 .../npm/@denotest/node-addon/1.0.0/binding.gyp     |  8 ++++++
 .../npm/@denotest/node-addon/1.0.0/index.js        |  1 +
 .../npm/@denotest/node-addon/1.0.0/package.json    | 10 ++++++++
 .../npm/@denotest/node-addon/1.0.0/src/binding.cc  | 29 ++++++++++++++++++++++
 .../node-lifecycle-scripts/1.0.0/helper.js         |  0
 .../node-lifecycle-scripts/1.0.0/index.js          |  5 ++++
 .../node-lifecycle-scripts/1.0.0/install.js        |  5 ++++
 .../node-lifecycle-scripts/1.0.0/package.json      | 12 +++++++++
 .../node-lifecycle-scripts/1.0.0/preinstall.js     |  5 ++++
 .../@denotest/say-hello-on-install/1.0.0/index.js  |  3 +++
 .../say-hello-on-install/1.0.0/package.json        | 10 ++++++++
 .../npm/@denotest/say-hello/1.0.0/index.js         |  3 +++
 .../npm/@denotest/say-hello/1.0.0/package.json     |  6 +++++
 .../npm/@denotest/say-hello/1.0.0/say-hello.js     |  2 ++
 21 files changed, 156 insertions(+)
 create mode 100644 tests/registry/npm/@denotest/better-say-hello/1.0.0/index.js
 create mode 100644 tests/registry/npm/@denotest/better-say-hello/1.0.0/package.json
 create mode 100644 tests/registry/npm/@denotest/better-say-hello/1.0.0/say-hello.js
 create mode 100644 tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/binding.gyp
 create mode 100644 tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/index.js
 create mode 100644 tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/package.json
 create mode 100644 tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/src/binding.cc
 create mode 100644 tests/registry/npm/@denotest/node-addon/1.0.0/binding.gyp
 create mode 100644 tests/registry/npm/@denotest/node-addon/1.0.0/index.js
 create mode 100644 tests/registry/npm/@denotest/node-addon/1.0.0/package.json
 create mode 100644 tests/registry/npm/@denotest/node-addon/1.0.0/src/binding.cc
 create mode 100644 tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/helper.js
 create mode 100644 tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/index.js
 create mode 100644 tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/install.js
 create mode 100644 tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/package.json
 create mode 100644 tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/preinstall.js
 create mode 100644 tests/registry/npm/@denotest/say-hello-on-install/1.0.0/index.js
 create mode 100644 tests/registry/npm/@denotest/say-hello-on-install/1.0.0/package.json
 create mode 100644 tests/registry/npm/@denotest/say-hello/1.0.0/index.js
 create mode 100644 tests/registry/npm/@denotest/say-hello/1.0.0/package.json
 create mode 100644 tests/registry/npm/@denotest/say-hello/1.0.0/say-hello.js

(limited to 'tests/registry/npm/@denotest')

diff --git a/tests/registry/npm/@denotest/better-say-hello/1.0.0/index.js b/tests/registry/npm/@denotest/better-say-hello/1.0.0/index.js
new file mode 100644
index 000000000..95ca40b89
--- /dev/null
+++ b/tests/registry/npm/@denotest/better-say-hello/1.0.0/index.js
@@ -0,0 +1,3 @@
+export function sayBetterHello() {
+  return '@denotest/better-say-hello says hello (but better)!';
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/better-say-hello/1.0.0/package.json b/tests/registry/npm/@denotest/better-say-hello/1.0.0/package.json
new file mode 100644
index 000000000..498ef08af
--- /dev/null
+++ b/tests/registry/npm/@denotest/better-say-hello/1.0.0/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "@denotest/better-say-hello",
+  "version": "1.0.0",
+  "bin": {
+    "say-hello": "./say-hello.js"
+  }
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/better-say-hello/1.0.0/say-hello.js b/tests/registry/npm/@denotest/better-say-hello/1.0.0/say-hello.js
new file mode 100644
index 000000000..0b8d63cf4
--- /dev/null
+++ b/tests/registry/npm/@denotest/better-say-hello/1.0.0/say-hello.js
@@ -0,0 +1,2 @@
+import { sayBetterHello } from "./index.js";
+sayBetterHello();
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/binding.gyp b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/binding.gyp
new file mode 100644
index 000000000..5f3293064
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/binding.gyp
@@ -0,0 +1,8 @@
+{
+  'targets': [
+    {
+      'target_name': 'node_addon',
+      'sources': [ 'src/binding.cc' ]
+    }
+  ]
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/index.js b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/index.js
new file mode 100644
index 000000000..540bfd82a
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/index.js
@@ -0,0 +1 @@
+module.exports.hello = require('./build/Release/node_addon').hello;
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/package.json b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/package.json
new file mode 100644
index 000000000..a77066711
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "@denotest/node-addon-implicit-node-gyp",
+  "version": "1.0.0",
+  "scripts": {
+    "install": "node-gyp configure build"
+  }
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/src/binding.cc b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/src/binding.cc
new file mode 100644
index 000000000..188b7c7dc
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon-implicit-node-gyp/1.0.0/src/binding.cc
@@ -0,0 +1,29 @@
+// hello.cc using Node-API
+#include <node_api.h>
+
+namespace demo {
+
+napi_value Method(napi_env env, napi_callback_info args) {
+  napi_value greeting;
+  napi_status status;
+
+  status = napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &greeting);
+  if (status != napi_ok) return nullptr;
+  return greeting;
+}
+
+napi_value init(napi_env env, napi_value exports) {
+  napi_status status;
+  napi_value fn;
+
+  status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn);
+  if (status != napi_ok) return nullptr;
+
+  status = napi_set_named_property(env, exports, "hello", fn);
+  if (status != napi_ok) return nullptr;
+  return exports;
+}
+
+NAPI_MODULE(NODE_GYP_MODULE_NAME, init)
+
+}  // namespace demo 
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon/1.0.0/binding.gyp b/tests/registry/npm/@denotest/node-addon/1.0.0/binding.gyp
new file mode 100644
index 000000000..5f3293064
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon/1.0.0/binding.gyp
@@ -0,0 +1,8 @@
+{
+  'targets': [
+    {
+      'target_name': 'node_addon',
+      'sources': [ 'src/binding.cc' ]
+    }
+  ]
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon/1.0.0/index.js b/tests/registry/npm/@denotest/node-addon/1.0.0/index.js
new file mode 100644
index 000000000..540bfd82a
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon/1.0.0/index.js
@@ -0,0 +1 @@
+module.exports.hello = require('./build/Release/node_addon').hello;
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon/1.0.0/package.json b/tests/registry/npm/@denotest/node-addon/1.0.0/package.json
new file mode 100644
index 000000000..5d50aa119
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon/1.0.0/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "@denotest/node-addon",
+  "version": "1.0.0",
+  "scripts": {
+    "install": "node-gyp configure build"
+  },
+  "dependencies": {
+    "node-gyp": "10.1.0"
+  }
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-addon/1.0.0/src/binding.cc b/tests/registry/npm/@denotest/node-addon/1.0.0/src/binding.cc
new file mode 100644
index 000000000..188b7c7dc
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-addon/1.0.0/src/binding.cc
@@ -0,0 +1,29 @@
+// hello.cc using Node-API
+#include <node_api.h>
+
+namespace demo {
+
+napi_value Method(napi_env env, napi_callback_info args) {
+  napi_value greeting;
+  napi_status status;
+
+  status = napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &greeting);
+  if (status != napi_ok) return nullptr;
+  return greeting;
+}
+
+napi_value init(napi_env env, napi_value exports) {
+  napi_status status;
+  napi_value fn;
+
+  status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn);
+  if (status != napi_ok) return nullptr;
+
+  status = napi_set_named_property(env, exports, "hello", fn);
+  if (status != napi_ok) return nullptr;
+  return exports;
+}
+
+NAPI_MODULE(NODE_GYP_MODULE_NAME, init)
+
+}  // namespace demo 
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/helper.js b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/helper.js
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/index.js b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/index.js
new file mode 100644
index 000000000..4eb9b107a
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/index.js
@@ -0,0 +1,5 @@
+modules.export = {
+  value: 42
+};
+
+console.log('index.js', modules.export.value);
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/install.js b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/install.js
new file mode 100644
index 000000000..298daa5f8
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/install.js
@@ -0,0 +1,5 @@
+module.exports = {
+  sayHi: () => 'Hi from node-lifecycle-scripts!'
+};
+
+console.log('install.js', module.exports.sayHi());
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/package.json b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/package.json
new file mode 100644
index 000000000..3c6fa005f
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@denotest/node-lifecycle-scripts",
+  "version": "1.0.0",
+  "scripts": {
+    "preinstall": "echo preinstall && node preinstall.js && node --require ./helper.js preinstall.js",
+    "install": "echo install && cli-esm 'hello from install script'",
+    "postinstall": "echo postinstall && npx cowsay postinstall"
+  },
+  "dependencies": {
+    "@denotest/bin": "1.0.0"
+  }
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/preinstall.js b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/preinstall.js
new file mode 100644
index 000000000..e3a59c753
--- /dev/null
+++ b/tests/registry/npm/@denotest/node-lifecycle-scripts/1.0.0/preinstall.js
@@ -0,0 +1,5 @@
+if ("Deno" in globalThis && typeof globalThis.Deno === 'object') {
+  console.log('deno preinstall.js');
+} else {
+  console.log('node preinstall.js');
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/say-hello-on-install/1.0.0/index.js b/tests/registry/npm/@denotest/say-hello-on-install/1.0.0/index.js
new file mode 100644
index 000000000..b275a8e35
--- /dev/null
+++ b/tests/registry/npm/@denotest/say-hello-on-install/1.0.0/index.js
@@ -0,0 +1,3 @@
+export function sayHelloOnInstall() {
+  return '@denotest/say-hello-on-install';
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/say-hello-on-install/1.0.0/package.json b/tests/registry/npm/@denotest/say-hello-on-install/1.0.0/package.json
new file mode 100644
index 000000000..f5cc2eef2
--- /dev/null
+++ b/tests/registry/npm/@denotest/say-hello-on-install/1.0.0/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "@denotest/say-hello-on-install",
+  "version": "1.0.0",
+  "scripts": {
+    "install": "echo 'install script' && say-hello"
+  },
+  "dependencies": {
+    "@denotest/say-hello": "1.0.0"
+  }
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/say-hello/1.0.0/index.js b/tests/registry/npm/@denotest/say-hello/1.0.0/index.js
new file mode 100644
index 000000000..2c5b6be8e
--- /dev/null
+++ b/tests/registry/npm/@denotest/say-hello/1.0.0/index.js
@@ -0,0 +1,3 @@
+export function sayHello() {
+  return '@denotest/say-hello says hello!';
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/say-hello/1.0.0/package.json b/tests/registry/npm/@denotest/say-hello/1.0.0/package.json
new file mode 100644
index 000000000..e4728c2c1
--- /dev/null
+++ b/tests/registry/npm/@denotest/say-hello/1.0.0/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@denotest/say-hello",
+  "version": "1.0.0",
+  "bin": "./say-hello.js",
+  "type": "module"
+}
\ No newline at end of file
diff --git a/tests/registry/npm/@denotest/say-hello/1.0.0/say-hello.js b/tests/registry/npm/@denotest/say-hello/1.0.0/say-hello.js
new file mode 100644
index 000000000..8751b8e47
--- /dev/null
+++ b/tests/registry/npm/@denotest/say-hello/1.0.0/say-hello.js
@@ -0,0 +1,2 @@
+import { sayHello } from "./index.js";
+console.log(sayHello());
\ No newline at end of file
-- 
cgit v1.2.3