failbot 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d59eaaa4b282ed08208605e95c1016cf129cc2bc8d8a877d9be047aac0a7a98
-  data.tar.gz: 08e20096fdc2ca17e6decb2a0528d0170d4dd836f627f1ef79de5062ff972684
+  metadata.gz: 72511c74e8a4c9b1dd06d9408c0c926568382e8e72cd3e3a28b7d262835e9aef
+  data.tar.gz: 649f8f43daedeb3044cc1457b09948b9f354db737e73e5b512a1ad2f90850684
 SHA512:
-  metadata.gz: 26da2ec068e6e273b984bf9c8ff5d231182914bff9a3bb0861e13854f1a43a8bab3587ea8b12531b4d2d41c2f98e71fa94e7880fa1ca0237fca4634eb46f04d0
-  data.tar.gz: ca25afcbfd0e45c8cf23218b4cc695347f9f39294e943a6402f4b698ff3dbeb22f0179276f7d691e323c9a6b733de034f88c9e9b3d3c57582ec1688be81c606b
+  metadata.gz: 95a20c76e4bee8e8517065af5f3d9325cf6773bcbb6f08f6a41e479ac41359927fe0c00aedd5dbd3fe43c1259d2cce44bd809c3b5aba913f7664844555101581
+  data.tar.gz: 163ca9571024669fa96a6ccfca233b4f81e23e4fe1e4b80a69c837dfd618eda50b20b8a3fa50e3cb99d053cd287448b2156d58816bfd72a22c455fcd53a113d2

data/lib/failbot.rb

@@ -9,6 +9,8 @@ require "uri"
 require 'failbot/version'
 require "failbot/compat"
 require "failbot/sensitive_data_scrubber"
+require "failbot/exception_format/haystack"
+require "failbot/exception_format/structured"
 
 # Failbot asynchronously takes exceptions and reports them to the
 # exception logger du jour. Keeps the main app from failing or lagging if
@@ -52,6 +54,26 @@ module Failbot
   # stubbed methods are replaced properly.
   require 'failbot/exit_hook'
 
+  EXCEPTION_DETAIL = 'exception_detail'
+
+  # Enumerates the available exception formats this gem supports.  The original
+  # format and the default is :haystack and the newer format is :structured
+  EXCEPTION_FORMATS = {
+    :haystack => ExceptionFormat::Haystack,
+    :structured => ExceptionFormat::Structured
+  }
+
+  # Set the current exception format.
+  def self.exception_format=(identifier)
+    @exception_formatter = EXCEPTION_FORMATS.fetch(identifier) do
+      fail ArgumentError, "#{identifier} is not an available exception_format (want one of #{EXCEPTION_FORMATS.keys})"
+    end
+  end
+
+  # Default to the original exception format used by haystack unless
+  # apps opt in to the newer version.
+  self.exception_format = :haystack
+
   # Public: Setup the backend for reporting exceptions.
   def setup(settings={}, default_context={})
     deprecated_settings = %w[
@@ -95,6 +117,11 @@ module Failbot
     # allows overriding the 'app' value to send to single haystack bucket.
     # used primarily on ghe.io.
     @app_override = settings["FAILBOT_APP_OVERRIDE"]
+
+    # Support setting exception_format from ENV/settings
+    if settings["FAILBOT_EXCEPTION_FORMAT"]
+      self.exception_format = settings["FAILBOT_EXCEPTION_FORMAT"].to_sym
+    end
   end
 
   # Bring in deprecated methods
@@ -348,6 +375,14 @@ module Failbot
           value
         when String, true, false
           value.to_s
+        when Array
+          if key == EXCEPTION_DETAIL
+            # special-casing for the exception_detail key, which is allowed to
+            # be an array with a specific structure.
+            value
+          else
+            value.inspect
+          end
         else
           value.inspect
         end
@@ -360,21 +395,9 @@ module Failbot
   #
   # e - The exception object to turn into a Hash.
   #
-  # Returns a Hash including a 'class', 'message', 'backtrace' keys.
+  # Returns a Hash.
   def exception_info(e)
-    backtrace = Array(e.backtrace)[0, 500]
-
-    res = {
-      'class'      => e.class.to_s,
-      'message'    => e.message,
-      'backtrace'  => backtrace.join("\n"),
-      'ruby'       => RUBY_DESCRIPTION,
-      'created_at' => Time.now.utc.iso8601(6)
-    }
-
-    if cause = pretty_print_cause(e)
-      res['cause'] = cause
-    end
+    res = @exception_formatter.call(e)
 
     if exception_context = (e.respond_to?(:failbot_context) && e.failbot_context)
       res.merge!(exception_context)
@@ -421,76 +444,6 @@ module Failbot
     end
   end
 
-  # We'll include this many nested Exception#cause objects in the needle
-  # context. We limit the number of objects to prevent excessive recursion and
-  # large needle contexts.
-  MAXIMUM_CAUSE_DEPTH = 2
-
-  # Pretty-print Exception#cause (and nested causes) for inclusion in needle
-  # context
-  #
-  # e     - The Exception object whose #cause should be printed
-  # depth - Integer number of Exception#cause objects to descend into.
-  #
-  # Returns a String.
-  def pretty_print_cause(e, depth = MAXIMUM_CAUSE_DEPTH)
-    return unless depth > 0
-
-    causes = []
-
-    current = e
-    depth.times do
-      pretty_cause = pretty_print_one_cause(current)
-      break unless pretty_cause
-      causes << pretty_cause
-      current = current.cause
-    end
-
-    return if causes.empty?
-
-    result = causes.join("\n\nCAUSED BY:\n\n")
-
-    if current.respond_to?(:cause) && current.cause
-      result << "\n\nFurther #cause backtraces were omitted\n"
-    end
-
-    result
-  end
-
-  # Pretty-print a single Exception#cause
-  #
-  # e - The Exception object whose #cause should be printed
-  #
-  # Returns a String.
-  def pretty_print_one_cause(e)
-    return unless e.respond_to?(:cause)
-    cause = e.cause
-    return unless cause
-
-    result = "#{cause.class.name}: #{cause.message}\n"
-
-    # Find where the cause's backtrace differs from the child exception's.
-    backtrace = Array(e.backtrace)
-    cause_backtrace = Array(cause.backtrace)
-    index = -1
-    min_index = [backtrace.size, cause_backtrace.size].min * -1
-    just_in_case = -5000
-
-    while index > min_index && backtrace[index] == cause_backtrace[index] && index >= just_in_case
-      index -= 1
-    end
-
-    # Add on a few common frames to make it clear where the backtraces line up.
-    index += 3
-    index = -1 if index >= 0
-
-    cause_backtrace[0..index].each do |line|
-      result << "\t#{line}\n"
-    end
-
-    result
-  end
-
   extend self
 
   # If the library was lazy loaded due to failbot/exit_hook.rb and a delayed

data/lib/failbot/backtrace.rb

@@ -0,0 +1,64 @@
+module Failbot
+  # A simple parser to extract structure from ruby backtraces.
+  class Backtrace
+    # Raised when a line fails parsing.
+    ParseError = Class.new(StandardError)
+
+    attr_reader :frames
+
+    def self.parse(backtrace)
+      fail ArgumentError, "expected Array, got #{backtrace.class}" unless backtrace.is_a?(Array)
+
+      frames = backtrace.map do |frame|
+        Frame.parse(frame)
+      end
+
+      new(frames)
+    end
+
+    def initialize(frames)
+      @frames = frames
+    end
+
+    # A parsed stack frame.
+    class Frame
+      # Regex matching the components of a ruby stack frame as they
+      # are printed in a backtrace.
+
+      # Regex adapted from sentry's parser:
+      # https://github.com/getsentry/raven-ruby/blob/2e4378d95dae95a31e3386b2b94c8520649c6876/lib/raven/backtrace.rb#L10-L14
+      FRAME_FORMAT = /
+        \A
+          \s*
+          ([^:]+ | <.*>):         # file_name
+          (\d+)                   # line_number
+          (?: :in \s `([^']+)')?  # method
+        \z
+      /x
+
+      attr_reader :file_name, :line_number, :method
+
+      # Returns a Frame given backtrace component string or raises
+      # ParseError if it's malformed.
+      def self.parse(unparsed_line)
+        match = unparsed_line.match(FRAME_FORMAT)
+        if match
+          file_name, line_number, method = match.captures
+          new(file_name, line_number, method)
+        else
+          raise ParseError, "unable to parse #{unparsed_line.inspect}"
+        end
+      end
+
+      def initialize(file_name, line_number, method)
+        @file_name = file_name
+        @line_number = line_number
+        @method = method
+      end
+
+      def to_s
+        "#{file_name}:#{line_number}:in `#{method}'"
+      end
+    end
+  end
+end

data/lib/failbot/exception_format/haystack.rb

@@ -0,0 +1,94 @@
+module Failbot
+  module ExceptionFormat
+    # The format recognized by haystack.
+    class Haystack
+
+      # Format an exception.
+      def self.call(e)
+        res = {
+          'class'      => e.class.to_s,
+          'message'    => e.message,
+          'backtrace'  => Array(e.backtrace)[0,500].join("\n"),
+          'ruby'       => RUBY_DESCRIPTION,
+          'created_at' => Time.now.utc.iso8601(6)
+        }
+
+        if cause = pretty_print_cause(e)
+          res['cause'] = cause
+        end
+
+        res
+      end
+
+      # We'll include this many nested Exception#cause objects in the needle
+      # context. We limit the number of objects to prevent excessive recursion and
+      # large needle contexts.
+      MAXIMUM_CAUSE_DEPTH = 2
+
+      # Pretty-print Exception#cause (and nested causes) for inclusion in needle
+      # context
+      #
+      # e     - The Exception object whose #cause should be printed
+      # depth - Integer number of Exception#cause objects to descend into.
+      #
+      # Returns a String.
+      def self.pretty_print_cause(e, depth = MAXIMUM_CAUSE_DEPTH)
+        return unless depth > 0
+
+        causes = []
+
+        current = e
+        depth.times do
+          pretty_cause = pretty_print_one_cause(current)
+          break unless pretty_cause
+          causes << pretty_cause
+          current = current.cause
+        end
+
+        return if causes.empty?
+
+        result = causes.join("\n\nCAUSED BY:\n\n")
+
+        if current.respond_to?(:cause) && current.cause
+          result << "\n\nFurther #cause backtraces were omitted\n"
+        end
+
+        result
+      end
+
+      # Pretty-print a single Exception#cause
+      #
+      # e - The Exception object whose #cause should be printed
+      #
+      # Returns a String.
+      def self.pretty_print_one_cause(e)
+        return unless e.respond_to?(:cause)
+        cause = e.cause
+        return unless cause
+
+        result = "#{cause.class.name}: #{cause.message}\n"
+
+        # Find where the cause's backtrace differs from the child exception's.
+        backtrace = Array(e.backtrace)
+        cause_backtrace = Array(cause.backtrace)
+        index = -1
+        min_index = [backtrace.size, cause_backtrace.size].min * -1
+        just_in_case = -5000
+
+        while index > min_index && backtrace[index] == cause_backtrace[index] && index >= just_in_case
+          index -= 1
+        end
+
+        # Add on a few common frames to make it clear where the backtraces line up.
+        index += 3
+        index = -1 if index >= 0
+
+        cause_backtrace[0..index].each do |line|
+          result << "\t#{line}\n"
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/failbot/exception_format/structured.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "failbot/backtrace"
+
+module Failbot
+  module ExceptionFormat
+    # A newer exception format , based on the one sentry uses.  Aside from
+    # different names and locations for things, the notable difference from
+    # haystack is that backtrace data has more structure.
+    class Structured
+      EMPTY_ARRAY = [].freeze
+
+      # Format an exception.
+      def self.call(e)
+        message = e.message.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}"
+          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,
+              "value" => message,
+              "stacktrace" => stacktrace
+            }
+          ],
+          "ruby" => RUBY_DESCRIPTION,
+          "created_at" => Time.now.utc.iso8601(6)
+        }
+      end
+
+      def self.formatted_backtrace(e)
+        if e.backtrace
+          Backtrace.parse(e.backtrace).frames.reverse.map do |line|
+            {
+              "filename" => line.file_name,
+              "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.3.3"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - "@rtomayko"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -90,8 +90,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/failbot.rb
+- lib/failbot/backtrace.rb
 - lib/failbot/compat.rb
 - lib/failbot/console_backend.rb
+- lib/failbot/exception_format/haystack.rb
+- lib/failbot/exception_format/structured.rb
 - lib/failbot/exit_hook.rb
 - lib/failbot/failbot.yml
 - lib/failbot/file_backend.rb
@@ -122,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Deliver exceptions to Haystack