lib: support FORCE_COLOR for non TTY streams

Author: MoLow

lib/internal/console/constructor.js

@@ -79,6 +79,12 @@ const kMaxGroupIndentation = 1000;
 // Lazy loaded for startup performance.
 let cliTable;
 
+let utilColors;
+function lazyUtilColors() {
+  utilColors ??= require('internal/util/colors');
+  return utilColors;
+}
+
 // Track amount of indentation required via `console.group()`.
 const kGroupIndent = Symbol('kGroupIndent');
 const kGroupIndentationWidth = Symbol('kGroupIndentWidth');
@@ -95,7 +101,6 @@ const kUseStdout = Symbol('kUseStdout');
 const kUseStderr = Symbol('kUseStderr');
 
 const optionsMap = new SafeWeakMap();
-
 function Console(options /* or: stdout, stderr, ignoreErrors = true */) {
   // We have to test new.target here to see if this function is called
   // with new, because we need to define a custom instanceof to accommodate
@@ -314,9 +319,7 @@ ObjectDefineProperties(Console.prototype, {
     value: function(stream) {
       let color = this[kColorMode];
       if (color === 'auto') {
-        color = stream.isTTY && (
-          typeof stream.getColorDepth === 'function' ?
-            stream.getColorDepth() > 2 : true);
+        color = lazyUtilColors().shouldColorize(stream);
       }
 
       const options = optionsMap.get(this);

lib/internal/errors.js

@@ -190,6 +190,12 @@ function lazyInternalUtilInspect() {
   return internalUtilInspect;
 }
 
+let utilColors;
+function lazyUtilColors() {
+  utilColors ??= require('internal/util/colors');
+  return utilColors;
+}
+
 let buffer;
 function lazyBuffer() {
   buffer ??= require('buffer').Buffer;
@@ -789,16 +795,8 @@ const fatalExceptionStackEnhancers = {
         useColors = false;
       }
     }
-    const {
-      inspect,
-      inspectDefaultOptions: {
-        colors: defaultColors,
-      },
-    } = lazyInternalUtilInspect();
-    const colors = useColors &&
-                   ((internalBinding('util').guessHandleType(2) === 'TTY' &&
-                   require('internal/tty').hasColors()) ||
-                   defaultColors);
+    const { inspect } = lazyInternalUtilInspect();
+    const colors = useColors && lazyUtilColors().shouldColorize(process.stderr);
     try {
       return inspect(error, {
         colors,

lib/internal/test_runner/reporter/spec.js

@@ -14,11 +14,11 @@ const {
 const assert = require('assert');
 const Transform = require('internal/streams/transform');
 const { inspectWithNoCustomRetry } = require('internal/errors');
-const { green, blue, red, white, gray, hasColors } = require('internal/util/colors');
+const { green, blue, red, white, gray, shouldColorize } = require('internal/util/colors');
 const { kSubtestsFailed } = require('internal/test_runner/test');
 const { getCoverageReport } = require('internal/test_runner/utils');
 
-const inspectOptions = { __proto__: null, colors: hasColors, breakLength: Infinity };
+const inspectOptions = { __proto__: null, colors: shouldColorize(process.stdout), breakLength: Infinity };
 
 const colors = {
   '__proto__': null,

lib/internal/util/colors.js

@@ -1,5 +1,11 @@
 'use strict';
 
+let internalTTy;
+function lazyInternalTTY() {
+  internalTTy ??= require('internal/tty');
+  return internalTTy;
+}
+
 module.exports = {
   blue: '',
   green: '',
@@ -8,9 +14,17 @@ module.exports = {
   gray: '',
   clear: '',
   hasColors: false,
+  shouldColorize(stream) {
+    if (process.env.FORCE_COLOR !== undefined) {
+      return lazyInternalTTY().getColorDepth() > 2;
+    }
+    return stream?.isTTY && (
+      typeof stream.getColorDepth === 'function' ?
+        stream.getColorDepth() > 2 : true);
+  },
   refresh() {
     if (process.stderr.isTTY) {
-      const hasColors = process.stderr.hasColors();
+      const hasColors = module.exports.shouldColorize(process.stderr);
       module.exports.blue = hasColors ? '\u001b[34m' : '';
       module.exports.green = hasColors ? '\u001b[32m' : '';
       module.exports.white = hasColors ? '\u001b[39m' : '';

lib/internal/util/debuglog.js

@@ -45,13 +45,19 @@ function emitWarningIfNeeded(set) {
 
 const noop = () => {};
 
+let utilColors;
+function lazyUtilColors() {
+  utilColors ??= require('internal/util/colors');
+  return utilColors;
+}
+
 function debuglogImpl(enabled, set) {
   if (debugImpls[set] === undefined) {
     if (enabled) {
       const pid = process.pid;
       emitWarningIfNeeded(set);
       debugImpls[set] = function debug(...args) {
-        const colors = process.stderr.hasColors && process.stderr.hasColors();
+        const colors = lazyUtilColors().shouldColorize(process.stderr);
         const msg = formatWithOptions({ colors }, ...args);
         const coloredPID = inspect(pid, { colors });
         process.stderr.write(format('%s %s: %s\n', set, coloredPID, msg));

lib/repl.js

@@ -121,6 +121,7 @@ const {
   commonPrefix,
 } = require('internal/readline/utils');
 const { Console } = require('console');
+const { shouldColorize } = require('internal/util/colors');
 const CJSModule = require('internal/modules/cjs/loader').Module;
 let _builtinLibs = ArrayPrototypeFilter(
   CJSModule.builtinModules,
@@ -270,8 +271,8 @@ function REPLServer(prompt,
 
   if (options.terminal && options.useColors === undefined) {
     // If possible, check if stdout supports colors or not.
-    if (options.output.hasColors) {
-      options.useColors = options.output.hasColors();
+    if (shouldColorize(options.output)) {
+      options.useColors = true;
     } else if (process.env.NODE_DISABLE_COLORS === undefined) {
       options.useColors = true;
     }

test/common/assertSnapshot.js

@@ -54,15 +54,15 @@ async function assertSnapshot(actual, filename = process.argv[1]) {
  * @param {boolean} [options.tty] - whether to spawn the process in a pseudo-tty
  * @returns {Promise<void>}
  */
-async function spawnAndAssert(filename, transform = (x) => x, { tty = false } = {}) {
+async function spawnAndAssert(filename, transform = (x) => x, { tty = false, ...options } = {}) {
   if (tty && common.isWindows) {
     test({ skip: 'Skipping pseudo-tty tests, as pseudo terminals are not available on Windows.' });
     return;
   }
   const flags = common.parseTestFlags(filename);
   const executable = tty ? 'tools/pseudo-tty.py' : process.execPath;
   const args = tty ? [process.execPath, ...flags, filename] : [...flags, filename];
-  const { stdout, stderr } = await common.spawnPromisified(executable, args);
+  const { stdout, stderr } = await common.spawnPromisified(executable, args, options);
   await assertSnapshot(transform(`${stdout}${stderr}`), filename);
 }
 

test/fixtures/console/force_colors.js

@@ -0,0 +1,5 @@
+'use strict';
+
+require('../../common');
+
+console.log(123, 'foo', { bar: 'baz' });

test/fixtures/console/force_colors.snapshot

@@ -0,0 +1 @@
+123 foo { bar: 'baz' }

test/fixtures/errors/force_colors.js

@@ -0,0 +1 @@
+throw new Error('Should include grayed stack trace')