airbrake-ruby 4.5.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffbab1be170a9aef318ba4f64637e80a8d272c4a
-  data.tar.gz: c79758680cc22faea98b5d93877a7c46a26949e4
+  metadata.gz: a05b705bc951aed966742d0403f8c29f9e96949b
+  data.tar.gz: e629610d7eace9ddca72ab165636b7e91bd7b255
 SHA512:
-  metadata.gz: 057622e0593896c5acbe522e1e248f37fcbafdf64f7d9cfed980a19bbfa0da07e07e46091d1feaa5a4a42890078f5e4acc99b85cfaea00d7919b3469046f171a
-  data.tar.gz: 859ab7e7f71ce69259481901f289746ac1cb2148a2690c8134db1cab087935d2e2944d2f821c875b7aeed41cfb0226fcb73399ffe247da373d23a7e5ec3993bd
+  metadata.gz: 37c876fee2ce05781a18f76cddd9f9c16c70a0d49e9d473736859ecfa6af5de03f6b3d75efde455096a79f80be73afbdd0ea0db85d49aa351c6875df3e16eecf
+  data.tar.gz: 2bd3600c3cf8263c4cc8f8606ea7a8ee55a2347275d2122b47a6703b0c0864061dfbc5ffa29524f966c6457261c77b991d19e0df1a07bb263154a6d42b45e987

data/lib/airbrake-ruby.rb

@@ -12,6 +12,7 @@ require 'airbrake-ruby/stashable'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
 require 'airbrake-ruby/promise'
+require 'airbrake-ruby/thread_pool'
 require 'airbrake-ruby/sync_sender'
 require 'airbrake-ruby/async_sender'
 require 'airbrake-ruby/response'
@@ -252,6 +253,7 @@ module Airbrake
     # @return [void]
     def close
       notice_notifier.close
+      performance_notifier.close
     end
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy.

data/lib/airbrake-ruby/async_sender.rb

@@ -1,7 +1,5 @@
 module Airbrake
-  # Responsible for sending notices to Airbrake asynchronously. The class
-  # supports an unlimited number of worker threads and an unlimited queue size
-  # (both values are configurable).
+  # Responsible for sending notices to Airbrake asynchronously.
   #
   # @see SyncSender
   # @api private
@@ -15,25 +13,9 @@ module Airbrake
       "and the following notice will not be delivered " \
       "Error: %<type>s - %<message>s\nBacktrace: %<backtrace>s\n".freeze
 
-    # @return [ThreadGroup] the list of workers
-    # @note This is exposed for eaiser unit testing
-    # @since v4.0.0
-    attr_reader :workers
-
-    # @return [Array<[Airbrake::Notice,Airbrake::Promise]>] the list of unsent
-    #   payload
-    # @note This is exposed for eaiser unit testing
-    # @since v4.0.0
-    attr_reader :unsent
-
-    def initialize
+    def initialize(method = :post)
       @config = Airbrake::Config.instance
-      @unsent = SizedQueue.new(Airbrake::Config.instance.queue_size)
-      @sender = SyncSender.new
-      @closed = false
-      @workers = ThreadGroup.new
-      @mutex = Mutex.new
-      @pid = nil
+      @method = method
     end
 
     # Asynchronously sends a notice to Airbrake.
@@ -41,83 +23,39 @@ module Airbrake
     # @param [Airbrake::Notice] notice A notice that was generated by the
     #   library
     # @return [Airbrake::Promise]
-    def send(notice, promise)
-      return will_not_deliver(notice, promise) if @unsent.size >= @unsent.max
+    def send(notice, promise, endpoint = @config.endpoint)
+      unless thread_pool << [notice, promise, endpoint]
+        return will_not_deliver(notice, promise)
+      end
 
-      @unsent << [notice, promise]
       promise
     end
 
-    # Closes the instance making it a no-op (it shut downs all worker
-    # threads). Before closing, waits on all unsent notices to be sent.
-    #
     # @return [void]
-    # @raise [Airbrake::Error] when invoked more than one time
     def close
-      threads = @mutex.synchronize do
-        raise Airbrake::Error, 'attempted to close already closed sender' if closed?
-
-        unless @unsent.empty?
-          msg = "#{LOG_LABEL} waiting to send #{@unsent.size} unsent notice(s)..."
-          logger.debug(msg + ' (Ctrl-C to abort)')
-        end
-
-        @config.workers.times { @unsent << [:stop, Airbrake::Promise.new] }
-        @closed = true
-        @workers.list.dup
-      end
-
-      threads.each(&:join)
-      logger.debug("#{LOG_LABEL} closed")
+      thread_pool.close
     end
 
-    # Checks whether the sender is closed and thus usable.
     # @return [Boolean]
     def closed?
-      @closed
+      thread_pool.closed?
     end
 
-    # Checks if an active sender has any workers. A sender doesn't have any
-    # workers only in two cases: when it was closed or when all workers
-    # crashed. An *active* sender doesn't have any workers only when something
-    # went wrong.
-    #
-    # Workers are expected to crash when you +fork+ the process the workers are
-    # living in. In this case we detect a +fork+ and try to revive them here.
-    #
-    # Another possible scenario that crashes workers is when you close the
-    # instance on +at_exit+, but some other +at_exit+ hook prevents the process
-    # from exiting.
-    #
-    # @return [Boolean] true if an instance wasn't closed, but has no workers
-    # @see https://goo.gl/oydz8h Example of at_exit that prevents exit
+    # @return [Boolean]
     def has_workers?
-      @mutex.synchronize do
-        return false if @closed
-
-        if @pid != Process.pid && @workers.list.empty?
-          @pid = Process.pid
-          spawn_workers
-        end
-
-        !@closed && @workers.list.any?
-      end
+      thread_pool.has_workers?
     end
 
     private
 
-    def spawn_workers
-      @workers = ThreadGroup.new
-      @config.workers.times { @workers.add(spawn_worker) }
-      @workers.enclose
-    end
-
-    def spawn_worker
-      Thread.new do
-        while (message = @unsent.pop)
-          break if message.first == :stop
-          @sender.send(*message)
-        end
+    def thread_pool
+      @thread_pool ||= begin
+        sender = SyncSender.new(@method)
+        ThreadPool.new(
+          worker_size: @config.workers,
+          queue_size: @config.queue_size,
+          block: proc { |args| sender.send(*args) }
+        )
       end
     end
 
@@ -128,7 +66,7 @@ module Airbrake
         format(
           WILL_NOT_DELIVER_MSG,
           log_label: LOG_LABEL,
-          capacity: @unsent.max,
+          capacity: @config.queue_size,
           type: error[:type],
           message: error[:message],
           backtrace: error[:backtrace].map do |line|
@@ -136,7 +74,7 @@ module Airbrake
           end.join("\n")
         )
       )
-      promise.reject("AsyncSender has reached its capacity of #{@unsent.max}")
+      promise.reject("AsyncSender has reached its capacity of #{@config.queue_size}")
     end
   end
 end

data/lib/airbrake-ruby/config.rb

@@ -83,18 +83,24 @@ module Airbrake
     # @since v2.5.0
     attr_accessor :code_hunks
 
-    # @return [Boolean] true if the library should send performance stats
-    #   information to Airbrake (routes, SQL queries), false otherwise
+    # @return [Boolean] true if the library should send route performance stats
+    #   to Airbrake, false otherwise
     # @api public
     # @since v3.2.0
     attr_accessor :performance_stats
 
     # @return [Integer] how many seconds to wait before sending collected route
     #   stats
-    # @api public
+    # @api private
     # @since v3.2.0
     attr_accessor :performance_stats_flush_period
 
+    # @return [Boolean] true if the library should send SQL stats to Airbrake,
+    #   false otherwise
+    # @api public
+    # @since v4.6.0
+    attr_accessor :query_stats
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -132,6 +138,7 @@ module Airbrake
       self.versions = {}
       self.performance_stats = true
       self.performance_stats_flush_period = 15
+      self.query_stats = false
 
       merge(user_config)
     end
@@ -197,6 +204,20 @@ module Airbrake
       check_notify_ability
     end
 
+    # @return [Promise] resolved promise if neither of the performance options
+    #   reject it, false otherwise
+    def check_performance_options(resource)
+      promise = Airbrake::Promise.new
+
+      if !performance_stats
+        promise.reject("The Performance Stats feature is disabled")
+      elsif resource.is_a?(Airbrake::Query) && !query_stats
+        promise.reject("The Query Stats feature is disabled")
+      else
+        promise
+      end
+    end
+
     private
 
     def set_option(option, value)

data/lib/airbrake-ruby/file_cache.rb

@@ -40,6 +40,12 @@ module Airbrake
       data.empty?
     end
 
+    # @since ?.?.?
+    # @return [void]
+    def self.reset
+      @data = {}
+    end
+
     def self.data
       @data ||= {}
     end

data/lib/airbrake-ruby/filters/sql_filter.rb

@@ -37,6 +37,10 @@ module Airbrake
         # rubocop:enable Metrics/LineLength
       }.freeze
 
+      # @return [Regexp] the regexp that is applied after the feature regexps
+      #   were used
+      POST_FILTER = /(?<=[values|in ]\().+(?=\))/i
+
       # @return [Hash{Symbol=>Array<Symbol>}] a set of features that corresponds
       #   to a certain dialect
       DIALECT_FEATURES = {
@@ -75,6 +79,16 @@ module Airbrake
         oracle_enhanced: %r{'|/\*|\*/}
       }.freeze
 
+      # @return [Array<Regexp>] the list of queries to be ignored
+      IGNORED_QUERIES = [
+        /\ACOMMIT/i,
+        /\ABEGIN/i,
+        /\ASET/i,
+        /\ASHOW/i,
+        /\AWITH/i,
+        /FROM pg_attribute/i
+      ].freeze
+
       def initialize(dialect)
         @dialect =
           case dialect
@@ -95,7 +109,14 @@ module Airbrake
       def call(resource)
         return unless resource.respond_to?(:query)
 
-        q = resource.query.gsub(@regexp, FILTERED)
+        query = resource.query
+        if IGNORED_QUERIES.any? { |q| q =~ query }
+          resource.ignore!
+          return
+        end
+
+        q = query.gsub(@regexp, FILTERED)
+        q.gsub!(POST_FILTER, FILTERED) if q =~ POST_FILTER
         q = ERROR_MSG if UNMATCHED_PAIR[@dialect] =~ q
         resource.query = q
       end

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -21,6 +21,7 @@ module Airbrake
       start_time:,
       end_time: Time.now
     )
+      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
       super(method, route, response_type, groups, start_time, end_time)
     end
 
@@ -37,7 +38,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'responseType' => response_type,
-        'time' => TimeTruncate.utc_truncate_minutes(start_time)
+        'time' => @start_time_utc
       }.delete_if { |_key, val| val.nil? }
     end
   end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -11,11 +11,12 @@ module Airbrake
     def initialize
       @config = Airbrake::Config.instance
       @flush_period = Airbrake::Config.instance.performance_stats_flush_period
-      @sender = SyncSender.new(:put)
+      @sender = AsyncSender.new(:put)
       @payload = {}
       @schedule_flush = nil
       @mutex = Mutex.new
       @filter_chain = FilterChain.new
+      @waiting = false
     end
 
     # @param [Hash] resource
@@ -25,20 +26,18 @@ module Airbrake
       promise = @config.check_configuration
       return promise if promise.rejected?
 
-      promise = Airbrake::Promise.new
-      unless @config.performance_stats
-        return promise.reject("The Performance Stats feature is disabled")
-      end
+      promise = @config.check_performance_options(resource)
+      return promise if promise.rejected?
 
       @filter_chain.refine(resource)
       return if resource.ignored?
 
       @mutex.synchronize do
         update_payload(resource)
-        @flush_period > 0 ? schedule_flush(promise) : send(@payload, promise)
+        @flush_period > 0 ? schedule_flush : send(@payload, promise)
       end
 
-      promise
+      promise.resolve(:success)
     end
 
     # @see Airbrake.add_performance_filter
@@ -51,6 +50,14 @@ module Airbrake
       @filter_chain.delete_filter(filter_class)
     end
 
+    def close
+      @mutex.synchronize do
+        @schedule_flush.kill if @schedule_flush
+        @sender.close
+        logger.debug("#{LOG_LABEL} performance notifier closed")
+      end
+    end
+
     private
 
     def update_payload(resource)
@@ -63,18 +70,39 @@ module Airbrake
       end
     end
 
-    def schedule_flush(promise)
-      @schedule_flush ||= Thread.new do
-        sleep(@flush_period)
+    def schedule_flush
+      return if @payload.empty?
 
-        payload = nil
-        @mutex.synchronize do
-          payload = @payload
-          @payload = {}
-          @schedule_flush = nil
+      if @schedule_flush && @schedule_flush.status == 'sleep' && @waiting
+        begin
+          @schedule_flush.run
+        rescue ThreadError => exception
+          logger.error("#{LOG_LABEL}: error occurred while flushing: #{exception}")
         end
+      end
 
-        send(payload, promise)
+      @schedule_flush ||= spawn_timer
+    end
+
+    def spawn_timer
+      Thread.new do
+        loop do
+          if @payload.none?
+            @waiting = true
+            Thread.stop
+            @waiting = false
+          end
+
+          sleep(@flush_period)
+
+          payload = nil
+          @mutex.synchronize do
+            payload = @payload
+            @payload = {}
+          end
+
+          send(payload, Airbrake::Promise.new)
+        end
       end
     end
 

data/lib/airbrake-ruby/query.rb

@@ -22,6 +22,7 @@ module Airbrake
       start_time:,
       end_time: Time.now
     )
+      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
       super(method, route, query, func, file, line, start_time, end_time)
     end
 
@@ -42,7 +43,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'query' => query,
-        'time' => TimeTruncate.utc_truncate_minutes(start_time),
+        'time' => @start_time_utc,
         'function' => func,
         'file' => file,
         'line' => line

data/lib/airbrake-ruby/request.rb

@@ -17,6 +17,7 @@ module Airbrake
       start_time:,
       end_time: Time.now
     )
+      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
       super(method, route, status_code, start_time, end_time)
     end
 
@@ -37,7 +38,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'statusCode' => status_code,
-        'time' => TimeTruncate.utc_truncate_minutes(start_time)
+        'time' => @start_time_utc
       }.delete_if { |_key, val| val.nil? }
     end
   end