failbot 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b0cb0e395a797b15f920bf62da3a4bc56a92545000e12f7195ac72e3df7288
-  data.tar.gz: 68dc6a523edceecc6b15f45799cabd380927f24d934b6c876c2d7f0726c55241
+  metadata.gz: 53e182bf0325cad972095bfc874140de2c28b0b771070719e7aff54fb02d8fae
+  data.tar.gz: 8da6d5c26fcfe301e0df2edf096e2afa0e19f40e5941ae5b03e084d8435cfab0
 SHA512:
-  metadata.gz: fa5282763cef5946b344467cc0f8a568e7b364cc682b038bff2abcc0f807a5e86de4f454e76a70dd2c17e60c017a6a13d82e34099d0297b8b5c77c5ba41dd01f
-  data.tar.gz: cac6f6bf0d01b2266d3c3b41507a84274bfaa9f1f9bc2d1f8b2780a1bd7c3ac51f32b4dba98541b9e6f374010559afb9769f500ee8df9cf423c6cc7e3fecc014
+  metadata.gz: 04c21e6c698b040686e522ebe442c04b03a31c4875e904395f4e312e07cc1741e31b59f7eca22dd5475fd32a8a867c0537306f5fbf36ef44870b5337f62ef31e
+  data.tar.gz: e13a7e8a016abddc60e5f071cc4b46d73f3f4e42e575bd123999d68dafdfcd7b42ec1ce2e52dfa0c4a8032b5acfbfaaaf93d6dd43efaf201ab1ad30ad085bd78

data/lib/failbot.rb

@@ -46,6 +46,16 @@ module Failbot
   # prevent recursive calls to Failbot.report!
   attr_accessor :already_reporting
 
+  # Root directory of the project's source. Used to clean up stack traces if the exception format supports it
+
+  def source_root=(str)
+    @source_root = if str
+      File.join(str, '')
+    end
+  end
+
+  attr_reader :source_root
+
   # see failbot/exit_hook.rb for more on these
   @failbot_loaded = true
   @auto_install_hook = false

data/lib/failbot/backtrace.rb

@@ -1,5 +1,7 @@
 module Failbot
   # A simple parser to extract structure from ruby backtraces.
+  #
+  # See https://docs.sentry.io/development/sdk-dev/event-payloads/stacktrace/ for details on what data can sent
   class Backtrace
     # Raised when a line fails parsing.
     ParseError = Class.new(StandardError)
@@ -30,27 +32,53 @@ module Failbot
       FRAME_FORMAT = /
         \A
           \s*
-          ([^:]+ | <.*>):         # file_name
+          ([^:]+ | <.*>):         # abs_path
           (\d+)                   # line_number
           (?: :in \s `([^']+)')?  # method
         \z
       /x
 
-      attr_reader :file_name, :line_number, :method
+      attr_reader :file_name, :line_number, :method, :abs_path
 
       # 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)
+          abs_path, line_number, method = match.captures
+
+          file_name = extract_file_name(abs_path)
+
+          new(abs_path, file_name, line_number, method)
         else
           raise ParseError, "unable to parse #{unparsed_line.inspect}"
         end
       end
 
-      def initialize(file_name, line_number, method)
+      # Older versions of ruby don't have String#delete_prefix so for them we
+      # fall back to a slower implementation.
+      if String.new.respond_to?(:delete_prefix)
+        def self.extract_file_name(abs_path)
+          if Failbot.source_root
+            abs_path.delete_prefix(Failbot.source_root)
+          else
+            abs_path
+          end
+        end
+      else
+        def self.extract_file_name(abs_path)
+          if Failbot.source_root
+            abs_path.gsub(/\A#{Failbot.source_root}/, "")
+          else
+            abs_path
+          end
+        end
+      end
+
+      private_class_method :extract_file_name
+
+      def initialize(abs_path, file_name, line_number, method)
+        @abs_path = abs_path
         @file_name = file_name
         @line_number = line_number
         @method = method

data/lib/failbot/exception_format/structured.rb

@@ -47,6 +47,7 @@ module Failbot
           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
             }

data/lib/failbot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - "@rtomayko"