honeybadger 4.6.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0a903cc9a64fe0e5b5bcbfef32b81656217d38316ffc66d368d8cc8982bdc04
-  data.tar.gz: fd4ff117b94da660a2039ebc106e7c29430834f3c691c6940cc1bc483dcbc0ac
+  metadata.gz: b3ec66f5016be98ed5d5a4d805a7dca2069a1c585ac10809813acd999a4f96eb
+  data.tar.gz: d7a4179a6bfad487e789749ca3e38d90bc84cc4bfa1b4fbc2ce48b48a233023c
 SHA512:
-  metadata.gz: e3f58753fa625545ffba12aaa7d9a86e3f8c7c8e3dc6ca1eaa518dd69e1636ef03d4a4b8a71677f34d8816166700102962e94288cb4e82913d1f5c2c0b6564f7
-  data.tar.gz: 33459d61b1eae5ab575f65a0ff6b1b7e64a891538b4f5508fe3a45b72fa8c47830a55007858f8aaef97b1c5eaf22a6efdfa3e9147e53eda9a9cde8e854335f7f
+  metadata.gz: c5b6a551d2d3fe7feca0d4c9c02878e476a5478532475a50b46f84801ede717ea7909903c8b267f33cf62fd1dac22d8258905e86fc764f372ce63bd7bdfcd400
+  data.tar.gz: d143a769fe1407606480ca83415e63c937bf7d26d3ce1cbf436eefad84542c9079b6eb8659bbb31d10fadc9baa03a38e96601e7d5e08f8e8cea9a1a0fee26ebc

data/CHANGELOG.md

@@ -5,11 +5,46 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [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=`
+- Fix Rails 6.1 deprecation warning with `ActiveRecord::Base.connection_config`
+- Fix agent where breadcrumbs.enabled = true and local_context = true
+
+### Added
+- Add `honeybadger_skip_rails_load` Capistrano option to skip rails load on
+  deployment notification (#355) -@NielsKSchjoedt
+
 ## [4.6.0] - 2020-03-12
 ### Fixed
 - Fixed issue where Sidekiq.attempt_threshold was triggering 2 attempts ahead
   of the setting
 - Dup notify opts before mutating (#345)
+
 ### Changed
 - Breadcrumbs on by default
 - Added Faktory plugin -@scottrobertson

data/README.md

@@ -1,6 +1,7 @@
 # Honeybadger for Ruby
 
-[![CircleCI](https://circleci.com/gh/honeybadger-io/honeybadger-ruby.svg?style=svg)](https://circleci.com/gh/honeybadger-io/honeybadger-ruby)
+![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)
 

data/lib/honeybadger/agent.rb

@@ -63,13 +63,17 @@ module Honeybadger
       end
 
       @context = opts.delete(:context)
-      if opts.delete(:local_context)
+      local_context = opts.delete(:local_context)
+
+      @config ||= Config.new(opts)
+
+      if local_context
         @context ||= ContextManager.new
         @breadcrumbs = Breadcrumbs::Collector.new(config)
+      else
+        @breadcrumbs = nil
       end
 
-      @config ||= Config.new(opts)
-
       init_worker
     end
 
@@ -186,6 +190,29 @@ module Honeybadger
       response.success?
     end
 
+    # Track a new deployment
+    #
+    # @example
+    #   Honeybadger.track_deployment(revision: 'be2ceb6')
+    #
+    # @param [String] :env 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(env: nil, revision: nil, local_username: nil, repository: nil)
+      opts = {
+        env: env || 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 = ::ActiveRecord::Base.connection_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
           },
 
@@ -103,6 +105,15 @@ module Honeybadger
         }
       end
 
+      private_class_method def self.active_record_connection_db_config
+        if ::ActiveRecord::Base.respond_to?(:connection_db_config)
+          # >= Rails 6.1
+          ::ActiveRecord::Base.connection_db_config.configuration_hash
+        else
+          # < Rails 6.1
+          ::ActiveRecord::Base.connection_config
+        end
+      end
     end
   end
 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,7 +13,12 @@ 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',

data/lib/honeybadger/notice.rb

@@ -118,6 +118,7 @@ module Honeybadger
     # The component (if any) which was used in this request (usually the controller).
     attr_accessor :component
     alias_method :controller, :component
+    alias_method :controller=, :component=
 
     # The action (if any) that was called in this request.
     attr_accessor :action

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.6.0'.freeze
+  VERSION = '4.8.0'.freeze
 end

data/vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap

@@ -24,6 +24,7 @@ namespace :honeybadger do
 
         api_key = fetch(:honeybadger_api_key, ENV['HONEYBADGER_API_KEY'])
         options += ['--api-key', api_key] if api_key
+        options << '--skip-rails-load' if fetch(:honeybadger_skip_rails_load, false)
 
         if fetch(:honeybadger_async_notify, false)
           ::SSHKit.config.command_map.prefix[:honeybadger].push(:nohup)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2021-03-16 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.0.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Error reports you can be happy about.