honeybadger 3.1.2 → 3.2.0.beta1

data/lib/honeybadger/context_manager.rb

@@ -1,5 +1,8 @@
+require 'honeybadger/conversions'
+
 module Honeybadger
   class ContextManager
+    include Conversions
 
     def self.current
       Thread.current[:__hb_context_manager] ||= new
@@ -19,7 +22,7 @@ module Honeybadger
     def set_context(hash)
       @mutex.synchronize do
         @context ||= {}
-        @context.update(hash)
+        @context.update(Context(hash))
       end
     end
 

data/lib/honeybadger/conversions.rb

@@ -0,0 +1,15 @@
+module Honeybadger
+  module Conversions
+    module_function
+
+    # Internal: Convert context into a Hash.
+    #
+    # object - The context object.
+    #
+    # Returns the Hash context.
+    def Context(object)
+      object = object.to_honeybadger_context if object.respond_to?(:to_honeybadger_context)
+      Hash(object)
+    end
+  end
+end

data/lib/honeybadger/logging.rb

@@ -85,7 +85,7 @@ module Honeybadger
     class StandardLogger < Base
       extend Forwardable
 
-      def initialize(logger = Logger.new('/dev/null'))
+      def initialize(logger = Logger.new(nil))
         raise ArgumentError, 'logger not specified' unless logger
         raise ArgumentError, 'logger must be a logger' unless logger.respond_to?(:add)
 
@@ -115,7 +115,7 @@ module Honeybadger
       INFO_SUPPLEMENT = ' level=%s pid=%s'.freeze
       DEBUG_SUPPLEMENT = ' at=%s'.freeze
 
-      def initialize(config, logger = Logger.new('/dev/null'))
+      def initialize(config, logger = Logger.new(nil))
         @config = config
         @tty = STDOUT.tty?
         @tty_level = @config.log_level(:'logging.tty_level')

data/lib/honeybadger/notice.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 
 require 'honeybadger/version'
 require 'honeybadger/backtrace'
+require 'honeybadger/conversions'
 require 'honeybadger/util/stats'
 require 'honeybadger/util/sanitizer'
 require 'honeybadger/util/request_hash'
@@ -23,7 +24,7 @@ module Honeybadger
   # Internal: Substitution for project root in backtrace lines.
   PROJECT_ROOT = '[PROJECT_ROOT]'.freeze
 
-  # Internal: Empty String (used for equality comparisons and assignment)
+  # Internal: Empty String (used for equality comparisons and assignment).
   STRING_EMPTY = ''.freeze
 
   # Internal: A Regexp which matches non-blank characters.
@@ -37,6 +38,8 @@ module Honeybadger
   class Notice
     extend Forwardable
 
+    include Conversions
+
     # Internal: The String character used to split tag strings.
     TAG_SEPERATOR = ','.freeze
 
@@ -50,6 +53,9 @@ module Honeybadger
     # Public: The exception that caused this notice, if any.
     attr_reader :exception
 
+    # Public: The exception cause if available.
+    attr_reader :cause
+
     # Public: The backtrace from the given exception or hash.
     attr_reader :backtrace
 
@@ -59,7 +65,7 @@ module Honeybadger
     # Public: Tags which will be applied to error.
     attr_reader :tags
 
-    # Public: The name of the class of error. (example: RuntimeError)
+    # Public: The name of the class of error (example: RuntimeError).
     attr_reader :error_class
 
     # Public: The message from the exception, or a general description of the error.
@@ -75,7 +81,7 @@ module Honeybadger
     def params; @request[:params]; end
     alias_method :parameters, :params
 
-    # Public: The component (if any) which was used in this request. (usually the controller)
+    # Public: The component (if any) which was used in this request (usually the controller).
     def component; @request[:component]; end
     alias_method :controller, :component
 
@@ -144,9 +150,10 @@ module Honeybadger
 
       @request = construct_request_hash(config, opts)
 
-      @context = construct_context_hash(opts)
+      @context = construct_context_hash(opts, exception)
 
-      @causes = unwrap_causes(@exception)
+      @cause = opts[:cause] || exception_cause(@exception) || $!
+      @causes = unwrap_causes(@cause)
 
       @tags = construct_tags(opts[:tags])
       @tags = construct_tags(context[:tags]) | @tags if context
@@ -163,9 +170,9 @@ module Honeybadger
       @fingerprint = construct_fingerprint(opts)
     end
 
-    # Internal: Template used to create JSON payload
+    # Internal: Template used to create JSON payload.
     #
-    # Returns Hash JSON representation of notice
+    # Returns Hash JSON representation of notice.
     def as_json(*args)
       @request[:context] = s(context)
       @request[:local_variables] = local_variables if local_variables
@@ -195,22 +202,22 @@ module Honeybadger
       }
     end
 
-    # Public: Creates JSON
+    # Public: Creates JSON.
     #
-    # Returns valid JSON representation of Notice
+    # Returns valid JSON representation of Notice.
     def to_json(*a)
       ::JSON.generate(as_json(*a))
     end
 
-    # Public: Allows properties to be accessed using a hash-like syntax
+    # Public: Allows properties to be accessed using a hash-like syntax.
     #
-    # method - The given key for an attribute
+    # method - The given key for an attribute.
     #
-    # Examples:
+    # Examples
     #
     #   notice[:error_message]
     #
-    # Returns the attribute value, or self if given +:request+
+    # Returns the attribute value, or self if given `:request`.
     def [](method)
       case method
       when :request
@@ -220,7 +227,7 @@ module Honeybadger
       end
     end
 
-    # Internal: Determines if this notice should be ignored
+    # Internal: Determines if this notice should be ignored.
     def ignore?
       ignore_by_origin? || ignore_by_class? || ignore_by_callbacks?
     end
@@ -242,15 +249,15 @@ module Honeybadger
     end
 
     # Gets a property named "attribute" of an exception, either from
-    # the #args hash or actual exception (in order of precidence)
+    # the #args hash or actual exception (in order of precidence).
     #
     # attribute - A Symbol existing as a key in #args and/or attribute on
-    #             Exception
-    # default   - Default value if no other value is found. (optional)
+    #             Exception.
+    # default   - Default value if no other value is found (optional).
     # block     - An optional block which receives an Exception and returns the
-    #             desired value
+    #             desired value.
     #
-    # Returns attribute value from args or exception, otherwise default
+    # Returns attribute value from args or exception, otherwise default.
     def exception_attribute(attribute, default = nil, &block)
       opts[attribute] || (exception && from_exception(attribute, &block)) || default
     end
@@ -273,12 +280,12 @@ module Honeybadger
       end
     end
 
-    # Internal: Determines if error class should be ignored
+    # Internal: Determines if error class should be ignored.
     #
     # ignored_class_name - The name of the ignored class. May be a
-    # string or regexp (optional)
+    # string or regexp (optional).
     #
-    # Returns true or false
+    # Returns true or false.
     def ignore_by_class?(ignored_class = nil)
       @ignore_by_class ||= Proc.new do |ignored_class|
         case error_class
@@ -317,10 +324,16 @@ module Honeybadger
       Util::RequestPayload.build(request)
     end
 
-    def construct_context_hash(opts)
+    def exception_context(exception)
+      return {}.freeze unless exception.respond_to?(:to_honeybadger_context)
+      exception.to_honeybadger_context
+    end
+
+    def construct_context_hash(opts, exception)
       context = {}
-      context.merge!(opts[:global_context]) if opts[:global_context]
-      context.merge!(opts[:context]) if opts[:context]
+      context.merge!(Context(opts[:global_context]))
+      context.merge!(Context(exception_context(exception)))
+      context.merge!(Context(opts[:context]))
       context.empty? ? nil : context
     end
 
@@ -362,7 +375,7 @@ module Honeybadger
     #
     # exception - The Exception containing the bindings stack.
     #
-    # Returns a Hash of local variables
+    # Returns a Hash of local variables.
     def local_variables_from_exception(exception, config)
       return nil unless send_local_variables?(config)
       return {} unless Exception === exception
@@ -394,7 +407,7 @@ module Honeybadger
 
     # Internal: Should local variables be sent?
     #
-    # Returns true to send local_variables
+    # Returns true to send local_variables.
     def send_local_variables?(config)
       config[:'exceptions.local_variables']
     end
@@ -440,23 +453,25 @@ module Honeybadger
       end
     end
 
-    # Internal: Unwrap causes from exception.
+    # Internal: Create a list of causes.
     #
-    # exception - Exception to unwrap.
+    # cause - The first cause to unwrap.
     #
-    # Returns Hash causes (in payload format).
-    def unwrap_causes(exception)
-      c, e, i = [], exception, 0
-      while (e = exception_cause(e)) && i < MAX_EXCEPTION_CAUSES
-        c << {
-          class: e.class.name,
-          message: e.message,
-          backtrace: parse_backtrace(e.backtrace || caller).to_a
+    # Returns Array causes (in Hash payload format).
+    def unwrap_causes(cause)
+      causes, c, i = [], cause, 0
+
+      while c && i < MAX_EXCEPTION_CAUSES
+        causes << {
+          class: c.class.name,
+          message: c.message,
+          backtrace: parse_backtrace(c.backtrace || caller).to_a
         }
         i += 1
+        c = exception_cause(c)
       end
 
-      c
+      causes
     end
 
     def params_filters
@@ -486,7 +501,7 @@ module Honeybadger
     # This method restores the correct #session method on @request and warns
     # the user of the issue.
     #
-    # Returns nothing
+    # Returns nothing.
     def monkey_patch_action_dispatch_test_process!
       return unless defined?(ActionDispatch::TestProcess) && defined?(self.fixture_file_upload)
 

data/lib/honeybadger/plugins/sidekiq.rb

@@ -24,9 +24,10 @@ module Honeybadger
           if defined?(::Sidekiq::VERSION) && ::Sidekiq::VERSION > '3'
             ::Sidekiq.configure_server do |sidekiq|
               sidekiq.error_handlers << lambda {|ex, params|
-                return if params['retry'.freeze] && params['retry_count'.freeze].to_i < config[:'sidekiq.attempt_threshold'].to_i
+                job = params[:job] || params
+                return if job['retry'.freeze] && job['retry_count'.freeze].to_i < config[:'sidekiq.attempt_threshold'].to_i
                 opts = {parameters: params}
-                opts[:component] = params['wrapped'.freeze] || params['class'.freeze] if config[:'sidekiq.use_component']
+                opts[:component] = job['wrapped'.freeze] || job['class'.freeze] if config[:'sidekiq.use_component']
                 Honeybadger.notify(ex, opts)
               }
             end

data/lib/honeybadger/rack/error_notifier.rb

@@ -8,7 +8,7 @@ module Honeybadger
     # Public: Middleware for Rack applications. Any errors raised by the upstream
     # application will be delivered to Honeybadger and re-raised.
     #
-    # Examples:
+    # Examples
     #
     #   require 'honeybadger/rack/error_notifier'
     #

data/lib/honeybadger/rack/user_feedback.rb

@@ -57,7 +57,7 @@ module Honeybadger
       end
 
       def custom_template_file?
-        custom_template_file && File.exists?(custom_template_file)
+        custom_template_file && File.exist?(custom_template_file)
       end
 
       def template_file

data/lib/honeybadger/singleton.rb

@@ -34,8 +34,6 @@ module Honeybadger
     config.api_key = 'project api key'
     config.exceptions.ignore += [CustomError]
   end
-
-  See https://git.io/v1Sd4 for documentation.
 WARNING
   end
 end

data/lib/honeybadger/util/sanitizer.rb

@@ -1,6 +1,8 @@
 require 'bigdecimal'
 require 'set'
 
+require 'honeybadger/conversions'
+
 module Honeybadger
   module Util
     # Internal: Sanitizer sanitizes data for sending to Honeybadger's API. The
@@ -12,14 +14,17 @@ module Honeybadger
 
       ENCODE_OPTS = { invalid: :replace, undef: :replace, replace: '?'.freeze }.freeze
 
+      BASIC_OBJECT = '#<BasicObject>'.freeze
+      DEPTH = '[DEPTH]'.freeze
       FILTERED = '[FILTERED]'.freeze
+      RAISED = '[RAISED]'.freeze
+      RECURSION = '[RECURSION]'.freeze
+      TRUNCATED = '[TRUNCATED]'.freeze
 
       IMMUTABLE = [NilClass, FalseClass, TrueClass, Symbol, Numeric, BigDecimal, Method].freeze
 
       MAX_STRING_SIZE = 65536
 
-      TRUNCATION_REPLACEMENT = '[TRUNCATED]'.freeze
-
       VALID_ENCODINGS = [Encoding::UTF_8, Encoding::ISO_8859_1].freeze
 
       def self.sanitize(data)
@@ -52,36 +57,47 @@ module Honeybadger
       end
 
       def sanitize(data, depth = 0, stack = nil, parents = [])
-        if enumerable?(data)
-          return '[possible infinite recursion halted]'.freeze if stack && stack.include?(data.object_id)
+        return BASIC_OBJECT if basic_object?(data)
+
+        if recursive?(data)
+          return RECURSION if stack && stack.include?(data.object_id)
+
           stack = stack ? stack.dup : Set.new
           stack << data.object_id
         end
 
         case data
         when Hash
-          return '[max depth reached]'.freeze if depth >= max_depth
+          return DEPTH if depth >= max_depth
+
           hash = data.to_hash
           new_hash = {}
+
           hash.each_pair do |key, value|
             parents.push(key) if deep_regexps
             key = key.kind_of?(Symbol) ? key : sanitize(key, depth+1, stack, parents)
+
             if filter_key?(key, parents)
               new_hash[key] = FILTERED
             else
               value = sanitize(value, depth+1, stack, parents)
-              if blocks.any? && !enumerable?(value)
+
+              if blocks.any? && !recursive?(value)
                 key = key.dup if can_dup?(key)
                 value = value.dup if can_dup?(value)
                 blocks.each { |b| b.call(key, value) }
               end
+
               new_hash[key] = value
             end
+
             parents.pop if deep_regexps
           end
+
           new_hash
         when Array, Set
-          return '[max depth reached]'.freeze if depth >= max_depth
+          return DEPTH if depth >= max_depth
+
           data.to_a.map do |value|
             sanitize(value, depth+1, stack, parents)
           end
@@ -89,15 +105,27 @@ module Honeybadger
           data
         when String
           sanitize_string(data)
-        else # all other objects:
-          data.respond_to?(:to_s) ? sanitize_string(data.to_s) : nil
-        end
-      end
+        when -> (d) { d.respond_to?(:to_honeybadger) }
+          begin
+            data = data.to_honeybadger
+          rescue
+            return RAISED
+          end
 
-      def sanitize_string(string)
-        string = valid_encoding(string.to_s)
-        return string unless string.respond_to?(:size) && string.size > MAX_STRING_SIZE
-        string[0...MAX_STRING_SIZE] + TRUNCATION_REPLACEMENT
+          sanitize(data, depth+1, stack, parents)
+        else # all other objects
+          klass = data.class
+
+          begin
+            data = String(data)
+          rescue
+            return RAISED
+          end
+
+          return "#<#{klass.name}>" if inspected?(data)
+
+          sanitize_string(data)
+        end
       end
 
       def filter_cookies(raw_cookies)
@@ -142,6 +170,12 @@ module Honeybadger
         false
       end
 
+      def sanitize_string(string)
+        string = valid_encoding(string)
+        return string unless string.respond_to?(:size) && string.size > MAX_STRING_SIZE
+        string[0...MAX_STRING_SIZE] + TRUNCATED
+      end
+
       def valid_encoding?(string)
         string.valid_encoding? && (
           VALID_ENCODINGS.include?(string.encoding) ||
@@ -154,13 +188,25 @@ module Honeybadger
         string.encode(Encoding::UTF_8, ENCODE_OPTS)
       end
 
-      def enumerable?(data)
-        data.kind_of?(Hash) || data.kind_of?(Array) || data.kind_of?(Set)
+      def recursive?(data)
+        data.is_a?(Hash) || data.is_a?(Array) || data.is_a?(Set) || data.respond_to?(:to_honeybadger)
+      end
+
+      def basic_object?(object)
+        object.respond_to?(:to_s)
+        false
+      rescue
+        # BasicObject doesn't respond to `#respond_to?`.
+        true
       end
 
       def can_dup?(obj)
         !IMMUTABLE.any? {|k| obj.kind_of?(k) }
       end
+
+      def inspected?(string)
+        String(string) =~ /#<.*>/
+      end
     end
   end
 end