Pass breadcrumb context through to the background Future #175
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
* Swaps to `Appraisal` gem for using different gemsets when testing * Modify JS exception tracking injection to handle Rack::Body * Adds Rails 7.1 dummy app and add to CI matrix
|
Waiting on rebase before reviewing :) |
Hi, I wrote something like this into our raygun wrapper module in our application code and thought might as well see if you think more of your users would enjoy this feature.
### Contrived illustration of the problem
Instantiated and Tracked vs Instantiated, Raised, Rescued, and Tracked
#### Instantiated and Tracked
This error has `backtrace` of `nil`:
```ruby
error = StandardError.new("I'm an error")
Vydia::ErrorTracker.track_exception(error) unless some_condition?
```
vs
#### Instantiated, Raised, Rescued, and Tracked
This error has a complete `backtrace`:
```ruby
begin
raise StandardError.new("I'm an error") unless some_condition?
rescue StandardError => error
Vydia::ErrorTracker.track_exception(error)
end
```
### Easiest solution
- This PR makes it so if the `error` does not have a `backtrace` already, `track_exception` will call `set_backtrace` and pass in the current callstack using [Ruby `Kernel`'s `caller` method thanks to this StackOverflow post](https://stackoverflow.com/a/21620257/2696867)
#### Avoid this message on your errors in raygun portal:
> No stacktrace data is available for this error.
> Find out why script errors can contain missing details.
> If the error was manually sent then check that the data contains a properly formed error payload. Read our API documentation for more information.
## Caveats
- Now `track_exception` is mutating its argument. This is fine for me in our application code, but probably not ideal for library code. Maybe you'd want to `.dup` the error and mutate that one instead of mutating the argument error object directly?
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.
This should close #146
(NB this branches from #174, so we should merge that first)