airbrake-ruby 4.6.0 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf81123734caec939f2b487e0ca743ea26659f46
-  data.tar.gz: ba8e315a20b3f59d0863d027010e54311ba15d9d
+  metadata.gz: f06a3a2de096ef24fbe7fc848acb44a8c631cdc4
+  data.tar.gz: 17cb5b6ac664e2e49ed2c4b656a774d327de2a01
 SHA512:
-  metadata.gz: 551704a67996c2064820507d4fb3dd0218df863e7433d77356dd45bc62ecab112508372125a98c8d2f651c2693716e96c86b8e0172ffd265b60de0258d1b7acf
-  data.tar.gz: c32da13a83d385bc91b7cc2f236324ae29918005bac9450076d03fc0b707f49b2474049dac7c13fb78f1b0c848c2a1e95579f3c5f1c2315581c8db7d8c1eb3e0
+  metadata.gz: 29c546f17ad80bb9953d63b60ae695ef900e35446f49666be2a7abed88e75be4682553ec30402469cf0f1a2a4f6c1bddd14c49bfeea8a1746d3621d064e6e064
+  data.tar.gz: 5802789e4df182654edb152608dd42536f359c4d2b7f88b08c51ad455d04e6826612cfbae1cfda69cb64950bdba0ebd706d06f2cfaeb0655c2e02f122cb57aef

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/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,19 @@ 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,
+        /FROM pg_index/i,
+        /FROM pg_class/i,
+        /FROM pg_type/i
+      ].freeze
+
       def initialize(dialect)
         @dialect =
           case dialect
@@ -95,7 +112,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
@@ -33,10 +34,10 @@ module Airbrake
 
       @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
@@ -49,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)
@@ -61,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
+
+      @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)
 
-        send(payload, promise)
+          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

data/lib/airbrake-ruby/thread_pool.rb

@@ -0,0 +1,128 @@
+module Airbrake
+  # ThreadPool implements a simple thread pool that can configure the number of
+  # worker threads and the size of the queue to process.
+  #
+  # @example
+  #   # Initialize a new thread pool with 5 workers and a queue size of 100. Set
+  #   # the block to be run concurrently.
+  #   thread_pool = ThreadPool.new(
+  #     worker_size: 5,
+  #     queue_size: 100,
+  #     block: proc { |message| print "ECHO: #{message}..."}
+  #   )
+  #
+  #   # Send work.
+  #   10.times { |i| thread_pool << i }
+  #   #=> ECHO: 0...ECHO: 1...ECHO: 2...
+  #
+  # @api private
+  # @since v4.6.1
+  class ThreadPool
+    include Loggable
+
+    # @return [ThreadGroup] the list of workers
+    # @note This is exposed for eaiser unit testing
+    attr_reader :workers
+
+    def initialize(worker_size:, queue_size:, block:)
+      @worker_size = worker_size
+      @queue_size = queue_size
+      @block = block
+
+      @queue = SizedQueue.new(queue_size)
+      @workers = ThreadGroup.new
+      @mutex = Mutex.new
+      @pid = nil
+      @closed = false
+
+      has_workers?
+    end
+
+    # Adds a new message to the thread pool. Rejects messages if the queue is at
+    # its capacity.
+    #
+    # @param [Object] message The message that gets passed to the block
+    # @return [Boolean] true if the message was successfully sent to the pool,
+    #   false if the queue is full
+    def <<(message)
+      return false if backlog >= @queue_size
+      @queue << message
+      true
+    end
+
+    # @return [Integer] how big the queue is at the moment
+    def backlog
+      @queue.size
+    end
+
+    # Checks if a thread pool has any workers. A thread pool doesn't have any
+    # workers only in two cases: when it was closed or when all workers
+    # crashed. An *active* thread pool 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
+    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
+    end
+
+    # Closes the thread pool making it a no-op (it shut downs all worker
+    # threads). Before closing, waits on all unprocessed tasks to be processed.
+    #
+    # @return [void]
+    # @raise [Airbrake::Error] when invoked more than one time
+    def close
+      threads = @mutex.synchronize do
+        raise Airbrake::Error, 'this thread pool is closed already' if @closed
+
+        unless @queue.empty?
+          msg = "#{LOG_LABEL} waiting to process #{@queue.size} task(s)..."
+          logger.debug(msg + ' (Ctrl-C to abort)')
+        end
+
+        @worker_size.times { @queue << :stop }
+        @closed = true
+        @workers.list.dup
+      end
+
+      threads.each(&:join)
+      logger.debug("#{LOG_LABEL} thread pool closed")
+    end
+
+    def closed?
+      @closed
+    end
+
+    def spawn_workers
+      @worker_size.times { @workers.add(spawn_worker) }
+      @workers.enclose
+    end
+
+    private
+
+    def spawn_worker
+      Thread.new do
+        while (message = @queue.pop)
+          break if message == :stop
+          @block.call(message)
+        end
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.6.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.7.1'.freeze
 end

data/spec/async_sender_spec.rb

@@ -8,148 +8,65 @@ RSpec.describe Airbrake::AsyncSender do
     Airbrake::Config.instance = Airbrake::Config.new(
       project_id: '1',
       workers: 3,
-      queue_size: queue_size
+      queue_size: 10
     )
-
-    allow(Airbrake::Loggable.instance).to receive(:debug)
-    expect(subject).to have_workers
   end
 
   describe "#send" do
-    it "sends payload to Airbrake" do
-      2.times do
-        subject.send(notice, Airbrake::Promise.new)
-      end
-      subject.close
-
-      expect(a_request(:post, endpoint)).to have_been_made.twice
-    end
-
-    context "when the queue is full" do
-      before do
-        allow(subject.unsent).to receive(:size).and_return(queue_size)
-      end
-
-      it "discards payload" do
-        200.times do
-          subject.send(notice, Airbrake::Promise.new)
-        end
+    context "when sender has the capacity to send" do
+      it "sends notices to Airbrake" do
+        2.times { subject.send(notice, Airbrake::Promise.new) }
         subject.close
 
-        expect(a_request(:post, endpoint)).not_to have_been_made
+        expect(a_request(:post, endpoint)).to have_been_made.twice
       end
 
-      it "logs discarded payload" do
-        expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /reached its capacity/
-        ).exactly(15).times
-
-        15.times do
-          subject.send(notice, Airbrake::Promise.new)
-        end
-        subject.close
-      end
-
-      it "returns a rejected promise" do
+      it "returns a resolved promise" do
         promise = Airbrake::Promise.new
-        200.times { subject.send(notice, promise) }
-        expect(promise.value).to eq(
-          'error' => "AsyncSender has reached its capacity of #{queue_size}"
-        )
-      end
-    end
-  end
-
-  describe "#close" do
-    context "when there are no unsent notices" do
-      it "joins the spawned thread" do
-        workers = subject.workers.list
-        expect(workers).to all(be_alive)
-
+        subject.send(notice, promise)
         subject.close
-        expect(workers).to all(be_stop)
+
+        expect(promise).to be_resolved
       end
     end
 
-    context "when there are some unsent notices" do
-      it "logs how many notices are left to send" do
-        expect(Airbrake::Loggable.instance).to receive(:debug).with(
-          /waiting to send \d+ unsent notice\(s\)/
+    context "when sender has exceeded the capacity to send" do
+      before do
+        Airbrake::Config.instance = Airbrake::Config.new(
+          project_id: '1',
+          workers: 0,
+          queue_size: 1
         )
-        expect(Airbrake::Loggable.instance).to receive(:debug).with(/closed/)
-
-        300.times { subject.send(notice, Airbrake::Promise.new) }
-        subject.close
       end
 
-      it "waits until the unsent notices queue is empty" do
+      it "doesn't send the exceeded notices to Airbrake" do
+        15.times { subject.send(notice, Airbrake::Promise.new) }
         subject.close
-        expect(subject.unsent.size).to be_zero
-      end
-    end
 
-    context "when it was already closed" do
-      it "doesn't increase the unsent queue size" do
-        begin
-          subject.close
-        rescue Airbrake::Error
-          nil
-        end
-
-        expect(subject.unsent.size).to be_zero
+        expect(a_request(:post, endpoint)).not_to have_been_made
       end
 
-      it "raises error" do
+      it "returns a rejected promise" do
+        promise = nil
+        15.times do
+          promise = subject.send(notice, Airbrake::Promise.new)
+        end
         subject.close
 
-        expect(subject).to be_closed
-        expect { subject.close }.to raise_error(
-          Airbrake::Error, 'attempted to close already closed sender'
+        expect(promise).to be_rejected
+        expect(promise.value).to eq(
+          'error' => "AsyncSender has reached its capacity of 1"
         )
       end
-    end
 
-    context "when workers were not spawned" do
-      it "correctly closes the notifier nevertheless" do
-        subject.close
-        expect(subject).to be_closed
-      end
-    end
-  end
+      it "logs discarded notice" do
+        expect(Airbrake::Loggable.instance).to receive(:error).with(
+          /reached its capacity/
+        ).at_least(:once)
 
-  describe "#has_workers?" do
-    it "returns false when the sender is not closed, but has 0 workers" do
-      subject.workers.list.each do |worker|
-        worker.kill.join
+        15.times { subject.send(notice, Airbrake::Promise.new) }
+        subject.close
       end
-      expect(subject).not_to have_workers
-    end
-
-    it "returns false when the sender is closed" do
-      subject.close
-      expect(subject).not_to have_workers
-    end
-
-    it "respawns workers on fork()", skip: %w[jruby rbx].include?(RUBY_ENGINE) do
-      pid = fork { expect(subject).to have_workers }
-      Process.wait(pid)
-      subject.close
-      expect(subject).not_to have_workers
-    end
-  end
-
-  describe "#spawn_workers" do
-    it "spawns alive threads in an enclosed ThreadGroup" do
-      expect(subject.workers).to be_a(ThreadGroup)
-      expect(subject.workers.list).to all(be_alive)
-      expect(subject.workers).to be_enclosed
-
-      subject.close
-    end
-
-    it "spawns exactly config.workers workers" do
-      expect(subject.workers.list.size).to eq(Airbrake::Config.instance.workers)
-      subject.close
     end
   end
 end

data/spec/{file_cache.rb → file_cache_spec.rb}

@@ -1,8 +1,6 @@
 RSpec.describe Airbrake::FileCache do
-  after do
-    %i[banana mango].each { |k| described_class.delete(k) }
-    expect(described_class).to be_empty
-  end
+  before { described_class.reset }
+  after { described_class.reset }
 
   describe ".[]=" do
     context "when cache limit isn't reached" do

data/spec/filters/sql_filter_spec.rb

@@ -10,6 +10,18 @@ RSpec.describe Airbrake::Filters::SqlFilter do
     end
   end
 
+  shared_examples "query blacklisting" do |query, opts|
+    it "ignores '#{query}'" do
+      filter = described_class.new('postgres')
+      q = Airbrake::Query.new(
+        query: query, method: 'GET', route: '/', start_time: Time.now
+      )
+      filter.call(q)
+
+      expect(q.ignored?).to eq(opts[:should_ignore])
+    end
+  end
+
   ALL_DIALECTS = %i[mysql postgres sqlite cassandra oracle].freeze
 
   # rubocop:disable Metrics/LineLength
@@ -60,7 +72,11 @@ RSpec.describe Airbrake::Filters::SqlFilter do
       dialects: %i[postgres]
     }, {
       input: "INSERT INTO `X` values(\"test\",0, 1 , 2, 'test')",
-      output: "INSERT INTO `X` values(?,?, ? , ?, ?)",
+      output: "INSERT INTO `X` values(?)",
+      dialects: %i[mysql]
+    }, {
+      input: "INSERT INTO `X` values(\"test\",0, 1 , 2, 'test')",
+      output: "INSERT INTO `X` values(?)",
       dialects: %i[mysql]
     }, {
       input: "SELECT c11.col1, c22.col2 FROM table c11, table c22 WHERE value='nothing'",
@@ -68,7 +84,7 @@ RSpec.describe Airbrake::Filters::SqlFilter do
       dialects: ALL_DIALECTS
     }, {
       input: "INSERT INTO X VALUES(1, 23456, 123.456, 99+100)",
-      output: "INSERT INTO X VALUES(?, ?, ?, ?+?)",
+      output: "INSERT INTO X VALUES(?)",
       dialects: ALL_DIALECTS
     }, {
       input: "SELECT * FROM table WHERE name=\"foo\" AND value=\"don't\"",
@@ -117,7 +133,7 @@ RSpec.describe Airbrake::Filters::SqlFilter do
       dialects: ALL_DIALECTS
     }, {
       input: "INSERT INTO X values('', 'a''b c',0, 1 , 'd''e f''s h')",
-      output: "INSERT INTO X values(?, ?,?, ? , ?)",
+      output: "INSERT INTO X values(?)",
       dialects: ALL_DIALECTS
     }, {
       input: "SELECT * FROM t WHERE -- '\n  bar='baz' -- '",
@@ -153,7 +169,7 @@ RSpec.describe Airbrake::Filters::SqlFilter do
       dialects: %i[postgres]
     }, {
       input: "INSERT INTO \"foo\" (\"bar\", \"baz\", \"qux\") VALUES ($1, $2, $3) RETURNING \"id\"",
-      output: "INSERT INTO \"foo\" (\"bar\", \"baz\", \"qux\") VALUES ($?, $?, $?) RETURNING \"id\"",
+      output: "INSERT INTO \"foo\" (?) RETURNING \"id\"",
       dialects: %i[postgres]
     }, {
       input: "select * from foo where bar = 'some\\tthing' and baz = 10",
@@ -216,4 +232,45 @@ RSpec.describe Airbrake::Filters::SqlFilter do
     include_examples 'query filtering', test
   end
   # rubocop:enable Metrics/LineLength
+
+  [
+    'COMMIT',
+    'commit',
+    'BEGIN',
+    'begin',
+    'SET time zone ?',
+    'set time zone ?',
+    'SHOW max_identifier_length',
+    'show max_identifier_length',
+
+    'WITH pk_constraint AS ( SELECT conrelid, unnest(conkey) AS connum ' \
+    'FROM pg_constraint WHERE contype = ? AND conrelid = ?::regclass ), ' \
+    'cons AS ( SELECT conrelid, connum, row_number() OVER() AS rownum FROM ' \
+    'pk_constraint ) SELECT attr.attname FROM pg_attribute attr INNER JOIN ' \
+    'cons ON attr.attrelid = cons.conrelid AND attr.attnum = cons.connum ' \
+    'ORDER BY cons.rownum',
+
+    'SELECT c.relname FROM pg_class c LEFT JOIN pg_namespace n ON ' \
+    'n.oid = c.relnamespace WHERE n.nspname = ANY (?)',
+
+    'SELECT a.attname FROM ( SELECT indrelid, indkey, generate_subscripts(?) ' \
+    'idx FROM pg_index WHERE indrelid = ?::regclass AND indisprimary ) i ' \
+    'JOIN pg_attribute a ON a.attrelid = i.indrelid AND ' \
+    'a.attnum = i.indkey[i.idx] ORDER BY i.idx',
+
+    'SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, r.rngsubtype, ' \
+    't.typtype, t.typbasetype FROM pg_type as t LEFT JOIN pg_range as r ON ' \
+    'oid = rngtypid WHERE t.typname IN (?) OR t.typtype IN (?) OR t.typinput ' \
+    '= ?::regprocedure OR t.typelem != ?',
+
+    'SELECT t.oid, t.typname FROM pg_type as t WHERE t.typname IN (?)'
+  ].each do |query|
+    include_examples 'query blacklisting', query, should_ignore: true
+  end
+
+  [
+    'UPDATE "users" SET "last_sign_in_at" = ? WHERE "users"."id" = ?'
+  ].each do |query|
+    include_examples 'query blacklisting', query, should_ignore: false
+  end
 end

data/spec/filters/thread_filter_spec.rb

@@ -245,12 +245,12 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
 
   it "appends thread inspect (self)" do
     subject.call(notice)
-    expect(notice[:params][:thread][:self]).to match(/\A#<Thread:.+ run>\z/)
+    expect(notice[:params][:thread][:self]).to match(/\A#<Thread:.+>\z/)
   end
 
   it "appends thread group" do
     subject.call(notice)
-    expect(notice[:params][:thread][:group][0]).to match(/\A#<Thread:.+ run>\z/)
+    expect(notice[:params][:thread][:group][0]).to match(/\A#<Thread:.+>\z/)
   end
 
   it "appends priority" do

data/spec/performance_notifier_spec.rb

@@ -31,6 +31,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
         )
       )
+      subject.close
 
       expect(
         a_request(:put, queries).with(body: %r|
@@ -60,6 +61,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
         )
       )
+      subject.close
 
       expect(
         a_request(:put, routes).with(body: %r|
@@ -87,6 +89,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           groups: { db: 131, view: 421 }
         )
       )
+      subject.close
 
       expect(
         a_request(:put, breakdowns).with(body: %r|
@@ -126,6 +129,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           start_time: Time.new(2018, 1, 1, 0, 0, 20, 0)
         )
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(body: /"time":"2018-01-01T00:00:00\+00:00"/)
       ).to have_been_made
@@ -148,6 +153,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           start_time: Time.new(2018, 1, 1, 0, 0, 50, 0)
         )
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(body: /"count":2/)
       ).to have_been_made
@@ -172,6 +179,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           end_time: Time.new(2018, 1, 1, 0, 1, 55, 0)
         )
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(
           body: %r|\A
@@ -206,6 +215,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           end_time: Time.new(2018, 1, 1, 0, 50, 0, 0)
         )
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(
           body: %r|\A
@@ -242,6 +253,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           groups: { db: 55, view: 11 }
         )
       )
+      subject.close
 
       expect(
         a_request(:put, breakdowns).with(body: %r|
@@ -281,6 +293,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
         )
       )
+      subject.close
+
       expect(promise).to be_an(Airbrake::Promise)
       expect(promise.value).to eq('' => nil)
     end
@@ -292,6 +306,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
       expect(Airbrake::Config.instance).to receive(:check_performance_options)
         .with(request).and_return(Airbrake::Promise.new)
       subject.notify(request)
+      subject.close
     end
 
     it "sends environment when it's specified" do
@@ -305,6 +320,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           start_time: Time.new
         )
       )
+      subject.close
+
       expect(
         a_request(:put, routes).with(
           body: /\A{"routes":\[.+\],"environment":"test"}\z/x
@@ -369,6 +386,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
             start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
           )
         )
+        subject.close
+
         expect(a_request(:put, routes)).not_to have_been_made
       end
 
@@ -381,6 +400,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
             start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
           )
         )
+        subject.close
+
         expect(a_request(:put, queries)).not_to have_been_made
       end
     end
@@ -401,6 +422,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
             start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
           )
         )
+        subject.close
+
         expect(
           a_request(:put, queries).with(
             body: /\A{"queries":\[{"method":"POST","route":"\[Filtered\]"/
@@ -410,6 +433,37 @@ RSpec.describe Airbrake::PerformanceNotifier do
     end
   end
 
+  describe "#close" do
+    before do
+      Airbrake::Config.instance.merge(performance_stats_flush_period: 0.1)
+    end
+
+    after do
+      Airbrake::Config.instance.merge(performance_stats_flush_period: 0)
+    end
+
+    it "kills the background thread" do
+      expect_any_instance_of(Thread).to receive(:kill).and_call_original
+      subject.notify(
+        Airbrake::Query.new(
+          method: 'POST',
+          route: '/foo',
+          query: 'SELECT * FROM things',
+          start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
+        )
+      )
+      subject.close
+    end
+
+    it "logs the exit message" do
+      allow(Airbrake::Loggable.instance).to receive(:debug)
+      expect(Airbrake::Loggable.instance).to receive(:debug).with(
+        /performance notifier closed/
+      )
+      subject.close
+    end
+  end
+
   describe "#delete_filter" do
     let(:filter) do
       Class.new do
@@ -429,6 +483,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
           start_time: Time.new(2018, 1, 1, 0, 49, 0, 0)
         )
       )
+      subject.close
+
       expect(a_request(:put, routes)).to have_been_made
     end
   end

data/spec/thread_pool_spec.rb

@@ -0,0 +1,158 @@
+RSpec.describe Airbrake::ThreadPool do
+  let(:tasks) { [] }
+  let(:worker_size) { 1 }
+  let(:queue_size) { 2 }
+
+  subject do
+    described_class.new(
+      worker_size: worker_size,
+      queue_size: queue_size,
+      block: proc { |message| tasks << message }
+    )
+  end
+
+  describe "#<<" do
+    it "returns true" do
+      retval = subject << 1
+      subject.close
+      expect(retval).to eq(true)
+    end
+
+    it "performs work in background" do
+      subject << 2
+      subject << 1
+      subject.close
+
+      expect(tasks).to eq([2, 1])
+    end
+
+    context "when the queue is full" do
+      before do
+        allow(subject).to receive(:backlog).and_return(queue_size)
+      end
+
+      subject do
+        described_class.new(
+          worker_size: 1,
+          queue_size: 1,
+          block: proc { |message| tasks << message }
+        )
+      end
+
+      it "returns false" do
+        retval = subject << 1
+        subject.close
+        expect(retval).to eq(false)
+      end
+
+      it "discards tasks" do
+        200.times { subject << 1 }
+        subject.close
+
+        expect(tasks.size).to be_zero
+      end
+    end
+  end
+
+  describe "#backlog" do
+    let(:worker_size) { 0 }
+
+    it "returns the size of the queue" do
+      subject << 1
+      expect(subject.backlog).to eq(1)
+    end
+  end
+
+  describe "#has_workers?" do
+    it "returns false when the thread pool is not closed, but has 0 workers" do
+      subject.workers.list.each do |worker|
+        worker.kill.join
+      end
+      expect(subject).not_to have_workers
+    end
+
+    it "returns false when the thread pool is closed" do
+      subject.close
+      expect(subject).not_to have_workers
+    end
+
+    it "respawns workers on fork()", skip: %w[jruby].include?(RUBY_ENGINE) do
+      pid = fork { expect(subject).to have_workers }
+      Process.wait(pid)
+      subject.close
+      expect(subject).not_to have_workers
+    end
+  end
+
+  describe "#close" do
+    context "when there's no work to do" do
+      it "joins the spawned thread" do
+        workers = subject.workers.list
+        expect(workers).to all(be_alive)
+
+        subject.close
+        expect(workers).to all(be_stop)
+      end
+    end
+
+    context "when there's some work to do" do
+      it "logs how many tasks are left to process" do
+        thread_pool = described_class.new(
+          worker_size: 0, queue_size: 2, block: proc {}
+        )
+
+        expect(Airbrake::Loggable.instance).to receive(:debug).with(
+          /waiting to process \d+ task\(s\)/
+        )
+        expect(Airbrake::Loggable.instance).to receive(:debug).with(/closed/)
+
+        2.times { thread_pool << 1 }
+        thread_pool.close
+      end
+
+      it "waits until the queue gets empty" do
+        thread_pool = described_class.new(
+          worker_size: 1, queue_size: 2, block: proc {}
+        )
+
+        10.times { subject << 1 }
+        thread_pool.close
+        expect(thread_pool.backlog).to be_zero
+      end
+    end
+
+    context "when it was already closed" do
+      it "doesn't increase the queue size" do
+        begin
+          subject.close
+        rescue Airbrake::Error
+          nil
+        end
+
+        expect(subject.backlog).to be_zero
+      end
+
+      it "raises error" do
+        subject.close
+        expect { subject.close }.to raise_error(
+          Airbrake::Error, 'this thread pool is closed already'
+        )
+      end
+    end
+  end
+
+  describe "#spawn_workers" do
+    it "spawns alive threads in an enclosed ThreadGroup" do
+      expect(subject.workers).to be_a(ThreadGroup)
+      expect(subject.workers.list).to all(be_alive)
+      expect(subject.workers).to be_enclosed
+
+      subject.close
+    end
+
+    it "spawns exactly `workers_size` workers" do
+      expect(subject.workers.list.size).to eq(worker_size)
+      subject.close
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -80,6 +80,7 @@ files:
 - lib/airbrake-ruby/stat.rb
 - lib/airbrake-ruby/sync_sender.rb
 - lib/airbrake-ruby/tdigest.rb
+- lib/airbrake-ruby/thread_pool.rb
 - lib/airbrake-ruby/time_truncate.rb
 - lib/airbrake-ruby/timed_trace.rb
 - lib/airbrake-ruby/truncator.rb
@@ -92,7 +93,7 @@ files:
 - spec/config/validator_spec.rb
 - spec/config_spec.rb
 - spec/deploy_notifier_spec.rb
-- spec/file_cache.rb
+- spec/file_cache_spec.rb
 - spec/filter_chain_spec.rb
 - spec/filters/context_filter_spec.rb
 - spec/filters/dependency_filter_spec.rb
@@ -118,8 +119,8 @@ files:
 - spec/inspectable_spec.rb
 - spec/monotonic_time_spec.rb
 - spec/nested_exception_spec.rb
+- spec/notice_notifier/options_spec.rb
 - spec/notice_notifier_spec.rb
-- spec/notice_notifier_spec/options_spec.rb
 - spec/notice_spec.rb
 - spec/performance_breakdown_spec.rb
 - spec/performance_notifier_spec.rb
@@ -132,6 +133,7 @@ files:
 - spec/stat_spec.rb
 - spec/sync_sender_spec.rb
 - spec/tdigest_spec.rb
+- spec/thread_pool_spec.rb
 - spec/time_truncate_spec.rb
 - spec/timed_trace_spec.rb
 - spec/truncator_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - spec/notice_notifier_spec.rb
 - spec/time_truncate_spec.rb
 - spec/promise_spec.rb
+- spec/thread_pool_spec.rb
 - spec/config/validator_spec.rb
 - spec/sync_sender_spec.rb
 - spec/ignorable_spec.rb
@@ -195,10 +198,11 @@ test_files:
 - spec/airbrake_spec.rb
 - spec/nested_exception_spec.rb
 - spec/timed_trace_spec.rb
+- spec/file_cache_spec.rb
 - spec/request_spec.rb
+- spec/notice_notifier/options_spec.rb
 - spec/filter_chain_spec.rb
 - spec/response_spec.rb
-- spec/file_cache.rb
 - spec/code_hunk_spec.rb
 - spec/fixtures/notroot.txt
 - spec/fixtures/project_root/long_line.txt
@@ -210,4 +214,3 @@ test_files:
 - spec/inspectable_spec.rb
 - spec/stashable_spec.rb
 - spec/query_spec.rb
-- spec/notice_notifier_spec/options_spec.rb