airbrake-ruby 4.8.0 → 4.11.1

data/lib/airbrake-ruby/inspectable.rb

@@ -21,7 +21,7 @@ module Airbrake
         project_id: @config.project_id,
         project_key: @config.project_key,
         host: @config.host,
-        filter_chain: @filter_chain.inspect
+        filter_chain: @filter_chain.inspect,
       )
     end
 
@@ -30,7 +30,7 @@ module Airbrake
       q.text("#<#{self.class}:0x#{(object_id << 1).to_s(16).rjust(16, '0')} ")
       q.text(
         "project_id=\"#{@config.project_id}\" project_key=\"#{@config.project_key}\" " \
-        "host=\"#{@config.host}\" filter_chain="
+        "host=\"#{@config.host}\" filter_chain=",
       )
       q.pp(@filter_chain)
       q.text('>')

data/lib/airbrake-ruby/mergeable.rb

@@ -0,0 +1,12 @@
+module Airbrake
+  # Mergeable adds the `#merge` method, so that we don't need to define it in
+  # all of performance models every time we add a model.
+  #
+  # @since 4.9.0
+  # @api private
+  module Mergeable
+    def merge(_other)
+      nil
+    end
+  end
+end

data/lib/airbrake-ruby/notice.rb

@@ -8,7 +8,7 @@ module Airbrake
     NOTIFIER = {
       name: 'airbrake-ruby'.freeze,
       version: Airbrake::AIRBRAKE_RUBY_VERSION,
-      url: 'https://github.com/airbrake/airbrake-ruby'.freeze
+      url: 'https://github.com/airbrake/airbrake-ruby'.freeze,
     }.freeze
 
     # @return [Hash{Symbol=>String,Hash}] the information to be displayed in the
@@ -16,7 +16,7 @@ module Airbrake
     CONTEXT = {
       os: RUBY_PLATFORM,
       language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
-      notifier: NOTIFIER
+      notifier: NOTIFIER,
     }.freeze
 
     # @return [Integer] the maxium size of the JSON payload in bytes
@@ -32,7 +32,7 @@ module Airbrake
       IOError,
       NotImplementedError,
       JSON::GeneratorError,
-      Encoding::UndefinedConversionError
+      Encoding::UndefinedConversionError,
     ].freeze
 
     # @return [Array<Symbol>] the list of keys that can be be overwritten with
@@ -60,10 +60,10 @@ module Airbrake
         errors: NestedException.new(exception).as_json,
         context: context,
         environment: {
-          program_name: $PROGRAM_NAME
+          program_name: $PROGRAM_NAME,
         },
         session: {},
-        params: params
+        params: params,
       }
       @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
 
@@ -138,7 +138,7 @@ module Airbrake
         # Make sure we always send hostname.
         hostname: HOSTNAME,
 
-        severity: DEFAULT_SEVERITY
+        severity: DEFAULT_SEVERITY,
       }.merge(CONTEXT).delete_if { |_key, val| val.nil? || val.empty? }
     end
 
@@ -152,7 +152,7 @@ module Airbrake
         logger.error(
           "#{LOG_LABEL} truncation failed. File an issue at " \
           "https://github.com/airbrake/airbrake-ruby " \
-          "and attach the following payload: #{@payload}"
+          "and attach the following payload: #{@payload}",
         )
       end
 

data/lib/airbrake-ruby/notice_notifier.rb

@@ -55,7 +55,8 @@ module Airbrake
     def build_notice(exception, params = {})
       if @async_sender.closed?
         raise Airbrake::Error,
-              "attempted to build #{exception} with closed Airbrake instance"
+              "Airbrake is closed; can't build exception: " \
+              "#{exception.class}: #{exception}"
       end
 
       if exception.is_a?(Airbrake::Notice)
@@ -116,7 +117,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

@@ -7,22 +7,28 @@ module Airbrake
   # @since v4.2.0
   # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
   PerformanceBreakdown = Struct.new(
-    :method, :route, :response_type, :groups, :start_time, :end_time
+    :method, :route, :response_type, :groups, :start_time, :end_time, :timing,
+    :time
   ) do
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
 
     def initialize(
       method:,
       route:,
       response_type:,
       groups:,
-      start_time:,
-      end_time: Time.now
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(method, route, response_type, groups, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(
+        method, route, response_type, groups, start_time, end_time, timing, time
+      )
     end
 
     def destination
@@ -38,7 +44,7 @@ module Airbrake
         'method' => method,
         'route' => route,
         'responseType' => response_type,
-        'time' => @start_time_utc
+        'time' => @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,8 +56,13 @@ module Airbrake
     private
 
     def update_payload(resource)
-      @payload[resource] ||= { total: Airbrake::Stat.new }
-      @payload[resource][:total].increment(resource.start_time, resource.end_time)
+      if (total_stat = @payload[resource])
+        @payload.key(total_stat).merge(resource)
+      else
+        @payload[resource] = { total: Airbrake::Stat.new }
+      end
+
+      update_total(resource, @payload[resource][:total])
 
       resource.groups.each do |name, ms|
         @payload[resource][name] ||= Airbrake::Stat.new
@@ -70,6 +70,19 @@ module Airbrake
       end
     end
 
+    def update_total(resource, total)
+      if resource.timing
+        total.increment_ms(resource.timing)
+      else
+        loc = caller_locations(6..6).first
+        Kernel.warn(
+          "#{loc.path}:#{loc.lineno}: warning: :start_time and :end_time are " \
+          "deprecated. Use :timing & :time instead",
+        )
+        total.increment(resource.start_time, resource.end_time)
+      end
+    end
+
     def schedule_flush
       return if @payload.empty?
 
@@ -101,12 +114,45 @@ 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 = check_configuration(resource)
+      return promise if promise.rejected?
+
+      @filter_chain.refine(resource)
+      if resource.ignored?
+        return Promise.new.reject("#{resource.class} was ignored by a filter")
+      end
+
+      @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 check_configuration(resource)
+      promise = @config.check_configuration
+      return promise if promise.rejected?
+
+      promise = @config.check_performance_options(resource)
+      return promise if promise.rejected?
+
+      if resource.timing && resource.timing == 0
+        return Promise.new.reject(':timing cannot be zero')
+      end
+
+      Promise.new
+    end
+
+    def send(sender, payload, promise)
       signature = "#{self.class.name}##{__method__}"
       raise "#{signature}: payload (#{payload}) cannot be empty. Race?" if payload.none?
 
@@ -115,9 +161,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 +198,5 @@ module Airbrake
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/airbrake-ruby/query.rb

@@ -6,11 +6,14 @@ module Airbrake
   # @since v3.2.0
   # rubocop:disable Metrics/ParameterLists, Metrics/BlockLength
   Query = Struct.new(
-    :method, :route, :query, :func, :file, :line, :start_time, :end_time
+    :method, :route, :query, :func, :file, :line, :start_time, :end_time,
+    :timing, :time
   ) do
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
+    include Grouppable
 
     def initialize(
       method:,
@@ -19,11 +22,16 @@ module Airbrake
       func: nil,
       file: nil,
       line: nil,
-      start_time:,
-      end_time: Time.now
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(method, route, query, func, file, line, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(
+        method, route, query, func, file, line, start_time, end_time, timing,
+        time
+      )
     end
 
     def destination
@@ -34,19 +42,15 @@ module Airbrake
       'queries'
     end
 
-    def groups
-      {}
-    end
-
     def to_h
       {
         'method' => method,
         'route' => route,
         'query' => query,
-        'time' => @start_time_utc,
+        'time' => @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,56 @@
+module Airbrake
+  # Queue represents a queue (worker).
+  #
+  # @see Airbrake.notify_queue
+  # @api public
+  # @since v4.9.0
+  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
+  Queue = Struct.new(
+    :queue, :error_count, :groups, :start_time, :end_time, :timing, :time
+  ) do
+    include HashKeyable
+    include Ignorable
+    include Stashable
+
+    def initialize(
+      queue:,
+      error_count:,
+      groups: {},
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
+    )
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(queue, error_count, groups, start_time, end_time, timing, time)
+    end
+
+    def destination
+      'queues-stats'
+    end
+
+    def cargo
+      'queues'
+    end
+
+    def to_h
+      {
+        'queue' => queue,
+        'errorCount' => error_count,
+        'time' => @time_utc,
+      }
+    end
+
+    def hash
+      {
+        'queue' => queue,
+        'time' => @time_utc,
+      }.hash
+    end
+
+    def merge(other)
+      self.error_count += other.error_count
+    end
+  end
+  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
+end

data/lib/airbrake-ruby/request.rb

@@ -4,21 +4,27 @@ module Airbrake
   # @see Airbrake.notify_request
   # @api public
   # @since v3.2.0
-  # rubocop:disable Metrics/BlockLength
-  Request = Struct.new(:method, :route, :status_code, :start_time, :end_time) do
+  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
+  Request = Struct.new(
+    :method, :route, :status_code, :start_time, :end_time, :timing, :time
+  ) do
     include HashKeyable
     include Ignorable
     include Stashable
+    include Mergeable
+    include Grouppable
 
     def initialize(
       method:,
       route:,
       status_code:,
-      start_time:,
-      end_time: Time.now
+      start_time: Time.now,
+      end_time: start_time + 1,
+      timing: nil,
+      time: Time.now
     )
-      @start_time_utc = TimeTruncate.utc_truncate_minutes(start_time)
-      super(method, route, status_code, start_time, end_time)
+      @time_utc = TimeTruncate.utc_truncate_minutes(time)
+      super(method, route, status_code, start_time, end_time, timing, time)
     end
 
     def destination
@@ -29,18 +35,14 @@ module Airbrake
       'routes'
     end
 
-    def groups
-      {}
-    end
-
     def to_h
       {
         'method' => method,
         'route' => route,
         'statusCode' => status_code,
-        'time' => @start_time_utc
+        'time' => @time_utc,
       }.delete_if { |_key, val| val.nil? }
     end
   end
-  # rubocop:enable Metrics/BlockLength
+  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
 end