Skip to content

fix(ext/console): Error Cause Not Inspect-Formatted when printed #24526

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

Merged
merged 11 commits into from
Jul 22, 2024
Merged

fix(ext/console): Error Cause Not Inspect-Formatted when printed #24526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
da798b7
fix(ext/console): Ensure Error.cause is properly formatted when using…
MujahedSafaa Jul 11, 2024
5d12a8b
Use the equivalent for "JSON.stringify" from the `primordials` object
MujahedSafaa Jul 11, 2024
7577bd8
Merge branch 'denoland:main' into fix-error_cause-is-not-inspect-form…
MujahedSafaa Jul 14, 2024
9e728dc
Fix failed test inspectErrorCircular
MujahedSafaa Jul 15, 2024
41d9b4d
Update 01_console.js
MujahedSafaa Jul 15, 2024
30234d9
format code based on lint rules
MujahedSafaa Jul 15, 2024
901810f
Enhance code readability
MujahedSafaa Jul 15, 2024
5e91199
Add test use case
MujahedSafaa Jul 16, 2024
8817772
Change from stringify to inspect to handle all types of data
MujahedSafaa Jul 17, 2024
9f3a251
Merge branch 'main' into fix-error_cause-is-not-inspect-formatted
bartlomieju Jul 18, 2024
7b6b1db
Merge branch 'main' into fix-error_cause-is-not-inspect-formatted
bartlomieju Jul 22, 2024
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
8 changes: 7 additions & 1 deletion ext/console/01_console.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1484,12 +1484,18 @@ function inspectError(value, ctx) {
finalMessage += `[${stack || ErrorPrototypeToString(value)}]`;
}
}
const doubleQuoteRegExp = new SafeRegExp('"', "g");
finalMessage += ArrayPrototypeJoin(
ArrayPrototypeMap(
causes,
(cause) =>
"\nCaused by " + (MapPrototypeGet(refMap, cause) ?? "") +
(cause?.stack ?? cause),
(cause?.stack ??
StringPrototypeReplace(
inspect(cause),
doubleQuoteRegExp,
"",
)),
Comment on lines +1494 to +1498
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inspect does not insert superfluous double quotes like JSON.stringify does, so the replace call can be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried tor remove the replace with the new code inspect but the test inspectErrorCircular failed on this:
image
Therefore, I retained the replace function.

),
"",
);
Expand Down
16 changes: 16 additions & 0 deletions tests/unit/console_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2206,6 +2206,22 @@ Deno.test(function inspectErrorCircular() {
);
});

Deno.test(function inspectErrorWithCauseFormat() {
const error = new Error("This is an error", {
cause: {
code: 100500,
},
});
assertStringIncludes(
stripColor(Deno.inspect(error)),
"Error: This is an error",
);
assertStringIncludes(
stripColor(Deno.inspect(error)),
"Caused by { code: 100500 }",
);
});

Deno.test(function inspectColors() {
assertEquals(Deno.inspect(1), "1");
assertStringIncludes(Deno.inspect(1, { colors: true }), "\x1b[");
Expand Down