Expose exception message via #to_s
#90
Closed
Conversation
This file contains 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
Exceptions in Ruby return the exception message when calling `#to_s` on
it:
```
> irb
irb(main):001:0> StandardError.new("Hi").to_s
=> "Hi"
```
Because this is default behaviour, libraries sometimes depend on `to_s`
to get a readable version of the exception message. For example, Sentry
does it to the exception a name:
https://github.com/getsentry/raven-ruby/blob/065cf973cb0ad3672d0d213e80b
6e8a9a8e6f8cb/lib/raven/event.rb#L144
Currently, Sentry reports do not show the error message set when
raising the exception - only “Notifications::Client::BadRequestError”.
This is because we’re only defining `RequestError#message`. This is
apparently not the same as initialising an exception with a message, as
you can see here:
```
> be rails c
Loading development environment (Rails 6.0.2.1)
[1] pry(main)>
Notifications::Client::BadRequestError.new(OpenStruct.new(code: "hey",
body: {errors: [{error: "BadRequestError", message: "Can’t send to this
recipient using a team-only API key"}] }.to_json )).to_s
=> "Notifications::Client::BadRequestError"
[2] pry(main)>
Notifications::Client::BadRequestError.new(OpenStruct.new(code: "hey",
body: {errors: [{error: "BadRequestError", message: "Can’t send to this
recipient using a team-only API key"}] }.to_json )).message
=> "BadRequestError: Can’t send to this recipient using a team-only API
key"
```
The issue was introduced in
#73 /
#72, which
removed the explicit `to_s` method.
This commit fixes the issue by constructing the message . Note that
we’ve renamed the `message` method, but calling `e.message` still works
because it’s part of the exception interface. Another option would be
to add the `to_s` method back (like I experimented with in
https://github.com/DFE-Digital/apply-for-postgraduate-teacher-training/p
ull/1024), but this solution seems the most Ruby-esque and relies on
less knowledge of Exception internals.
This change is backwards compatible.
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.
Recreating @tijmenb's PR (#89) to get concourse to run it.