honeybadger 4.7.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c106736f2bbc8d50ef833e9672693b6261cfb7c5852273caad63d2bd77c4e6c6
-  data.tar.gz: 1a23b8213a91d8f2cd0c58e33815bc78dec8c6cb0b361c6ae246b542667d1ab3
+  metadata.gz: f4c153814c322b2ffbd8064199f37a30814ab57fd768803f379da3d42f4b2a85
+  data.tar.gz: 88586b69b9ca68cd26cf619a39aef833bb18e360c1c140f275e8dd78b3470fce
 SHA512:
-  metadata.gz: b5fa74f25ec9d2acb5dcfb9743900015973c30f83082a8d67016e70afd767021c75dea3afb4179af365b35ebacd359f866fe72bec3ab59b1b9698a986cb1b8c8
-  data.tar.gz: d748ce7cbc8f5de4241d30bca391a1bcfb80e336720e1f8d7430af034b265898e4b76491cfabe36525b65ddcb7aa7956664b3648d0adf9642c9d5f4b14d9bf12
+  metadata.gz: 5ef4ba277d6953369569fa01f3008ff772d80e4bb6aadddbfa27ab55e29791ef49ebd8a9e4643133e7f6eccb0536a55f8937263e49b69c0e376dbdb5ba09cff7
+  data.tar.gz: 9703e65ff2847ef0f91c701a70b9f4aaae04d9bbdd13d28ec1021673d0b7bd110cc7e45de028c162441d4a1b165c5bdb5c587da0698fd7b08a398308cab9bcf6

data/CHANGELOG.md

@@ -5,6 +5,36 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [4.9.0] - 2021-06-28
+- Added 'ActionDispatch::Http::MimeNegotiation::InvalidType' (Rails 6.1) to
+  default ignore list. (#402, @jrochkind)
+- Replaced fixed number for retries in Sidekiq Plugin with Sidekiq::JobRetry constant
+- Properly set environment in deployment tracking (#404, @stmllr)
+
+## [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)
+- Check for UTF-8 in ActiveRecord breadcrumb exclusion filter
+
+## [4.7.1] - 2020-08-11
+### Fixed
+- ActiveRecord SQL Breadcrumb event pulls adapter from supplied connection,
+  allowing for multiple databases.
+- Fix Rails deprecation of `ActionDispatch::ParamsParser::ParseError`
+- Deal with invalid UTF-8 byte sequences during SQL obfuscation
+- Fix Ruby 2.7 deprecation notice in sql.rb
+
 ## [4.7.0] - 2020-06-02
 ### Fixed
 - Alias `Notice#controller=` as `Notice#component=`

data/lib/honeybadger/agent.rb

@@ -70,6 +70,8 @@ module Honeybadger
       if local_context
         @context ||= ContextManager.new
         @breadcrumbs = Breadcrumbs::Collector.new(config)
+      else
+        @breadcrumbs = nil
       end
 
       init_worker
@@ -188,6 +190,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/breadcrumbs/active_support.rb

@@ -15,17 +15,19 @@ module Honeybadger
               ["Active Record", name].compact.join(" - ")
             end,
             category: "query",
-            select_keys: [:sql, :name, :connection_id, :cached],
+            select_keys: [:sql, :name, :connection, :connection_id, :cached],
             transform: lambda do |data|
               if data[:sql]
-                adapter = active_record_connection_db_config[:adapter]
+                connection = data.delete(:connection)
+                adapter = (connection && connection.adapter_name.downcase) || active_record_connection_db_config[:adapter]
                 data[:sql] = Util::SQL.obfuscate(data[:sql], adapter)
               end
               data
             end,
             exclude_when: lambda do |data|
               # Ignore schema, begin, and commit transaction queries
-              data[:name] == "SCHEMA" || (data[:sql] && (data[:sql] =~ /^(begin|commit)( transaction)?$/i))
+              data[:name] == "SCHEMA" ||
+                (data[:sql] && (Util::SQL.force_utf_8(data[:sql].dup) =~ /^(begin|commit)( transaction)?$/i))
             end
           },
 

data/lib/honeybadger/cli/helpers.rb

@@ -15,7 +15,7 @@ To fix this issue, please try the following:
 
   - Make sure the gem is configured properly.
   - Retry executing this command a few times.
-  - Make sure you can connect to #{host} (`ping #{host}`).
+  - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
   - Email support@honeybadger.io for help. Include as much debug info as you
     can for a faster resolution!
 

data/lib/honeybadger/cli/main.rb

@@ -196,7 +196,7 @@ WELCOME
 # What can I do?
 
   - Retry the command.
-  - Make sure you can connect to api.honeybadger.io (`ping api.honeybadger.io`).
+  - Make sure you can connect to api.honeybadger.io (`curl https://api.honeybadger.io/v1/notices`).
   - If you continue to see this message, email us at support@honeybadger.io
     (don't forget to attach this output!)
 

data/lib/honeybadger/cli/test.rb

@@ -175,7 +175,7 @@ To fix this issue, please try the following:
 
   - Make sure the gem is configured properly.
   - Retry executing this command a few times.
-  - Make sure you can connect to #{host} (`ping #{host}`).
+  - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
   - Email support@honeybadger.io for help. Include as much debug info as you
     can for a faster resolution!
 

data/lib/honeybadger/config/defaults.rb

@@ -13,11 +13,17 @@ module Honeybadger
                       'ActionController::UnknownFormat',
                       'ActionController::InvalidAuthenticityToken',
                       'ActionController::InvalidCrossOriginRequest',
+                      # ActionDispatch::ParamsParser::ParseError was removed in Rails 6.0
+                      # and may be removed here once support for Rails 5.2 is dropped.
+                      # https://github.com/rails/rails/commit/e16c765ac6dcff068ff2e5554d69ff345c003de1
+                      # https://github.com/honeybadger-io/honeybadger-ruby/pull/358
                       'ActionDispatch::ParamsParser::ParseError',
+                      'ActionDispatch::Http::Parameters::ParseError',
                       'ActionController::BadRequest',
                       'ActionController::ParameterMissing',
                       'ActiveRecord::RecordNotFound',
                       'ActionController::UnknownAction',
+                      'ActionDispatch::Http::MimeNegotiation::InvalidType',
                       'Rack::QueryParser::ParameterTypeError',
                       'Rack::QueryParser::InvalidParameterError',
                       'CGI::Session::CookieStore::TamperedWithCookie',

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/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/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/revision.rb

@@ -26,7 +26,7 @@ module Honeybadger
 
         def from_git
           return nil unless File.directory?('.git')
-          `git rev-parse HEAD`.strip rescue nil
+          `git rev-parse HEAD 2> #{File::NULL}`.strip rescue nil
         end
       end
     end

data/lib/honeybadger/util/sql.rb

@@ -11,7 +11,7 @@ module Honeybadger
       DoubleQuoters = /(postgres|sqlite|postgis)/.freeze
 
       def self.obfuscate(sql, adapter)
-        sql.dup.tap do |s|
+        force_utf_8(sql.dup).tap do |s|
           s.gsub!(EscapedQuotes, EmptyReplacement)
           s.gsub!(SQuotedData, Replacement)
           s.gsub!(DQuotedData, Replacement) if adapter =~ DoubleQuoters
@@ -20,6 +20,15 @@ module Honeybadger
           s.squeeze!(' ')
         end
       end
+
+      def self.force_utf_8(string)
+        string.encode(
+          Encoding.find('UTF-8'),
+          invalid: :replace, 
+          undef: :replace, 
+          replace: ''
+        )
+      end
     end
   end
 end

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2021-06-28 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.1.4
 signing_key: 
 specification_version: 4
 summary: Error reports you can be happy about.