Use Exception#detailed_message when generating exception message if applicable #1924
Merged
Use Exception#detailed_message when generating exception message if applicable #1924
Exception#detailed_message when generating exception message if applicable #1924Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1924 +/- ##
==========================================
- Coverage 98.45% 98.43% -0.02%
==========================================
Files 151 151
Lines 9259 9273 +14
==========================================
+ Hits 9116 9128 +12
- Misses 143 145 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…pplicable
Ruby 3.1 provided more detailed exception messages like
```
undefined method `[]' for nil:NilClass
{}[:foo][:bar]
^^^^^^
```
But the additional information was put directly input `Exception#message`, which caused some problems
(as described in [this ticket](https://bugs.ruby-lang.org/issues/18438)).
So in Ruby 3.2, the additional message will be put into the `Exception#detailed_message`,
which as a error monitoring service is what we should use.
64a96bf to
1c4888f
Compare
st0012
commented
Oct 23, 2022
|
|
||
| expect(event["exception"]["values"][0]["type"]).to eq("RuntimeError") | ||
| expect(event["exception"]["values"][0]["value"]).to eq("An unhandled exception!") | ||
| expect(event["exception"]["values"][0]["value"]).to match("An unhandled exception!") |
Contributor
Author
There was a problem hiding this comment.
#detailed_message always includes (ExceptionClass), which I think is beneficial and should be kept.
But I also don't want to check Ruby version before every message check, so I just switch to match instead.
Contributor
Author
|
cc @mame |
st0012
commented
Oct 23, 2022
| @value = (exception.message || "").byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES) | ||
| exception_message = | ||
| if exception.respond_to?(:detailed_message) | ||
| exception.detailed_message(highlight: false) |
Contributor
Author
There was a problem hiding this comment.
highlight: falseremoves ANSI escape code that's mainly for standard output.#detailed_messagealways returns a string. Even if the exception's message isnil, it still returns"(Exception)".
sl0thentr0py
approved these changes
Oct 24, 2022
Member
sl0thentr0py
left a comment
There was a problem hiding this comment.
nice! the only (negligible) concern I have is if this somehow affects grouping?
But I think it should be fine, let's merge it.
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
3 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.
Ruby 3.1 provided more detailed exception messages like
But the additional information was put directly input
Exception#message, which caused some problems (as described in this ticket).So in Ruby 3.2, the additional message will be put into the
Exception#detailed_message(proposal), which as a error monitoring service is what we should use.