cli: add --heap-prof flag available to NODE_OPTIONS

Fixes: #54257 Signed-off-by: Juan José Arboleda <[email protected]> PR-URL: #54259 Reviewed-By: Zeyu "Alex" Yang <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]>

Author: juanarbol

doc/api/cli.md

@@ -3075,6 +3075,10 @@ one is included in the list below.
 *`--force-fips`
 *`--force-node-api-uncaught-exceptions-policy`
 *`--frozen-intrinsics`
+*`--heap-prof-dir`
+*`--heap-prof-interval`
+*`--heap-prof-name`
+*`--heap-prof`
 *`--heapsnapshot-near-heap-limit`
 *`--heapsnapshot-signal`
 *`--http-parser`

src/node_options.cc

@@ -617,19 +617,23 @@ EnvironmentOptionsParser::EnvironmentOptionsParser(){
 "Start the V8 heap profiler on start up, and write the heap profile "
 "to disk before exit. If --heap-prof-dir is not specified, write "
 "the profile to the current working directory.",
- &EnvironmentOptions::heap_prof);
+ &EnvironmentOptions::heap_prof,
+kAllowedInEnvvar);
 AddOption("--heap-prof-name",
 "specified file name of the V8 heap profile generated with "
 "--heap-prof",
- &EnvironmentOptions::heap_prof_name);
+ &EnvironmentOptions::heap_prof_name,
+kAllowedInEnvvar);
 AddOption("--heap-prof-dir",
 "Directory where the V8 heap profiles generated by --heap-prof "
 "will be placed.",
- &EnvironmentOptions::heap_prof_dir);
+ &EnvironmentOptions::heap_prof_dir,
+kAllowedInEnvvar);
 AddOption("--heap-prof-interval",
 "specified sampling interval in bytes for the V8 heap "
 "profile generated with --heap-prof. (default: 512 * 1024)",
- &EnvironmentOptions::heap_prof_interval);
+ &EnvironmentOptions::heap_prof_interval,
+kAllowedInEnvvar);
 #endif// HAVE_INSPECTOR
 AddOption("--max-http-header-size",
 "set the maximum size of HTTP headers (default: 16384 (16KB))",

test/parallel/test-process-env-allowed-flags-are-documented.js

@@ -86,6 +86,18 @@ const difference = (setA, setB) =>{
 returnnewSet([...setA].filter((x)=>!setB.has(x)));
 };
 
+// Remove heap prof options if the inspector is not enabled.
+// NOTE: this is for ubuntuXXXX_sharedlibs_withoutssl_x64, no SSL, no inspector
+// Refs: https://github.com/nodejs/node/pull/54259#issuecomment-2308256647
+if(!process.features.inspector){
+[
+'--heap-prof-dir',
+'--heap-prof-interval',
+'--heap-prof-name',
+'--heap-prof',
+].forEach((opt)=>documented.delete(opt));
+}
+
 constoverdocumented=difference(documented,
 process.allowedNodeEnvironmentFlags);
 assert.strictEqual(overdocumented.size,0,