Skip to content

util: special handle maxArrayLength while grouping arrays #28059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BridgeAR wants to merge 1 commit into from
Closed

util: special handle maxArrayLength while grouping arrays #28059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
util: special handle maxArrayLength while grouping arrays 
This makes sure that large arrays with lots of small entries ignore
the `... n more item(s)` part since it often resulted in output that
users did not expect.

Now that part is printed on a separate line to indicate extra entries.
  • Loading branch information
@BridgeAR
BridgeAR committed Jun 4, 2019
commit ee1b4d818ea97f8c049767359a1d3b30fa7f90f8
18 changes: 13 additions & 5 deletions lib/internal/util/inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -970,12 +970,17 @@ function groupArrayElements(ctx, output) {
let totalLength = 0;
let maxLength = 0;
let i = 0;
let outputLength = output.length;
if (ctx.maxArrayLength < output.length) {
// This makes sure the "... n more items" part is not taken into account.
outputLength--;
}
const separatorSpace = 2; // Add 1 for the space and 1 for the separator.
const dataLen = new Array(output.length);
const dataLen = new Array(outputLength);
// Calculate the total length of all output entries and the individual max
// entries length of all output entries. We have to remove colors first,
// otherwise the length would not be calculated properly.
for (; i < output.length; i++) {
for (; i < outputLength; i++) {
const len = ctx.colors ? removeColors(output[i]).length : output[i].length;
dataLen[i] = len;
totalLength += len + separatorSpace;
Expand Down Expand Up @@ -1003,7 +1008,7 @@ function groupArrayElements(ctx, output) {
// The added bias slightly increases the columns for short entries.
Math.round(
Math.sqrt(
approxCharHeights * (actualMax - bias) * output.length
approxCharHeights * (actualMax - bias) * outputLength
) / (actualMax - bias)
),
// Do not exceed the breakLength.
Expand All @@ -1027,20 +1032,23 @@ function groupArrayElements(ctx, output) {
firstLineMaxLength = dataLen[i];
}
// Each iteration creates a single line of grouped entries.
for (i = 0; i < output.length; i += columns) {
for (i = 0; i < outputLength; i += columns) {
// Calculate extra color padding in case it's active. This has to be done
// line by line as some lines might contain more colors than others.
let colorPadding = output[i].length - dataLen[i];
// Add padding to the first column of the output.
let str = output[i].padStart(firstLineMaxLength + colorPadding, ' ');
// The last lines may contain less entries than columns.
const max = Math.min(i + columns, output.length);
const max = Math.min(i + columns, outputLength);
for (var j = i + 1; j < max; j++) {
colorPadding = output[j].length - dataLen[j];
str += `, ${output[j].padStart(maxLength + colorPadding, ' ')}`;
}
tmp.push(str);
}
if (ctx.maxArrayLength < output.length) {
tmp.push(output[outputLength]);
}
output = tmp;
}
return output;
Expand Down
5 changes: 3 additions & 2 deletions test/parallel/test-util-inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2193,7 +2193,7 @@ assert.strictEqual(
[ 1, 2, { a: 1, b: 2, c: 3 } ]
],
c: ['foo', 4, 444444],
d: Array.from({ length: 100 }).map((e, i) => {
d: Array.from({ length: 101 }).map((e, i) => {
return i % 2 === 0 ? i * i : i;
}),
e: Array(6).fill('foobar'),
Expand Down Expand Up @@ -2242,7 +2242,8 @@ assert.strictEqual(
' 77, 6084, 79, 6400, 81, 6724, 83,',
' 7056, 85, 7396, 87, 7744, 89, 8100,',
' 91, 8464, 93, 8836, 95, 9216, 97,',
' 9604, 99',
' 9604, 99,',
' ... 1 more item',
' ],',
' e: [',
" 'foobar',",
Expand Down