airbrake-ruby 4.11.1 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b9d78ba8789ccfa27f139a5ad0fef6b544da9bde4239dfda22cc543493bdb45
-  data.tar.gz: c32c7e64425037221491c64de8e22d548815929ec6e3a0289aad3c74f8ffedc7
+  metadata.gz: 21b45126851240764d75da35e8f7fbc7c73effdda1b01854065dc25db0c351e3
+  data.tar.gz: 5dd7a704b0a16a841fb93b30b72a0acf28cb887f2e7abdda57e48078289d107b
 SHA512:
-  metadata.gz: 711d058e48af32390e7b92243171014122b5e454cea35afd19ca72e5fe39d04b919f0cbc95dfdf23685a3114cac14430310eb5a0c785c263d85a52ca26bab861
-  data.tar.gz: 300176c0bab2a6ddcb4b3453069be19ef5a477021ca10f68256edabc97c9d0d15b3b4a5659f2676e53071f89229b59c90ac6d0f1016d953342af8d9fc8b27581
+  metadata.gz: 9252437e39b4a415e2e90ca8a4434540ecd7e45737bdacd788e772a308fbc6c1f231c293eaa11aaaf90310f695f7a44e87b7511cd5af204259949746a6e85013
+  data.tar.gz: 969b2e55a423d02f241e04ccb27eeb13d352dbe3b0f4394c53dccdf4a3bab8c4d59e19ac7a9c7e455a08b5c22340e49b126581b1be90adcd972faaa79fbb6e11

data/lib/airbrake-ruby.rb

@@ -84,6 +84,13 @@ module Airbrake
   #  special cases where we need to work around older implementations
   JRUBY = (RUBY_ENGINE == 'jruby')
 
+  # @return [Boolean] true if this Ruby supports safe levels and tainting,
+  #  to guard against using deprecated or unsupported features.
+  HAS_SAFE_LEVEL = (
+    RUBY_ENGINE == 'ruby' &&
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
+  )
+
   class << self
     # @since v4.2.3
     # @api private
@@ -364,7 +371,7 @@ module Airbrake
     # @since v3.0.0
     # @see Airbrake::PerformanceNotifier#notify
     def notify_request(request_info, stash = {})
-      request = Request.new(request_info)
+      request = Request.new(**request_info)
       request.stash.merge!(stash)
       performance_notifier.notify(request)
     end
@@ -374,7 +381,7 @@ module Airbrake
     # @since v4.10.0
     # @see .notify_request
     def notify_request_sync(request_info, stash = {})
-      request = Request.new(request_info)
+      request = Request.new(**request_info)
       request.stash.merge!(stash)
       performance_notifier.notify_sync(request)
     end
@@ -407,7 +414,7 @@ module Airbrake
     # @since v3.2.0
     # @see Airbrake::PerformanceNotifier#notify
     def notify_query(query_info, stash = {})
-      query = Query.new(query_info)
+      query = Query.new(**query_info)
       query.stash.merge!(stash)
       performance_notifier.notify(query)
     end
@@ -418,7 +425,7 @@ module Airbrake
     # @since v4.10.0
     # @see .notify_query
     def notify_query_sync(query_info, stash = {})
-      query = Query.new(query_info)
+      query = Query.new(**query_info)
       query.stash.merge!(stash)
       performance_notifier.notify_sync(query)
     end
@@ -446,7 +453,7 @@ module Airbrake
     # @return [void]
     # @since v4.2.0
     def notify_performance_breakdown(breakdown_info, stash = {})
-      performance_breakdown = PerformanceBreakdown.new(breakdown_info)
+      performance_breakdown = PerformanceBreakdown.new(**breakdown_info)
       performance_breakdown.stash.merge!(stash)
       performance_notifier.notify(performance_breakdown)
     end
@@ -456,7 +463,7 @@ module Airbrake
     # @since v4.10.0
     # @see .notify_performance_breakdown
     def notify_performance_breakdown_sync(breakdown_info, stash = {})
-      performance_breakdown = PerformanceBreakdown.new(breakdown_info)
+      performance_breakdown = PerformanceBreakdown.new(**breakdown_info)
       performance_breakdown.stash.merge!(stash)
       performance_notifier.notify_sync(performance_breakdown)
     end
@@ -484,7 +491,7 @@ module Airbrake
     # @since v4.9.0
     # @see .notify_queue_sync
     def notify_queue(queue_info, stash = {})
-      queue = Queue.new(queue_info)
+      queue = Queue.new(**queue_info)
       queue.stash.merge!(stash)
       performance_notifier.notify(queue)
     end
@@ -493,7 +500,7 @@ module Airbrake
     # @since v4.10.0
     # @see .notify_queue
     def notify_queue_sync(queue_info, stash = {})
-      queue = Queue.new(queue_info)
+      queue = Queue.new(**queue_info)
       queue.stash.merge!(stash)
       performance_notifier.notify_sync(queue)
     end

data/lib/airbrake-ruby/config.rb

@@ -101,6 +101,12 @@ module Airbrake
     # @since v4.6.0
     attr_accessor :query_stats
 
+    # @return [Boolean] true if the library should send job/queue/worker stats
+    #   to Airbrake, false otherwise
+    # @api public
+    # @since v4.12.0
+    attr_accessor :job_stats
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -139,6 +145,7 @@ module Airbrake
       self.performance_stats = true
       self.performance_stats_flush_period = 15
       self.query_stats = true
+      self.job_stats = true
 
       merge(user_config)
     end
@@ -213,6 +220,8 @@ module Airbrake
         promise.reject("The Performance Stats feature is disabled")
       elsif resource.is_a?(Airbrake::Query) && !query_stats
         promise.reject("The Query Stats feature is disabled")
+      elsif resource.is_a?(Airbrake::Queue) && !job_stats
+        promise.reject("The Job Stats feature is disabled")
       else
         promise
       end

data/lib/airbrake-ruby/filters/thread_filter.rb

@@ -72,7 +72,7 @@ module Airbrake
         thread_info[:group] = th.group.list.map(&:inspect)
         thread_info[:priority] = th.priority
 
-        thread_info[:safe_level] = th.safe_level unless Airbrake::JRUBY
+        thread_info[:safe_level] = th.safe_level if Airbrake::HAS_SAFE_LEVEL
       end
 
       def sanitize_value(value)

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -5,16 +5,16 @@ module Airbrake
   # @see Airbrake.notify_breakdown
   # @api public
   # @since v4.2.0
-  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
-  PerformanceBreakdown = Struct.new(
-    :method, :route, :response_type, :groups, :start_time, :end_time, :timing,
-    :time
-  ) do
+  # rubocop:disable Metrics/ParameterLists
+  class PerformanceBreakdown
     include HashKeyable
     include Ignorable
     include Stashable
     include Mergeable
 
+    attr_accessor :method, :route, :response_type, :groups, :start_time,
+                  :end_time, :timing, :time
+
     def initialize(
       method:,
       route:,
@@ -26,9 +26,14 @@ module Airbrake
       time: Time.now
     )
       @time_utc = TimeTruncate.utc_truncate_minutes(time)
-      super(
-        method, route, response_type, groups, start_time, end_time, timing, time
-      )
+      @method = method
+      @route = route
+      @response_type = response_type
+      @groups = groups
+      @start_time = start_time
+      @end_time = end_time
+      @timing = timing
+      @time = time
     end
 
     def destination
@@ -48,5 +53,5 @@ module Airbrake
       }.delete_if { |_key, val| val.nil? }
     end
   end
-  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
+  # rubocop:enable Metrics/ParameterLists
 end

data/lib/airbrake-ruby/query.rb

@@ -4,17 +4,17 @@ module Airbrake
   # @see Airbrake.notify_query
   # @api public
   # @since v3.2.0
-  # rubocop:disable Metrics/ParameterLists, Metrics/BlockLength
-  Query = Struct.new(
-    :method, :route, :query, :func, :file, :line, :start_time, :end_time,
-    :timing, :time
-  ) do
+  # rubocop:disable Metrics/ParameterLists
+  class Query
     include HashKeyable
     include Ignorable
     include Stashable
     include Mergeable
     include Grouppable
 
+    attr_accessor :method, :route, :query, :func, :file, :line, :start_time,
+                  :end_time, :timing, :time
+
     def initialize(
       method:,
       route:,
@@ -28,10 +28,16 @@ module Airbrake
       time: Time.now
     )
       @time_utc = TimeTruncate.utc_truncate_minutes(time)
-      super(
-        method, route, query, func, file, line, start_time, end_time, timing,
-        time
-      )
+      @method = method
+      @route = route
+      @query = query
+      @func = func
+      @file = file
+      @line = line
+      @start_time = start_time
+      @end_time = end_time
+      @timing = timing
+      @time = time
     end
 
     def destination
@@ -53,6 +59,6 @@ module Airbrake
         'line' => line,
       }.delete_if { |_key, val| val.nil? }
     end
-    # rubocop:enable Metrics/ParameterLists, Metrics/BlockLength
+    # rubocop:enable Metrics/ParameterLists
   end
 end

data/lib/airbrake-ruby/queue.rb

@@ -4,14 +4,15 @@ module Airbrake
   # @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
+  # rubocop:disable Metrics/ParameterLists
+  class Queue
     include HashKeyable
     include Ignorable
     include Stashable
 
+    attr_accessor :queue, :error_count, :groups, :start_time, :end_time,
+                  :timing, :time
+
     def initialize(
       queue:,
       error_count:,
@@ -22,7 +23,13 @@ module Airbrake
       time: Time.now
     )
       @time_utc = TimeTruncate.utc_truncate_minutes(time)
-      super(queue, error_count, groups, start_time, end_time, timing, time)
+      @queue = queue
+      @error_count = error_count
+      @groups = groups
+      @start_time = start_time
+      @end_time = end_time
+      @timing = timing
+      @time = time
     end
 
     def destination
@@ -51,6 +58,15 @@ module Airbrake
     def merge(other)
       self.error_count += other.error_count
     end
+
+    # Queues don't have routes, but we want to define this to make sure our
+    # filter API is consistent (other models define this property)
+    #
+    # @return [String] empty route
+    # @see https://github.com/airbrake/airbrake-ruby/pull/537
+    def route
+      ''
+    end
   end
-  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
+  # rubocop:enable Metrics/ParameterLists
 end

data/lib/airbrake-ruby/request.rb

@@ -4,16 +4,17 @@ module Airbrake
   # @see Airbrake.notify_request
   # @api public
   # @since v3.2.0
-  # rubocop:disable Metrics/BlockLength, Metrics/ParameterLists
-  Request = Struct.new(
-    :method, :route, :status_code, :start_time, :end_time, :timing, :time
-  ) do
+  # rubocop:disable Metrics/ParameterLists
+  class Request
     include HashKeyable
     include Ignorable
     include Stashable
     include Mergeable
     include Grouppable
 
+    attr_accessor :method, :route, :status_code, :start_time, :end_time,
+                  :timing, :time
+
     def initialize(
       method:,
       route:,
@@ -24,7 +25,13 @@ module Airbrake
       time: Time.now
     )
       @time_utc = TimeTruncate.utc_truncate_minutes(time)
-      super(method, route, status_code, start_time, end_time, timing, time)
+      @method = method
+      @route = route
+      @status_code = status_code
+      @start_time = start_time
+      @end_time = end_time
+      @timing = timing
+      @time = time
     end
 
     def destination
@@ -44,5 +51,5 @@ module Airbrake
       }.delete_if { |_key, val| val.nil? }
     end
   end
-  # rubocop:enable Metrics/BlockLength, Metrics/ParameterLists
+  # rubocop:enable Metrics/ParameterLists
 end

data/lib/airbrake-ruby/stat.rb

@@ -1,6 +1,5 @@
 require 'base64'
 
-# rubocop:disable Metrics/BlockLength
 module Airbrake
   # Stat is a data structure that allows accumulating performance data (route
   # performance, SQL query performance and such). It's powered by TDigests.
@@ -14,14 +13,19 @@ module Airbrake
   #   stat.to_h # Pack and serialize data so it can be transmitted.
   #
   # @since v3.2.0
-  Stat = Struct.new(:count, :sum, :sumsq, :tdigest) do
+  class Stat
+    attr_accessor :count, :sum, :sumsq, :tdigest
+
     # @param [Integer] count How many times this stat was incremented
     # @param [Float] sum The sum of duration in milliseconds
     # @param [Float] sumsq The squared sum of duration in milliseconds
     # @param [TDigest::TDigest] tdigest Packed durations. By default,
     #   compression is 20
     def initialize(count: 0, sum: 0.0, sumsq: 0.0, tdigest: TDigest.new(0.05))
-      super(count, sum, sumsq, tdigest)
+      @count = count
+      @sum = sum
+      @sumsq = sumsq
+      @tdigest = tdigest
     end
 
     # @return [Hash{String=>Object}] stats as a hash with compressed TDigest
@@ -67,7 +71,6 @@ module Airbrake
     def inspect
       "#<struct Airbrake::Stat count=#{count}, sum=#{sum}, sumsq=#{sumsq}>"
     end
-    alias_method :pretty_print, :inspect
+    alias pretty_print inspect
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/airbrake-ruby/truncator.rb

@@ -108,8 +108,8 @@ module Airbrake
       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,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.11.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.13.0'.freeze
 end

data/spec/config_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe Airbrake::Config do
   its(:performance_stats) { is_expected.to eq(true) }
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
   its(:query_stats) { is_expected.to eq(true) }
+  its(:job_stats) { is_expected.to eq(true) }
 
   describe "#new" do
     context "when user config is passed" do
@@ -146,5 +147,20 @@ RSpec.describe Airbrake::Config do
         )
       end
     end
+
+    context "when job stats are disabled" do
+      before { subject.job_stats = false }
+
+      let(:resource) do
+        Airbrake::Queue.new(queue: 'foo_queue', error_count: 0, timing: 1)
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Job Stats feature is disabled",
+        )
+      end
+    end
   end
 end

data/spec/filters/thread_filter_spec.rb

@@ -258,7 +258,9 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     expect(notice[:params][:thread][:priority]).to eq(0)
   end
 
-  it "appends safe_level", skip: Airbrake::JRUBY do
+  it "appends safe_level", skip: (
+    "Not supported on this version of Ruby." unless Airbrake::HAS_SAFE_LEVEL
+  ) do
     subject.call(notice)
     expect(notice[:params][:thread][:safe_level]).to eq(0)
   end

data/spec/performance_notifier_spec.rb

@@ -16,6 +16,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
       performance_stats: true,
       performance_stats_flush_period: 0,
       query_stats: true,
+      job_stats: true,
     )
   end
 

data/spec/queue_spec.rb

@@ -18,4 +18,13 @@ RSpec.describe Airbrake::Queue do
       expect(queue.end_time).to eq(time + 1)
     end
   end
+
+  describe "#route" do
+    it "always returns an empty route" do
+      queue = described_class.new(
+        queue: 'a', error_count: 0, start_time: Time.now,
+      )
+      expect(queue.route).to be_empty
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.11.1
+  version: 4.13.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-20 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3