failbot 2.5.2 → 2.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e17fb2d80a08382f07201582e708558ab9288c33c085950136d42c38ac9e47ff
-  data.tar.gz: 664d9e980cb2901a1487518435a8c15bcd1e7fbce8d72eb16298e43db50d531c
+  metadata.gz: 1bae1044f6d88c6617750ffe63b606591880ebe5132d9714d2e4c9534e309962
+  data.tar.gz: b1d80185dae5e664c049ed38583d25086d3659f517826c38912974d93fed32a6
 SHA512:
-  metadata.gz: 5228d0b4914759a86d5605b8573f4c55de41716b2f9fa1248c6df87c169dacff3653a46da0ad4287866ecdb8a60aac5b0ed762202c0aaff89444e3b7cbbd75da
-  data.tar.gz: 332e27bc52d28068b62b6eda1fe30925401788ab3225f68d0a09573e07182f2caa6e7437edf6627cd94cba9fa0be04c44fd6a873e594428ea8bf78a22e2707fa
+  metadata.gz: 8114032ca98920f4b902447d1b3c69b28ea6bfe14b52d8b1f431d0537295d5c565d9d8a17540afa72f00f439023bc711291542baa2044ada4cd6f547e9506c35
+  data.tar.gz: f0040811958da514da048dd38af5de2cfd3978d6f036dc78c19b6080991b02bf69cca5b79f684ecc3a8c5b3885b577ecf77116fca445439f7ecfa06fbe5a3452

data/lib/failbot.rb

@@ -3,6 +3,7 @@ require 'digest/md5'
 require 'logger'
 require 'socket'
 require "time"
+require "timeout"
 require "date"
 require "uri"
 
@@ -25,8 +26,7 @@ module Failbot
   autoload :HTTPBackend,    'failbot/http_backend'
   autoload :MemoryBackend,  'failbot/memory_backend'
   autoload :JSONBackend,    'failbot/json_backend'
-
-  autoload :ThreadLocalVariable, 'failbot/thread_local_variable'
+  autoload :WaiterBackend,  'failbot/waiter_backend'
 
   # Public: Set an instrumenter to be called when exceptions are reported.
   #
@@ -46,6 +46,9 @@ module Failbot
   #
   attr_accessor :instrumenter
 
+  # 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)
@@ -134,16 +137,9 @@ module Failbot
       return setup_deprecated(settings)
     end
 
-    initial_context = if default_context.respond_to?(:to_hash) && !default_context.to_hash.empty?
-                        default_context.to_hash
-                      else
-                        { 'server' => hostname }
-                      end
-
-    @thread_local_context = ::Failbot::ThreadLocalVariable.new do
-      [initial_context]
+    if default_context.respond_to?(:to_hash) && !default_context.to_hash.empty?
+      context[0] = default_context.to_hash
     end
-    @thread_local_already_reporting = ::Failbot::ThreadLocalVariable.new { false }
 
     populate_context_from_settings(settings)
 
@@ -151,6 +147,8 @@ module Failbot
       case (name = settings["FAILBOT_BACKEND"])
       when "memory"
         Failbot::MemoryBackend.new
+      when "waiter"
+        Failbot::WaiterBackend.new
       when "file"
         Failbot::FileBackend.new(settings["FAILBOT_BACKEND_FILE_PATH"])
       when "http"
@@ -165,6 +163,11 @@ module Failbot
 
     @raise_errors  = !settings["FAILBOT_RAISE"].to_s.empty?
     @report_errors = settings["FAILBOT_REPORT"] != "0"
+    @enable_timeout = false
+    if settings.key?("FAILBOT_TIMEOUT_MS")
+      @timeout_seconds = settings["FAILBOT_TIMEOUT_MS"].to_f / 1000
+      @enable_timeout = (@timeout_seconds != 0.0)
+    end
 
     # allows overriding the 'app' value to send to single haystack bucket.
     # used primarily on ghe.io.
@@ -185,7 +188,7 @@ module Failbot
   # hashes are condensed down into one and included in the next report. Don't
   # mess with this structure directly - use the #push and #pop methods.
   def context
-    @thread_local_context.value
+    @context ||= [{'server' => hostname}]
   end
 
   # Add info to be sent in the next failbot report, should one occur.
@@ -209,7 +212,7 @@ module Failbot
 
   # Reset the context stack to a pristine state.
   def reset!
-    @thread_local_context.value = [context[0]].dup
+    @context = [context[0]]
   end
 
   # Loops through the stack of contexts and deletes the given key if it exists.
@@ -351,7 +354,13 @@ module Failbot
       "report_status" => "error",
     }
     begin
-      backend.report(data)
+      if @enable_timeout
+        Timeout.timeout(@timeout_seconds) do
+          backend.report(data)
+        end
+      else
+        backend.report(data)
+      end
       instrumentation_data["report_status"] = "success"
     rescue Object => i
       log_failure("reporting", data, e, i)
@@ -487,14 +496,6 @@ module Failbot
     @hostname ||= Socket.gethostname
   end
 
-  def already_reporting=(bool)
-    @thread_local_already_reporting.value = bool
-  end
-
-  def already_reporting
-    @thread_local_already_reporting.value
-  end
-
   private
 
   # Internal: Publish an event to the instrumenter

data/lib/failbot/haystack.rb

@@ -52,6 +52,10 @@ module Failbot
 
       # push it through
       http.request(request)
+    ensure
+      if defined?(http) && http.started?
+        http.finish
+      end
     end
   end
 end

data/lib/failbot/version.rb

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

data/lib/failbot/waiter_backend.rb

@@ -0,0 +1,21 @@
+module Failbot
+  class WaiterBackend
+    # This backend waits a configured amount of time before returning.  This is
+    # intended be used to test timeouts.  Delay is the number of seconds to wait.
+
+    attr_reader :reports
+    def initialize(delay = 5)
+      @delay = delay
+      @reports = []
+    end
+
+    def report(data)
+      @reports << data
+      sleep(@delay)
+    end
+
+    def ping
+      # nop
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: failbot
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.4
 platform: ruby
 authors:
 - "@rtomayko"
 - "@atmos"
 - "@sr"
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -106,13 +106,13 @@ files:
 - lib/failbot/middleware.rb
 - lib/failbot/resque_failure_backend.rb
 - lib/failbot/sensitive_data_scrubber.rb
-- lib/failbot/thread_local_variable.rb
 - lib/failbot/version.rb
+- lib/failbot/waiter_backend.rb
 homepage: http://github.com/github/failbot#readme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Deliver exceptions to Haystack
 test_files: []

data/lib/failbot/thread_local_variable.rb

@@ -1,24 +0,0 @@
-module Failbot
-  # Public: A simplified implementation of [`::Concurrent::ThreadLocalVar`](https://github.com/ruby-concurrency/concurrent-ruby/blob/7dc6eb04142f008ffa79a59c125669c6fcbb85a8/lib/concurrent-ruby/concurrent/atomic/thread_local_var.rb)
-  #
-  # Why not just use `concurrent-ruby`? We wanted to minimize external dependencies to avoid conflicts with gems already installed with `github/github`.
-  #
-  class ThreadLocalVariable
-    def initialize(&block)
-      @default_block = block || proc {}
-      @key = "_thread_local_variable##{object_id}"
-    end
-
-    def value
-      if Thread.current.key?(@key)
-        Thread.current[@key]
-      else
-        Thread.current[@key] = @default_block.call
-      end
-    end
-
-    def value=(val)
-      Thread.current[@key] = val
-    end
-  end
-end