bugsnag 5.5.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f984eec70917a0c4be84872ebe37ddafe29a6b90
-  data.tar.gz: ae64caceca203ed92c2bf2a45dc11a87eb21f665
+  metadata.gz: bdb80b010ab8da05acfddaa542a8b7cbff4be599
+  data.tar.gz: 7fa7188b650b1ebc07e074f4d6f2f1a365105033
 SHA512:
-  metadata.gz: 61fb130e43e7bda70b320c3c4094961732d63597da430ac70a692f2065f04026d046bf67c15402e642ab9dc531491173a76f8b13e80ca3f05af175eabb7dbf9d
-  data.tar.gz: 6a46b86c0218851ee2c213246bfb5122d70bc1d274c70e21fefdcc50bfed0fd092851bef5f74ba32c870148184b4e352d57c1f10869126f376dfcfe4b21ad824
+  metadata.gz: 9f19d8a8b92a80747fb160ca3d55c5b19c35aefe8c9293eff1843668a76e90965b37a643e90ebc912b4e1e621411d0968241e024d01b490b5a1d0484621a2b2f
+  data.tar.gz: 2b46521a1dbe916993b13f546992533ef2ab0422cf45a27ea6a30c1c13f8ba01c0a42c2e2486ac655eccff531443452a00fe765e51fea039346d205803da9373

data/.travis.yml

@@ -1,16 +1,38 @@
 sudo: false
 language: ruby
-cache: bundler
-rvm:
-- 2.3.0
-- 2.2.4
-- 2.1.8
-- 2.0.0
-- 1.9.3
-- jruby-19mode
 
 before_install:
-- gem install bundler -v 1.12
-- gem update --system
-- bundle --version
+- gem update --system 2.6.14
 - gem --version
+- gem install bundler -v 1.12
+- bundle _1.12.0_ --version
+
+install:
+- bundle _1.12.0_ install --with "$GEMSETS" --binstubs
+
+script:
+- bundle exec ./bin/rake spec
+
+jobs:
+  include:
+  - stage: test
+    env: GEMSETS=test
+    rvm: jruby-19mode
+  - stage: test
+    env: GEMSETS=test
+    rvm: 1.9.3
+  - stage: test
+    env: GEMSETS=test
+    rvm: 2.0.0
+  - stage: test
+    env: GEMSETS=test
+    rvm: 2.1.10
+  - stage: test
+    env: GEMSETS="test sidekiq"
+    rvm: 2.2.4
+  - stage: test
+    env: GEMSETS="test sidekiq coverage"
+    rvm: 2.3.0
+  - stage: test
+    env: GEMSETS="test sidekiq"
+    rvm: 2.4.1

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 Changelog
 =========
 
+## 6.0.0 (09 Nov 2017)
+
+This notifier has been extensively re-written to make it easier to add new integrations and maintain in the future.  This has led to several changes that are not backwards compatible.  Please refer to the [upgrading guide](https://github.com/bugsnag/bugsnag-ruby/blob/master/UPGRADING.md) for more information.
+
+### Enhancements
+
+* General notifier re-write
+  | [#320](https://github.com/bugsnag/bugsnag-ruby/pull/320)
+  | [#378](https://github.com/bugsnag/bugsnag-ruby/pull/378)
+  | [#368](https://github.com/bugsnag/bugsnag-ruby/pull/368)
+  | [#381](https://github.com/bugsnag/bugsnag-ruby/pull/381)
+  | [#385](https://github.com/bugsnag/bugsnag-ruby/pull/385)
+  | [#386](https://github.com/bugsnag/bugsnag-ruby/pull/386)
+
+* Added Upgrade guide
+  | [#370](https://github.com/bugsnag/bugsnag-ruby/pull/370)
+
+* Did-you-mean suggestions middleware
+  | [#372](https://github.com/bugsnag/bugsnag-ruby/pull/372)
+
+* Updated examples
+  | [#374](https://github.com/bugsnag/bugsnag-ruby/pull/374)
+
 ## 5.5.0 (09 Nov 2017)
 
 ### Enhancements

data/Gemfile

@@ -1,2 +1,22 @@
 source "https://rubygems.org"
+
+group :test, optional: true do
+    gem 'rake', '~> 10.1.1'
+    gem 'rspec'
+    gem 'rdoc'
+    gem 'pry'
+    gem 'addressable', '~> 2.3.8'
+    gem 'delayed_job' if RUBY_VERSION >= '2.2.2'
+    gem 'webmock', RUBY_VERSION <= '1.9.3' ? '2.3.2': '>2.3.2'
+end
+
+group :coverage, optional: true do
+    gem 'simplecov'
+    gem 'coveralls'
+end
+
+group :sidekiq, optional: true do
+    gem 'sidekiq', '~> 5.0.4'
+end
+
 gemspec

data/Rakefile

@@ -1,16 +1,5 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
-require 'bundler/gem_tasks'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -24,6 +13,24 @@ end
 # RSpec tasks
 require 'rspec/core'
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  integration_exclusions = []
+  begin
+    require 'sidekiq/testing'
+  rescue LoadError
+    puts "Skipping sidekiq tests, missing dependencies"
+    integration_exclusions << 'sidekiq'
+  end
+  begin
+    require 'delayed_job'
+  rescue LoadError
+    puts "Skipping delayed_job tests, missing dependencies"
+    integration_exclusions << 'delayed_job'
+  end
+  if integration_exclusions.length > 0
+    pattern = integration_exclusions.join(',')
+    task.rspec_opts = " --exclude-pattern **/integrations/{#{pattern}}_spec.rb"
+  end
+end
 
 task :default  => :spec

data/UPGRADING.md

@@ -0,0 +1,58 @@
+# Upgrade Guide
+
+## 5.x to 6.x
+
+_Our Ruby library has gone through some major improvements and there are a few
+changes required to use the new integrations_
+
+#### Capistrano and deploys
+
+Support for notifying Bugsnag of deployments has been separated into a separate
+gem named `bugsnag-capistrano`. See the [integration
+guide](https://docs.bugsnag.com/platforms/ruby/capistrano) for more information.
+
+
+#### Configuration
+
+* `Configuration.use_ssl` has been removed. Include the preferred protocol in `Configuration.endpoint` instead.
+  ```diff
+    Bugsnag.configure do |config|
+  -   config.use_ssl = true
+  -   config.endpoint = 'myserver.example.com'
+  +   config.endpoint = 'https://myserver.example.com'
+    end
+  ```
+* `Configuration.ignore_classes` now no longer accepts strings. Use classes directly instead.
+* `Configuration.delay_with_resque` has been removed
+* `Configuration.vendor_paths` has been removed
+* `Configuration.params_filters` has been renamed to `Configuration.meta_data_filters` to be clearer
+* `Configuration.proxy_host` will now default to `ENV['http_proxy']` if set. It can still be manually set.
+
+#### Notifying
+
+* `notify` now only supports block syntax. Replace usage of the overrides hash with a block
+
+  ```diff
+  - Bugsnag.notify(e, {severity: 'info'})
+  + Bugsnag.notify(e) do |report|
+  +   report.severity = 'info'
+  + end
+  ```
+
+* `Bugsnag.notify_or_ignore` and `Bugsnag.auto_notify` have been removed removed. Call `notify` directly instead.
+* `after_notify_callbacks` has been removed
+* `Bugsnag::Notification` has been renamed to `Bugsnag::Report`
+
+#### Logging
+
+* `config.debug` boolean has been removed. Set the logger level directly
+
+  ```diff
+  + require 'logger'
+
+    Bugsnag.configure do |config|
+      # .. set API key and other properties
+  -   config.debug = true
+  +   config.logger.level = Logger::DEBUG
+    end
+  ```

data/VERSION

@@ -1 +1 @@
-5.5.0
+6.0.0

data/bugsnag.gemspec

@@ -18,13 +18,4 @@ Gem::Specification.new do |s|
   ]
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 1.9.2'
-
-  s.add_development_dependency 'rake', '~> 10.1.1'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rdoc'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'addressable', '~> 2.3.8'
-  s.add_development_dependency 'webmock', '2.1.0'
-  s.add_development_dependency 'delayed_job'
-  s.add_development_dependency 'activesupport', '~> 4.2.10'
 end

data/lib/bugsnag.rb

@@ -4,16 +4,16 @@ require "thread"
 require "bugsnag/version"
 require "bugsnag/configuration"
 require "bugsnag/meta_data"
-require "bugsnag/notification"
+require "bugsnag/report"
 require "bugsnag/cleaner"
 require "bugsnag/helpers"
-require "bugsnag/deploy"
 
 require "bugsnag/delivery"
 require "bugsnag/delivery/synchronous"
 require "bugsnag/delivery/thread_queue"
 
-require "bugsnag/rack"
+require "bugsnag/integrations/rack"
+require "bugsnag/integrations/railtie" if defined?(Rails::Railtie)
 
 require "bugsnag/middleware/rack_request"
 require "bugsnag/middleware/warden_user"
@@ -27,92 +27,88 @@ require "bugsnag/middleware/callbacks"
 require "bugsnag/middleware/classify_error"
 
 module Bugsnag
-  LOG_PREFIX = "** [Bugsnag] "
   LOCK = Mutex.new
 
   class << self
     # Configure the Bugsnag notifier application-wide settings.
-    def configure(config_hash=nil)
-      if config_hash
-        config_hash.each do |k,v|
-          configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
-        end
-      end
-
+    def configure
       yield(configuration) if block_given?
 
-      # 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"
+      if !configuration.valid_api_key? && !@key_warning
+        configuration.warn("No valid API key has been set, notifications will not be sent")
         @key_warning = true
       end
+    end
 
-      # Log that we are ready to rock
-      @logged_ready = false unless defined?(@logged_ready)
+    # Explicitly notify of an exception
+    def notify(exception, auto_notify=false, &block)
 
-      if configuration.api_key && !@logged_ready
-        log "Bugsnag exception handler #{VERSION} ready"
-        @logged_ready = true
+      if !configuration.auto_notify && auto_notify
+        configuration.debug("Not notifying because auto_notify is disabled")
+        return
       end
-    end
 
-    # Explicitly notify of an exception
-    def notify(exception, overrides=nil, request_data=nil, &block)
-      notification = Notification.new(exception, configuration, overrides, request_data)
+      if !configuration.valid_api_key?
+        configuration.debug("Not notifying due to an invalid api_key")
+        return
+      end
 
-      initial_severity = notification.severity
-      initial_reason = notification.severity_reason
+      if !configuration.should_notify_release_stage?
+        configuration.debug("Not notifying due to notify_release_stages :#{configuration.notify_release_stages.inspect}")
+        return
+      end
 
-      yield(notification) if block_given?
+      report = Report.new(exception, configuration, auto_notify)
 
-      if notification.severity != initial_severity
-        notification.severity_reason = {
-          :type => Bugsnag::Notification::USER_CALLBACK_SET_SEVERITY
-        }
-      else
-        notification.severity_reason = initial_reason
+      # 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
       end
 
-      unless notification.ignore?
-        notification.deliver
-        notification
-      else
-        false
+      # Run internal middleware
+      configuration.internal_middleware.run(report)
+      if report.ignore?
+        configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in internal middlewares")
+        return
       end
-    end
-    alias_method :notify_or_ignore, :notify
-
-    # Auto notify of an exception, called from rails and rack exception
-    # rescuers, unless auto notification is disabled, or we should ignore this
-    # error class
-    def auto_notify(exception, overrides=nil, request_data=nil, &block)
-      overrides ||= {}
-      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
 
-    # Log wrapper
-    def log(message)
-      configuration.logger.info("#{LOG_PREFIX}#{message}")
-    end
+      # Store before_middleware severity reason for future reference
+      initial_severity = report.severity
+      initial_reason = report.severity_reason
 
-    # Warning logger
-    def warn(message)
-      configuration.logger.warn("#{LOG_PREFIX}#{message}")
-    end
+      # Run users middleware
+      configuration.middleware.run(report) do
+        if report.ignore?
+          configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in user provided middleware")
+          return
+        end
+
+        # 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
+        end
+
+        # Test whether severity has been changed and ensure severity_reason is consistant in auto_notify case
+        if report.severity != initial_severity
+          report.severity_reason = {
+            :type => Report::USER_CALLBACK_SET_SEVERITY
+          }
+        else
+          report.severity_reason = initial_reason
+        end
 
-    # Debug logger
-    def debug(message)
-      configuration.logger.info("#{LOG_PREFIX}#{message}") if configuration.debug
+        # Deliver
+        configuration.info("Notifying #{configuration.endpoint} of #{report.exceptions.last[:errorClass]}")
+        payload_string = ::JSON.dump(Bugsnag::Helpers.trim_if_needed(report.as_json))
+        configuration.debug("Payload: #{payload_string}")
+        Bugsnag::Delivery[configuration.delivery_method].deliver(configuration.endpoint, payload_string, configuration)
+      end
     end
 
     # Configuration getters
@@ -121,34 +117,16 @@ module Bugsnag
       @configuration || LOCK.synchronize { @configuration ||= Bugsnag::Configuration.new }
     end
 
-    # Set "per-request" data, temporal data for use in bugsnag middleware
-    def set_request_data(key, value)
-      Bugsnag.configuration.set_request_data(key, value)
-    end
-
-    # Clear all "per-request" data, temporal data for use in bugsnag middleware
-    # This method should be called after each distinct request or session ends
-    # Eg. After completing a page request in a web app
-    def clear_request_data
-      Bugsnag.configuration.clear_request_data
-    end
-
     # Allow access to "before notify" callbacks
     def before_notify_callbacks
       Bugsnag.configuration.request_data[:before_callbacks] ||= []
     end
-
-    # Allow access to "after notify" callbacks
-    def after_notify_callbacks
-      Bugsnag.configuration.request_data[:after_callbacks] ||= []
-    end
   end
 end
 
-require "bugsnag/railtie" if defined?(Rails::Railtie)
 [:resque, :sidekiq, :mailman, :delayed_job, :shoryuken, :que].each do |integration|
   begin
-    require "bugsnag/#{integration}"
+    require "bugsnag/integrations/#{integration}"
   rescue LoadError
   end
 end

data/lib/bugsnag/configuration.rb

@@ -2,6 +2,11 @@ require "set"
 require "socket"
 require "logger"
 require "bugsnag/middleware_stack"
+require "bugsnag/middleware/callbacks"
+require "bugsnag/middleware/exception_meta_data"
+require "bugsnag/middleware/ignore_error_class"
+require "bugsnag/middleware/suggestion_data"
+require "bugsnag/middleware/classify_error"
 
 module Bugsnag
   class Configuration
@@ -9,35 +14,30 @@ module Bugsnag
     attr_accessor :release_stage
     attr_accessor :notify_release_stages
     attr_accessor :auto_notify
-    attr_accessor :use_ssl
     attr_accessor :ca_file
     attr_accessor :send_environment
     attr_accessor :send_code
     attr_accessor :project_root
-    attr_accessor :vendor_paths
     attr_accessor :app_version
     attr_accessor :app_type
-    attr_accessor :params_filters
-    attr_accessor :ignore_user_agents
+    attr_accessor :meta_data_filters
     attr_accessor :endpoint
     attr_accessor :logger
     attr_accessor :middleware
     attr_accessor :internal_middleware
-    attr_accessor :delay_with_resque
-    attr_accessor :debug
     attr_accessor :proxy_host
     attr_accessor :proxy_port
     attr_accessor :proxy_user
     attr_accessor :proxy_password
     attr_accessor :timeout
     attr_accessor :hostname
-    attr_writer :ignore_classes
+    attr_accessor :ignore_classes
 
+    API_KEY_REGEX = /[0-9a-f]{32}/i
     THREAD_LOCAL_NAME = "bugsnag_req_data"
+    DEFAULT_ENDPOINT = "https://notify.bugsnag.com"
 
-    DEFAULT_ENDPOINT = "notify.bugsnag.com"
-
-    DEFAULT_PARAMS_FILTERS = [
+    DEFAULT_META_DATA_FILTERS = [
       /authorization/i,
       /cookie/i,
       /password/i,
@@ -45,36 +45,39 @@ module Bugsnag
       "rack.request.form_vars"
     ].freeze
 
-    DEFAULT_IGNORE_USER_AGENTS = [].freeze
-
-    DEFAULT_DELIVERY_METHOD = :thread_queue
-
     def initialize
       @mutex = Mutex.new
 
       # Set up the defaults
       self.auto_notify = true
-      self.use_ssl = true
       self.send_environment = false
       self.send_code = true
-      self.params_filters = Set.new(DEFAULT_PARAMS_FILTERS)
-      self.ignore_classes = Set.new()
-      self.ignore_user_agents = Set.new(DEFAULT_IGNORE_USER_AGENTS)
+      self.meta_data_filters = Set.new(DEFAULT_META_DATA_FILTERS)
+      self.ignore_classes = Set.new([])
       self.endpoint = DEFAULT_ENDPOINT
       self.hostname = default_hostname
       self.timeout = 15
-      self.vendor_paths = [%r{vendor/}]
       self.notify_release_stages = nil
 
       # Read the API key from the environment
       self.api_key = ENV["BUGSNAG_API_KEY"]
 
+      # Read NET::HTTP proxy environment variable
+      self.proxy_host = ENV["http_proxy"]
+
       # Set up logging
       self.logger = Logger.new(STDOUT)
-      self.logger.level = Logger::WARN
+      self.logger.level = Logger::INFO
+      self.logger.formatter = proc do |severity, datetime, progname, msg|
+        "** [Bugsnag] #{datetime}: #{msg}\n"
+      end
 
       # Configure the bugsnag middleware stack
       self.internal_middleware = Bugsnag::MiddlewareStack.new
+      self.internal_middleware.use Bugsnag::Middleware::ExceptionMetaData
+      self.internal_middleware.use Bugsnag::Middleware::IgnoreErrorClass
+      self.internal_middleware.use Bugsnag::Middleware::SuggestionData
+      self.internal_middleware.use Bugsnag::Middleware::ClassifyError
 
       self.middleware = Bugsnag::MiddlewareStack.new
       self.middleware.use Bugsnag::Middleware::Callbacks
@@ -85,7 +88,7 @@ module Bugsnag
     # notification endpoint.
     #
     def delivery_method
-      @delivery_method || @default_delivery_method || DEFAULT_DELIVERY_METHOD
+      @delivery_method || @default_delivery_method || :thread_queue
     end
 
     ##
@@ -104,13 +107,12 @@ module Bugsnag
       @default_delivery_method = delivery_method
     end
 
-    # Accept both String and Class instances as an ignored class
-    def ignore_classes
-      @mutex.synchronize { @ignore_classes.map! { |klass| klass.is_a?(Class) ? klass.name : klass } }
+    def should_notify_release_stage?
+      @release_stage.nil? || @notify_release_stages.nil? || @notify_release_stages.include?(@release_stage)
     end
 
-    def should_notify?
-      @release_stage.nil? || @notify_release_stages.nil? || @notify_release_stages.include?(@release_stage)
+    def valid_api_key?
+      !api_key.nil? && api_key =~ API_KEY_REGEX
     end
 
     def request_data
@@ -129,6 +131,20 @@ module Bugsnag
       Thread.current[THREAD_LOCAL_NAME] = nil
     end
 
+    def info(message)
+      logger.info(message)
+    end
+
+    # Warning logger
+    def warn(message)
+      logger.warn(message)
+    end
+
+    # Debug logger
+    def debug(message)
+      logger.debug(message)
+    end
+
     private
 
     def default_hostname