Improve error messages for includePanelProcessor.ts
#2703
Merged
Conversation
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
14 tasks
14 tasks
tlylt
reviewed
Apr 17, 2025
tlylt
approved these changes
Apr 18, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2703 +/- ##
=======================================
Coverage 52.80% 52.80%
=======================================
Files 130 130
Lines 7162 7162
Branches 1479 1573 +94
=======================================
Hits 3782 3782
Misses 3225 3225
Partials 155 155 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What is the purpose of this pull request?
Improve user experience (authors)
Overview of changes:
This PR improves the error messages of
includePanelProcessor.tsby only logging the error message, rather than the entire error stack. This makes the errors more user-friendly and readable. The error message for URL src in popover is also updated to provide more details for authors to find the issue.For example, currently the error would be logged as:
But the PR will update them to be logged as:
Anything you'd like to highlight/discuss:
These changes are derived from the PR #2639
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Improve error messages for
includePanelProcessor.tsCurrently, the error messages for
includePanelProcessor.tslog boththe error message and the error stack. This may be confusing and
intimidating to users as it exposes some unnecessary details to them.
Let's update the logger to only log the
error.messageto hide theerror stack. Let's also update the error message for URLs in src to
be more user-friendly.
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):