bugsnag 6.13.1 → 6.14.0

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 Changelog
 =========
 
+## 6.14.0 (20 July 2020)
+
+### Enhancements
+
+* Add configurable `discard_classes` option to allow filtering errors using either a `String` or `Regexp` matched against the error's class name
+  | [#597](https://github.com/bugsnag/bugsnag-ruby/pull/597)
+
+* The Breadcrumb name limit of 30 characters has been removed
+  | [#600](https://github.com/bugsnag/bugsnag-ruby/pull/600)
+
+* Improve performance of payload cleaning
+  | [#601](https://github.com/bugsnag/bugsnag-ruby/pull/601)
+
+* Improve performance when processing stacktraces
+  | [#602](https://github.com/bugsnag/bugsnag-ruby/pull/602)
+  | [#603](https://github.com/bugsnag/bugsnag-ruby/pull/603)
+
+* If a custom object responds to `id` method, show the id and class in error reports
+  | [#531](https://github.com/bugsnag/bugsnag-ruby/pull/531)
+  | [manojmj92](https://github.com/manojmj92)
+
+### Deprecated
+
+* The `ignore_classes` configuration option has been deprecated in favour of `discard_classes`. `ignore_classes` will be removed in the next major release
+
 ## 6.13.1 (11 May 2020)
 
 ### Fixes

data/Gemfile

@@ -32,13 +32,15 @@ group :coverage, optional: true do
 end
 
 group :rubocop, optional: true do
-  gem 'rubocop', '~> 0.52.1'
+  gem 'rubocop', '~> 0.83'
 end
 
 group :sidekiq, optional: true do
   gem 'sidekiq', '~> 5.2.7'
   # redis 4.1.2 dropped support for Ruby 2.2
   gem 'redis', ruby_version < Gem::Version.new('2.3.0') ? '4.1.1' : '>= 4.1.2'
+  # rack 2.2.0 dropped support for Ruby 2.2
+  gem 'rack', ruby_version < Gem::Version.new('2.3.0') ? '< 2.2.0' : '~> 2.2'
 end
 
 group :doc, optional: true do

data/TESTING.md

@@ -42,7 +42,7 @@ aws configure --profile=opensource
 Subsequently you'll need to run the following commmand to authenticate with the registry:
 
 ```
-$(aws ecr get-login --profile=opensource --no-include-email)
+aws ecr get-login-password --profile=opensource | docker login --username AWS --password-stdin 855461928731.dkr.ecr.us-west-1.amazonaws.com
 ```
 
 __Your session will periodically expire__, so you'll need to run this command to re-authenticate when that happens.
@@ -64,7 +64,7 @@ Configure the tests to be run in the following way:
 When running the end-to-end tests, you'll want to restrict the feature files run to the specific test features for the platform.  This is done using the Cucumber CLI syntax at the end of the `docker-compose run ruby-maze-runner` command, i.e:
 
 ```
-RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run ruby-maze-runner features/rails_features --tags "@rails6"
+RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run --use-aliases ruby-maze-runner features/rails_features --tags "@rails6"
 ```
 
 - Plain ruby tests should target `features/plain_features`
@@ -75,7 +75,7 @@ RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run ruby-maze-runner featur
 In order to target specific features the exact `.feature` file can be specified, i.e:
 
 ```
-RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run ruby-maze-runner features/rails_features/app_version.feature --tags "@rails6"
+RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run --use-aliases ruby-maze-runner features/rails_features/app_version.feature --tags "@rails6"
 ```
 
 In order to avoid running flakey or unfinished tests, the tag `"not @wip"` can be added to the tags option. This is recommended for all CI runs. If a tag is already specified, this should be added using the `and` keyword, e.g. `--tags "@rails6 and not @wip"`

data/VERSION

@@ -1 +1 @@
-6.13.1
+6.14.0

data/dockerfiles/Dockerfile.ruby-maze-runner

@@ -20,7 +20,7 @@ COPY spec ./spec
 RUN gem build bugsnag.gemspec
 
 # The maze-runner node tests
-FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:v2-cli as ruby-maze-runner
+FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:latest-cli as ruby-maze-runner
 WORKDIR /app/
 COPY features ./features
 COPY --from=ruby-package-builder /app/bugsnag-*.gem bugsnag.gem

data/features/fixtures/rails3/app/config/initializers/bugsnag.rb

@@ -11,10 +11,11 @@ Bugsnag.configure do |config|
   config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
   config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
   config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+  config.meta_data_filters << 'filtered_parameter'
 
   if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
     config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
       breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
     end
   end
-end
+end

data/features/fixtures/rails4/app/config/initializers/bugsnag.rb

@@ -11,6 +11,7 @@ Bugsnag.configure do |config|
   config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
   config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
   config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+  config.meta_data_filters << 'filtered_parameter'
 
   if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
     config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|

data/features/fixtures/rails5/app/config/initializers/bugsnag.rb

@@ -11,6 +11,7 @@ Bugsnag.configure do |config|
   config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
   config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
   config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+  config.meta_data_filters << 'filtered_parameter'
 
   if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
     config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|

data/features/fixtures/rails6/app/config/initializers/bugsnag.rb

@@ -11,6 +11,7 @@ Bugsnag.configure do |config|
   config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
   config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
   config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+  config.meta_data_filters << 'filtered_parameter'
 
   if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
     config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|

data/features/rails_features/meta_data_filters.feature

@@ -3,12 +3,14 @@ Feature: Metadata filters
 @rails3 @rails4 @rails5 @rails6
 Scenario: Meta_data_filters should include Rails.configuration.filter_parameters
   Given I start the rails service
-  When I navigate to the route "/metadata_filters/filter" on the rails app
+  When I navigate to the route "/metadata_filters/filter?filtered_parameter=foo&other_parameter=bar" on the rails app
   And I wait to receive a request
   Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "unhandled" is false
   And the exception "errorClass" equals "RuntimeError"
   And the exception "message" starts with "handled string"
   And the event "app.type" equals "rails"
-  And the event "metaData.request.url" ends with "/metadata_filters/filter"
+  And the event "metaData.request.url" ends with "/metadata_filters/filter?filtered_parameter=[FILTERED]&other_parameter=bar"
   And the event "metaData.my_specific_filter" equals "[FILTERED]"
+  And the event "metaData.request.params.filtered_parameter" equals "[FILTERED]"
+  And the event "metaData.request.params.other_parameter" equals "bar"

data/lib/bugsnag.rb

@@ -33,6 +33,7 @@ require "bugsnag/breadcrumbs/validator"
 require "bugsnag/breadcrumbs/breadcrumb"
 require "bugsnag/breadcrumbs/breadcrumbs"
 
+# rubocop:todo Metrics/ModuleLength
 module Bugsnag
   LOCK = Mutex.new
   INTEGRATIONS = [:resque, :sidekiq, :mailman, :delayed_job, :shoryuken, :que, :mongo]
@@ -63,7 +64,7 @@ module Bugsnag
         auto_notify = false
       end
 
-      return unless deliver_notification?(exception, auto_notify)
+      return unless should_deliver_notification?(exception, auto_notify)
 
       exception = NIL_EXCEPTION_DESCRIPTION if exception.nil?
 
@@ -71,6 +72,7 @@ module Bugsnag
 
       # If this is an auto_notify we yield the block before the any middleware is run
       yield(report) if block_given? && auto_notify
+
       if report.ignore?
         configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in auto_notify block")
         return
@@ -97,6 +99,7 @@ module Bugsnag
         # If this is not an auto_notify then the block was provided by the user. This should be the last
         # block that is run as it is the users "most specific" block.
         yield(report) if block_given? && !auto_notify
+
         if report.ignore?
           configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in user provided block")
           return
@@ -111,13 +114,7 @@ module Bugsnag
           report.severity_reason = initial_reason
         end
 
-        # Deliver
-        configuration.info("Notifying #{configuration.notify_endpoint} of #{report.exceptions.last[:errorClass]}")
-        options = {:headers => report.headers}
-        payload = ::JSON.dump(Bugsnag::Helpers.trim_if_needed(report.as_json))
-        Bugsnag::Delivery[configuration.delivery_method].deliver(configuration.notify_endpoint, payload, configuration, options)
-        report_summary = report.summary
-        leave_breadcrumb(report_summary[:error_class], report_summary, Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE, :auto)
+        deliver_notification(report)
       end
     end
 
@@ -147,6 +144,7 @@ module Bugsnag
     # Configuration getters
     ##
     # Returns the client's Configuration object, or creates one if not yet created.
+    # @return [Configuration]
     def configuration
       @configuration = nil unless defined?(@configuration)
       @configuration || LOCK.synchronize { @configuration ||= Bugsnag::Configuration.new }
@@ -211,27 +209,40 @@ module Bugsnag
       validator.validate(breadcrumb)
 
       # Skip if it's already invalid
-      unless breadcrumb.ignore?
-        # Run callbacks
-        configuration.before_breadcrumb_callbacks.each do |c|
-          c.arity > 0 ? c.call(breadcrumb) : c.call
-          break if breadcrumb.ignore?
-        end
+      return if breadcrumb.ignore?
 
-        # Return early if ignored
-        return if breadcrumb.ignore?
+      # Run callbacks
+      configuration.before_breadcrumb_callbacks.each do |c|
+        c.arity > 0 ? c.call(breadcrumb) : c.call
+        break if breadcrumb.ignore?
+      end
+
+      # Return early if ignored
+      return if breadcrumb.ignore?
 
-        # Validate again in case of callback alteration
-        validator.validate(breadcrumb)
+      # Validate again in case of callback alteration
+      validator.validate(breadcrumb)
 
-        # Add to breadcrumbs buffer if still valid
-        configuration.breadcrumbs << breadcrumb unless breadcrumb.ignore?
+      # Add to breadcrumbs buffer if still valid
+      configuration.breadcrumbs << breadcrumb unless breadcrumb.ignore?
+    end
+
+    ##
+    # Returns the client's Cleaner object, or creates one if not yet created.
+    #
+    # @api private
+    #
+    # @return [Cleaner]
+    def cleaner
+      @cleaner = nil unless defined?(@cleaner)
+      @cleaner || LOCK.synchronize do
+        @cleaner ||= Bugsnag::Cleaner.new(configuration)
       end
     end
 
     private
 
-    def deliver_notification?(exception, auto_notify)
+    def should_deliver_notification?(exception, auto_notify)
       reason = abort_reason(exception, auto_notify)
       configuration.debug(reason) unless reason.nil?
       reason.nil?
@@ -249,6 +260,32 @@ module Bugsnag
       end
     end
 
+    ##
+    # Deliver the notification to Bugsnag
+    #
+    # @param report [Report]
+    # @return void
+    def deliver_notification(report)
+      configuration.info("Notifying #{configuration.notify_endpoint} of #{report.exceptions.last[:errorClass]}")
+
+      payload = report_to_json(report)
+      options = {:headers => report.headers}
+
+      Bugsnag::Delivery[configuration.delivery_method].deliver(
+        configuration.notify_endpoint,
+        payload,
+        configuration,
+        options
+      )
+
+      leave_breadcrumb(
+        report.summary[:error_class],
+        report.summary,
+        Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE,
+        :auto
+      )
+    end
+
     # Check if the API key is valid and warn (once) if it is not
     def check_key_valid
       @key_warning = false unless defined?(@key_warning)
@@ -273,7 +310,23 @@ module Bugsnag
         raise ArgumentError, "The session endpoint cannot be modified without the notify endpoint"
       end
     end
+
+    ##
+    # Convert the Report object to JSON
+    #
+    # We ensure the report is safe to send by removing recursion, fixing
+    # encoding errors and redacting metadata according to "meta_data_filters"
+    #
+    # @param report [Report]
+    # @return string
+    def report_to_json(report)
+      cleaned = cleaner.clean_object(report.as_json)
+      trimmed = Bugsnag::Helpers.trim_if_needed(cleaned)
+
+      ::JSON.dump(trimmed)
+    end
   end
 end
+# rubocop:enable Metrics/ModuleLength
 
 Bugsnag.load_integrations unless ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"]

data/lib/bugsnag/breadcrumbs/breadcrumbs.rb

@@ -1,6 +1,4 @@
 module Bugsnag::Breadcrumbs
-  MAX_NAME_LENGTH = 30
-
   VALID_BREADCRUMB_TYPES = [
     ERROR_BREADCRUMB_TYPE = "error",
     MANUAL_BREADCRUMB_TYPE = "manual",

data/lib/bugsnag/breadcrumbs/validator.rb

@@ -15,12 +15,6 @@ module Bugsnag::Breadcrumbs
     #
     # @param breadcrumb [Bugsnag::Breadcrumbs::Breadcrumb] the breadcrumb to be validated
     def validate(breadcrumb)
-      # Check name length
-      if breadcrumb.name.size > Bugsnag::Breadcrumbs::MAX_NAME_LENGTH
-        @configuration.debug("Breadcrumb name trimmed to length #{Bugsnag::Breadcrumbs::MAX_NAME_LENGTH}.  Original name: #{breadcrumb.name}")
-        breadcrumb.name = breadcrumb.name.slice(0...Bugsnag::Breadcrumbs::MAX_NAME_LENGTH)
-      end
-
       # Check meta_data hash doesn't contain complex values
       breadcrumb.meta_data = breadcrumb.meta_data.select do |k, v|
         if valid_meta_data_type?(v)

data/lib/bugsnag/cleaner.rb

@@ -1,19 +1,76 @@
 require 'uri'
 
 module Bugsnag
+  # @api private
   class Cleaner
     FILTERED = '[FILTERED]'.freeze
     RECURSION = '[RECURSION]'.freeze
     OBJECT = '[OBJECT]'.freeze
     RAISED = '[RAISED]'.freeze
+    OBJECT_WITH_ID_AND_CLASS = '[OBJECT]: [Class]: %<class_name>s [ID]: %<id>d'.freeze
 
-    def initialize(filters)
-      @filters = Array(filters)
-      @deep_filters = @filters.any? {|f| f.kind_of?(Regexp) && f.to_s.include?("\\.".freeze) }
+    ##
+    # @param configuration [Configuration]
+    def initialize(configuration)
+      @configuration = configuration
     end
 
-    def clean_object(obj)
-      traverse_object(obj, {}, nil)
+    def clean_object(object)
+      @deep_filters = deep_filters?
+
+      traverse_object(object, {}, nil)
+    end
+
+    ##
+    # @param url [String]
+    # @return [String]
+    def clean_url(url)
+      return url if @configuration.meta_data_filters.empty?
+
+      uri = URI(url)
+      return url unless uri.query
+
+      query_params = uri.query.split('&').map { |pair| pair.split('=') }
+      query_params.map! do |key, val|
+        if filters_match?(key)
+          "#{key}=#{FILTERED}"
+        else
+          "#{key}=#{val}"
+        end
+      end
+
+      uri.query = query_params.join('&')
+      uri.to_s
+    end
+
+    private
+
+    ##
+    # This method calculates whether we need to filter deeply or not; i.e. whether
+    # we should match both with and without 'request.params'
+    #
+    # This is cached on the instance variable '@deep_filters' for performance
+    # reasons
+    #
+    # @return [Boolean]
+    def deep_filters?
+      @configuration.meta_data_filters.any? do |filter|
+        filter.is_a?(Regexp) && filter.to_s.include?("\\.".freeze)
+      end
+    end
+
+    def clean_string(str)
+      if defined?(str.encoding) && defined?(Encoding::UTF_8)
+        if str.encoding == Encoding::UTF_8
+          str.valid_encoding? ? str : str.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
+        else
+          str.encode('utf-8', invalid: :replace, undef: :replace)
+        end
+      elsif defined?(Iconv)
+        Iconv.conv('UTF-8//IGNORE', 'UTF-8', str) || str
+      else
+        str
+      end
     end
 
     def traverse_object(obj, seen, scope)
@@ -28,12 +85,14 @@ module Bugsnag
       value = case obj
       when Hash
         clean_hash = {}
-        obj.each do |k,v|
+        obj.each do |k, v|
           begin
-            if filters_match_deeply?(k, scope)
+            current_scope = [scope, k].compact.join('.')
+
+            if filters_match_deeply?(k, current_scope)
               clean_hash[k] = FILTERED
             else
-              clean_hash[k] = traverse_object(v, seen, [scope, k].compact.join('.'))
+              clean_hash[k] = traverse_object(v, seen, current_scope)
             end
           # If we get an error here, we assume the key needs to be filtered
           # to avoid leaking things we shouldn't. We also remove the key itself
@@ -63,7 +122,12 @@ module Bugsnag
 
         # avoid leaking potentially sensitive data from objects' #inspect output
         if str =~ /#<.*>/
-          OBJECT
+          # Use id of the object if available
+          if obj.respond_to?(:id)
+            format(OBJECT_WITH_ID_AND_CLASS, class_name: obj.class, id: obj.id)
+          else
+            OBJECT
+          end
         else
           clean_string(str)
         end
@@ -73,67 +137,56 @@ module Bugsnag
       value
     end
 
-    def clean_string(str)
-      if defined?(str.encoding) && defined?(Encoding::UTF_8)
-        if str.encoding == Encoding::UTF_8
-          str.valid_encoding? ? str : str.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
+    ##
+    # @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.encode('utf-8', invalid: :replace, undef: :replace)
+          str.include?(filter.to_s)
         end
-      elsif defined?(Iconv)
-        Iconv.conv('UTF-8//IGNORE', 'UTF-8', str) || str
-      else
-        str
       end
     end
 
-    def self.clean_object_encoding(obj)
-      new(nil).clean_object(obj)
-    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
+    # "request.params." bit.
+    #
+    # @param key [String, #to_s]
+    # @param scope [String]
+    # @return [Boolean]
+    def filters_match_deeply?(key, scope)
+      return false unless scope_should_be_filtered?(scope)
 
-    def clean_url(url)
-      return url if @filters.empty?
+      return true if filters_match?(key)
+      return false unless @deep_filters
 
-      uri = URI(url)
-      return url unless uri.query
+      return true if filters_match?(scope)
 
-      query_params = uri.query.split('&').map { |pair| pair.split('=') }
-      query_params.map! do |key, val|
-        if filters_match?(key)
-          "#{key}=#{FILTERED}"
+      @configuration.scopes_to_filter.any? do |scope_to_filter|
+        if scope.start_with?("#{scope_to_filter}.request.params.")
+          filters_match?(scope.sub("#{scope_to_filter}.request.params.", ''))
         else
-          "#{key}=#{val}"
+          filters_match?(scope.sub("#{scope_to_filter}.", ''))
         end
       end
-
-      uri.query = query_params.join('&')
-      uri.to_s
     end
 
-    private
-
-    def filters_match?(key)
-      str = key.to_s
-
-      @filters.any? do |f|
-        case f
-        when Regexp
-          str.match(f)
-        else
-          str.include?(f.to_s)
-        end
+    ##
+    # Should the given scope be filtered?
+    #
+    # @param scope [String]
+    # @return [Boolean]
+    def scope_should_be_filtered?(scope)
+      @configuration.scopes_to_filter.any? do |scope_to_filter|
+        scope.start_with?("#{scope_to_filter}.")
       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 "request.params." bit.
-    def filters_match_deeply?(key, scope)
-      return true if filters_match?(key)
-      return false unless @deep_filters
-
-      long = [scope, key].compact.join('.')
-      short = long.sub(/^request\.params\./, '')
-      filters_match?(long) || filters_match?(short)
-    end
   end
 end