process: add process.features.require_module

For detecting whether `require(esm)` is supported without triggering the experimental warning. PR-URL: #55241 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Oct 11, 2024 · e95163b · e95163b
1 parent 39c7a9e
commit e95163b
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 0 deletions.
diff --git a/doc/api/modules.md b/doc/api/modules.md
@@ -250,6 +250,9 @@ If `--experimental-print-required-tla` is enabled, instead of throwing
 module, try to locate the top-level awaits, and print their location to
 help users fix them.
 
+This feature can be detected by checking if
+[`process.features.require_module`][] is `true`.
+
 ## All together
 
 <!-- type=misc -->
@@ -1214,6 +1217,7 @@ This section was moved to
 [`node:test`]: test.md
 [`package.json`]: packages.md#nodejs-packagejson-field-definitions
 [`path.dirname()`]: path.md#pathdirnamepath
+[`process.features.require_module`]: process.md#processfeaturesrequire_module
 [`require.main`]: #requiremain
 [exports shortcut]: #exports-shortcut
 [module resolution]: #all-together

diff --git a/doc/api/process.md b/doc/api/process.md
@@ -1928,6 +1928,17 @@ added: v0.5.3
 
 A boolean value that is `true` if the current Node.js build includes support for IPv6.
 
+## `process.features.require_module`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* {boolean}
+
+A boolean value that is `true` if the current Node.js build supports
+[loading ECMAScript modules using `require()`][].
+
 ## `process.features.tls`
 
 <!-- YAML
@@ -4419,6 +4430,7 @@ cases:
 [built-in modules with mandatory `node:` prefix]: modules.md#built-in-modules-with-mandatory-node-prefix
 [debugger]: debugger.md
 [deprecation code]: deprecations.md
+[loading ECMAScript modules using `require()`]: modules.md#loading-ecmascript-modules-using-require
 [note on process I/O]: #a-note-on-process-io
 [process.cpuUsage]: #processcpuusagepreviousvalue
 [process_emit_warning]: #processemitwarningwarning-type-code-ctor

diff --git a/lib/internal/bootstrap/node.js b/lib/internal/bootstrap/node.js
@@ -288,6 +288,9 @@ const features = {
   get cached_builtins() {
     return binding.hasCachedBuiltins();
   },
+  get require_module() {
+    return getOptionValue('--experimental-require-module');
+  },
 };
 
 ObjectDefineProperty(process, 'features', {

diff --git a/test/es-module/test-require-module-feature-detect.js b/test/es-module/test-require-module-feature-detect.js
@@ -0,0 +1,38 @@
+'use strict';
+
+// This tests that process.features.require_module can be used to feature-detect
+// require(esm) without triggering a warning.
+
+require('../common');
+const { spawnSyncAndAssert } = require('../common/child_process');
+
+spawnSyncAndAssert(process.execPath, [
+  '--no-warnings',
+  '--experimental-require-module',
+  '-p',
+  'process.features.require_module',
+], {
+  trim: true,
+  stdout: 'true',
+  stderr: '',  // Should not emit warnings.
+});
+
+// It is not enabled by default.
+spawnSyncAndAssert(process.execPath, [
+  '-p',
+  'process.features.require_module',
+], {
+  trim: true,
+  stdout: 'false',
+  stderr: '',  // Should not emit warnings.
+});
+
+spawnSyncAndAssert(process.execPath, [
+  '--no-experimental-require-module',
+  '-p',
+  'process.features.require_module',
+], {
+  trim: true,
+  stdout: 'false',
+  stderr: '',  // Should not emit warnings.
+});
diff --git a/test/parallel/test-process-features.js b/test/parallel/test-process-features.js
@@ -14,6 +14,7 @@ const expectedKeys = new Map([
   ['tls_ocsp', ['boolean']],
   ['tls', ['boolean']],
   ['cached_builtins', ['boolean']],
+  ['require_module', ['boolean']],
   ['typescript', ['boolean', 'string']],
 ]);