airbrake-ruby 4.5.1 → 4.7.0

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.5.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.7.0'.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/config_spec.rb

@@ -21,6 +21,7 @@ RSpec.describe Airbrake::Config do
   its(:whitelist_keys) { is_expected.to be_empty }
   its(:performance_stats) { is_expected.to eq(true) }
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
+  its(:query_stats) { is_expected.to eq(false) }
 
   describe "#new" do
     context "when user config is passed" do
@@ -106,4 +107,48 @@ RSpec.describe Airbrake::Config do
       its(:check_configuration) { is_expected.not_to be_rejected }
     end
   end
+
+  describe "#check_performance_options" do
+    it "returns a promise" do
+      resource = Airbrake::Query.new(
+        method: '', route: '', query: '', start_time: Time.now
+      )
+      expect(subject.check_performance_options(resource))
+        .to be_an(Airbrake::Promise)
+    end
+
+    context "when performance stats are disabled" do
+      before { subject.performance_stats = false }
+
+      let(:resource) do
+        Airbrake::Request.new(
+          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
+        )
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Performance Stats feature is disabled"
+        )
+      end
+    end
+
+    context "when query stats are disabled" do
+      before { subject.query_stats = false }
+
+      let(:resource) do
+        Airbrake::Query.new(
+          method: 'GET', route: '/foo', query: '', start_time: Time.new
+        )
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Query Stats feature is disabled"
+        )
+      end
+    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,31 @@ 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'
+
+  ].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