Add on_breadcrumb
callbacks to replace before_breadcrumb_callbacks
#686
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.
Goal
Adds
on_breadcrumb
callbacks, which will replacebefore_breadcrumb_callbacks
in the next major releaseThe API is similar to
on_error
callbacks:The semantics also follow
on_error
callbacks:false
from a callback will discard the breadcrumb and stop any subsequent callbacks from running#call
is a valid callbackChangeset
Bugsnag::Breadcrumbs::OnBreadcrumbCallbackList
which manages the callbacks and can call them with the correct semanticsBugnsag#add_on_breadcrumb
,Bugnsag#remove_on_breadcrumb
,Bugnsag#add_on_breadcrumb
andBugnsag::Configuration#remove_on_breadcrumb
Bugsnag#leave_breadcrumb
to call the new callbacks via theOnBreadcrumbCallbackList
Testing
This is tested both in tests specifically for
OnBreadcrumbCallbackList
to ensure the semantics are correct and as part of the main set ofBugsnag
tests to ensure they are called when leaving a breadcrumbThere are big whitespace changes in
bugsnag_spec.rb
to splitbefore_breadcrumb_callbacks
into their owndescribe
, so it's easier to review that file by ignoring whitespace