airbrake-ruby 4.8.0 → 4.10.0

data/lib/airbrake-ruby/notice_notifier.rb

@@ -116,7 +116,7 @@ module Airbrake
 
       logger.warn(
         "#{LOG_LABEL} falling back to sync delivery because there are no " \
-        "running async workers"
+        "running async workers",
       )
       @sync_sender
     end

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -12,6 +12,7 @@ module Airbrake
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
 
     def initialize(
       method:,
@@ -38,7 +39,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'responseType' => response_type,
-        'time' => @start_time_utc
+        'time' => @start_time_utc,
       }.delete_if { |_key, val| val.nil? }
     end
   end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -4,6 +4,7 @@ module Airbrake
   #
   # @api public
   # @since v3.2.0
+  # rubocop:disable Metrics/ClassLength
   class PerformanceNotifier
     include Inspectable
     include Loggable
@@ -11,7 +12,8 @@ module Airbrake
     def initialize
       @config = Airbrake::Config.instance
       @flush_period = Airbrake::Config.instance.performance_stats_flush_period
-      @sender = AsyncSender.new(:put)
+      @async_sender = AsyncSender.new(:put)
+      @sync_sender = SyncSender.new(:put)
       @payload = {}
       @schedule_flush = nil
       @mutex = Mutex.new
@@ -23,21 +25,14 @@ module Airbrake
     # @see Airbrake.notify_query
     # @see Airbrake.notify_request
     def notify(resource)
-      promise = @config.check_configuration
-      return promise if promise.rejected?
-
-      promise = @config.check_performance_options(resource)
-      return promise if promise.rejected?
-
-      @filter_chain.refine(resource)
-      return if resource.ignored?
-
-      @mutex.synchronize do
-        update_payload(resource)
-        @flush_period > 0 ? schedule_flush : send(@payload, promise)
-      end
+      send_resource(resource, sync: false)
+    end
 
-      promise.resolve(:success)
+    # @param [Hash] resource
+    # @since v4.10.0
+    # @see Airbrake.notify_queue_sync
+    def notify_sync(resource)
+      send_resource(resource, sync: true).value
     end
 
     # @see Airbrake.add_performance_filter
@@ -53,7 +48,7 @@ module Airbrake
     def close
       @mutex.synchronize do
         @schedule_flush.kill if @schedule_flush
-        @sender.close
+        @async_sender.close
         logger.debug("#{LOG_LABEL} performance notifier closed")
       end
     end
@@ -61,7 +56,12 @@ module Airbrake
     private
 
     def update_payload(resource)
-      @payload[resource] ||= { total: Airbrake::Stat.new }
+      if (total_stat = @payload[resource])
+        @payload.key(total_stat).merge(resource)
+      else
+        @payload[resource] = { total: Airbrake::Stat.new }
+      end
+
       @payload[resource][:total].increment(resource.start_time, resource.end_time)
 
       resource.groups.each do |name, ms|
@@ -101,12 +101,32 @@ module Airbrake
             @payload = {}
           end
 
-          send(payload, Airbrake::Promise.new)
+          send(@async_sender, payload, Airbrake::Promise.new)
+        end
+      end
+    end
+
+    def send_resource(resource, sync:)
+      promise = @config.check_configuration
+      return promise if promise.rejected?
+
+      promise = @config.check_performance_options(resource)
+      return promise if promise.rejected?
+
+      @filter_chain.refine(resource)
+      return if resource.ignored?
+
+      @mutex.synchronize do
+        update_payload(resource)
+        if sync || @flush_period == 0
+          send(@sync_sender, @payload, promise)
+        else
+          schedule_flush
         end
       end
     end
 
-    def send(payload, promise)
+    def send(sender, payload, promise)
       signature = "#{self.class.name}##{__method__}"
       raise "#{signature}: payload (#{payload}) cannot be empty. Race?" if payload.none?
 
@@ -115,9 +135,9 @@ module Airbrake
       with_grouped_payload(payload) do |resource_hash, destination|
         url = URI.join(
           @config.host,
-          "api/v5/projects/#{@config.project_id}/#{destination}"
+          "api/v5/projects/#{@config.project_id}/#{destination}",
         )
-        @sender.send(resource_hash, promise, url)
+        sender.send(resource_hash, promise, url)
       end
 
       promise
@@ -152,4 +172,5 @@ module Airbrake
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/airbrake-ruby/query.rb

@@ -11,6 +11,8 @@ module Airbrake
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
+    include Grouppable
 
     def initialize(
       method:,
@@ -34,10 +36,6 @@ module Airbrake
       'queries'
     end
 
-    def groups
-      {}
-    end
-
     def to_h
       {
         'method' => method,
@@ -46,7 +44,7 @@ module Airbrake
         'time' => @start_time_utc,
         'function' => func,
         'file' => file,
-        'line' => line
+        'line' => line,
       }.delete_if { |_key, val| val.nil? }
     end
     # rubocop:enable Metrics/ParameterLists, Metrics/BlockLength

data/lib/airbrake-ruby/queue.rb

@@ -0,0 +1,52 @@
+module Airbrake
+  # Queue represents a queue (worker).
+  #
+  # @see Airbrake.notify_queue
+  # @api public
+  # @since v4.9.0
+  # rubocop:disable Metrics/BlockLength
+  Queue = Struct.new(:queue, :error_count, :groups, :start_time, :end_time) do
+    include HashKeyable
+    include Ignorable
+    include Stashable
+
+    def initialize(
+      queue:,
+      error_count:,
+      groups: {},
+      start_time: Time.now,
+      end_time: Time.now
+    )
+      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
+      super(queue, error_count, groups, start_time, end_time)
+    end
+
+    def destination
+      'queues-stats'
+    end
+
+    def cargo
+      'queues'
+    end
+
+    def to_h
+      {
+        'queue' => queue,
+        'errorCount' => error_count,
+        'time' => @start_time_utc,
+      }
+    end
+
+    def hash
+      {
+        'queue' => queue,
+        'time' => @start_time_utc,
+      }.hash
+    end
+
+    def merge(other)
+      self.error_count += other.error_count
+    end
+  end
+  # rubocop:enable Metrics/BlockLength
+end

data/lib/airbrake-ruby/request.rb

@@ -9,6 +9,8 @@ module Airbrake
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
+    include Grouppable
 
     def initialize(
       method:,
@@ -29,16 +31,12 @@ module Airbrake
       'routes'
     end
 
-    def groups
-      {}
-    end
-
     def to_h
       {
         'method' => method,
         'route' => route,
         'statusCode' => status_code,
-        'time' => @start_time_utc
+        'time' => @start_time_utc,
       }.delete_if { |_key, val| val.nil? }
     end
   end

data/lib/airbrake-ruby/stat.rb

@@ -32,7 +32,7 @@ module Airbrake
         'count' => count,
         'sum' => sum,
         'sumsq' => sumsq,
-        'tdigest' => Base64.strict_encode64(tdigest.as_small_bytes)
+        'tdigest' => Base64.strict_encode64(tdigest.as_small_bytes),
       }
     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.8.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.10.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -51,28 +51,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 {}
@@ -182,19 +160,6 @@ 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
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the request" do
@@ -206,7 +171,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           status_code: 200,
-          start_time: Time.now
+          start_time: Time.now,
         )
       end
     end
@@ -222,14 +187,30 @@ RSpec.describe Airbrake do
             method: 'GET',
             route: '/',
             status_code: 200,
-            start_time: Time.now
+            start_time: Time.now,
           },
-          request_id: 1
+          request_id: 1,
         )
       end
     end
   end
 
+  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,
+          start_time: Time.now,
+        },
+        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
@@ -241,7 +222,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now
+          start_time: Time.now,
         )
       end
     end
@@ -257,14 +238,30 @@ RSpec.describe Airbrake do
             method: 'GET',
             route: '/',
             query: '',
-            start_time: Time.now
+            start_time: Time.now,
           },
-          request_id: 1
+          request_id: 1,
         )
       end
     end
   end
 
+  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: '',
+          start_time: Time.now,
+        },
+        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
@@ -276,7 +273,7 @@ RSpec.describe Airbrake do
           method: 'GET',
           route: '/',
           query: '',
-          start_time: Time.now
+          start_time: Time.now,
         )
       end
     end
@@ -284,7 +281,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 +292,76 @@ RSpec.describe Airbrake do
             route: '/',
             response_type: :html,
             groups: {},
-            start_time: Time.now
+            start_time: Time.now,
+          },
+          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: {},
+          start_time: Time.now,
+        },
+        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 +380,35 @@ RSpec.describe Airbrake do
       expect(described_class.deploy_notifier).to be_an(Airbrake::DeployNotifier)
     end
   end
+
+  describe ".close" do
+    after { Airbrake.reset }
+
+    context "when notice_notifier is defined" do
+      it "gets closed" do
+        expect(Airbrake.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
+        Airbrake.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(Airbrake.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
+        Airbrake.instance_variable_set(:@performance_notifier, nil)
+        expect_any_instance_of(Airbrake::PerformanceNotifier)
+          .not_to receive(:close)
+      end
+    end
+  end
 end