bugsnag 5.3.3 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0f59a73d8f4b8c5594828664573e892ecf8bd49
-  data.tar.gz: ec14896b7774fac186b1db8e42c5e41b233e4555
+  metadata.gz: 1d3869fd6bf3186cfc8d91a049cba4a365d97b64
+  data.tar.gz: fb2cd85bf8583242d04d10f7962cae0dc19d6b6c
 SHA512:
-  metadata.gz: 4a20576b59c6a146d2290a6a65a8ac13d30c75aaa76f0b2cfd216d0c7505b36af8a10b4f0269bc869e926b50c844cf435bd10634fc5c118e251f85b9d8bd3d59
-  data.tar.gz: 52fbb7da5f06de0f178c3c0d3b37c84cdbdcd79421923764a26dd6753b400fd509df3efe62862d51fe55a888d2b5db39eb711812e5470df82588d49b1bb03d05
+  metadata.gz: 28e4baccdf37a126880827fe389c19ae3c2e44719257509fdcb031192a7485d6b879bec48f2440c34ec1a76a716db68a3076d9567368f50d9e6d2f8363b73559
+  data.tar.gz: ea9958e1172c387a2b6b6c1864218be3489870f66e2f68ff6e007e46d1724ab9baa40d06760e0ed00b9c0f0412f0d8869d8450c5bcc7932433ccebb6308e0840

data/.travis.yml

@@ -10,4 +10,7 @@ rvm:
 - jruby-19mode
 
 before_install:
+- gem install bundler -v 1.12
+- gem update --system
+- bundle --version
 - gem --version

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## 5.4.0 (02 Oct 2017)
+
+### Enhancements
+
+* Add a one-time warning if the API key is not set
+* Track whether errors were captured automatically and by which middleware
+
 ## 5.3.3 (16 June 2017)
 
 * [Rails] Fix failure to report when encountering objects which throw in `to_s`

data/VERSION

@@ -1 +1 @@
-5.3.3
+5.4.0

data/issue_template.md

@@ -0,0 +1,18 @@
+### Expected behavior
+*[Insert details on expected behaviour]*
+
+### Observed behavior
+*[Insert details on observed behaviour]*
+
+### Steps to reproduce
+*[Insert reproduction steps (if known)]*
+
+### Version
+*[Insert version information]*
+
+### Additional information
+*[Insert any additional information]*
+
+#### Can't comment on Issues?
+Some users have been unable to comment on Github issues when an [adblocker extension is enabled](https://docs.bugsnag.com/platforms/browsers/faq/#is-bugsnag-blocked-by-ad-blockers).
+We recommend temporarily disabling the extension, or if that fails, contacting support@bugsnag.com.

data/lib/bugsnag.rb

@@ -24,6 +24,7 @@ require "bugsnag/middleware/sidekiq"
 require "bugsnag/middleware/mailman"
 require "bugsnag/middleware/rake"
 require "bugsnag/middleware/callbacks"
+require "bugsnag/middleware/classify_error"
 
 module Bugsnag
   LOG_PREFIX = "** [Bugsnag] "
@@ -43,6 +44,17 @@ module Bugsnag
       # Use resque for asynchronous notification if required
       require "bugsnag/delay/resque" if configuration.delay_with_resque && defined?(Resque)
 
+      # Add info error classifier to internal middleware
+      configuration.internal_middleware.use(Bugsnag::Middleware::ClassifyError)
+
+      # Warn if an api_key hasn't been set
+      @key_warning = false unless defined?(@key_warning)
+
+      if !configuration.api_key && !@key_warning
+        warn "No API key has been set, check your configuration"
+        @key_warning = true
+      end
+
       # Log that we are ready to rock
       @logged_ready = false unless defined?(@logged_ready)
 
@@ -56,8 +68,19 @@ module Bugsnag
     def notify(exception, overrides=nil, request_data=nil, &block)
       notification = Notification.new(exception, configuration, overrides, request_data)
 
+      initial_severity = notification.severity
+      initial_reason = notification.severity_reason
+
       yield(notification) if block_given?
 
+      if notification.severity != initial_severity
+        notification.severity_reason = {
+          :type => Bugsnag::Notification::USER_CALLBACK_SET_SEVERITY
+        }
+      else
+        notification.severity_reason = initial_reason
+      end
+
       unless notification.ignore?
         notification.deliver
         notification
@@ -72,7 +95,8 @@ module Bugsnag
     # error class
     def auto_notify(exception, overrides=nil, request_data=nil, &block)
       overrides ||= {}
-      overrides.merge!({:severity => "error"})
+      overrides[:severity] = "error" unless overrides.has_key? :severity
+      overrides[:unhandled] = true unless overrides.has_key? :unhandled
       notify_or_ignore(exception, overrides, request_data, &block) if configuration.auto_notify
     end
 

data/lib/bugsnag/configuration.rb

@@ -45,20 +45,6 @@ module Bugsnag
       "rack.request.form_vars"
     ].freeze
 
-    DEFAULT_IGNORE_CLASSES = [
-      "AbstractController::ActionNotFound",
-      "ActionController::InvalidAuthenticityToken",
-      "ActionController::ParameterMissing",
-      "ActionController::UnknownAction",
-      "ActionController::UnknownFormat",
-      "ActionController::UnknownHttpMethod",
-      "ActiveRecord::RecordNotFound",
-      "CGI::Session::CookieStore::TamperedWithCookie",
-      "Mongoid::Errors::DocumentNotFound",
-      "SignalException",
-      "SystemExit",
-    ].freeze
-
     DEFAULT_IGNORE_USER_AGENTS = [].freeze
 
     DEFAULT_DELIVERY_METHOD = :thread_queue
@@ -72,7 +58,7 @@ module Bugsnag
       self.send_environment = false
       self.send_code = true
       self.params_filters = Set.new(DEFAULT_PARAMS_FILTERS)
-      self.ignore_classes = Set.new(DEFAULT_IGNORE_CLASSES)
+      self.ignore_classes = Set.new()
       self.ignore_user_agents = Set.new(DEFAULT_IGNORE_USER_AGENTS)
       self.endpoint = DEFAULT_ENDPOINT
       self.hostname = default_hostname

data/lib/bugsnag/delayed_job.rb

@@ -17,6 +17,12 @@ unless defined? Delayed::Plugins::Bugsnag
               :job => {
                 :class => job.class.name,
                 :id => job.id,
+              },
+              :severity_reason => {
+                :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+                :attributes => {
+                  :framework => "DelayedJob"
+                }
               }
             }
             if job.respond_to?(:queue) && (queue = job.queue)

data/lib/bugsnag/mailman.rb

@@ -15,7 +15,14 @@ module Bugsnag
         yield
       rescue Exception => ex
         raise ex if [Interrupt, SystemExit, SignalException].include? ex.class
-        Bugsnag.auto_notify(ex)
+        Bugsnag.auto_notify(ex, {
+          :severity_reason => {
+            :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+            :attributes => {
+              :framework => "Mailman"
+            }
+          }
+        })
         raise
       ensure
         Bugsnag.clear_request_data

data/lib/bugsnag/middleware/classify_error.rb

@@ -0,0 +1,53 @@
+module Bugsnag::Middleware
+  class ClassifyError
+    INFO_CLASSES = [
+        "AbstractController::ActionNotFound",
+        "ActionController::InvalidAuthenticityToken",
+        "ActionController::ParameterMissing",
+        "ActionController::UnknownAction",
+        "ActionController::UnknownFormat",
+        "ActionController::UnknownHttpMethod",
+        "ActiveRecord::RecordNotFound",
+        "CGI::Session::CookieStore::TamperedWithCookie",
+        "Mongoid::Errors::DocumentNotFound",
+        "SignalException",
+        "SystemExit"
+    ]
+
+    def initialize(bugsnag)
+      @bugsnag = bugsnag
+    end
+
+    def call(notification)
+      notification.exceptions.each do |ex|
+
+        outer_break = false
+
+        ancestor_chain = ex.class.ancestors.select {
+          |ancestor| ancestor.is_a?(Class) 
+        }.map {
+          |ancestor| ancestor.to_s
+        }
+
+        INFO_CLASSES.each do |info_class|
+          if ancestor_chain.include?(info_class)
+            notification.severity_reason = {
+              :type => Bugsnag::Notification::ERROR_CLASS,
+              :attributes => {
+                :errorClass => info_class
+              }
+            }
+            notification.severity = 'info'
+            outer_break = true
+            break
+          end
+        end
+
+        break if outer_break
+      end
+
+      @bugsnag.call(notification)
+    end
+  end
+end
+    

data/lib/bugsnag/notification.rb

@@ -15,6 +15,13 @@ module Bugsnag
     NOTIFIER_VERSION = Bugsnag::VERSION
     NOTIFIER_URL = "http://www.bugsnag.com"
 
+    HANDLED_EXCEPTION = "handledException"
+    UNHANDLED_EXCEPTION = "unhandledException"
+    UNHANDLED_EXCEPTION_MIDDLEWARE = "unhandledExceptionMiddleware"
+    ERROR_CLASS = "errorClass"
+    USER_SPECIFIED_SEVERITY = "userSpecifiedSeverity"
+    USER_CALLBACK_SET_SEVERITY = "userCallbackSetSeverity"
+
     API_KEY_REGEX = /[0-9a-f]{32}/i
 
     # e.g. "org/jruby/RubyKernel.java:1264:in `catch'"
@@ -31,6 +38,8 @@ module Bugsnag
 
     attr_accessor :context
     attr_reader :user
+    attr_reader :severity
+    attr_accessor :severity_reason
     attr_accessor :configuration
     attr_accessor :meta_data
 
@@ -50,10 +59,36 @@ module Bugsnag
       @user = {}
       @should_ignore = false
       @severity = nil
+      @unhandled = false
+      @severity_reason = nil
       @grouping_hash = nil
       @delivery_method = nil
 
-      self.severity = @overrides[:severity]
+      if @overrides.key? :unhandled
+        @unhandled = @overrides[:unhandled]
+        @overrides.delete :unhandled
+      end
+
+      valid_severity = @overrides.key?(:severity) && SUPPORTED_SEVERITIES.include?(@overrides[:severity])
+      has_reason = @overrides.key? :severity_reason
+
+      if valid_severity && has_reason
+        @severity = @overrides[:severity]
+        @severity_reason = @overrides[:severity_reason]
+      elsif valid_severity
+        @severity = @overrides[:severity]
+        @severity_reason = {
+          :type => USER_SPECIFIED_SEVERITY
+        }
+      elsif has_reason
+        @severity_reason = @overrides[:severity_reason]
+      else
+        @severity_reason = {
+          :type => HANDLED_EXCEPTION
+        }
+      end
+      
+      @overrides.delete :severity_reason
       @overrides.delete :severity
 
       if @overrides.key? :grouping_hash
@@ -214,12 +249,19 @@ module Bugsnag
       # make meta_data available to public middleware
       @meta_data = generate_meta_data(@exceptions, @overrides)
 
+      initial_severity = self.severity
+
       # Run the middleware here (including Bugsnag::Middleware::Callbacks)
       # at the end of the middleware stack, execute the actual notification delivery
       @configuration.middleware.run(self) do
         # This supports self.ignore! for before_notify_callbacks.
         return if @should_ignore
 
+        # Check to see if the severity has been changed
+        if initial_severity != self.severity
+
+        end
+
         # Build the endpoint url
         endpoint = (@configuration.use_ssl ? "https://" : "http://") + @configuration.endpoint
         Bugsnag.log("Notifying #{endpoint} of #{@exceptions.last.class}")
@@ -243,6 +285,8 @@ module Bugsnag
         :payloadVersion => payload_version,
         :exceptions => exception_list,
         :severity => self.severity,
+        :unhandled => @unhandled,
+        :severityReason => @severity_reason,
         :groupingHash => self.grouping_hash,
       }
 

data/lib/bugsnag/que.rb

@@ -3,7 +3,14 @@ if defined?(::Que)
     begin
       job = job.dup # Make sure the original job object is not mutated.
 
-      Bugsnag.auto_notify(error) do |notification|
+      Bugsnag.auto_notify(error, {
+        :severity_reason => {
+          :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+          :attributes => {
+            :framework => "Que"
+          }
+        }
+      }) do |notification|
         job[:error_count] += 1
 
         # If the job was scheduled using ActiveJob then unwrap the job details for clarity:

data/lib/bugsnag/rack.rb

@@ -1,5 +1,13 @@
 module Bugsnag
   class Rack
+
+    SEVERITY_REASON = {
+      :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+      :attributes => {
+        :framework => "Rack"
+      }
+    }
+
     def initialize(app)
       @app = app
 
@@ -34,7 +42,9 @@ module Bugsnag
         response = @app.call(env)
       rescue Exception => raised
         # Notify bugsnag of rack exceptions
-        Bugsnag.auto_notify(raised)
+        Bugsnag.auto_notify(raised, {
+          :severity_reason => SEVERITY_REASON
+        })
 
         # Re-raise the exception
         raise
@@ -42,7 +52,9 @@ module Bugsnag
 
       # Notify bugsnag of rack exceptions
       if env["rack.exception"]
-        Bugsnag.auto_notify(env["rack.exception"])
+        Bugsnag.auto_notify(env["rack.exception"], {
+          :severity_reason => SEVERITY_REASON
+        })
       end
 
       response

data/lib/bugsnag/rails/action_controller_rescue.rb

@@ -1,6 +1,14 @@
 # Rails 2.x only
 module Bugsnag::Rails
   module ActionControllerRescue
+
+    SEVERITY_REASON = {
+      :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+      :attributes => {
+        :framework => "Rails"
+      }
+    }
+
     def self.included(base)
       base.extend(ClassMethods)
 
@@ -22,13 +30,17 @@ module Bugsnag::Rails
     end
 
     def rescue_action_in_public_with_bugsnag(exception)
-      Bugsnag.auto_notify(exception)
+      Bugsnag.auto_notify(exception, {
+        :severity_reason => SEVERITY_REASON
+      })
 
       rescue_action_in_public_without_bugsnag(exception)
     end
 
     def rescue_action_locally_with_bugsnag(exception)
-      Bugsnag.auto_notify(exception)
+      Bugsnag.auto_notify(exception, {
+        :severity_reason => SEVERITY_REASON
+      })
 
       rescue_action_locally_without_bugsnag(exception)
     end

data/lib/bugsnag/rails/active_record_rescue.rb

@@ -8,7 +8,14 @@ module Bugsnag::Rails
           super
         rescue StandardError => exception
           # This exception will NOT be escalated, so notify it here.
-          Bugsnag.auto_notify(exception)
+          Bugsnag.auto_notify(exception, {
+            :severity_reason => {
+              :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+              :attributes => {
+                :framework => "Rails"
+              }
+            }
+          })
           raise
         end
       else

data/lib/bugsnag/railtie.rb

@@ -17,7 +17,14 @@ module Bugsnag
       runner do
         at_exit do
           if $!
-            Bugsnag.auto_notify($!)
+            Bugsnag.auto_notify($!, {
+              :severity_reason => {
+                :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+                :attributes => {
+                  :framework => "Rails"
+                }
+              }
+            })
           end
         end
       end

data/lib/bugsnag/rake.rb

@@ -12,7 +12,14 @@ class Rake::Task
     execute_without_bugsnag(args)
 
   rescue Exception => ex
-    Bugsnag.auto_notify(ex)
+    Bugsnag.auto_notify(ex, {
+      :severity_reason => {
+        :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+        :attributes => {
+          :framework => "Rake"
+        }
+      }
+    })
     raise
   ensure
     Bugsnag.set_request_data :bugsnag_running_task, old_task

data/lib/bugsnag/resque.rb

@@ -26,7 +26,16 @@ module Bugsnag
     end
 
     def save
-      Bugsnag.auto_notify(exception, {:context => "#{payload['class']}@#{queue}", :payload => payload})
+      Bugsnag.auto_notify(exception, {
+        :context => "#{payload['class']}@#{queue}",
+        :payload => payload,
+        :severity_reason => {
+          :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+          :attributes => {
+            :framework => "Resque"
+          }
+        }
+      })
     end
   end
 end

data/lib/bugsnag/shoryuken.rb

@@ -18,7 +18,14 @@ module Bugsnag
 
         yield
       rescue Exception => ex
-        Bugsnag.auto_notify(ex) unless [Interrupt, SystemExit, SignalException].include?(ex.class)
+        Bugsnag.auto_notify(ex, {
+          :severity_reason => {
+            :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+            :attributes => {
+              :framework => "Shoryuken"
+            }
+          }
+        }) unless [Interrupt, SystemExit, SignalException].include?(ex.class)
         raise
       ensure
         Bugsnag.clear_request_data

data/lib/bugsnag/sidekiq.rb

@@ -16,7 +16,14 @@ module Bugsnag
         yield
       rescue Exception => ex
         raise ex if [Interrupt, SystemExit, SignalException].include? ex.class
-        Bugsnag.auto_notify(ex)
+        Bugsnag.auto_notify(ex, {
+          :severity_reason => {
+            :type => Bugsnag::Notification::UNHANDLED_EXCEPTION_MIDDLEWARE,
+            :attributes => {
+              :framework => "Sidekiq"
+            }
+          }
+        })
         raise
       ensure
         Bugsnag.clear_request_data

data/spec/integration_spec.rb

@@ -28,8 +28,10 @@ describe 'Bugsnag' do
     Dir.chdir(task_fixtures_path) do
       system("bundle exec rake test:crash > /dev/null 2>&1")
     end
-    expect(request["events"][0]["metaData"]["rake_task"]).not_to be_nil
-    expect(request["events"][0]["metaData"]["rake_task"]["name"]).to eq("test:crash")
+
+    result = request()
+    expect(result["events"][0]["metaData"]["rake_task"]).not_to be_nil
+    expect(result["events"][0]["metaData"]["rake_task"]["name"]).to eq("test:crash")
   end
 
   it 'should send notifications over the wire' do

data/spec/notification_spec.rb

@@ -113,6 +113,83 @@ describe Bugsnag::Notification do
     }
   end
 
+  it "uses correct unhandled defaults" do
+    Bugsnag.notify(BugsnagTestException.new("It crashed"))
+    
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      event = get_event_from_payload(payload)
+      expect(event["unhandled"]).to be false
+      expect(event["severity"]).to eq("warning")
+      expect(event["severityReason"]).to eq({
+        "type" => "handledException"
+      })
+    }
+  end
+
+  it "sets correct severityReason if severity is modified" do
+    Bugsnag.notify(BugsnagTestException.new("It crashed"), {:severity => "info"})
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      event = get_event_from_payload(payload)
+      expect(event["unhandled"]).to be false
+      expect(event["severity"]).to eq("info")
+      expect(event["severityReason"]).to eq({
+        "type" => "userSpecifiedSeverity"
+      })
+    }
+  end
+
+  it "sets correct severityReason if severity is modified in a block" do
+    Bugsnag.notify(BugsnagTestException.new("It crashed")) do |notification|
+      notification.severity = "info"
+    end
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      event = get_event_from_payload(payload)
+      expect(event["unhandled"]).to be false
+      expect(event["severity"]).to eq("info")
+      expect(event["severityReason"]).to eq({
+        "type" => "userCallbackSetSeverity"
+      })
+    }
+  end
+
+  it "sets unhandled and severityReasons through auto_notify" do
+    Bugsnag.auto_notify(BugsnagTestException.new("It crashed"), {
+      :severity_reason => {
+        :type => "unhandledExceptionMiddleware",
+        :attributes => {
+          :framework => "ruby test"
+        }
+      }
+    })
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      event = get_event_from_payload(payload)
+      expect(event["unhandled"]).to be true
+      expect(event["severity"]).to eq("error")
+      expect(event["severityReason"]).to eq({
+        "type" => "unhandledExceptionMiddleware",
+        "attributes" => {
+          "framework" => "ruby test"
+        }
+      })
+    }
+  end
+
+  it "sets correct severity and reason for specific error classes" do
+    Bugsnag.notify(SignalException.new("TERM"))
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      event = get_event_from_payload(payload)
+      expect(event["unhandled"]).to be false
+      expect(event["severity"]).to eq("info")
+      expect(event["severityReason"]).to eq({
+        "type" => "errorClass",
+        "attributes" => {
+          "errorClass" => "SignalException"
+        }
+      })
+    }
+  end
+
   # TODO: nested context
 
   it "accepts tabs in overrides and adds them to metaData" do
@@ -580,12 +657,6 @@ describe Bugsnag::Notification do
     }
   end
 
-  it "does not notify if the exception class is in the default ignore_classes list" do
-    Bugsnag.notify_or_ignore(ActiveRecord::RecordNotFound.new("It crashed"))
-
-    expect(Bugsnag).not_to have_sent_notification
-  end
-
   it "does not notify if the non-default exception class is added to the ignore_classes" do
     Bugsnag.configuration.ignore_classes << "BugsnagTestException"
 

data/spec/rack_spec.rb

@@ -32,6 +32,21 @@ describe Bugsnag::Rack do
 
     end
 
+    it "applies the correct severity reason" do
+      rack_stack.call(rack_env) rescue nil
+
+      expect(Bugsnag).to have_sent_notification{ |payload|
+        event = get_event_from_payload(payload)
+        expect(event["unhandled"]).to be true
+        expect(event["severityReason"]).to eq({
+          "type" => "unhandledExceptionMiddleware",
+          "attributes" => {
+            "framework" => "Rack"
+          }
+        })
+      }
+    end
+
     it "does not deliver an exception if auto_notify is disabled" do
       Bugsnag.configure do |config|
         config.auto_notify = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 5.4.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -115,6 +115,7 @@ files:
 - Rakefile
 - VERSION
 - bugsnag.gemspec
+- issue_template.md
 - lib/bugsnag.rb
 - lib/bugsnag/capistrano.rb
 - lib/bugsnag/capistrano2.rb
@@ -130,6 +131,7 @@ files:
 - lib/bugsnag/mailman.rb
 - lib/bugsnag/meta_data.rb
 - lib/bugsnag/middleware/callbacks.rb
+- lib/bugsnag/middleware/classify_error.rb
 - lib/bugsnag/middleware/clearance_user.rb
 - lib/bugsnag/middleware/mailman.rb
 - lib/bugsnag/middleware/rack_request.rb