Release v6.23.0 #697

imjoehaines · 2021-09-17T10:48:25Z

Enhancements

Sessions will now be delivered every 10 seconds, instead of every 30 seconds
| #680
Log errors that prevent delivery at ERROR level
| #681
Add on_breadcrumb callbacks to replace before_breadcrumb_callbacks
| #686
Add context attribute to configuration, which will be used as the default context for events. Using this option will disable automatic context setting
| #687
| #688
Add Bugsnag#breadcrumbs getter to fetch the current list of breadcrumbs
| #689
Add time (an ISO8601 string in UTC) to device metadata
| #690
Add errors to Report/Event containing an array of Error objects. The Error object contains error_class, error_message, stacktrace and type (always "ruby")
| #691
Add original_error to Report/Event containing the original Exception instance
| #692
Add request to Report/Event containing HTTP request metadata
| #693
Add add_metadata and clear_metadata to Report/Event
| #694
Add set_user to Report/Event
| #695

Fixes

Avoid starting session delivery thread when the current release stage is not enabled
| #677

Deprecated

before_breadcrumb_callbacks have been deprecated in favour of on_breadcrumb callbacks and will be removed in the next major release
For consistency with Bugsnag notifiers for other languages, a number of methods have been deprecated in this release. The old options will be removed in the next major version | #676
- The notify_release_stages configuration option has been deprecated in favour of enabled_release_stages
- The auto_capture_sessions and track_sessions configuration options have been deprecated in favour of auto_track_sessions
- The enabled_automatic_breadcrumb_types configuration option has been deprecated in favour of enabled_breadcrumb_types
- The Report class has been deprecated in favour of the Event class
- The Report#meta_data attribute has been deprecated in favour of Event#metadata
- The Breadcrumb#meta_data attribute has been deprecated in favour of Breadcrumb#metadata
- The Breadcrumb#name attribute has been deprecated in favour of Breadcrumb#message
- The breadcrumb type constants in the Bugsnag::Breadcrumbs module has been deprecated in favour of the constants available in the Bugsnag::BreadcrumbType module
  For example, Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE is now available as Bugsnag::BreadcrumbType::ERROR
Report#exceptions has been deprecated in favour of the new errors property
Report#raw_exceptions has been deprecated in favour of the new original_error property
Accessing request data via Report#metadata has been deprecated in favour of using the new request property. Request data will be moved out of metadata in the next major version
The Report#add_tab and Report#remove_tab methods have been deprecated in favour of the new add_metadata and clear_metadata methods

This will eventually replace the breadcrumb types in the Bugsnag::Breadcrumbs module

This will eventually replace notify_release_stages entirely, but for now exists as an alias

By using them in the Rails 5 app, but not the Rails 4 & 6 apps, we can be more confident that the aliases work exactly as the old names did

Co-authored-by: Delisa <[email protected]>

Deprecate and provide replacements for inconsistent methods

…ease-stage Don't start sessions when the current release stage is not enabled

Send sessions every 10 seconds instead of every 30 seconds

This should help to differentiate errors that prevent things from being delivered from errors that we can continue from, e.g. errors raised in middleware

Log delivery failures as errors

Add tests for successful active job execution

…elog Add missing deprecation to changelog

This manages and calls any registered on_breadcrumb callbacks

This stores the original Exception instance directly. This is different to 'raw_exceptions' because 'raw_exceptions' traverses 'cause' chains to build an array of Exception objects and attempts to normalise non-Exception objects into Exceptions

This currently reads from metadata to avoid a breaking change, however this will be extracted from metadata as it's a top-level field in the API

Add `errors` to Report/Event

Add `original_error` to Report/Event

Add `request` to Report/Event

This class handles the various ways metadata can be updated so this logic can be reused in multiple classes

This will let us re-use them in other tests, to ensure all classes support every use-case of the metadata delegate

These can be replaced with add/clear metadata

Improve metadata API in Report/Event

Add the stacktrace to `Error`s

Add `set_user` to Report/Event

imjoehaines and others added 30 commits August 12, 2021 15:04

Add Bugsnag::BreadcrumbType module

7bea4f0

This will eventually replace the breadcrumb types in the Bugsnag::Breadcrumbs module

Add Configuration#enabled_release_stages

5eff8c0

This will eventually replace notify_release_stages entirely, but for now exists as an alias

Add message & metadata to replace name & meta_data

afa4599

Add Configuration#enabled_breadcrumb_types

63050e4

Add metadata to Report to replace meta_data

4ff542e

Add Event as an alias of the Report class

8fc8894

Add Configuration#auto_track_sessions

1154aaa

Use the new property names in some MR tests

9cf9d76

By using them in the Rails 5 app, but not the Rails 4 & 6 apps, we can be more confident that the aliases work exactly as the old names did

Update changelog

c987ca7

Update CHANGELOG.md

44c0494

Co-authored-by: Delisa <[email protected]>

Merge pull request #676 from bugsnag/aliases

5ca25e8

Deprecate and provide replacements for inconsistent methods

Don't start a session in a disabled release stage

e31e408

Update changelog

86a9aa6

Merge pull request #677 from bugsnag/dont-start-sessions-in-wrong-rel…

e03bebd

…ease-stage Don't start sessions when the current release stage is not enabled

Deliver sessions every 10 seconds

3ad02fd

Update changelog

abe01c7

Merge pull request #680 from bugsnag/send-sessions-more-frequently

444c8d6

Send sessions every 10 seconds instead of every 30 seconds

Refactor logging tests to use a real Logger

9bf9dd8

Add Configuration#error to log error messages

7b4b57c

Log delivery failures at error level

52f67e7

This should help to differentiate errors that prevent things from being delivered from errors that we can continue from, e.g. errors raised in middleware

Update changelog

693a666

Merge pull request #681 from bugsnag/log-delivery-failures-as-errors

1bcfe6a

Log delivery failures as errors

Add tests for a job that does not raise

a1daac7

Allow rails_integration fixture to be run manually

f4602ff

Add routes & a controller to queue jobs

448fb37

Add missing deprecation to changelog

1084ebb

Merge pull request #682 from bugsnag/tests-for-successful-job-execution

616210e

Add tests for successful active job execution

Merge pull request #684 from bugsnag/add-missing-deprecation-to-chang…

574b3dd

…elog Add missing deprecation to changelog

Add OnBreadcrumbCallbackList class

f4030f9

This manages and calls any registered on_breadcrumb callbacks

Handle errors raised in on_breadcrumb callbacks

c4de39f

imjoehaines added 26 commits September 6, 2021 13:26

Update changelog

6cb175e

Add 'original_error' attribute

d45a084

This stores the original Exception instance directly. This is different to 'raw_exceptions' because 'raw_exceptions' traverses 'cause' chains to build an array of Exception objects and attempts to normalise non-Exception objects into Exceptions

Update changelog

46c9a84

Refactor Rack spec to use a real Report instance

8bc5558

Add Report#request to fetch HTTP request data

2467be3

This currently reads from metadata to avoid a breaking change, however this will be extracted from metadata as it's a top-level field in the API

Update changelog

87b39ac

Add a MR test for all request data

d10d22e

Add MR test showing request data can be mutated

452d0d8

Merge pull request #691 from bugsnag/add-report-errors

91eee12

Add `errors` to Report/Event

Merge pull request #692 from bugsnag/add-original-error

e1938de

Add `original_error` to Report/Event

Merge pull request #693 from bugsnag/add-report-request

6710a46

Add `request` to Report/Event

Add MetadataDelegate utility class

95abdd9

This class handles the various ways metadata can be updated so this logic can be reused in multiple classes

Move metadata delegate tests into shared examples

aa0f7dc

This will let us re-use them in other tests, to ensure all classes support every use-case of the metadata delegate

Add #add_metadata and #clear_metadata methods

4f8d6f9

Deprecated add_tab & remove_tab

cb0e926

These can be replaced with add/clear metadata

Update changelog

17bdb42

Merge pull request #694 from bugsnag/improve-metadata-api

d5ae38c

Improve metadata API in Report/Event

Add the stacktrace to each Error

1074a63

Refactor Error class to make stacktrace readonly

9f3a75f

Add Report#set_user

6e63b62

Update changelog

91ff9c7

Merge pull request #695 from bugsnag/add-stacktrace-to-errors

bc36cd1

Add the stacktrace to `Error`s

Merge pull request #696 from bugsnag/add-set-user-to-report

e8fe0d2

Add `set_user` to Report/Event

Add stacktrace to Error object summary

ca54356

Update changelog

2089377

Bump version

00460bf

imjoehaines requested a review from kattrali September 17, 2021 10:48

kattrali approved these changes Sep 20, 2021

View reviewed changes

imjoehaines merged commit 13fe956 into master Sep 21, 2021

imjoehaines deleted the release/v6.23.0 branch September 21, 2021 08:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release v6.23.0 #697

Release v6.23.0 #697

imjoehaines commented Sep 17, 2021

Release v6.23.0 #697

Release v6.23.0 #697

Conversation

imjoehaines commented Sep 17, 2021

Enhancements

Fixes

Deprecated