failbot 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d95ed657556e73833f309a37497784e45ac94f959f79988acf8ac066e6f4a6b
-  data.tar.gz: c95554288cab069cf33ce8c1c4bdfad43ebaa5e9e1f1f83492865e67d014977d
+  metadata.gz: e17fb2d80a08382f07201582e708558ab9288c33c085950136d42c38ac9e47ff
+  data.tar.gz: 664d9e980cb2901a1487518435a8c15bcd1e7fbce8d72eb16298e43db50d531c
 SHA512:
-  metadata.gz: a1223f04684f214ed5dfcdf444a1e4b9b1a209aee0ba1aa065e85e52603b3fda012790002237b3629ca9e588533aec48a2bd482d995ffa5d149f575c8619465c
-  data.tar.gz: 2acb08a403bbdd7b4fdae7973e40a11320b1002bac4aba4e8393d467d8c9b45d45efa0eaae85b4b6b4e6139be1b7185e7d387ccff7edba33b9dfe4724eaad963
+  metadata.gz: 5228d0b4914759a86d5605b8573f4c55de41716b2f9fa1248c6df87c169dacff3653a46da0ad4287866ecdb8a60aac5b0ed762202c0aaff89444e3b7cbbd75da
+  data.tar.gz: 332e27bc52d28068b62b6eda1fe30925401788ab3225f68d0a09573e07182f2caa6e7437edf6627cd94cba9fa0be04c44fd6a873e594428ea8bf78a22e2707fa

data/lib/failbot.rb

@@ -66,6 +66,11 @@ module Failbot
 
   EXCEPTION_DETAIL = 'exception_detail'
 
+  # 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
+
   # Enumerates the available exception formats this gem supports.  The original
   # format and the default is :haystack and the newer format is :structured
   EXCEPTION_FORMATS = {

data/lib/failbot/exception_format/haystack.rb

@@ -30,11 +30,6 @@ module Failbot
         hash["class"]
       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
       #
@@ -59,7 +54,7 @@ module Failbot
 
         result = causes.join("\n\nCAUSED BY:\n\n")
 
-        if current.respond_to?(:cause) && current.cause
+        if current.cause
           result << "\n\nFurther #cause backtraces were omitted\n"
         end
 
@@ -72,7 +67,6 @@ module Failbot
       #
       # Returns a String.
       def self.pretty_print_one_cause(e)
-        return unless e.respond_to?(:cause)
         cause = e.cause
         return unless cause
 

data/lib/failbot/exception_format/structured.rb

@@ -22,18 +22,47 @@ module Failbot
           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" => class_name,
-              "value" => message,
-              "stacktrace" => stacktrace
-            }
-          ],
+          "exception_detail" => exception_details(e),
           "ruby" => RUBY_DESCRIPTION,
           "created_at" => Time.now.utc.iso8601(6)
         }
       end
 
+      FURTHER_CAUSES_WERE_OMITTED = {
+        "type" => "Notice",
+        "value" => "further Exception#cause values were omitted",
+        "stacktrace" => EMPTY_ARRAY
+      }.freeze
+
+      def self.exception_details(e)
+        result = []
+        depth = 0
+
+        loop do
+          message = e.message.to_s
+          class_name = e.class.to_s
+          stacktrace = begin
+            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
+          result.unshift({
+            "type" => class_name,
+            "value" => message,
+            "stacktrace" => stacktrace
+          })
+          depth += 1
+          break unless (e=e.cause)
+          if depth > MAXIMUM_CAUSE_DEPTH
+            result.unshift(FURTHER_CAUSES_WERE_OMITTED)
+            break
+          end
+        end
+        result
+      end
+
       # given a hash generated by this class, return the exception message.
       def self.exception_message_from_hash(hash)
         hash.dig("exception_detail", 0, "value")

data/lib/failbot/version.rb

@@ -1,3 +1,3 @@
 module Failbot
-  VERSION = "2.5.1"
+  VERSION = "2.5.2"
 end

metadata

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