tty: do not end in an infinite warning recursion

It was possible that this warning ends up in an infinite recursion. The reason is that printing the warning triggered a color check and that triggered another warning. Limiting it to a single warning prevents this. PR-URL: #31429 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · Feb 17, 2020 · be55f3e · be55f3e
1 parent 58f17c0
commit be55f3e
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 11 deletions.
diff --git a/lib/internal/tty.js b/lib/internal/tty.js
@@ -73,18 +73,26 @@ const TERM_ENVS_REG_EXP = [
   /^vt100/
 ];
 
+let warned = false;
 function warnOnDeactivatedColors(env) {
-  let name;
+  if (warned)
+    return;
+  let name = '';
   if (env.NODE_DISABLE_COLORS !== undefined)
     name = 'NODE_DISABLE_COLORS';
-  if (env.NO_COLOR !== undefined)
-    name = 'NO_COLOR';
+  if (env.NO_COLOR !== undefined) {
+    if (name !== '') {
+      name += "' and '";
+    }
+    name += 'NO_COLOR';
+  }
 
-  if (name !== undefined) {
+  if (name !== '') {
     process.emitWarning(
       `The '${name}' env is ignored due to the 'FORCE_COLOR' env being set.`,
       'Warning'
     );
+    warned = true;
   }
 }
 

diff --git a/test/pseudo-tty/test-tty-color-support-warning-2.js b/test/pseudo-tty/test-tty-color-support-warning-2.js
@@ -0,0 +1,8 @@
+'use strict';
+
+require('../common');
+
+process.env.NODE_DISABLE_COLORS = '1';
+process.env.FORCE_COLOR = '3';
+
+console.log();
diff --git a/test/pseudo-tty/test-tty-color-support-warning-2.out b/test/pseudo-tty/test-tty-color-support-warning-2.out
@@ -0,0 +1,2 @@
+
+(node:*) Warning: The 'NODE_DISABLE_COLORS' env is ignored due to the 'FORCE_COLOR' env being set.
diff --git a/test/pseudo-tty/test-tty-color-support-warning.js b/test/pseudo-tty/test-tty-color-support-warning.js
@@ -0,0 +1,9 @@
+'use strict';
+
+require('../common');
+
+process.env.NO_COLOR = '1';
+process.env.NODE_DISABLE_COLORS = '1';
+process.env.FORCE_COLOR = '3';
+
+console.log();
diff --git a/test/pseudo-tty/test-tty-color-support-warning.out b/test/pseudo-tty/test-tty-color-support-warning.out
@@ -0,0 +1,2 @@
+
+(node:*) Warning: The 'NODE_DISABLE_COLORS' and 'NO_COLOR' env is ignored due to the 'FORCE_COLOR' env being set.
diff --git a/test/pseudo-tty/test-tty-color-support.out b/test/pseudo-tty/test-tty-color-support.out
@@ -1,8 +1 @@
 (node:*) Warning: The 'NO_COLOR' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NO_COLOR' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NO_COLOR' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NO_COLOR' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NODE_DISABLE_COLORS' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NODE_DISABLE_COLORS' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NODE_DISABLE_COLORS' env is ignored due to the 'FORCE_COLOR' env being set.
-(node:*) Warning: The 'NODE_DISABLE_COLORS' env is ignored due to the 'FORCE_COLOR' env being set.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@

		(node:*) Warning: The 'NODE_DISABLE_COLORS' env is ignored due to the 'FORCE_COLOR' env being set.