console: add table method #18137

devsnek · 2018-01-13T19:54:19Z

Refs https://console.spec.whatwg.org/#table

new super fine console.table method

i've been using firefox as my model for how the outputs should look

some column ordering stuff:

indexed properties before named properties unless properties is passed
Values column is always last, independent from properties
Key column always directly before Values column, independent from properties
(index) and (iteration index) columns are always first, independent from properties

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

console

Trott

Thanks for doing this. Can you update the documentation for console.table() in console.md?

TimothyGu · 2018-01-14T07:16:51Z

lib/console.js

@@ -249,6 +249,75 @@ Console.prototype.groupEnd = function groupEnd() {
    this[kGroupIndent].slice(0, this[kGroupIndent].length - 2);
 };

+const untablableTypes = [
+  'symbol', 'undefined', 'boolean', 'number', 'string', 'function',


function works just fine in Chrome: console.table([function a() {}, function b() {}]).

TimothyGu · 2018-01-14T07:17:02Z

lib/console.js

+];
+
+const untablableValues = [
+  undefined, null, NaN, true, false, global, process,


Why are global and process singled out?

they are objectively easier to read when not run through the table method, and the spec says Fall back to just logging the argument if it can’t be parsed as tabular. which i think is fairly true for both of those.

I agree in this case that it is going to be easier to read. The question is if we want to have a special handling here. And there could theoretically be other things that are difficult to read as well because they have lots of properties.

In chrome window works as tableable and I think that is comparable. I guess most people will not add process or global so I would say either we should not special handle them at all or we add a limit that by checking the property number.

TimothyGu · 2018-01-14T07:19:17Z

lib/console.js

+  if (isSet(O))
+    return Array.from({ length: O.size }, (e, i) => i);
+  if (isSetIterator(O))
+    return Array.from(O).map((i) => i - 1);


This will exhaust O, preventing it from further usage; use the previewMapIterator and previewSetIterator from internal/v8 instead. Make sure to set a limit in how many elements to allow. See how it's used in util.format (the limit is 100 in this case):

node/lib/util.js

Lines 821 to 840 in c84582c

function formatCollectionIterator(preview, ctx, value, recurseTimes,

visibleKeys, keys) {

var nextRecurseTimes = recurseTimes === null ? null : recurseTimes - 1;

var vals = preview(value, 100);

var output = [];

for (const o of vals) {

output.push(formatValue(ctx, o, nextRecurseTimes));

}

return output;

}

function formatMapIterator(ctx, value, recurseTimes, visibleKeys, keys) {

return formatCollectionIterator(previewMapIterator, ctx, value, recurseTimes,

visibleKeys, keys);

}

function formatSetIterator(ctx, value, recurseTimes, visibleKeys, keys) {

return formatCollectionIterator(previewSetIterator, ctx, value, recurseTimes,

visibleKeys, keys);

}

TimothyGu · 2018-01-14T07:19:32Z

lib/console.js

+  if (isSetIterator(O))
+    return Array.from(O).map((i) => i - 1);
+  if (isMap(O))
+    O = O.keys();


Did you mean return [...O.keys()];?

TimothyGu · 2018-01-14T07:20:20Z

lib/console.js

+  if (isMap(O))
+    O = O.keys();
+  if (isMapIterator(O))
+    return Array.from(O);


Same as SetIterator

TimothyGu · 2018-01-14T07:21:20Z

lib/console.js

+  untablableValues.includes(value) ||
+  untablableTypes.includes(typeof value);
+
+const { isSet, isMap, isSetIterator, isMapIterator } = process.binding('util');


Move to the top

TimothyGu · 2018-01-14T07:34:21Z

test/parallel/test-console-table.js

+assert.strictEqual(queue.shift(), `(index)	a	b
+0	1	undefined
+1	undefined	2
+`);


Needs more tests:

console.table([3, 4, { a: 3 }]); console.table([3, 4, { a: 3 }], ['nonexistent']); console.table([3, 4, { a: 3 }], ['Value']); console.table([3, 4, { Value: 3 }], ['Value']); console.table([,,,,,,,,,4]); console.table([[,,,,,,,,,4]]); console.table([[,,,,,,,,,{}]]); // etc. // Check browsers for sensible behaviors.

Also needed to test are Map objects, Map Iterator objects, Set objects, Set Iterator objects.

BridgeAR · 2018-02-01T17:35:41Z

Ping @devsnek

devsnek · 2018-02-01T17:51:12Z

yeah sorry i've been meaning to get to this, its on my list

devsnek · 2018-02-01T21:44:56Z

@Trott @TimothyGu changes have been made

requested changes have been made

BridgeAR · 2018-02-12T12:07:49Z

doc/api/console.md

+```
+
+```js
+console.log([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);


I guess console.log should actually be console.table.

BridgeAR · 2018-02-12T12:17:06Z

lib/console.js

@@ -249,6 +252,74 @@ Console.prototype.groupEnd = function groupEnd() {
    this[kGroupIndent].slice(0, this[kGroupIndent].length - 2);
 };

+const untablableTypes = [


Shall we maybe call it untableable?

doesn't really make sense, the method below is already named that

You misunderstood my comment: I did not mean the whole variable name but only the beginning. And that for all of these variables.

The difference is the e.

oh. i have no idea. pretty sure tableable/tablable isn't english anyway so i have no idea where to go with that. i think following other words it would become tablible but that looks really wrong.

Maybe @Trott has a opinion about it?

BridgeAR · 2018-02-12T12:18:36Z

lib/console.js

+];
+
+const untablableValues = [
+  undefined, null, NaN, true, false, global, process,


I agree in this case that it is going to be easier to read. The question is if we want to have a special handling here. And there could theoretically be other things that are difficult to read as well because they have lots of properties.

In chrome window works as tableable and I think that is comparable. I guess most people will not add process or global so I would say either we should not special handle them at all or we add a limit that by checking the property number.

BridgeAR · 2018-02-12T12:23:57Z

lib/console.js

+
+function getTablableKeysOf(O) {
+  if (isSet(O))
+    return Array.from({ length: O.size }, (e, i) => i);


The spec says it should log the properties. We could show those and add a special handling for them but e.g. Chrome does not show them.

The same applies to the entries below.

BridgeAR · 2018-02-12T12:36:40Z

lib/console.js

+        else
+          item = item[column];
+      }
+      r += `\t${item}`;


This will always print \tundefined for Map and Set but it is possible to get the value from those.

BridgeAR · 2018-02-12T12:37:40Z

lib/console.js

+    for (const column of columns) {
+      let item = data[row];
+      if (deep) {
+        if (isMap(item))


This can probably never be reached. The same applies to isSet.

BridgeAR · 2018-02-12T12:42:55Z

test/parallel/test-console-table.js

+2	3
+`);
+
+test([3, 4, { a: 3 }], ['nonexistent'], `(index)	a


Chrome shows this as the following that I think would be great to have:

(index) Value a 0 3 1 4 2 3

i don't understand the output of that table

There is no undefined value for a in index 0 and 1. The value does not exist. But there is a value and we can show that with 3 and 4.

Just enter console.table([3, 4, { a: 3 }]) in chrome to see the output :-)

rn the only disparity seems to be that i choose to ignore filters of props that don't exist while the browsers use undefined. i can change that.

This is how it looks like for me:

@BridgeAR There isn’t really a standard on what should be printed. As long as the output makes sense, which IMO it does, it’s good.

@TimothyGu I am aware that there is no standard for it but I feel like the output used in chrome does make more sense and provides a relatively good user experience.

I'm in favour of the change requested by @BridgeAR here, in relation to missing vs undefined values. I think it would go a long way towards making this feature more useful.

BridgeAR · 2018-02-12T12:49:54Z

test/parallel/test-console-table.js

+
+test([{ a: 1 }, { b: 2 }], `(index)	a	b
+0	1	undefined
+1	undefined	2


I think it would be best to add extra padding up to the value length that has the highest length of the column. That way it will improve the readability massively.

i was considering that but i decided that as this isn't really intended to do more than humor the spec, and in general tables in terminals have a history of being formatted with single tabs without compensation (especially in configs and stuff) so i wanted to stay consistent with that.

I feel like it improves the readability a lot, so I would really like to add that. I do not see any issues about inconsistencies here.

Showing the value undefined is actually wrong here out of my perspective because there is just no value. So it should be empty instead of showing undefined. Otherwise this can not be distinguished from the value undefined.

As an extra test I would add:

test( [{ a: 1 }, { b: undefined }], '(index) a b' + '0 1 ' + '1 undefined' )

BridgeAR · 2018-02-12T12:51:52Z

lib/console.js

+  if (isSet(O))
+    return Array.from({ length: O.size }, (e, i) => i);
+  if (isSetIterator(O))
+    return previewSetIterator(O, 50);


I feel like we should handle iterators as not tableable.

BridgeAR · 2018-02-16T22:46:39Z

Ping @devsnek

BridgeAR · 2018-03-02T14:29:57Z

lib/console.js

+  'symbol', 'undefined', 'boolean', 'number', 'string',
+];
+
+const untablableValues = [undefined, null, NaN, true, false];


The booleans, undefined and NaN are actually redundant to the untablableTypes. So it would be best to remove the untablableValues and just explicitely test for null in the untableable function.

BridgeAR · 2018-03-02T14:30:19Z

lib/console.js

@@ -249,6 +252,74 @@ Console.prototype.groupEnd = function groupEnd() {
    this[kGroupIndent].slice(0, this[kGroupIndent].length - 2);
 };

+const untablableTypes = [


Maybe @Trott has a opinion about it?

BridgeAR · 2018-03-02T14:32:26Z

lib/console.js

+const untablableValues = [undefined, null, NaN, true, false];
+
+const untablable = (value) =>
+  Object.keys(value).length > 20 ||


This check has to be last. Otherwise it will fail for null and undefined. Please add a test for this as well.

BridgeAR · 2018-03-02T14:35:02Z

lib/console.js

+    const item = data[row];
+    if (!item || (typeof item !== 'object' && typeof item !== 'function'))
+      continue;
+    for (const key of getTablableKeysOf(data[row])) {


data[row] should be replaced with item here.

BridgeAR · 2018-03-02T14:41:52Z

test/parallel/test-console-table.js

+
+test([{ a: 1 }, { b: 2 }], `(index)	a	b
+0	1	undefined
+1	undefined	2


Showing the value undefined is actually wrong here out of my perspective because there is just no value. So it should be empty instead of showing undefined. Otherwise this can not be distinguished from the value undefined.

As an extra test I would add:

test( [{ a: 1 }, { b: undefined }], '(index) a b' + '0 1 ' + '1 undefined' )

devsnek · 2018-03-03T23:44:11Z

@BridgeAR new code is here, i'm planning to clean up cli_table.js a bit but the behavior is where i want it to be

BridgeAR · 2018-03-04T00:14:21Z

lib/console.js

@@ -249,6 +253,86 @@ Console.prototype.groupEnd = function groupEnd() {
    this[kGroupIndent].slice(0, this[kGroupIndent].length - 2);
 };

+const untablable = (value) =>
+  value == null ||
+  ['symbol', 'undefined', 'boolean', 'number', 'string']


undefined is redundant to value == null. Either the check above should be strict equal or the undefined should be removed here.

TimothyGu · 2018-03-09T15:38:39Z

doc/api/console.md

+-->
+
+* `tabularData` {any}
+* `properties` {Array<String>} Alternate properties for constructing the table.


TimothyGu · 2018-03-09T15:40:21Z

test/parallel/test-console-table.js

+
+test(new Map([ ['a', 1], [Symbol(), [2]] ]), `
+┌───────────────────┬──────────┬────────┐
+│ (iteration index) │   Key    │ Values │


Actually: we might want to change Values to Value instead. Because it is a single value at the specific index position.

BridgeAR

I do not want to block this any further from landing. So LGTM. I would like to get some further adjustments in but I can open a PR for that at some point in the future.

devsnek · 2018-03-30T03:19:27Z

CI https://ci.nodejs.org/job/node-test-pull-request/13937/

devsnek · 2018-03-30T14:17:46Z

CI https://ci.nodejs.org/job/node-test-pull-request/13947/

devsnek · 2018-03-30T23:33:13Z

as a heads-up i will be landing this in a few hours

devsnek · 2018-03-31T00:42:18Z

landed in 97ace04

PR-URL: #18137 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

targos · 2018-04-02T14:01:15Z

Don't forget the semver-minor label for PRs that add new features ;)

targos · 2018-04-02T14:11:09Z

Should this be backported to v9.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

PR-URL: nodejs#18137 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

vitaly-t · 2018-04-24T21:21:04Z

Method console.table has been in Node.js for a very long time, but it was doing nothing. And now that there is an implementation, it raises a question of how to do a proper check that the current version of Node.js actually implements console.table?

BridgeAR · 2018-04-24T21:30:38Z

@vitaly-t I can think of two ways: 1) check for the version. Everything from 10.x on does something. It will likely be backported as well. So that might not be a reliable check. 2) Hook into stdout while a module is loaded and do a feature check.

PR-URL: nodejs#18137 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

nodejs-github-bot added the console Issues and PRs related to the console subsystem. label Jan 13, 2018

devsnek force-pushed the feature/console-table branch from 322d8dd to e0eb3af Compare January 13, 2018 19:55

Trott previously requested changes Jan 14, 2018

View reviewed changes

devsnek force-pushed the feature/console-table branch from e0eb3af to 460001c Compare January 14, 2018 03:58

TimothyGu reviewed Jan 14, 2018

View reviewed changes

maclover7 force-pushed the master branch from bb5575a to 993b716 Compare January 26, 2018 22:02

cjihrig force-pushed the master branch from 993b716 to 082f952 Compare January 26, 2018 22:36

devsnek force-pushed the feature/console-table branch from 460001c to 71a8035 Compare February 1, 2018 21:44

TimothyGu self-assigned this Feb 3, 2018

BridgeAR reviewed Feb 12, 2018

View reviewed changes

devsnek force-pushed the feature/console-table branch 2 times, most recently from 7c583c7 to 0f8b7d7 Compare February 12, 2018 20:25

BridgeAR reviewed Mar 2, 2018

View reviewed changes

devsnek force-pushed the feature/console-table branch 2 times, most recently from bdb7755 to 6399953 Compare March 3, 2018 23:40

devsnek force-pushed the feature/console-table branch 2 times, most recently from 2b8769b to 3288a89 Compare March 3, 2018 23:55

devsnek added the wip Issues and PRs that are still a work in progress. label Mar 3, 2018

devsnek force-pushed the feature/console-table branch 2 times, most recently from be31b6a to c36dd94 Compare March 4, 2018 00:09

BridgeAR reviewed Mar 4, 2018

View reviewed changes

devsnek force-pushed the feature/console-table branch 2 times, most recently from c579032 to 8382250 Compare March 4, 2018 01:14

devsnek removed the wip Issues and PRs that are still a work in progress. label Mar 4, 2018

devsnek force-pushed the feature/console-table branch from 87ea21f to 5eea243 Compare March 5, 2018 20:53

TimothyGu approved these changes Mar 9, 2018

View reviewed changes

devsnek force-pushed the feature/console-table branch 2 times, most recently from b50f098 to 600c45b Compare March 11, 2018 16:59

BridgeAR approved these changes Mar 25, 2018

View reviewed changes

devsnek force-pushed the feature/console-table branch from 600c45b to 77b8fd2 Compare March 30, 2018 03:18

devsnek added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 30, 2018

console: add table method

8a0babe

devsnek force-pushed the feature/console-table branch from 77b8fd2 to 8a0babe Compare March 30, 2018 14:16

devsnek closed this Mar 31, 2018

devsnek deleted the feature/console-table branch March 31, 2018 00:42

devsnek added a commit that referenced this pull request Mar 31, 2018

console: add table method

97ace04

PR-URL: #18137 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

targos added semver-minor PRs that contain new features and should be released in the next minor version. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Apr 2, 2018

targos added the backport-requested-v9.x label Apr 2, 2018

devsnek added a commit to devsnek/node that referenced this pull request Apr 2, 2018

console: add table method

db254ef

PR-URL: nodejs#18137 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

devsnek mentioned this pull request Apr 2, 2018

[v9.x backport] console: add table method #19750

Closed

apapirovski mentioned this pull request Apr 22, 2018

console: implement console.table and console.dirxml #17128

Closed

devsnek mentioned this pull request Apr 24, 2018

console.table doesn't do anything #14952

Closed

BridgeAR pushed a commit to BridgeAR/node that referenced this pull request May 1, 2018

console: add table method

789279b

PR-URL: nodejs#18137 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

vsemozhetbyt mentioned this pull request May 4, 2018

console: console.table() uses colored inspect #20510

Closed

4 tasks

MylesBorins added the dont-land-on-v8.x label Aug 7, 2018

	function formatCollectionIterator(preview, ctx, value, recurseTimes,
	visibleKeys, keys) {
	var nextRecurseTimes = recurseTimes === null ? null : recurseTimes - 1;
	var vals = preview(value, 100);
	var output = [];
	for (const o of vals) {
	output.push(formatValue(ctx, o, nextRecurseTimes));
	}
	return output;
	}

	function formatMapIterator(ctx, value, recurseTimes, visibleKeys, keys) {
	return formatCollectionIterator(previewMapIterator, ctx, value, recurseTimes,
	visibleKeys, keys);
	}

	function formatSetIterator(ctx, value, recurseTimes, visibleKeys, keys) {
	return formatCollectionIterator(previewSetIterator, ctx, value, recurseTimes,
	visibleKeys, keys);
	}

console: add table method #18137

console: add table method #18137

Conversation

devsnek commented Jan 13, 2018 • edited Loading

Checklist

Affected core subsystem(s)

Trott left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR commented Feb 1, 2018

devsnek commented Feb 1, 2018

devsnek commented Feb 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devsnek Feb 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR commented Feb 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devsnek commented Mar 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR left a comment

Choose a reason for hiding this comment

devsnek commented Mar 30, 2018

devsnek commented Mar 30, 2018

devsnek commented Mar 30, 2018

devsnek commented Mar 31, 2018

targos commented Apr 2, 2018

targos commented Apr 2, 2018

vitaly-t commented Apr 24, 2018 • edited Loading

BridgeAR commented Apr 24, 2018

devsnek commented Jan 13, 2018 •

edited

Loading

devsnek Feb 17, 2018 •

edited

Loading

devsnek commented Mar 3, 2018 •

edited

Loading

vitaly-t commented Apr 24, 2018 •

edited

Loading