airbrake-ruby 4.5.1 → 4.7.0

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

@@ -12,7 +12,8 @@ RSpec.describe Airbrake::PerformanceNotifier do
       project_id: 1,
       project_key: 'banana',
       performance_stats: true,
-      performance_stats_flush_period: 0
+      performance_stats_flush_period: 0,
+      query_stats: true
     )
   end
 
@@ -30,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|
@@ -59,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|
@@ -86,6 +89,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           groups: { db: 131, view: 421 }
         )
       )
+      subject.close
 
       expect(
         a_request(:put, breakdowns).with(body: %r|
@@ -125,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
@@ -147,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
@@ -171,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
@@ -205,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
@@ -241,6 +253,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
           groups: { db: 55, view: 11 }
         )
       )
+      subject.close
 
       expect(
         a_request(:put, breakdowns).with(body: %r|
@@ -280,38 +293,20 @@ 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
 
-    it "doesn't send route stats when performance stats are disabled" do
-      Airbrake::Config.instance.merge(performance_stats: false)
-
-      promise = subject.notify(
-        Airbrake::Request.new(
-          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
-        )
-      )
-
-      expect(a_request(:put, routes)).not_to have_been_made
-      expect(promise.value).to eq(
-        'error' => "The Performance Stats feature is disabled"
-      )
-    end
-
-    it "doesn't send route stats when current environment is ignored" do
-      Airbrake::Config.instance.merge(
-        performance_stats: true, environment: 'test', ignore_environments: %w[test]
+    it "checks performance stat configuration" do
+      request = Airbrake::Request.new(
+        method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
       )
-
-      promise = subject.notify(
-        Airbrake::Request.new(
-          method: 'GET', route: '/foo', status_code: 200, start_time: Time.new
-        )
-      )
-
-      expect(a_request(:put, routes)).not_to have_been_made
-      expect(promise.value).to eq('error' => "current environment 'test' is ignored")
+      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
@@ -325,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
@@ -389,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
 
@@ -401,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
@@ -421,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\]"/
@@ -430,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
@@ -449,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.5.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-10-03 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