src: add --disable-warning option

Co-authored-by: Geoffrey Booth <[email protected]> Co-authored-by: Antoine du Hamel <[email protected]> PR-URL: #50661Fixes: #30810Fixes: #47478Fixes: #46862Fixes: #40940 Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Richard Lau <[email protected]>

Author: 3 people

doc/api/cli.md

@@ -443,6 +443,57 @@ Affects the default output directory of:
 *[`--heap-prof-dir`][]
 *[`--redirect-warnings`][]
 
+### `--disable-warning=code-or-type`
+
+> Stability: 1.1 - Active development
+
+<!-- YAML
+added: REPLACEME
+-->
+
+Disable specific process warnings by `code` or `type`.
+
+Warnings emitted from [`process.emitWarning()`][emit_warning] may contain a
+`code` and a `type`. This option will not-emit warnings that have a matching
+`code` or `type`.
+
+List of [deprecation warnings][].
+
+The Node.js core warning types are: `DeprecationWarning` and
+`ExperimentalWarning`
+
+For example, the following script will not emit
+[DEP0025 `require('node:sys')`][DEP0025 warning] when executed with
+`node --disable-warning=DEP0025`:
+
+```mjs
+importsysfrom'node:sys';
+```
+
+```cjs
+constsys=require('node:sys');
+```
+
+For example, the following script will emit the
+[DEP0025 `require('node:sys')`][DEP0025 warning], but not any Experimental
+Warnings (such as
+[ExperimentalWarning: `vm.measureMemory` is an experimental feature][]
+in <=v21) when executed with `node --disable-warning=ExperimentalWarnings`:
+
+```mjs
+importsysfrom'node:sys';
+importvmfrom'node:vm';
+
+vm.measureMemory();
+```
+
+```cjs
+constsys=require('node:sys');
+constvm=require('node:vm');
+
+vm.measureMemory();
+```
+
 ### `--disable-proto=mode`
 
 <!-- YAML
@@ -2327,6 +2378,7 @@ Node.js options that are allowed are:
 *`--conditions`, `-C`
 *`--diagnostic-dir`
 *`--disable-proto`
+*`--disable-warning`
 *`--dns-result-order`
 *`--enable-fips`
 *`--enable-network-family-autoselection`
@@ -2779,7 +2831,9 @@ done
 [CommonJS]: modules.md
 [CommonJS module]: modules.md
 [CustomEvent Web API]: https://dom.spec.whatwg.org/#customevent
+[DEP0025 warning]: deprecations.md#dep0025-requirenodesys
 [ECMAScript module]: esm.md#modules-ecmascript-modules
+[ExperimentalWarning: `vm.measureMemory` is an experimental feature]: vm.md#vmmeasurememoryoptions
 [Fetch API]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
 [File System Permissions]: permissions.md#file-system-permissions
 [Module customization hooks]: module.md#customization-hooks
@@ -2835,6 +2889,7 @@ done
 [context-aware]: addons.md#context-aware-addons
 [debugger]: debugger.md
 [debugging security implications]: https://nodejs.org/en/docs/guides/debugging-getting-started/#security-implications
+[deprecation warnings]: deprecations.md#list-of-deprecated-apis
 [emit_warning]: process.md#processemitwarningwarning-options
 [environment_variables]: #environment-variables
 [filtering tests by name]: test.md#filtering-tests-by-name

lib/internal/process/warning.js

@@ -6,8 +6,13 @@ const{
  ErrorPrototypeToString,
  ErrorCaptureStackTrace,
  String,
+ SafeSet,
 }=primordials;
 
+const{
+ getOptionValue,
+}=require('internal/options');
+
 constassert=require('internal/assert');
 const{
 codes: {
@@ -89,8 +94,21 @@ function doEmitWarning(warning){
 process.emit('warning',warning);
 }
 
+letdisableWarningSet;
+
 functiononWarning(warning){
+if(!disableWarningSet){
+disableWarningSet=newSafeSet();
+constdisableWarningValues=getOptionValue('--disable-warning');
+for(leti=0;i<disableWarningValues.length;i++){
+disableWarningSet.add(disableWarningValues[i]);
+}
+}
+if((warning?.code&&disableWarningSet.has(warning.code))||
+(warning?.name&&disableWarningSet.has(warning.name)))return;
+
 if(!(warninginstanceofError))return;
+
 constisDeprecation=warning.name==='DeprecationWarning';
 if(isDeprecation&&process.noDeprecation)return;
 consttrace=process.traceProcessWarnings||

src/node_options.cc

@@ -527,6 +527,10 @@ EnvironmentOptionsParser::EnvironmentOptionsParser(){
  &EnvironmentOptions::warnings,
 kAllowedInEnvvar,
 true);
+AddOption("--disable-warning",
+"silence specific process warnings",
+ &EnvironmentOptions::disable_warnings,
+kAllowedInEnvvar);
 AddOption("--force-context-aware",
 "disable loading non-context-aware addons",
  &EnvironmentOptions::force_context_aware,

src/node_options.h

@@ -139,6 +139,7 @@ class EnvironmentOptions : public Options{
 bool allow_native_addons = true;
 bool global_search_paths = true;
 bool warnings = true;
+ std::vector<std::string> disable_warnings;
 bool force_context_aware = false;
 bool pending_deprecation = false;
 bool preserve_symlinks = false;

test/fixtures/disable-warning-worker.js

@@ -0,0 +1,4 @@
+'use strict';
+constpath=require('node:path');
+const{ Worker }=require('node:worker_threads');
+newWorker(path.join(__dirname,'./disable-warning.js'));

test/fixtures/disable-warning.js

@@ -0,0 +1,15 @@
+'use strict';
+
+process.emitWarning('Deprecation Warning 1',{
+code: 'DEP1',
+type: 'DeprecationWarning'
+});
+
+process.emitWarning('Deprecation Warning 2',{
+code: 'DEP2',
+type: 'DeprecationWarning'
+});
+
+process.emitWarning('Experimental Warning',{
+type: 'ExperimentalWarning'
+});

test/parallel/test-process-warnings.mjs

@@ -0,0 +1,163 @@
+import{spawnPromisified}from'../common/index.mjs';
+import*asfixturesfrom'../common/fixtures.mjs';
+import{describe,it}from'node:test';
+importassertfrom'node:assert';
+
+constfixturePath=fixtures.path('disable-warning.js');
+constfixturePathWorker=fixtures.path('disable-warning-worker.js');
+constdep1Message=/\(node:\d+\)\[DEP1\]DeprecationWarning/;
+constdep2Message=/\(node:\d+\)\[DEP2\]DeprecationWarning/;
+constexperimentalWarningMessage=/\(node:\d+\)ExperimentalWarning/;
+
+describe('process warnings',{concurrency: true},()=>{
+
+it('should emit all warnings by default',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.match(stderr,dep1Message);
+assert.match(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+describe('--no-warnings',{concurrency: true},()=>{
+it('should silence all warnings by default',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--no-warnings',
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.doesNotMatch(stderr,dep1Message);
+assert.doesNotMatch(stderr,dep2Message);
+assert.doesNotMatch(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+});
+
+describe('--no-deprecation',{concurrency: true},()=>{
+it('should silence all deprecation warnings',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--no-deprecation',
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.doesNotMatch(stderr,dep1Message);
+assert.doesNotMatch(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+});
+
+describe('--disable-warning',{concurrency: true},()=>{
+it('should silence deprecation warning DEP1',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--disable-warning=DEP1',
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.doesNotMatch(stderr,dep1Message);
+assert.match(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+it('should silence deprecation warnings DEP1 and DEP2',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--disable-warning=DEP1',
+'--disable-warning=DEP2',
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.doesNotMatch(stderr,dep1Message);
+assert.doesNotMatch(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+it('should silence all deprecation warnings using type DeprecationWarning',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--disable-warning=DeprecationWarning',
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.doesNotMatch(stderr,dep1Message);
+assert.doesNotMatch(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+it('should silence all experimental warnings using type ExperimentalWarning',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--disable-warning=ExperimentalWarning',
+fixturePath,
+]);
+
+assert.strictEqual(stdout,'');
+assert.match(stderr,dep1Message);
+assert.match(stderr,dep2Message);
+assert.doesNotMatch(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+it('should pass down option to worker',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--disable-warning=DEP2',
+fixturePathWorker,
+]);
+
+assert.strictEqual(stdout,'');
+assert.match(stderr,dep1Message);
+assert.doesNotMatch(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+it('should not support a comma separated list',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+'--disable-warning=DEP1,DEP2',
+fixturePathWorker,
+]);
+
+assert.strictEqual(stdout,'');
+assert.match(stderr,dep1Message);
+assert.match(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+
+it('should be specifiable in NODE_OPTIONS',async()=>{
+const{ stdout, stderr, code, signal }=awaitspawnPromisified(process.execPath,[
+fixturePath,
+],{
+env: {
+ ...process.env,
+NODE_OPTIONS: '--disable-warning=DEP2'
+}
+});
+
+assert.strictEqual(stdout,'');
+assert.match(stderr,dep1Message);
+assert.doesNotMatch(stderr,dep2Message);
+assert.match(stderr,experimentalWarningMessage);
+assert.strictEqual(code,0);
+assert.strictEqual(signal,null);
+});
+});
+});