airbrake-ruby 4.8.0 → 5.2.0

data/lib/airbrake-ruby/thread_pool.rb

@@ -45,7 +45,15 @@ module Airbrake
     # @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
+      if backlog >= @queue_size
+        logger.error(
+          "#{LOG_LABEL} ThreadPool has reached its capacity of " \
+          "#{@queue_size} and the following message will not be " \
+          "processed: #{message.inspect}",
+        )
+        return false
+      end
+
       @queue << message
       true
     end
@@ -75,6 +83,7 @@ module Airbrake
 
         if @pid != Process.pid && @workers.list.empty?
           @pid = Process.pid
+          @workers = ThreadGroup.new
           spawn_workers
         end
 
@@ -120,6 +129,7 @@ module Airbrake
       Thread.new do
         while (message = @queue.pop)
           break if message == :stop
+
           @block.call(message)
         end
       end

data/lib/airbrake-ruby/truncator.rb

@@ -12,6 +12,10 @@ module Airbrake
     #   strings with +ENCODING_OPTIONS+
     TEMP_ENCODING = 'utf-16'.freeze
 
+    # @return [Array<Encoding>] encodings that are eligible for fixing invalid
+    #   characters
+    SUPPORTED_ENCODINGS = [Encoding::UTF_8, Encoding::ASCII].freeze
+
     # @return [String] what to append when something is a circular reference
     CIRCULAR = '[Circular]'.freeze
 
@@ -35,6 +39,7 @@ module Airbrake
     def truncate(object, seen = Set.new)
       if seen.include?(object.object_id)
         return CIRCULAR if CIRCULAR_TYPES.any? { |t| object.is_a?(t) }
+
         return object
       end
       truncate_object(object, seen << object.object_id)
@@ -63,6 +68,7 @@ module Airbrake
     def truncate_string(str)
       fixed_str = replace_invalid_characters(str)
       return fixed_str if fixed_str.length <= @max_size
+
       (fixed_str.slice(0, @max_size) + TRUNCATED).freeze
     end
 
@@ -76,6 +82,7 @@ module Airbrake
       truncated_hash = {}
       hash.each_with_index do |(key, val), idx|
         break if idx + 1 > @max_size
+
         truncated_hash[key] = truncate(val, seen)
       end
 
@@ -103,13 +110,12 @@ module Airbrake
     # @return [String] a UTF-8 encoded string
     # @see https://github.com/flori/json/commit/3e158410e81f94dbbc3da6b7b35f4f64983aa4e3
     def replace_invalid_characters(str)
-      encoding = str.encoding
-      utf8_string = (encoding == Encoding::UTF_8 || encoding == Encoding::ASCII)
+      utf8_string = SUPPORTED_ENCODINGS.include?(str.encoding)
       return str if utf8_string && str.valid_encoding?
 
       temp_str = str.dup
-      temp_str.encode!(TEMP_ENCODING, ENCODING_OPTIONS) if utf8_string
-      temp_str.encode!('utf-8', ENCODING_OPTIONS)
+      temp_str.encode!(TEMP_ENCODING, **ENCODING_OPTIONS) if utf8_string
+      temp_str.encode!('utf-8', **ENCODING_OPTIONS)
     end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,15 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.8.0'.freeze
+  # @api public
+  AIRBRAKE_RUBY_VERSION = '5.2.0'.freeze
+
+  # @return [Hash{Symbol=>String}] the information about the notifier library
+  # @since v5.0.0
+  # @api public
+  NOTIFIER_INFO = {
+    name: 'airbrake-ruby'.freeze,
+    version: Airbrake::AIRBRAKE_RUBY_VERSION,
+    url: 'https://github.com/airbrake/airbrake-ruby'.freeze,
+  }.freeze
 end

data/spec/airbrake_spec.rb

@@ -1,4 +1,13 @@
 RSpec.describe Airbrake do
+  let(:remote_settings) { instance_double(Airbrake::RemoteSettings) }
+
+  before do
+    allow(Airbrake::RemoteSettings).to receive(:poll).and_return(remote_settings)
+    allow(remote_settings).to receive(:stop_polling)
+  end
+
+  after { described_class.instance_variable_set(:@remote_settings, nil) }
+
   it "gets initialized with a performance notifier" do
     expect(described_class.performance_notifier).not_to be_nil
   end
@@ -51,28 +60,6 @@ RSpec.describe Airbrake do
       expect(described_class).to be_configured
     end
 
-    context "when a notifier was configured" do
-      before do
-        expect(described_class).to receive(:configured?).and_return(true)
-      end
-
-      it "closes previously configured notice notifier" do
-        expect(described_class).to receive(:close)
-        described_class.configure {}
-      end
-    end
-
-    context "when a notifier wasn't configured" do
-      before do
-        expect(described_class).to receive(:configured?).and_return(false)
-      end
-
-      it "doesn't close previously configured notice notifier" do
-        expect(described_class).not_to receive(:close)
-        described_class.configure {}
-      end
-    end
-
     context "when called multiple times" do
       it "doesn't overwrite performance notifier" do
         described_class.configure {}
@@ -97,43 +84,65 @@ RSpec.describe Airbrake do
         described_class.configure {}
         expect(described_class.deploy_notifier).to eql(deploy_notifier)
       end
+
+      it "doesn't append the same notice notifier filters over and over" do
+        described_class.configure do |c|
+          c.project_id = 1
+          c.project_key = '2'
+        end
+
+        expect(described_class.notice_notifier).not_to receive(:add_filter)
+        10.times { described_class.configure {} }
+      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
+      end
     end
 
-    context "when blacklist_keys gets configured" do
-      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+    context "when blocklist_keys gets configured" do
+      before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
-      it "adds blacklist filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysBlacklist))
-        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      it "adds blocklist filter" do
+        expect(described_class.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysBlocklist))
+        described_class.configure { |c| c.blocklist_keys = %w[password] }
       end
 
-      it "initializes blacklist with specified parameters" do
-        expect(Airbrake::Filters::KeysBlacklist).to receive(:new).with(%w[password])
-        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      it "initializes blocklist with specified parameters" do
+        expect(Airbrake::Filters::KeysBlocklist).to receive(:new).with(%w[password])
+        described_class.configure { |c| c.blocklist_keys = %w[password] }
       end
     end
 
-    context "when whitelist_keys gets configured" do
-      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+    context "when allowlist_keys gets configured" do
+      before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
-      it "adds whitelist filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysWhitelist))
-        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      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] }
       end
 
-      it "initializes whitelist with specified parameters" do
-        expect(Airbrake::Filters::KeysWhitelist).to receive(:new).with(%w[banana])
-        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      it "initializes allowlist with specified parameters" do
+        expect(Airbrake::Filters::KeysAllowlist).to receive(:new).with(%w[banana])
+        described_class.configure { |c| c.allowlist_keys = %w[banana] }
       end
     end
 
     context "when root_directory gets configured" do
-      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+      before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
       it "adds root directory filter" do
-        expect(Airbrake.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 { |c| c.root_directory = '/my/path' }
       end
@@ -145,7 +154,7 @@ RSpec.describe Airbrake do
       end
 
       it "adds git revision filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        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' }
       end
@@ -157,7 +166,7 @@ RSpec.describe Airbrake do
       end
 
       it "adds git repository filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        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' }
       end
@@ -169,7 +178,7 @@ RSpec.describe Airbrake do
       end
 
       it "adds git last checkout filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        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' }
       end
@@ -182,20 +191,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#reset" do
-    context "when Airbrake was previously configured" do
-      before do
-        expect(described_class).to receive(:configured?).and_return(true)
-      end
-
-      it "closes notice notifier" do
-        expect(described_class).to receive(:close)
-        subject.reset
-      end
-    end
-  end
-
-  describe "#notify_request" do
+  describe ".notify_request" do
     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|
@@ -206,7 +202,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           status_code: 200,
-          start_time: Time.now
+          timing: 1,
         )
       end
     end
@@ -222,15 +218,31 @@ RSpec.describe Airbrake do
             method: 'GET',
             route: '/',
             status_code: 200,
-            start_time: Time.now
+            timing: 1,
           },
-          request_id: 1
+          request_id: 1,
         )
       end
     end
   end
 
-  describe "#notify_query" do
+  describe ".notify_request_sync" do
+    it "notifies request synchronously" do
+      expect(described_class.performance_notifier).to receive(:notify_sync)
+
+      described_class.notify_request_sync(
+        {
+          method: 'GET',
+          route: '/',
+          status_code: 200,
+          timing: 1,
+        },
+        request_id: 1,
+      )
+    end
+  end
+
+  describe ".notify_query" do
     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|
@@ -241,7 +253,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now
+          timing: 1,
         )
       end
     end
@@ -257,15 +269,31 @@ RSpec.describe Airbrake do
             method: 'GET',
             route: '/',
             query: '',
-            start_time: Time.now
+            timing: 1,
           },
-          request_id: 1
+          request_id: 1,
         )
       end
     end
   end
 
-  describe "#notify_performance_breakdown" do
+  describe ".notify_query_sync" do
+    it "notifies query synchronously" do
+      expect(described_class.performance_notifier).to receive(:notify_sync)
+
+      described_class.notify_query_sync(
+        {
+          method: 'GET',
+          route: '/',
+          query: '',
+          timing: 1,
+        },
+        request_id: 1,
+      )
+    end
+  end
+
+  describe ".notify_performance_breakdown" do
     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|
@@ -276,7 +304,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now
+          timing: 1,
         )
       end
     end
@@ -284,7 +312,7 @@ RSpec.describe Airbrake do
     context "when :stash key is provided" do
       it "adds the value as the stash of the performance breakdown" do
         expect(
-          described_class.performance_notifier
+          described_class.performance_notifier,
         ).to receive(:notify) do |performance_breakdown|
           expect(performance_breakdown.stash).to eq(request_id: 1)
         end
@@ -295,14 +323,76 @@ RSpec.describe Airbrake do
             route: '/',
             response_type: :html,
             groups: {},
-            start_time: Time.now
+            timing: 1,
+          },
+          request_id: 1,
+        )
+      end
+    end
+  end
+
+  describe ".notify_performance_breakdown_sync" do
+    it "notifies performance breakdown synchronously" do
+      expect(described_class.performance_notifier).to receive(:notify_sync)
+
+      described_class.notify_performance_breakdown_sync(
+        {
+          method: 'GET',
+          route: '/',
+          response_type: :html,
+          groups: {},
+          timing: 1,
+        },
+        request_id: 1,
+      )
+    end
+  end
+
+  describe ".notify_queue" do
+    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,
+        )
+      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',
+            error_count: 10,
           },
-          request_id: 1
+          request_id: 1,
         )
       end
     end
   end
 
+  describe ".notify_queue_sync" do
+    it "notifies queue synchronously" do
+      expect(described_class.performance_notifier).to receive(:notify_sync)
+
+      described_class.notify_queue_sync(
+        {
+          queue: 'bananas',
+          error_count: 10,
+        },
+        request_id: 1,
+      )
+    end
+  end
+
   describe ".performance_notifier" do
     it "returns a performance notifier" do
       expect(described_class.performance_notifier)
@@ -321,4 +411,49 @@ RSpec.describe Airbrake do
       expect(described_class.deploy_notifier).to be_an(Airbrake::DeployNotifier)
     end
   end
+
+  describe ".close" do
+    after { described_class.reset }
+
+    context "when notice_notifier is defined" do
+      it "gets closed" do
+        expect(described_class.notice_notifier).to receive(:close)
+      end
+    end
+
+    context "when notice_notifier is undefined" do
+      it "doesn't get closed (because it wasn't initialized)" do
+        described_class.instance_variable_set(:@notice_notifier, nil)
+        expect_any_instance_of(Airbrake::NoticeNotifier).not_to receive(:close)
+      end
+    end
+
+    context "when performance_notifier is defined" do
+      it "gets closed" do
+        expect(described_class.performance_notifier).to receive(:close)
+      end
+    end
+
+    context "when perforance_notifier is undefined" do
+      it "doesn't get closed (because it wasn't initialized)" do
+        described_class.instance_variable_set(:@performance_notifier, nil)
+        expect_any_instance_of(Airbrake::PerformanceNotifier)
+          .not_to receive(:close)
+      end
+    end
+
+    context "when remote settings are defined" do
+      it "stops polling" do
+        described_class.instance_variable_set(:@remote_settings, remote_settings)
+        expect(remote_settings).to receive(:stop_polling)
+      end
+    end
+
+    context "when remote settings are undefined" do
+      it "doesn't stop polling (because they weren't initialized)" do
+        described_class.instance_variable_set(:@remote_settings, nil)
+        expect(remote_settings).not_to receive(:stop_polling)
+      end
+    end
+  end
 end