honeybadger 4.7.2 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae86ea681a8b1e58775976adc5fe1300cfa043865c9a72344b5ae2dfcde2565a
-  data.tar.gz: 98a92af83ec77fff0fba12fd551ca81417ed04d0cfdba225a262f1db2786ad82
+  metadata.gz: 807947f2bfdd4fac0c50e1665b0538eb42e5811f30903b7f9e6e19cacc5e999b
+  data.tar.gz: 1e3b8f5e462963083a41e336378d2e8a25a6efadf70e5216992be5e2517f814c
 SHA512:
-  metadata.gz: bad75cfca393708ec07292b6e34257afdaad23753e7fe26b96e8c9d1ca5d46099f9da13b93b53d49d5a77569913e0048a883cc6bf73b04686d85060805e8d681
-  data.tar.gz: 79e8f88c82d3e8da1eb968b4f9df0ba88da145a034cd6c82cd7e3bf84649d9d5d3c7e3586ce12e391b3f097c9a955231654a825726ac9a697050ffdbca2df64d
+  metadata.gz: 0dad8d9da2e9a648796ad3cedc58fadc7f5c1144e4b0985556f7dbba92348ee36b08073fb8d67a0b1ff2920c12b853b8b937b80f1f351fd172348fd3119f9dc0
+  data.tar.gz: f5c7cc958c542c60a85abe624e6625fe30e449e6d3bef6760f05a8218134ea92b74b6c982460739d828069aa17e21cb6303adb5e6568699543099587c406fb9c

data/CHANGELOG.md

@@ -5,6 +5,82 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [5.0.2] - 2022-11-04
+### Fixed
+- `Honeybadger.check_in` would raise an exception when used with the test backend (#449)
+
+## [5.0.1] - 2022-10-27
+### Fixed
+- Ignore `Sidekiq::JobRetry` skip exception. Since support was added for Rails 7
+  error reporting interface these exceptions are being reported in addition to
+  the exception that caused the job to be retried. Mike Perham says these
+  exceptions can safely be ignored.
+  See https://github.com/rails/rails/pull/43625#issuecomment-1071574110
+
+## [5.0.0] - 2022-10-18
+### Changed
+- `Honeybadger.notify` is now idempotent; it will skip reporting exception
+  objects that have already been reported before, and simply return the existing
+  notice ID.
+- Honeybadger is now initialized before Rails' initializers, allowing you to
+  report errors raised during startup. Config added via `Honeybadger.configure`
+  is added later in the Rails initialization process.
+
+### Added
+- Support Rails 7 error reporting interface (#443)
+
+### Fixed
+- Replace deployhook with release webhook (#444)
+  See https://blog.heroku.com/deployhooks-sunset
+
+## [4.12.2] - 2022-08-15
+### Fixed
+- Fix a bug where the auto-detected revision is blank instead of nil
+- Fix inadvertent creation of invalid sessions (#441)
+
+## [4.12.1] - 2022-04-01
+### Fixed
+- Fix Lambda plugin: support Ruby <2.5 (#428)
+
+## [4.12.0] - 2022-03-30
+### Added
+- Added `hb_wrap_handler` to automatically capture AWS Lambda handler errors
+
+### Fixed
+- Change `:exception_message` key name to just `:exception` for error breadcrumb metadata.
+
+## [4.11.0] - 2022-02-15
+### Fixed
+- Allow special characters in tags. Also support space-delimited tags:
+  "one two three" and "one, two, three" are equivalent
+
+## [4.10.0] - 2022-01-19
+### Added
+- Add more items to the default config file
+
+### Fixed
+- Fix a Ruby 3.1 bug that breaks regexp classes in honeybadger.yml (#418)
+
+## [4.9.0] - 2021-06-28
+### Fixed
+- Replaced fixed number for retries in Sidekiq Plugin with Sidekiq::JobRetry constant
+- Properly set environment in deployment tracking (#404, @stmllr)
+
+### Added
+- Added 'ActionDispatch::Http::MimeNegotiation::InvalidType' (Rails 6.1) to
+  default ignore list. (#402, @jrochkind)
+
+## [4.8.0] - 2021-03-16
+### Fixed
+- Suppress any error output from the `git rev-parse` command. ([#394](https://github.com/honeybadger-io/honeybadger-ruby/pull/394))
+
+### Added
+- Support deployment tracking in code (#397, @danleyden)
+
+## [4.7.3] - 2021-02-10
+### Fixed
+- Don't enable Lambda plugin in non-Lambda execution environments
+
 ## [4.7.2] - 2020-08-17
 ### Fixed
 - Remove usage of `ActiveRecord::Base.connection` (thanks @jcoyne for testing)
@@ -32,7 +108,7 @@ adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - Fixed issue where Sidekiq.attempt_threshold was triggering 2 attempts ahead
   of the setting
-- Dup notify opts before mutating (#345)
+- Dupe notify opts before mutating (#345)
 
 ### Changed
 - Breadcrumbs on by default

data/README.md

@@ -3,7 +3,6 @@
 ![Ruby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/Ruby/badge.svg)
 ![JRuby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/JRuby/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/honeybadger.svg)](http://badge.fury.io/rb/honeybadger)
-[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=honeybadger&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=honeybadger&package-manager=bundler&version-scheme=semver)
 
 This is the notifier gem for integrating apps with the :zap: [Honeybadger Exception Notifier for Ruby and Rails](http://honeybadger.io).
 

data/lib/honeybadger/agent.rb

@@ -122,6 +122,9 @@ module Honeybadger
       opts = opts.dup
 
       if exception_or_opts.is_a?(Exception)
+        already_reported_notice_id = exception_or_opts.instance_variable_get(:@__hb_notice_id)
+        return already_reported_notice_id if already_reported_notice_id
+
         opts[:exception] = exception_or_opts
       elsif exception_or_opts.respond_to?(:to_hash)
         opts.merge!(exception_or_opts.to_hash)
@@ -171,6 +174,10 @@ module Honeybadger
         push(notice)
       end
 
+      if exception_or_opts.is_a?(Exception)
+        exception_or_opts.instance_variable_set(:@__hb_notice_id, notice.id) unless exception_or_opts.frozen?
+      end
+
       notice.id
     end
 
@@ -190,6 +197,29 @@ module Honeybadger
       response.success?
     end
 
+    # Track a new deployment
+    #
+    # @example
+    #   Honeybadger.track_deployment(revision: 'be2ceb6')
+    #
+    # @param [String] :environment The environment name. Defaults to the current configured environment.
+    # @param [String] :revision The VCS revision being deployed. Defaults to the currently configured revision.
+    # @param [String] :local_username The name of the user who performed the deploy.
+    # @param [String] :repository The base URL of the VCS repository. It should be HTTPS-style.
+    #
+    # @return [Boolean] true if the deployment was successfully tracked and false
+    #   otherwise.
+    def track_deployment(environment: nil, revision: nil, local_username: nil, repository: nil)
+      opts = {
+        environment: environment || config[:env],
+        revision: revision || config[:revision],
+        local_username: local_username,
+        repository: repository
+      }
+      response = backend.track_deployment(opts)
+      response.success?
+    end
+
     # Save global context for the current request.
     #
     # @example

data/lib/honeybadger/backend/base.rb

@@ -99,6 +99,15 @@ module Honeybadger
         raise NotImplementedError, 'must define #check_in on subclass.'
       end
 
+      # Track a deployment
+      # @example
+      #   backend.track_deployment({ revision: 'be2ceb6' })
+      #
+      # @param [#to_json] payload The JSON payload containing all deployment data.
+      def track_deployment(payload)
+        notify(:deploys, payload)
+      end
+
       private
 
       attr_reader :config

data/lib/honeybadger/backend/test.rb

@@ -39,6 +39,7 @@ module Honeybadger
 
       def check_in(id)
         check_ins << id
+        super
       end
     end
   end

data/lib/honeybadger/cli/heroku.rb

@@ -23,7 +23,7 @@ module Honeybadger
           exit(1)
         end
 
-        cmd = %Q(heroku addons:create deployhooks:http --url="https://api.honeybadger.io/v1/deploys?deploy[environment]=#{rails_env}&deploy[local_username]={{user}}&deploy[revision]={{head}}&api_key=#{api_key}"#{app ? " --app #{app}" : ''})
+        cmd = %Q(heroku webhooks:add -i api:release -l notify -u "https://api.honeybadger.io/v1/deploys/heroku?environment=#{rails_env}&api_key=#{api_key}"#{app ? " --app #{app}" : ''})
 
         say("Running: `#{cmd}`")
         say(run(cmd))
@@ -93,7 +93,7 @@ module Honeybadger
       end
 
       def run(cmd)
-        Bundler.with_clean_env { `#{cmd}` }
+        Bundler.with_unbundled_env { `#{cmd}` }
       end
 
       def heroku_var(var, app_name, default = nil)

data/lib/honeybadger/cli/install.rb

@@ -43,10 +43,36 @@ module Honeybadger
             exit(1)
           end
 
+          default_env = defined?(::Rails.application) ? "Rails.env" : "ENV['RUBY_ENV'] || ENV['RACK_ENV']"
+          default_root = defined?(::Rails.application) ? "Rails.root.to_s" : "Dir.pwd"
           File.open(path, 'w+') do |file|
             file.write(<<-CONFIG)
 ---
+# For more options, see https://docs.honeybadger.io/lib/ruby/gem-reference/configuration
+
 api_key: '#{api_key}'
+
+# The environment your app is running in.
+env: "<%= #{default_env} %>"
+
+# The absolute path to your project folder.
+root: "<%= #{default_root} %>"
+
+# Honeybadger won't report errors in these environments.
+development_environments:
+- test
+- development
+- cucumber
+
+# By default, Honeybadger won't report errors in the development_environments.
+# You can override this by explicitly setting report_data to true or false.
+# report_data: true
+
+# The current Git revision of your project. Defaults to the last commit hash.
+# revision: null
+
+# Enable verbose debug logging (useful for troubleshooting).
+debug: false
 CONFIG
           end
         end

data/lib/honeybadger/cli/test.rb

@@ -256,7 +256,7 @@ love: making developers awesome.
 Happy 'badgering!
 
 Sincerely,
-Ben, Josh and Starr
+The Honeybadger Crew
 https://www.honeybadger.io/about/
 
 ⚡ --- End --------------------------------------------------------------------

data/lib/honeybadger/config/defaults.rb

@@ -23,11 +23,13 @@ module Honeybadger
                       'ActionController::ParameterMissing',
                       'ActiveRecord::RecordNotFound',
                       'ActionController::UnknownAction',
+                      'ActionDispatch::Http::MimeNegotiation::InvalidType',
                       'Rack::QueryParser::ParameterTypeError',
                       'Rack::QueryParser::InvalidParameterError',
                       'CGI::Session::CookieStore::TamperedWithCookie',
                       'Mongoid::Errors::DocumentNotFound',
-                      'Sinatra::NotFound'].map(&:freeze).freeze
+                      'Sinatra::NotFound',
+                      'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
 
     DEVELOPMENT_ENVIRONMENTS = ['development', 'test', 'cucumber'].map(&:freeze).freeze
 
@@ -299,6 +301,11 @@ module Honeybadger
         default: true,
         type: Boolean
       },
+      :'rails.subscriber_ignore_sources' => {
+        description: "Sources (strings or regexes) that should be ignored when using the Rails' (7+) native error reporter.",
+        default: [],
+        type: Array
+      },
       :'resque.resque_retry.send_exceptions_when_retrying' => {
         description: 'Send exceptions when retrying job.',
         default: true,

data/lib/honeybadger/config/yaml.rb

@@ -26,7 +26,11 @@ module Honeybadger
 
       def self.load_yaml(path)
         begin
-          yaml = YAML.load(ERB.new(path.read).result)
+          # This uses `YAML.unsafe_load` to support loading arbitrary Ruby
+          # classes, such as !ruby/regexp. This was the default behavior prior
+          # to Psych 4. https://bugs.ruby-lang.org/issues/17866
+          method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
+          yaml = YAML.send(method, ERB.new(path.read).result)
         rescue => e
           config_error = ConfigError.new(e.to_s)
 

data/lib/honeybadger/init/rails.rb

@@ -17,7 +17,7 @@ module Honeybadger
           app.config.middleware.insert_before(Honeybadger::Rack::ErrorNotifier, Honeybadger::Rack::UserFeedback)
         end
 
-        config.after_initialize do
+        config.before_initialize do
           Honeybadger.init!({
             :root           => ::Rails.root.to_s,
             :env            => ::Rails.env,
@@ -25,6 +25,9 @@ module Honeybadger
             :logger         => Logging::FormattedLogger.new(::Rails.logger),
             :framework      => :rails
           })
+        end
+
+        config.after_initialize do
           Honeybadger.load_plugins!
         end
       end

data/lib/honeybadger/notice.rb

@@ -53,11 +53,11 @@ module Honeybadger
 
     # @api private
     # The String character used to split tag strings.
-    TAG_SEPERATOR = ','.freeze
+    TAG_SEPERATOR = /,|\s/.freeze
 
     # @api private
     # The Regexp used to strip invalid characters from individual tags.
-    TAG_SANITIZER = /[^\w]/.freeze
+    TAG_SANITIZER = /\s/.freeze
 
     # @api private
     class Cause

data/lib/honeybadger/plugin.rb

@@ -2,7 +2,7 @@ require 'forwardable'
 
 module Honeybadger
   # +Honeybadger::Plugin+ defines the API for registering plugins with
-  # Honeybadger. Each plugin has requirements which must be satisified before
+  # Honeybadger. Each plugin has requirements which must be satisfied before
   # executing the plugin's execution block(s). This allows us to detect
   # optional dependencies and load the plugin for each dependency only if it's
   # present in the application.
@@ -62,7 +62,7 @@ module Honeybadger
       #     execution { }
       #   end
       #
-      # @param [String] name The optional name of the plugin. Should use
+      # @param [String, Symbol] name The optional name of the plugin. Should use
       #   +snake_case+. The name is inferred from the current file name if omitted.
       #
       # @return nil

data/lib/honeybadger/plugins/lambda.rb

@@ -3,12 +3,57 @@ require 'honeybadger/util/lambda'
 
 module Honeybadger
   module Plugins
+    module LambdaExtension
+      # Wrap Lambda handlers so exceptions can be automatically captured
+      #
+      # Usage:
+      #
+      # # Automatically included in the top-level main object
+      # hb_wrap_handler :my_handler_1, :my_handler_2
+      #
+      # def my_handler_1(event:, context:)
+      # end
+      #
+      # class MyLambdaApp
+      #   extend ::Honeybadger::Plugins::LambdaExtension
+      #
+      #   hb_wrap_handler :my_handler_1, :my_handler_2
+      #
+      #   def self.my_handler_1(event:, context:)
+      #   end
+      # end
+      def hb_wrap_handler(*handler_names)
+        mod = Module.new do
+          handler_names.each do |handler|
+            define_method(handler) do |event:, context:|
+              begin
+                Honeybadger.context(aws_request_id: context.aws_request_id) if context.respond_to?(:aws_request_id)
+
+                super(event: event, context: context)
+              rescue => e
+                Honeybadger.notify(e)
+                raise
+              end
+            end
+          end
+        end
+
+        self.singleton_class.prepend(mod)
+        Kernel.singleton_class.prepend(mod) if self == TOPLEVEL_BINDING.eval("self")
+      end
+    end
+
     # @api private
     Plugin.register :lambda do
       requirement { Util::Lambda.lambda_execution? }
 
       execution do
         config[:sync] = true
+        config[:'exceptions.notify_at_exit'] = false
+
+        main = TOPLEVEL_BINDING.eval("self")
+        main.extend(LambdaExtension)
+
         (config[:before_notify] ||= []) << lambda do |notice|
           data = Util::Lambda.normalized_data
 

data/lib/honeybadger/plugins/rails.rb

@@ -29,6 +29,16 @@ module Honeybadger
         end
       end
 
+      class ErrorSubscriber
+        def self.report(exception, handled:, severity:, context: {}, source: nil)
+          return if source && ::Honeybadger.config[:'rails.subscriber_ignore_sources'].any? { |regex| regex.match?(source) }
+
+          tags = ["severity:#{severity}", "handled:#{handled}"]
+          tags << "source:#{source}" if source
+          Honeybadger.notify(exception, context: context, tags: tags)
+        end
+      end
+
       Plugin.register :rails_exceptions_catcher do
         requirement { defined?(::Rails.application) && ::Rails.application }
 
@@ -41,6 +51,11 @@ module Honeybadger
             # Rails 3.0.x and 3.1.x
             ::ActionDispatch::ShowExceptions.prepend(ExceptionsCatcher)
           end
+
+          if defined?(::ActiveSupport::ErrorReporter)
+            # Rails 7
+            ::Rails.error.subscribe(ErrorSubscriber)
+          end
         end
       end
     end

data/lib/honeybadger/plugins/sidekiq.rb

@@ -5,7 +5,7 @@ module Honeybadger
   module Plugins
     module Sidekiq
       class Middleware
-        def call(worker, msg, queue)
+        def call(_worker, _msg, _queue)
           Honeybadger.clear!
           yield
         end
@@ -23,7 +23,7 @@ module Honeybadger
 
           if defined?(::Sidekiq::VERSION) && ::Sidekiq::VERSION > '3'
             ::Sidekiq.configure_server do |sidekiq|
-              sidekiq.error_handlers << lambda {|ex, params|
+              sidekiq.error_handlers << lambda { |ex, params|
                 job = params[:job] || params
                 job_retry = job['retry'.freeze]
 
@@ -37,13 +37,15 @@ module Honeybadger
                   attempt = retry_count ? retry_count + 1 : 0
 
                   # Ensure we account for modified max_retries setting
-                  retry_limit = job_retry == true ? (sidekiq.options[:max_retries] || 25) : job_retry.to_i
+                  default_max_retry_attempts = defined?(::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS) ? ::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS : 25
+                  retry_limit = job_retry == true ? (sidekiq.options[:max_retries] || default_max_retry_attempts) : job_retry.to_i
+
                   limit = [retry_limit, threshold].min
 
                   return if attempt < limit
                 end
 
-                opts = {parameters: params}
+                opts = { parameters: params }
                 if config[:'sidekiq.use_component']
                   opts[:component] = job['wrapped'.freeze] || job['class'.freeze]
                   opts[:action] = 'perform' if opts[:component]

data/lib/honeybadger/rack/error_notifier.rb

@@ -74,7 +74,7 @@ module Honeybadger
           agent.add_breadcrumb(
             exception.class,
             metadata: {
-              exception_message: exception.message
+              message: exception.message
             },
             category: "error"
           )

data/lib/honeybadger/singleton.rb

@@ -37,6 +37,7 @@ module Honeybadger
   def_delegator :'Honeybadger::Agent.instance', :add_breadcrumb
   def_delegator :'Honeybadger::Agent.instance', :breadcrumbs
   def_delegator :'Honeybadger::Agent.instance', :clear!
+  def_delegator :'Honeybadger::Agent.instance', :track_deployment
 
   # @!macro [attach] def_delegator
   #   @!method $2(...)

data/lib/honeybadger/templates/feedback_form.erb

@@ -4,7 +4,6 @@
 #honeybadger_feedback_form label { font-weight: bold; }
 #honeybadger_feedback_name, #honeybadger_feedback_email, #honeybadger_feedback_comment { width: 100%; padding: 0.5em; }
 #honeybadger_feedback_comment { height: 10em; }
-#honeybadger_feedback_submit { height: 1em; }
 #honeybadger_feedback_form .honeybadger-feedback-phone { display: none; }
 #honeybadger_feedback_link { font-size: 90%; }
 </style>

data/lib/honeybadger/util/lambda.rb

@@ -14,7 +14,7 @@ module Honeybadger
 
       class << self
         def lambda_execution?
-          !!ENV["AWS_EXECUTION_ENV"]
+          !!ENV["AWS_LAMBDA_FUNCTION_NAME"]
         end
 
         def normalized_data

data/lib/honeybadger/util/request_hash.rb

@@ -28,7 +28,7 @@ module Honeybadger
         return {} unless defined?(::Rack::Request)
         return {} unless env
 
-        hash, request = {}, ::Rack::Request.new(env)
+        hash, request = {}, ::Rack::Request.new(env.dup)
 
         hash[:url] = extract_url(request)
         hash[:params] = extract_params(request)

data/lib/honeybadger/util/revision.rb

@@ -3,9 +3,14 @@ module Honeybadger
     class Revision
       class << self
         def detect(root = Dir.pwd)
-          from_heroku ||
+          revision = from_heroku ||
             from_capistrano(root) ||
             from_git
+
+          revision = revision.to_s.strip
+          return unless revision =~ /\S/
+
+          revision
         end
 
         private
@@ -21,12 +26,12 @@ module Honeybadger
         def from_capistrano(root)
           file = File.join(root, 'REVISION')
           return nil unless File.file?(file)
-          File.read(file).strip rescue nil
+          File.read(file) rescue nil
         end
 
         def from_git
           return nil unless File.directory?('.git')
-          `git rev-parse HEAD`.strip rescue nil
+          `git rev-parse HEAD 2> #{File::NULL}` rescue nil
         end
       end
     end

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # The current String Honeybadger version.
-  VERSION = '4.7.2'.freeze
+  VERSION = '5.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 4.7.2
+  version: 5.0.2
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Error reports you can be happy about.