airbrake-ruby 5.0.1 → 5.2.1

data/lib/airbrake-ruby/remote_settings/callback.rb

@@ -0,0 +1,44 @@
+module Airbrake
+  class RemoteSettings
+    # Callback is a class that provides a callback for the config poller, which
+    # updates the local config according to the data.
+    #
+    # @api private
+    # @since v5.0.2
+    class Callback
+      def initialize(config)
+        @config = config
+        @orig_error_notifications = config.error_notifications
+        @orig_performance_stats = config.performance_stats
+      end
+
+      # @param [Airbrake::RemoteSettings::SettingsData] data
+      # @return [void]
+      def call(data)
+        @config.logger.debug do
+          "#{LOG_LABEL} applying remote settings: #{data.to_h}"
+        end
+
+        @config.error_host = data.error_host if data.error_host
+        @config.apm_host = data.apm_host if data.apm_host
+
+        process_error_notifications(data)
+        process_performance_stats(data)
+      end
+
+      private
+
+      def process_error_notifications(data)
+        return unless @orig_error_notifications
+
+        @config.error_notifications = data.error_notifications?
+      end
+
+      def process_performance_stats(data)
+        return unless @orig_performance_stats
+
+        @config.performance_stats = data.performance_stats?
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/remote_settings/settings_data.rb

@@ -11,7 +11,7 @@ module Airbrake
     #
     #   settings_data.interval #=> 600
     #
-    # @since 5.0.0
+    # @since v5.0.0
     # @api private
     class SettingsData
       # @return [Integer] how frequently we should poll the config API
@@ -58,13 +58,8 @@ module Airbrake
       # @param [String] remote_config_host
       # @return [String] where the config is stored on S3.
       def config_route(remote_config_host)
-        if @data.key?('config_route') &&
-           @data['config_route'] && !@data['config_route'].empty?
-          return format(
-            CONFIG_ROUTE_PATTERN,
-            host: @data['config_route'].chomp('/'),
-            project_id: @project_id,
-          )
+        if @data['config_route'] && !@data['config_route'].empty?
+          return "#{remote_config_host.chomp('/')}/#{@data['config_route']}"
         end
 
         format(

data/lib/airbrake-ruby/tdigest.rb

@@ -24,6 +24,7 @@ module Airbrake
     # @since v3.2.0
     class Centroid
       attr_accessor :mean, :n, :cumn, :mean_cumn
+
       def initialize(mean, n, cumn, mean_cumn = nil)
         @mean      = mean
         @n         = n
@@ -130,7 +131,7 @@ module Airbrake
       points = to_a
       reset!
       push_centroid(points.shuffle)
-      _cumulate(true, true)
+      _cumulate(exact: true, force: true)
       nil
     end
 
@@ -175,7 +176,7 @@ module Airbrake
         elsif item > max[1].mean
           1.0
         else
-          _cumulate(true)
+          _cumulate(exact: true)
           bound = bound_mean(item)
           lower, upper = bound
           mean_cumn = lower.mean_cumn
@@ -204,7 +205,7 @@ module Airbrake
         if size == 0
           nil
         else
-          _cumulate(true)
+          _cumulate(exact: true)
           h = @size * item
           lower, upper = bound_mean_cumn(h)
           if lower.nil? && upper.nil?
@@ -306,7 +307,7 @@ module Airbrake
         centroid.mean += n * (x - centroid.mean) / (centroid.n + n)
       end
 
-      _cumulate(false, true) if centroid.mean_cumn.nil?
+      _cumulate(exact: false, force: true) if centroid.mean_cumn.nil?
 
       centroid.cumn += n
       centroid.mean_cumn += n / 2.0
@@ -314,7 +315,7 @@ module Airbrake
     end
 
     # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-    def _cumulate(exact = false, force = false)
+    def _cumulate(exact: false, force: false)
       unless force
         factor = if @last_cumulate == 0
                    Float::INFINITY
@@ -361,7 +362,7 @@ module Airbrake
         end
       end
 
-      _cumulate(false)
+      _cumulate(exact: false)
 
       # If the number of centroids has grown to a very large size,
       # it may be due to values being inserted in sorted order.

data/lib/airbrake-ruby/thread_pool.rb

@@ -6,6 +6,7 @@ module Airbrake
   #   # 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(
+  #     name: 'performance-notifier',
   #     worker_size: 5,
   #     queue_size: 100,
   #     block: proc { |message| print "ECHO: #{message}..."}
@@ -24,7 +25,8 @@ module Airbrake
     # @note This is exposed for eaiser unit testing
     attr_reader :workers
 
-    def initialize(worker_size:, queue_size:, block:)
+    def initialize(worker_size:, queue_size:, block:, name: nil)
+      @name = name
       @worker_size = worker_size
       @queue_size = queue_size
       @block = block
@@ -102,7 +104,7 @@ module Airbrake
 
         unless @queue.empty?
           msg = "#{LOG_LABEL} waiting to process #{@queue.size} task(s)..."
-          logger.debug(msg + ' (Ctrl-C to abort)')
+          logger.debug("#{msg} (Ctrl-C to abort)")
         end
 
         @worker_size.times { @queue << :stop }
@@ -111,7 +113,7 @@ module Airbrake
       end
 
       threads.each(&:join)
-      logger.debug("#{LOG_LABEL} thread pool closed")
+      logger.debug("#{LOG_LABEL} #{@name} thread pool closed")
     end
 
     def closed?

data/lib/airbrake-ruby/timed_trace.rb

@@ -50,9 +50,7 @@ module Airbrake
 
     # @return [Hash<String=>Float>]
     def spans
-      @spans.each_with_object({}) do |(label, benchmark), new_spans|
-        new_spans[label] = benchmark.duration
-      end
+      @spans.transform_values(&:duration)
     end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -3,10 +3,10 @@
 module Airbrake
   # @return [String] the library version
   # @api public
-  AIRBRAKE_RUBY_VERSION = '5.0.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '5.2.1'.freeze
 
   # @return [Hash{Symbol=>String}] the information about the notifier library
-  # @since 5.0.0
+  # @since v5.0.0
   # @api public
   NOTIFIER_INFO = {
     name: 'airbrake-ruby'.freeze,

data/spec/airbrake_spec.rb

@@ -30,11 +30,9 @@ RSpec.describe Airbrake do
 
     it "yields the config" do
       expect do |b|
-        begin
-          described_class.configure(&b)
-        rescue Airbrake::Error
-          nil
-        end
+        described_class.configure(&b)
+      rescue Airbrake::Error
+        nil
       end.to yield_with_args(Airbrake::Config)
     end
 
@@ -62,26 +60,26 @@ RSpec.describe Airbrake do
 
     context "when called multiple times" do
       it "doesn't overwrite performance notifier" do
-        described_class.configure {}
+        described_class.configure { anything }
         performance_notifier = described_class.performance_notifier
 
-        described_class.configure {}
+        described_class.configure { anything }
         expect(described_class.performance_notifier).to eql(performance_notifier)
       end
 
       it "doesn't overwrite notice notifier" do
-        described_class.configure {}
+        described_class.configure { anything }
         notice_notifier = described_class.notice_notifier
 
-        described_class.configure {}
+        described_class.configure { anything }
         expect(described_class.notice_notifier).to eql(notice_notifier)
       end
 
       it "doesn't overwrite deploy notifier" do
-        described_class.configure {}
+        described_class.configure { anything }
         deploy_notifier = described_class.deploy_notifier
 
-        described_class.configure {}
+        described_class.configure { anything }
         expect(described_class.deploy_notifier).to eql(deploy_notifier)
       end
 
@@ -91,20 +89,24 @@ RSpec.describe Airbrake do
           c.project_key = '2'
         end
 
-        expect(described_class.notice_notifier).not_to receive(:add_filter)
-        10.times { described_class.configure {} }
+        allow(described_class.notice_notifier).to receive(:add_filter)
+
+        10.times { described_class.configure { anything } }
+
+        expect(described_class.notice_notifier).not_to have_received(:add_filter)
       end
 
       it "appends some default filters" do
         allow(described_class.notice_notifier).to receive(:add_filter)
-        expect(described_class.notice_notifier).to receive(:add_filter).with(
-          an_instance_of(Airbrake::Filters::RootDirectoryFilter),
-        )
 
         described_class.configure do |c|
           c.project_id = 1
           c.project_key = '2'
         end
+
+        expect(described_class.notice_notifier).to have_received(:add_filter).with(
+          an_instance_of(Airbrake::Filters::RootDirectoryFilter),
+        )
       end
     end
 
@@ -112,14 +114,21 @@ RSpec.describe Airbrake do
       before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
       it "adds blocklist filter" do
-        expect(described_class.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysBlocklist))
+        allow(described_class.notice_notifier).to receive(:add_filter)
+
         described_class.configure { |c| c.blocklist_keys = %w[password] }
+
+        expect(described_class.notice_notifier).to have_received(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysBlocklist))
       end
 
       it "initializes blocklist with specified parameters" do
-        expect(Airbrake::Filters::KeysBlocklist).to receive(:new).with(%w[password])
+        allow(Airbrake::Filters::KeysBlocklist).to receive(:new)
+
         described_class.configure { |c| c.blocklist_keys = %w[password] }
+
+        expect(Airbrake::Filters::KeysBlocklist)
+          .to have_received(:new).with(%w[password])
       end
     end
 
@@ -127,14 +136,17 @@ RSpec.describe Airbrake do
       before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
       it "adds allowlist filter" do
-        expect(described_class.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysAllowlist))
         described_class.configure { |c| c.allowlist_keys = %w[banana] }
+        expect(described_class.notice_notifier).to have_received(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysAllowlist))
       end
 
       it "initializes allowlist with specified parameters" do
-        expect(Airbrake::Filters::KeysAllowlist).to receive(:new).with(%w[banana])
+        allow(Airbrake::Filters::KeysAllowlist).to receive(:new)
+
         described_class.configure { |c| c.allowlist_keys = %w[banana] }
+        expect(Airbrake::Filters::KeysAllowlist)
+          .to have_received(:new).with(%w[banana])
       end
     end
 
@@ -142,77 +154,90 @@ RSpec.describe Airbrake do
       before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
       it "adds root directory filter" do
-        expect(described_class.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::RootDirectoryFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
+
+        expect(described_class.notice_notifier).to have_received(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::RootDirectoryFilter))
       end
 
       it "initializes root directory filter with specified path" do
-        expect(Airbrake::Filters::RootDirectoryFilter)
-          .to receive(:new).with('/my/path')
+        allow(Airbrake::Filters::RootDirectoryFilter).to receive(:new)
         described_class.configure { |c| c.root_directory = '/my/path' }
+
+        expect(Airbrake::Filters::RootDirectoryFilter)
+          .to have_received(:new).with('/my/path')
       end
 
       it "adds git revision filter" do
-        expect(described_class.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::GitRevisionFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
+        expect(described_class.notice_notifier).to have_received(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::GitRevisionFilter))
       end
 
       it "initializes git revision filter with correct root directory" do
-        expect(Airbrake::Filters::GitRevisionFilter)
-          .to receive(:new).with('/my/path')
+        allow(Airbrake::Filters::GitRevisionFilter).to receive(:new)
         described_class.configure { |c| c.root_directory = '/my/path' }
+
+        expect(Airbrake::Filters::GitRevisionFilter)
+          .to have_received(:new).with('/my/path')
       end
 
       it "adds git repository filter" do
-        expect(described_class.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::GitRepositoryFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
+
+        expect(described_class.notice_notifier).to have_received(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::GitRepositoryFilter))
       end
 
       it "initializes git repository filter with correct root directory" do
-        expect(Airbrake::Filters::GitRepositoryFilter)
-          .to receive(:new).with('/my/path')
+        allow(Airbrake::Filters::GitRepositoryFilter).to receive(:new)
+
         described_class.configure { |c| c.root_directory = '/my/path' }
+
+        expect(Airbrake::Filters::GitRepositoryFilter)
+          .to have_received(:new).with('/my/path')
       end
 
       it "adds git last checkout filter" do
-        expect(described_class.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::GitLastCheckoutFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
+        expect(described_class.notice_notifier).to have_received(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::GitLastCheckoutFilter))
       end
 
       it "initializes git last checkout filter with correct root directory" do
-        expect(Airbrake::Filters::GitLastCheckoutFilter)
-          .to receive(:new).with('/my/path')
+        allow(Airbrake::Filters::GitLastCheckoutFilter).to receive(:new)
         described_class.configure { |c| c.root_directory = '/my/path' }
+
+        expect(Airbrake::Filters::GitLastCheckoutFilter)
+          .to have_received(:new).with('/my/path')
       end
     end
   end
 
   describe ".notify_request" do
+    before do
+      allow(described_class.performance_notifier).to receive(:notify)
+    end
+
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the request" do
-        expect(described_class.performance_notifier).to receive(:notify) do |request|
-          expect(request.stash).to be_empty
-        end
-
         described_class.notify_request(
           method: 'GET',
           route: '/',
           status_code: 200,
           timing: 1,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |request|
+          expect(request.stash).to be_empty
+        end
       end
     end
 
     context "when :stash key is provided" do
       it "adds the value as the stash of the request" do
-        expect(described_class.performance_notifier).to receive(:notify) do |request|
-          expect(request.stash).to eq(request_id: 1)
-        end
-
         described_class.notify_request(
           {
             method: 'GET',
@@ -222,13 +247,19 @@ RSpec.describe Airbrake do
           },
           request_id: 1,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |request|
+          expect(request.stash).to eq(request_id: 1)
+        end
       end
     end
   end
 
   describe ".notify_request_sync" do
     it "notifies request synchronously" do
-      expect(described_class.performance_notifier).to receive(:notify_sync)
+      allow(described_class.performance_notifier).to receive(:notify_sync)
 
       described_class.notify_request_sync(
         {
@@ -239,31 +270,35 @@ RSpec.describe Airbrake do
         },
         request_id: 1,
       )
+
+      expect(described_class.performance_notifier).to have_received(:notify_sync)
     end
   end
 
   describe ".notify_query" do
+    before do
+      allow(described_class.performance_notifier).to receive(:notify)
+    end
+
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the query" do
-        expect(described_class.performance_notifier).to receive(:notify) do |query|
-          expect(query.stash).to be_empty
-        end
-
         described_class.notify_query(
           method: 'GET',
           route: '/',
           query: '',
           timing: 1,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |query|
+          expect(query.stash).to be_empty
+        end
       end
     end
 
     context "when :stash key is provided" do
       it "adds the value as the stash of the query" do
-        expect(described_class.performance_notifier).to receive(:notify) do |query|
-          expect(query.stash).to eq(request_id: 1)
-        end
-
         described_class.notify_query(
           {
             method: 'GET',
@@ -273,13 +308,19 @@ RSpec.describe Airbrake do
           },
           request_id: 1,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |query|
+          expect(query.stash).to eq(request_id: 1)
+        end
       end
     end
   end
 
   describe ".notify_query_sync" do
     it "notifies query synchronously" do
-      expect(described_class.performance_notifier).to receive(:notify_sync)
+      allow(described_class.performance_notifier).to receive(:notify_sync)
 
       described_class.notify_query_sync(
         {
@@ -290,33 +331,35 @@ RSpec.describe Airbrake do
         },
         request_id: 1,
       )
+
+      expect(described_class.performance_notifier).to have_received(:notify_sync)
     end
   end
 
   describe ".notify_performance_breakdown" do
+    before do
+      allow(described_class.performance_notifier).to receive(:notify)
+    end
+
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the performance breakdown" do
-        expect(described_class.performance_notifier).to receive(:notify) do |query|
-          expect(query.stash).to be_empty
-        end
-
         described_class.notify_query(
           method: 'GET',
           route: '/',
           query: '',
           timing: 1,
         )
-      end
-    end
 
-    context "when :stash key is provided" do
-      it "adds the value as the stash of the performance breakdown" do
         expect(
           described_class.performance_notifier,
-        ).to receive(:notify) do |performance_breakdown|
-          expect(performance_breakdown.stash).to eq(request_id: 1)
+        ).to have_received(:notify) do |query|
+          expect(query.stash).to be_empty
         end
+      end
+    end
 
+    context "when :stash key is provided" do
+      it "adds the value as the stash of the performance breakdown" do
         described_class.notify_performance_breakdown(
           {
             method: 'GET',
@@ -327,13 +370,19 @@ RSpec.describe Airbrake do
           },
           request_id: 1,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |performance_breakdown|
+          expect(performance_breakdown.stash).to eq(request_id: 1)
+        end
       end
     end
   end
 
   describe ".notify_performance_breakdown_sync" do
     it "notifies performance breakdown synchronously" do
-      expect(described_class.performance_notifier).to receive(:notify_sync)
+      allow(described_class.performance_notifier).to receive(:notify_sync)
 
       described_class.notify_performance_breakdown_sync(
         {
@@ -345,29 +394,33 @@ RSpec.describe Airbrake do
         },
         request_id: 1,
       )
+
+      expect(described_class.performance_notifier).to have_received(:notify_sync)
     end
   end
 
   describe ".notify_queue" do
+    before do
+      allow(described_class.performance_notifier).to receive(:notify)
+    end
+
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the queue" do
-        expect(described_class.performance_notifier).to receive(:notify) do |queue|
-          expect(queue.stash).to be_empty
-        end
-
         described_class.notify_queue(
           queue: 'bananas',
           error_count: 10,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |queue|
+          expect(queue.stash).to be_empty
+        end
       end
     end
 
     context "when :stash key is provided" do
       it "adds the value as the stash of the queue" do
-        expect(described_class.performance_notifier).to receive(:notify) do |queue|
-          expect(queue.stash).to eq(request_id: 1)
-        end
-
         described_class.notify_queue(
           {
             queue: 'bananas',
@@ -375,13 +428,19 @@ RSpec.describe Airbrake do
           },
           request_id: 1,
         )
+
+        expect(
+          described_class.performance_notifier,
+        ).to have_received(:notify) do |queue|
+          expect(queue.stash).to eq(request_id: 1)
+        end
       end
     end
   end
 
   describe ".notify_queue_sync" do
     it "notifies queue synchronously" do
-      expect(described_class.performance_notifier).to receive(:notify_sync)
+      allow(described_class.performance_notifier).to receive(:notify_sync)
 
       described_class.notify_queue_sync(
         {
@@ -390,6 +449,8 @@ RSpec.describe Airbrake do
         },
         request_id: 1,
       )
+
+      expect(described_class.performance_notifier).to have_received(:notify_sync)
     end
   end
 
@@ -412,6 +473,7 @@ RSpec.describe Airbrake do
     end
   end
 
+  # rubocop:disable RSpec/MessageSpies
   describe ".close" do
     after { described_class.reset }
 
@@ -456,4 +518,5 @@ RSpec.describe Airbrake do
       end
     end
   end
+  # rubocop:enable RSpec/MessageSpies
 end