bugsnag 6.20.0 → 6.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe6701fa69f8d7c3c78476d17d127f921a6f730cdd3b618f92e6f7c2483da74
-  data.tar.gz: '0857ab0742b7a33acfa39a60f4ecf9114f20b30293c78ef7bb1d1ba52ddef664'
+  metadata.gz: ee1b5d5046b6ba8e68cf45b4ccac412c02051c774bcf8e205c97b4254d058468
+  data.tar.gz: 787717ba06a5bba3266c0030e8de943bf02fe4c6a9c6d979ec4bf543aa7d82bd
 SHA512:
-  metadata.gz: 3a917b2fc75798b3bd5e95416ab8c26f013133c84739f9d58df7bbd687de5b736184d11eae1e604944ba85267f214999f4a552e7beef1b271401e8598841a966
-  data.tar.gz: abb394a0305a254ce1fda64eba446e49949142f42480e6adf176bf1e62e5cfe6a0280421afbfbefda48bfa3dab31f815891705de4eb1d0d59df2b520575aea93
+  metadata.gz: e53bfdf8c6c23f2a9e4412fbca888884936c3c26ff5f1262f80aa5081a8edb3ba51a6e0a64065c41490efc20c1fe32d8795ec841f09f733062d3691c0c007e2e
+  data.tar.gz: 3fe002c3a094014f0fbb56a1863ed309b50b4e733cd651df0136ad8af2f72c6759d122baf7f6bbb34607baf18631395000bd9fd7312eec432b7dce14482d9cef

data/CHANGELOG.md

@@ -1,6 +1,116 @@
 Changelog
 =========
 
+## v6.24.0 (6 October 2021)
+
+### Enhancements
+
+* Allow overriding an event's unhandled flag
+  | [#698](https://github.com/bugsnag/bugsnag-ruby/pull/698)
+* Add the ability to store metadata globally
+  | [#699](https://github.com/bugsnag/bugsnag-ruby/pull/699)
+* Add `cookies`, `body` and `httpVersion` to the automatically captured request data for Rack apps
+  | [#700](https://github.com/bugsnag/bugsnag-ruby/pull/700)
+* Add `Configuration#endpoints` for reading the notify and sessions endpoints and `Configuration#endpoints=` for setting them
+  | [#701](https://github.com/bugsnag/bugsnag-ruby/pull/701)
+* Add `Configuration#redacted_keys`. This is like `meta_data_filters` but matches strings with case-insensitive equality, rather than matching based on inclusion
+  | [#703](https://github.com/bugsnag/bugsnag-ruby/pull/703)
+* Allow pausing and resuming sessions, giving more control over the stability score
+  | [#704](https://github.com/bugsnag/bugsnag-ruby/pull/704)
+* Add `Configuration#vendor_paths` to replace `Configuration#vendor_path`
+  | [#705](https://github.com/bugsnag/bugsnag-ruby/pull/705)
+
+### Deprecated
+
+* In the next major release, `params` will only contain query string parameters. Currently it also contains the request body for form data requests, but this is deprecated in favour of the new `body` property
+* The `Configuration#set_endpoints` method is now deprecated in favour of `Configuration#endpoints=`
+* The `Configuration#meta_data_filters` option is now deprecated in favour of `Configuration#redacted_keys`
+* The `Configuration#vendor_path` option is now deprecated in favour of `Configuration#vendor_paths`
+
+## v6.23.0 (21 September 2021)
+
+### Enhancements
+
+* Sessions will now be delivered every 10 seconds, instead of every 30 seconds
+  | [#680](https://github.com/bugsnag/bugsnag-ruby/pull/680)
+* Log errors that prevent delivery at `ERROR` level
+  | [#681](https://github.com/bugsnag/bugsnag-ruby/pull/681)
+* Add `on_breadcrumb` callbacks to replace `before_breadcrumb_callbacks`
+  | [#686](https://github.com/bugsnag/bugsnag-ruby/pull/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](https://github.com/bugsnag/bugsnag-ruby/pull/687)
+  | [#688](https://github.com/bugsnag/bugsnag-ruby/pull/688)
+* Add `Bugsnag#breadcrumbs` getter to fetch the current list of breadcrumbs
+  | [#689](https://github.com/bugsnag/bugsnag-ruby/pull/689)
+* Add `time` (an ISO8601 string in UTC) to `device` metadata
+  | [#690](https://github.com/bugsnag/bugsnag-ruby/pull/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](https://github.com/bugsnag/bugsnag-ruby/pull/691)
+* Add `original_error` to `Report`/`Event` containing the original Exception instance
+  | [#692](https://github.com/bugsnag/bugsnag-ruby/pull/692)
+* Add `request` to `Report`/`Event` containing HTTP request metadata
+  | [#693](https://github.com/bugsnag/bugsnag-ruby/pull/693)
+* Add `add_metadata` and `clear_metadata` to `Report`/`Event`
+  | [#694](https://github.com/bugsnag/bugsnag-ruby/pull/694)
+* Add `set_user` to `Report`/`Event`
+  | [#695](https://github.com/bugsnag/bugsnag-ruby/pull/695)
+
+### Fixes
+
+* Avoid starting session delivery thread when the current release stage is not enabled
+  | [#677](https://github.com/bugsnag/bugsnag-ruby/pull/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](https://github.com/bugsnag/bugsnag-ruby/pull/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
+
+## v6.22.1 (11 August 2021)
+
+### Fixes
+
+* Fix possible `LocalJumpError` introduced in v6.22.0
+  | [#675](https://github.com/bugsnag/bugsnag-ruby/pull/675)
+
+## v6.22.0 (10 August 2021)
+
+### Enhancements
+
+* Add support for tracking exceptions and capturing metadata in Active Job, when not using an existing integration
+  | [#670](https://github.com/bugsnag/bugsnag-ruby/pull/670)
+
+* Improve the report context when using Delayed Job or Resque as the Active Job queue adapter
+  | [#671](https://github.com/bugsnag/bugsnag-ruby/pull/671)
+
+## v6.21.0 (23 June 2021)
+
+### Enhancements
+
+* Allow a `Method` or any object responding to `#call` to be used as an `on_error` callback or middleware
+  | [#662](https://github.com/bugsnag/bugsnag-ruby/pull/662)
+  | [odlp](https://github.com/odlp)
+
+### Fixes
+
+* Deliver when an error is raised in the block argument to `notify`
+  | [#660](https://github.com/bugsnag/bugsnag-ruby/pull/660)
+  | [aki77](https://github.com/aki77)
+* Fix potential `NoMethodError` in `Bugsnag::Railtie` when using `require: false` in a Gemfile
+  | [#666](https://github.com/bugsnag/bugsnag-ruby/pull/666)
+
 ## v6.20.0 (29 March 2021)
 
 ### Enhancements

data/VERSION

@@ -1 +1 @@
-6.20.0
+6.24.0

data/lib/bugsnag/breadcrumb_type.rb

@@ -0,0 +1,14 @@
+require "bugsnag/breadcrumbs/breadcrumbs"
+
+module Bugsnag
+  module BreadcrumbType
+    ERROR = Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
+    LOG = Bugsnag::Breadcrumbs::LOG_BREADCRUMB_TYPE
+    MANUAL = Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE
+    NAVIGATION = Bugsnag::Breadcrumbs::NAVIGATION_BREADCRUMB_TYPE
+    PROCESS = Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE
+    REQUEST = Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE
+    STATE = Bugsnag::Breadcrumbs::STATE_BREADCRUMB_TYPE
+    USER = Bugsnag::Breadcrumbs::USER_BREADCRUMB_TYPE
+  end
+end

data/lib/bugsnag/breadcrumbs/breadcrumb.rb

@@ -1,11 +1,13 @@
 module Bugsnag::Breadcrumbs
   class Breadcrumb
+    # @deprecated Use {#message} instead
     # @return [String] the breadcrumb name
     attr_accessor :name
 
     # @return [String] the breadcrumb type
     attr_accessor :type
 
+    # @deprecated Use {#metadata} instead
     # @return [Hash, nil] metadata hash containing strings, numbers, or booleans, or nil
     attr_accessor :meta_data
 
@@ -23,7 +25,7 @@ module Bugsnag::Breadcrumbs
     # @api private
     #
     # @param name [String] the breadcrumb name
-    # @param type [String] the breadcrumb type from Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES
+    # @param type [String] the breadcrumb type from Bugsnag::BreadcrumbType
     # @param meta_data [Hash, nil] a hash containing strings, numbers, or booleans, or nil
     # @param auto [Symbol] set to `:auto` if the breadcrumb is automatically generated
     def initialize(name, type, meta_data, auto)
@@ -72,5 +74,36 @@ module Bugsnag::Breadcrumbs
         :timestamp => @timestamp.iso8601(3)
       }
     end
+
+    # TODO: "message" and "metadata" can be simple attr_accessors when they
+    #       replace "name" and "meta_data"
+    # NOTE: these are not aliases as YARD doesn't allow documenting the non-alias
+    #       as deprecated without also marking the alias as deprecated
+
+    # The breadcrumb message
+    # @!attribute message
+    # @return [String]
+    def message
+      @name
+    end
+
+    # @param message [String]
+    # @return [void]
+    def message=(message)
+      @name = message
+    end
+
+    # A Hash containing arbitrary metadata associated with this breadcrumb
+    # @!attribute metadata
+    # @return [Hash, nil]
+    def metadata
+      @meta_data
+    end
+
+    # @param metadata [Hash, nil]
+    # @return [void]
+    def metadata=(metadata)
+      @meta_data = metadata
+    end
   end
 end

data/lib/bugsnag/breadcrumbs/breadcrumbs.rb

@@ -1,4 +1,5 @@
 module Bugsnag::Breadcrumbs
+  # @deprecated Use {Bugsnag::BreadcrumbType} instead
   VALID_BREADCRUMB_TYPES = [
     ERROR_BREADCRUMB_TYPE = "error",
     MANUAL_BREADCRUMB_TYPE = "manual",

data/lib/bugsnag/breadcrumbs/on_breadcrumb_callback_list.rb

@@ -0,0 +1,50 @@
+require "set"
+
+module Bugsnag::Breadcrumbs
+  class OnBreadcrumbCallbackList
+    def initialize(configuration)
+      @callbacks = Set.new
+      @mutex = Mutex.new
+      @configuration = configuration
+    end
+
+    ##
+    # @param callback [Proc, Method, #call]
+    # @return [void]
+    def add(callback)
+      @mutex.synchronize do
+        @callbacks.add(callback)
+      end
+    end
+
+    ##
+    # @param callback [Proc, Method, #call]
+    # @return [void]
+    def remove(callback)
+      @mutex.synchronize do
+        @callbacks.delete(callback)
+      end
+    end
+
+    ##
+    # @param breadcrumb [Breadcrumb]
+    # @return [void]
+    def call(breadcrumb)
+      @callbacks.each do |callback|
+        begin
+          should_continue = callback.call(breadcrumb)
+        rescue StandardError => e
+          @configuration.warn("Error occurred in on_breadcrumb callback: '#{e}'")
+          @configuration.warn("on_breadcrumb callback stacktrace: #{e.backtrace.inspect}")
+        end
+
+        # only stop if should_continue is explicity 'false' to allow callbacks
+        # to return 'nil'
+        if should_continue == false
+          breadcrumb.ignore!
+          break
+        end
+      end
+    end
+  end
+end

data/lib/bugsnag/cleaner.rb

@@ -25,7 +25,7 @@ module Bugsnag
     # @param url [String]
     # @return [String]
     def clean_url(url)
-      return url if @configuration.meta_data_filters.empty?
+      return url if @configuration.meta_data_filters.empty? && @configuration.redacted_keys.empty?
 
       uri = URI(url)
       return url unless uri.query
@@ -43,6 +43,33 @@ module Bugsnag
       uri.to_s
     end
 
+    ##
+    # @param key [String, #to_s]
+    # @return [Boolean]
+    def filters_match?(key)
+      str = key.to_s
+
+      matched = @configuration.meta_data_filters.any? do |filter|
+        case filter
+        when Regexp
+          str.match(filter)
+        else
+          str.include?(filter.to_s)
+        end
+      end
+
+      return true if matched
+
+      @configuration.redacted_keys.any? do |redaction_pattern|
+        case redaction_pattern
+        when Regexp
+          str.match(redaction_pattern)
+        when String
+          str.downcase == redaction_pattern.downcase
+        end
+      end
+    end
+
     private
 
     ##
@@ -54,9 +81,11 @@ module Bugsnag
     #
     # @return [Boolean]
     def deep_filters?
-      @configuration.meta_data_filters.any? do |filter|
+      is_deep_filter = proc do |filter|
         filter.is_a?(Regexp) && filter.to_s.include?("\\.".freeze)
       end
+
+      @configuration.meta_data_filters.any?(&is_deep_filter) || @configuration.redacted_keys.any?(&is_deep_filter)
     end
 
     def clean_string(str)
@@ -137,22 +166,6 @@ module Bugsnag
       value
     end
 
-    ##
-    # @param key [String, #to_s]
-    # @return [Boolean]
-    def filters_match?(key)
-      str = key.to_s
-
-      @configuration.meta_data_filters.any? do |filter|
-        case filter
-        when Regexp
-          str.match(filter)
-        else
-          str.include?(filter.to_s)
-        end
-      end
-    end
-
     ##
     # If someone has a Rails filter like /^stuff\.secret/, it won't match
     # "request.params.stuff.secret", so we try it both with and without the