fix(core): surface NamedError detail without doubling the tag#31408
Open
albertdbio wants to merge 1 commit into
Open
fix(core): surface NamedError detail without doubling the tag#31408albertdbio wants to merge 1 commit into
albertdbio wants to merge 1 commit into
Conversation
NamedError set Error.message to the bare tag, so Cause.pretty (which composes name and message) rendered Name: Name and hid data.message. Keep Error.message as the human detail only; the tag stays on .name and renderers compose it. log.ts formatError now renders via Error.toString() so the raw-message path no longer drops the tag. Adds a regression test covering both render paths.
Contributor
|
Thanks for your contribution! This PR doesn't have a linked issue. All PRs must reference an existing issue. Please:
See CONTRIBUTING.md for details. |
Contributor
|
Thanks for updating your PR! It now meets our contributing guidelines. 👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue for this PR
Closes #31414
Type of change
What does this PR do?
NamedError's constructor calledsuper(name), so every instance hadError.message === Error.name. SinceCause.prettyandError.prototype.toString()render an error as${name}: ${message}, this produced output likeProviderAuthError: ProviderAuthErrorand hid the actualdata.message.This sets
Error.messageto the human detail —data.messagewhen the data carries a stringmessage, otherwise empty — and keeps the tag on.name. Renderers then composeProviderAuthError: <real message>once: no doubled tag, and the detail is no longer hidden.util/log.ts'sformatErrorreturned the bareerror.message, which after the above change would drop the tag. It now useserror.toString(), which composes${name}: ${message}and omits the": "separator when the message is empty — so errors whose data has nomessagefield render as just the tag rather than an empty string.How did you verify your code works?
Added
packages/core/test/util-error.test.tscovering both paths: an error with amessagerenders as"Name: message"via bothtoString()andCause.pretty; one without renders as"Name"(no trailing colon, no doubled tag).bun testpasses locally andbun typecheckis clean across all packages.Screenshots / recordings
N/A — not a UI change.
Checklist