From 67516e14fbffe49c10afead8d0f8af6b5e9fd1e0 Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Thu, 17 Aug 2017 22:41:14 -0700
Subject: [PATCH 1/4] console: implement minimal `console.group()`

Node.js exposes `console.group()` and `console.groupEnd()` via the
inspector. These functions have no apparent effect when called from
Node.js without the inspector. We cannot easily hide them when Node.js
is started without the inspector because we support opening the
inspector during runtime via `inspector.port()`.

Implement a minimal `console.group()`/`console.groupEnd()`. More
sophisticated implementations are possible, but they can be done in
userland and/or features can be added to this at a later time. (It lacks
the `label` argument to `console.group()` right now, for example. How to
handle `label`, or even whether to handle it,  may become
a bikeshed discussion. Landing a minimal implementation first avoids the
pitfall of that discussion or a similar discussion delaying the
implementation indefinitely.)

Refs: https://github.com/nodejs/node/issues/12675
Fixes: https://github.com/nodejs/node/issues/1716
---
 doc/api/console.md                  | 14 ++++++
 lib/console.js                      | 19 ++++++--
 test/parallel/test-console-group.js | 76 +++++++++++++++++++++++++++++
 3 files changed, 106 insertions(+), 3 deletions(-)
 create mode 100644 test/parallel/test-console-group.js

diff --git a/doc/api/console.md b/doc/api/console.md
index 08fcfa027c7bad..3c2a02cb2fdab1 100644
--- a/doc/api/console.md
+++ b/doc/api/console.md
@@ -286,6 +286,20 @@ If formatting elements (e.g. `%d`) are not found in the first string then
 [`util.inspect()`][] is called on each argument and the resulting string
 values are concatenated. See [`util.format()`][] for more information.
 
+### console.group()
+<!-- YAML
+added: REPLACEME
+-->
+
+Increases indentation of subsequent lines by one tab (`\t`).
+
+### console.groupEnd()
+<!-- YAML
+added: REPLACEME
+-->
+
+Decreases indentation of subsequent lines by one tab (`\t`).
+
 ### console.info([data][, ...args])
 <!-- YAML
 added: v0.1.100
diff --git a/lib/console.js b/lib/console.js
index b0701ba32c4a1f..7261de53134ca5 100644
--- a/lib/console.js
+++ b/lib/console.js
@@ -25,6 +25,9 @@ const errors = require('internal/errors');
 const util = require('util');
 const kCounts = Symbol('counts');
 
+// Track amount of indentation required via `console.group()`.
+const groupIndent = Symbol('groupIndent');
+
 function Console(stdout, stderr, ignoreErrors = true) {
   if (!(this instanceof Console)) {
     return new Console(stdout, stderr, ignoreErrors);
@@ -64,6 +67,8 @@ function Console(stdout, stderr, ignoreErrors = true) {
     var k = keys[v];
     this[k] = this[k].bind(this);
   }
+
+  this[groupIndent] = '';
 }
 
 // Make a function that can serve as the callback passed to `stream.write()`.
@@ -111,7 +116,7 @@ function write(ignoreErrors, stream, string, errorhandler) {
 Console.prototype.log = function log(...args) {
   write(this._ignoreErrors,
         this._stdout,
-        `${util.format.apply(null, args)}\n`,
+        `${this[groupIndent]}${util.format.apply(null, args)}\n`,
         this._stdoutErrorHandler);
 };
 
@@ -122,7 +127,7 @@ Console.prototype.info = Console.prototype.log;
 Console.prototype.warn = function warn(...args) {
   write(this._ignoreErrors,
         this._stderr,
-        `${util.format.apply(null, args)}\n`,
+        `${this[groupIndent]}${util.format.apply(null, args)}\n`,
         this._stderrErrorHandler);
 };
 
@@ -134,7 +139,7 @@ Console.prototype.dir = function dir(object, options) {
   options = Object.assign({ customInspect: false }, options);
   write(this._ignoreErrors,
         this._stdout,
-        `${util.inspect(object, options)}\n`,
+        `${this[groupIndent]}${util.inspect(object, options)}\n`,
         this._stdoutErrorHandler);
 };
 
@@ -214,6 +219,14 @@ Console.prototype.countReset = function countReset(label = 'default') {
   counts.delete(`${label}`);
 };
 
+Console.prototype.group = function group() {
+  this[groupIndent] += '  ';
+};
+
+Console.prototype.groupEnd = function groupEnd() {
+  this[groupIndent] = this[groupIndent].slice(0, this[groupIndent].length - 2);
+};
+
 module.exports = new Console(process.stdout, process.stderr);
 module.exports.Console = Console;
 
diff --git a/test/parallel/test-console-group.js b/test/parallel/test-console-group.js
new file mode 100644
index 00000000000000..9c6a4c0510b470
--- /dev/null
+++ b/test/parallel/test-console-group.js
@@ -0,0 +1,76 @@
+'use strict';
+const common = require('../common');
+
+const assert = require('assert');
+const Console = require('console').Console;
+
+let stdout, stderr;
+
+function setup() {
+  stdout = '';
+  common.hijackStdout(function(data) {
+    stdout += data;
+  });
+
+  stderr = '';
+  common.hijackStderr(function(data) {
+    stderr += data;
+  });
+}
+
+function teardown() {
+  common.restoreStdout();
+  common.restoreStderr();
+}
+
+{
+  setup();
+  const expectedOut = 'This is the outer level\n' +
+                      '  Level 2\n' +
+                      '    Level 3\n' +
+                      '  Back to level 2\n' +
+                      'Back to the outer level\n' +
+                      'Still at the outer level\n';
+
+
+  const expectedErr = '    More of level 3\n';
+
+  console.log('This is the outer level');
+  console.group();
+  console.log('Level 2');
+  console.group();
+  console.log('Level 3');
+  console.warn('More of level 3');
+  console.groupEnd();
+  console.log('Back to level 2');
+  console.groupEnd();
+  console.log('Back to the outer level');
+  console.groupEnd();
+  console.log('Still at the outer level');
+
+  assert.strictEqual(stdout, expectedOut);
+  assert.strictEqual(stderr, expectedErr);
+  teardown();
+}
+
+// Group indentation is tracked per Console instance.
+{
+  setup();
+  const expectedOut = 'No indentation\n' +
+                      'None here either\n' +
+                      '  Now the first console is indenting\n' +
+                      'But the second one does not\n';
+  const expectedErr = '';
+
+  const c1 = new Console(process.stdout, process.stderr);
+  const c2 = new Console(process.stdout, process.stderr);
+  c1.log('No indentation');
+  c2.log('None here either');
+  c1.group();
+  c1.log('Now the first console is indenting');
+  c2.log('But the second one does not');
+
+  assert.strictEqual(stdout, expectedOut);
+  assert.strictEqual(stderr, expectedErr);
+  teardown();
+}

From e5bbcd2047e0544c43a06a62d46b2c6434d1acfb Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Mon, 21 Aug 2017 13:00:39 -0700
Subject: [PATCH 2/4] console: add label feature for group()

---
 doc/api/console.md                  | 11 ++++++++---
 lib/console.js                      |  5 ++++-
 test/parallel/test-console-group.js | 16 ++++++++++++++++
 3 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/doc/api/console.md b/doc/api/console.md
index 3c2a02cb2fdab1..db11c630943291 100644
--- a/doc/api/console.md
+++ b/doc/api/console.md
@@ -286,19 +286,24 @@ If formatting elements (e.g. `%d`) are not found in the first string then
 [`util.inspect()`][] is called on each argument and the resulting string
 values are concatenated. See [`util.format()`][] for more information.
 
-### console.group()
+### console.group([...label])
 <!-- YAML
 added: REPLACEME
 -->
 
-Increases indentation of subsequent lines by one tab (`\t`).
+* `label` {any}
+
+Increases indentation of subsequent lines by two spaces.
+
+If one or more `label`s are provided, those are printed first without the
+additional indentation.
 
 ### console.groupEnd()
 <!-- YAML
 added: REPLACEME
 -->
 
-Decreases indentation of subsequent lines by one tab (`\t`).
+Decreases indentation of subsequent lines by two spaces.
 
 ### console.info([data][, ...args])
 <!-- YAML
diff --git a/lib/console.js b/lib/console.js
index 7261de53134ca5..9705081686df6e 100644
--- a/lib/console.js
+++ b/lib/console.js
@@ -219,7 +219,10 @@ Console.prototype.countReset = function countReset(label = 'default') {
   counts.delete(`${label}`);
 };
 
-Console.prototype.group = function group() {
+Console.prototype.group = function group(...data) {
+  if (data.length > 0) {
+    this.log(...data);
+  }
   this[groupIndent] += '  ';
 };
 
diff --git a/test/parallel/test-console-group.js b/test/parallel/test-console-group.js
index 9c6a4c0510b470..c02db6d2cf41b4 100644
--- a/test/parallel/test-console-group.js
+++ b/test/parallel/test-console-group.js
@@ -23,6 +23,7 @@ function teardown() {
   common.restoreStderr();
 }
 
+// Basic group() functionality
 {
   setup();
   const expectedOut = 'This is the outer level\n' +
@@ -74,3 +75,18 @@ function teardown() {
   assert.strictEqual(stderr, expectedErr);
   teardown();
 }
+
+// Make sure labels work.
+{
+  setup();
+  const expectedOut = 'This is a label\n' +
+                      '  And this is the data for that label\n';
+  const expectedErr = '';
+
+  console.group('This is a label');
+  console.log('And this is the data for that label');
+
+  assert.strictEqual(stdout, expectedOut);
+  assert.strictEqual(stderr, expectedErr);
+  teardown();
+}

From c1d5bcc26746df47507880571df3e19c7406993a Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Mon, 21 Aug 2017 13:18:15 -0700
Subject: [PATCH 3/4] console: add groupCollapsed()

---
 doc/api/console.md                  |  8 ++++
 lib/console.js                      |  2 +
 test/parallel/test-console-group.js | 57 +++++++++++++++++++----------
 3 files changed, 48 insertions(+), 19 deletions(-)

diff --git a/doc/api/console.md b/doc/api/console.md
index db11c630943291..ee130d7b9714b7 100644
--- a/doc/api/console.md
+++ b/doc/api/console.md
@@ -298,6 +298,13 @@ Increases indentation of subsequent lines by two spaces.
 If one or more `label`s are provided, those are printed first without the
 additional indentation.
 
+### console.groupCollapsed()
+<!-- YAML
+  added: REPLACEME
+-->
+
+An alias for [`console.group()`][].
+
 ### console.groupEnd()
 <!-- YAML
 added: REPLACEME
@@ -409,6 +416,7 @@ added: v0.1.100
 The `console.warn()` function is an alias for [`console.error()`][].
 
 [`console.error()`]: #console_console_error_data_args
+[`console.group()`]: #console_console_group_label
 [`console.log()`]: #console_console_log_data_args
 [`console.time()`]: #console_console_time_label
 [`console.timeEnd()`]: #console_console_timeend_label
diff --git a/lib/console.js b/lib/console.js
index 9705081686df6e..c901a4970e18f4 100644
--- a/lib/console.js
+++ b/lib/console.js
@@ -226,6 +226,8 @@ Console.prototype.group = function group(...data) {
   this[groupIndent] += '  ';
 };
 
+Console.prototype.groupCollapsed = Console.prototype.group;
+
 Console.prototype.groupEnd = function groupEnd() {
   this[groupIndent] = this[groupIndent].slice(0, this[groupIndent].length - 2);
 };
diff --git a/test/parallel/test-console-group.js b/test/parallel/test-console-group.js
index c02db6d2cf41b4..8f7d84f2f17e99 100644
--- a/test/parallel/test-console-group.js
+++ b/test/parallel/test-console-group.js
@@ -4,7 +4,7 @@ const common = require('../common');
 const assert = require('assert');
 const Console = require('console').Console;
 
-let stdout, stderr;
+let c, stdout, stderr;
 
 function setup() {
   stdout = '';
@@ -16,6 +16,8 @@ function setup() {
   common.hijackStderr(function(data) {
     stderr += data;
   });
+
+  c = new Console(process.stdout, process.stderr);
 }
 
 function teardown() {
@@ -36,18 +38,18 @@ function teardown() {
 
   const expectedErr = '    More of level 3\n';
 
-  console.log('This is the outer level');
-  console.group();
-  console.log('Level 2');
-  console.group();
-  console.log('Level 3');
-  console.warn('More of level 3');
-  console.groupEnd();
-  console.log('Back to level 2');
-  console.groupEnd();
-  console.log('Back to the outer level');
-  console.groupEnd();
-  console.log('Still at the outer level');
+  c.log('This is the outer level');
+  c.group();
+  c.log('Level 2');
+  c.group();
+  c.log('Level 3');
+  c.warn('More of level 3');
+  c.groupEnd();
+  c.log('Back to level 2');
+  c.groupEnd();
+  c.log('Back to the outer level');
+  c.groupEnd();
+  c.log('Still at the outer level');
 
   assert.strictEqual(stdout, expectedOut);
   assert.strictEqual(stderr, expectedErr);
@@ -63,12 +65,11 @@ function teardown() {
                       'But the second one does not\n';
   const expectedErr = '';
 
-  const c1 = new Console(process.stdout, process.stderr);
   const c2 = new Console(process.stdout, process.stderr);
-  c1.log('No indentation');
+  c.log('No indentation');
   c2.log('None here either');
-  c1.group();
-  c1.log('Now the first console is indenting');
+  c.group();
+  c.log('Now the first console is indenting');
   c2.log('But the second one does not');
 
   assert.strictEqual(stdout, expectedOut);
@@ -83,8 +84,26 @@ function teardown() {
                       '  And this is the data for that label\n';
   const expectedErr = '';
 
-  console.group('This is a label');
-  console.log('And this is the data for that label');
+  c.group('This is a label');
+  c.log('And this is the data for that label');
+
+  assert.strictEqual(stdout, expectedOut);
+  assert.strictEqual(stderr, expectedErr);
+  teardown();
+}
+
+// Check that console.groupCollapsed() is an alias of console.group()
+{
+  setup();
+  const expectedOut = 'Label\n' +
+                      '  Level 2\n' +
+                      '    Level 3\n';
+  const expectedErr = '';
+
+  c.groupCollapsed('Label');
+  c.log('Level 2');
+  c.groupCollapsed();
+  c.log('Level 3');
 
   assert.strictEqual(stdout, expectedOut);
   assert.strictEqual(stderr, expectedErr);

From 667be1a8d5486b8aa1918aa3e813f48280dcd2e4 Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Tue, 22 Aug 2017 10:41:49 -0700
Subject: [PATCH 4/4] squash: groupIndent -> kgroupIndent

---
 lib/console.js | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/lib/console.js b/lib/console.js
index c901a4970e18f4..13e3c05631aad1 100644
--- a/lib/console.js
+++ b/lib/console.js
@@ -26,7 +26,7 @@ const util = require('util');
 const kCounts = Symbol('counts');
 
 // Track amount of indentation required via `console.group()`.
-const groupIndent = Symbol('groupIndent');
+const kGroupIndent = Symbol('groupIndent');
 
 function Console(stdout, stderr, ignoreErrors = true) {
   if (!(this instanceof Console)) {
@@ -60,6 +60,7 @@ function Console(stdout, stderr, ignoreErrors = true) {
   Object.defineProperty(this, '_stderrErrorHandler', prop);
 
   this[kCounts] = new Map();
+  this[kGroupIndent] = '';
 
   // bind the prototype functions to this Console instance
   var keys = Object.keys(Console.prototype);
@@ -67,8 +68,6 @@ function Console(stdout, stderr, ignoreErrors = true) {
     var k = keys[v];
     this[k] = this[k].bind(this);
   }
-
-  this[groupIndent] = '';
 }
 
 // Make a function that can serve as the callback passed to `stream.write()`.
@@ -116,7 +115,7 @@ function write(ignoreErrors, stream, string, errorhandler) {
 Console.prototype.log = function log(...args) {
   write(this._ignoreErrors,
         this._stdout,
-        `${this[groupIndent]}${util.format.apply(null, args)}\n`,
+        `${this[kGroupIndent]}${util.format.apply(null, args)}\n`,
         this._stdoutErrorHandler);
 };
 
@@ -127,7 +126,7 @@ Console.prototype.info = Console.prototype.log;
 Console.prototype.warn = function warn(...args) {
   write(this._ignoreErrors,
         this._stderr,
-        `${this[groupIndent]}${util.format.apply(null, args)}\n`,
+        `${this[kGroupIndent]}${util.format.apply(null, args)}\n`,
         this._stderrErrorHandler);
 };
 
@@ -139,7 +138,7 @@ Console.prototype.dir = function dir(object, options) {
   options = Object.assign({ customInspect: false }, options);
   write(this._ignoreErrors,
         this._stdout,
-        `${this[groupIndent]}${util.inspect(object, options)}\n`,
+        `${this[kGroupIndent]}${util.inspect(object, options)}\n`,
         this._stdoutErrorHandler);
 };
 
@@ -223,13 +222,14 @@ Console.prototype.group = function group(...data) {
   if (data.length > 0) {
     this.log(...data);
   }
-  this[groupIndent] += '  ';
+  this[kGroupIndent] += '  ';
 };
 
 Console.prototype.groupCollapsed = Console.prototype.group;
 
 Console.prototype.groupEnd = function groupEnd() {
-  this[groupIndent] = this[groupIndent].slice(0, this[groupIndent].length - 2);
+  this[kGroupIndent] =
+    this[kGroupIndent].slice(0, this[kGroupIndent].length - 2);
 };
 
 module.exports = new Console(process.stdout, process.stderr);