failbot 2.4.2 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e182bf0325cad972095bfc874140de2c28b0b771070719e7aff54fb02d8fae
-  data.tar.gz: 8da6d5c26fcfe301e0df2edf096e2afa0e19f40e5941ae5b03e084d8435cfab0
+  metadata.gz: c5d1f28105f9f590c7c9160004bfa4a15101da5a1372ee0e40e882c493dad5fd
+  data.tar.gz: 5b09392f7d2243343a7982c6ae031f80d8501eb946d687490be6ad88e7321b1f
 SHA512:
-  metadata.gz: 04c21e6c698b040686e522ebe442c04b03a31c4875e904395f4e312e07cc1741e31b59f7eca22dd5475fd32a8a867c0537306f5fbf36ef44870b5337f62ef31e
-  data.tar.gz: e13a7e8a016abddc60e5f071cc4b46d73f3f4e42e575bd123999d68dafdfcd7b42ec1ce2e52dfa0c4a8032b5acfbfaaaf93d6dd43efaf201ab1ad30ad085bd78
+  metadata.gz: 011af8c261c0826685972133268b52b85dcd358c402ee662575ef853b36f7c8ea6ff527673f2ec1210316d9cefc053aa8a20b119bfd55c09cf9666cbd6a0eeb8
+  data.tar.gz: 58bc429f5b2e27ef75f570eb2d194d2e956dc935bc5ec471042a0029ae8e14a929ee486abe25d2bd9e52ee9f052eccec559b18f31bf3ee292441e51820880bf1

data/lib/failbot.rb

@@ -11,6 +11,7 @@ require "failbot/compat"
 require "failbot/sensitive_data_scrubber"
 require "failbot/exception_format/haystack"
 require "failbot/exception_format/structured"
+require "failbot/default_backtrace_parser"
 
 # Failbot asynchronously takes exceptions and reports them to the
 # exception logger du jour. Keeps the main app from failing or lagging if
@@ -84,6 +85,27 @@ module Failbot
   # apps opt in to the newer version.
   self.exception_format = :haystack
 
+  # Set a callable that is responsible for parsing and formatting ruby
+  # backtraces.  This is only necessary to set if your app deals with
+  # exceptions that are manipulated to contain something other than actual
+  # stackframe strings in the format produced by `caller`.  The argument passed
+  # must respond to `call` with an arity of 1.  The callable expects to be
+  # passed Exception instances as its argument.
+  def self.backtrace_parser=(callable)
+    unless callable.respond_to?(:call)
+      raise ArgumentError, "backtrace_parser= passed #{callable.inspect}, which is not callable"
+    end
+    if callable.method(:call).arity != 1
+      raise ArgumentError, "backtrace_parser= passed #{callable.inspect}, whose `#call` has arity =! 1"
+    end
+    @backtrace_parser = callable
+  end
+
+  attr_reader :backtrace_parser
+
+  # Default backtrace parser is provided:
+  self.backtrace_parser = ::Failbot::DefaultBacktraceParser
+
   # Helpers needed to parse hashes included in e.g. Failbot.reports.
   def self.exception_message_from_hash(hash)
     @exception_formatter.exception_message_from_hash(hash)

data/lib/failbot/default_backtrace_parser.rb

@@ -0,0 +1,23 @@
+module Failbot
+  # This is the default backtrace parser for the Structured formatter.
+  module DefaultBacktraceParser
+    EMPTY_ARRAY = [].freeze
+
+    # Takes an Exception instance, returns an array of hashes with the keys
+    # that the Structured formatter expects.
+    def self.call(exception)
+      if exception.backtrace
+        Backtrace.parse(exception.backtrace).frames.reverse.map do |line|
+          {
+            "filename" => line.file_name,
+            "abs_path" => line.abs_path,
+            "lineno"   => line.line_number,
+            "function" => line.method
+          }
+        end
+      else
+        EMPTY_ARRAY
+      end
+    end
+  end
+end

data/lib/failbot/exception_format/structured.rb

@@ -13,16 +13,18 @@ module Failbot
       # Format an exception.
       def self.call(e)
         message = e.message.to_s
+        class_name = e.class.to_s
         stacktrace = begin
-          formatted_backtrace(e) || EMPTY_ARRAY
-        rescue Backtrace::ParseError
-          message += "\nUnable to parse backtrace!  Don't put non-backtrace text in Exception#backtrace please!\n#{e.backtrace}"
+          Failbot.backtrace_parser.call(e)
+        rescue => ex
+          message += "\nUnable to parse backtrace (#{ex.inspect})\nDon't put non-backtrace text in Exception#backtrace please!\nSo-called backtrace follows:\n#{e.backtrace.join("\n")}"
+          class_name += " (backtrace failed to parse)"
           EMPTY_ARRAY
         end
         {
           "exception_detail" => [ # TODO Once supported in failbotg, this should be an array of
             {                     # hashes generated from subsequent calls to Exception#cause.
-              "type" => e.class.to_s,
+              "type" => class_name,
               "value" => message,
               "stacktrace" => stacktrace
             }
@@ -41,19 +43,6 @@ module Failbot
       def self.exception_classname_from_hash(hash)
         hash.dig("exception_detail", 0, "type")
       end
-
-      def self.formatted_backtrace(e)
-        if e.backtrace
-          Backtrace.parse(e.backtrace).frames.reverse.map do |line|
-            {
-              "filename" => line.file_name,
-              "abs_path" => line.abs_path,
-              "lineno"   => line.line_number,
-              "function" => line.method
-            }
-          end
-        end
-      end
     end
   end
 end

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "2.4.2"
+  VERSION = "2.4.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.3
 platform: ruby
 authors:
 - "@rtomayko"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -93,6 +93,7 @@ files:
 - lib/failbot/backtrace.rb
 - lib/failbot/compat.rb
 - lib/failbot/console_backend.rb
+- lib/failbot/default_backtrace_parser.rb
 - lib/failbot/exception_format/haystack.rb
 - lib/failbot/exception_format/structured.rb
 - lib/failbot/exit_hook.rb