airbrake-ruby 5.2.0 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8102082d97168a2204b3e730fc2085d30d06d4ab501e6207d91ce9d67bd91584
-  data.tar.gz: cf2234bd6fc61e439796b0f664163a12fdd4c39c4256a1c469f06dd1f8132de3
+  metadata.gz: f0310134480c9c13f2e8ab87a4c616768c213b590f98edd38e9c9abbd539a7ba
+  data.tar.gz: 6f5e8d2411eee4e18ff97ef7d89b3c4a1c8ebb3ba5ec14fafe24c25e850672b1
 SHA512:
-  metadata.gz: d5b353597aa2bf9d59fa454f8a6a87fadcdc71685a7e21ef3ec9f74e57b20268e5d6cad2d6d0fe061bdcdbe02e65cf2e5761d4e92c6370ea1d1316972da9d9af
-  data.tar.gz: d13b77d0f959ff3a5326f054b8df67c9402b216038afd25672df8b6803623ac135bb5366739687fc5c234ae2e127d075828f747bb945d9ba4d48f3f354775f17
+  metadata.gz: d6e19e37eca3e38af441560c044ac1472ab06a282c4d8b4873a4c8529b9fb9e9a70634a42b4d0d5fe668ba866649ee115942678e5bbfffa1f60373ccd66e964b
+  data.tar.gz: f8b22c23d2534b1f4dc12dd1b5d8bf970504b297a61421cda6d496ec2f1143ac9eb031e2c1b033e8d8a24b94b634c2a17ea475f9ef13d482be08a419a54b1d98

data/lib/airbrake-ruby/async_sender.rb

@@ -7,9 +7,10 @@ module Airbrake
   class AsyncSender
     include Loggable
 
-    def initialize(method = :post)
+    def initialize(method = :post, name = 'async-sender')
       @config = Airbrake::Config.instance
       @method = method
+      @name = name
     end
 
     # Asynchronously sends a notice to Airbrake.
@@ -47,6 +48,7 @@ module Airbrake
       @thread_pool ||= begin
         sender = SyncSender.new(@method)
         ThreadPool.new(
+          name: @name,
           worker_size: @config.workers,
           queue_size: @config.queue_size,
           block: proc { |args| sender.send(*args) },

data/lib/airbrake-ruby/config.rb

@@ -248,14 +248,14 @@ module Airbrake
 
     # @return [Promise] resolved promise if neither of the performance options
     #   reject it, false otherwise
-    def check_performance_options(resource)
+    def check_performance_options(metric)
       promise = Airbrake::Promise.new
 
       if !performance_stats
         promise.reject("The Performance Stats feature is disabled")
-      elsif resource.is_a?(Airbrake::Query) && !query_stats
+      elsif metric.is_a?(Airbrake::Query) && !query_stats
         promise.reject("The Query Stats feature is disabled")
-      elsif resource.is_a?(Airbrake::Queue) && !job_stats
+      elsif metric.is_a?(Airbrake::Queue) && !job_stats
         promise.reject("The Job Stats feature is disabled")
       else
         promise

data/lib/airbrake-ruby/context.rb

@@ -0,0 +1,51 @@
+module Airbrake
+  # Represents a thread-safe Airbrake context object, which carries arbitrary
+  # information added via {Airbrake.merge_context} calls.
+  #
+  # @example
+  #   Airbrake::Context.current.merge!(foo: 'bar')
+  #
+  # @api private
+  # @since v5.2.1
+  class Context
+    # Returns current, thread-local, context.
+    # @return [self]
+    def self.current
+      Thread.current[:airbrake_context] ||= new
+    end
+
+    def initialize
+      @mutex = Mutex.new
+      @context = {}
+    end
+
+    # Merges the given context with the current one.
+    #
+    # @param [Hash{Object=>Object}] other
+    # @return [void]
+    def merge!(other)
+      @mutex.synchronize do
+        @context.merge!(other)
+      end
+    end
+
+    # @return [Hash] duplicated Hash context
+    def to_h
+      @mutex.synchronize do
+        @context.dup
+      end
+    end
+
+    # @return [Hash] clears (resets) the current context
+    def clear
+      @mutex.synchronize do
+        @context.clear
+      end
+    end
+
+    # @return [Boolean] checks whether the context has any data
+    def empty?
+      @context.empty?
+    end
+  end
+end

data/lib/airbrake-ruby/filter_chain.rb

@@ -57,7 +57,9 @@ module Airbrake
     # @return [void]
     # @since v3.1.0
     def delete_filter(filter_class)
+      # rubocop:disable Style/ClassEqualityComparison
       index = @filters.index { |f| f.class.name == filter_class.name }
+      # rubocop:enable Style/ClassEqualityComparison
       @filters.delete_at(index) if index
     end
 

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

@@ -9,8 +9,7 @@ module Airbrake
       # @return [Integer]
       attr_reader :weight
 
-      def initialize(context)
-        @context = context
+      def initialize
         @weight = 119
         @mutex = Mutex.new
       end
@@ -18,10 +17,10 @@ module Airbrake
       # @macro call_filter
       def call(notice)
         @mutex.synchronize do
-          return if @context.empty?
+          return if Airbrake::Context.current.empty?
 
-          notice[:params][:airbrake_context] = @context.dup
-          @context.clear
+          notice[:params][:airbrake_context] = Airbrake::Context.current.to_h
+          Airbrake::Context.current.clear
         end
       end
     end

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

@@ -13,7 +13,7 @@ module Airbrake
       end
 
       # @macro call_filter
-      def call(notice)
+      def call(notice) # rubocop:disable Metrics/AbcSize
         exception = notice.stash[:exception]
         return unless exception.respond_to?(:to_airbrake)
 

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

@@ -50,7 +50,7 @@ module Airbrake
       def last_checkout
         return unless (line = last_checkout_line)
 
-        parts = line.chomp.split("\t").first.split(' ')
+        parts = line.chomp.split("\t").first.split
         if parts.size < MIN_HEAD_COLS
           logger.error(
             "#{LOG_LABEL} Airbrake::#{self.class.name}: can't parse line: #{line}",
@@ -72,7 +72,7 @@ module Airbrake
         return unless File.exist?(head_path)
 
         last_line = nil
-        IO.foreach(head_path) do |line|
+        File.foreach(head_path) do |line|
           last_line = line if checkout_line?(line)
         end
         last_line

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

@@ -36,7 +36,7 @@ module Airbrake
             `cd #{@git_path} && git config --get remote.origin.url`.chomp
           else
             "`git remote get-url` is unsupported in git #{@git_version}. " \
-            'Consider an upgrade to 2.7+'
+              'Consider an upgrade to 2.7+'
           end
 
         return unless @repository

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

@@ -57,7 +57,7 @@ module Airbrake
 
         File.readlines(packed_refs_path).each do |line|
           next if %w[# ^].include?(line[0])
-          next unless (parts = line.split(' ')).size == 2
+          next unless (parts = line.split).size == 2
           return parts.first if parts.last == head
         end
 

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

@@ -82,7 +82,7 @@ module Airbrake
 
       private
 
-      def filter_hash(hash)
+      def filter_hash(hash) # rubocop:disable Metrics/AbcSize
         return hash unless hash.is_a?(Hash)
 
         hash_copy = hash.dup
@@ -103,7 +103,7 @@ module Airbrake
       end
 
       def filter_url_params(url)
-        url.query = Hash[URI.decode_www_form(url.query)].map do |key, val|
+        url.query = URI.decode_www_form(url.query).to_h.map do |key, val|
           should_filter?(key) ? "#{key}=[Filtered]" : "#{key}=#{val}"
         end.join('&')
 

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

@@ -27,13 +27,13 @@ module Airbrake
         single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
         double_quotes: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
         dollar_quotes: /(\$(?!\d)[^$]*?\$).*?(?:\1|$)/,
-        uuids: /\{?(?:[0-9a-fA-F]\-*){32}\}?/,
+        uuids: /\{?(?:[0-9a-fA-F]-*){32}\}?/,
         numeric_literals: /\b-?(?:[0-9]+\.)?[0-9]+([eE][+-]?[0-9]+)?\b/,
         boolean_literals: /\b(?:true|false|null)\b/i,
         hexadecimal_literals: /0x[0-9a-fA-F]+/,
         comments: /(?:#|--).*?(?=\r|\n|$)/i,
         multi_line_comments: %r{/\*(?:[^/]|/[^*])*?(?:\*/|/\*.*)},
-        oracle_quoted_strings: /q'\[.*?(?:\]'|$)|q'\{.*?(?:\}'|$)|q'\<.*?(?:\>'|$)|q'\(.*?(?:\)'|$)/,
+        oracle_quoted_strings: /q'\[.*?(?:\]'|$)|q'\{.*?(?:\}'|$)|q'<.*?(?:>'|$)|q'\(.*?(?:\)'|$)/,
         # rubocop:enable Layout/LineLength
       }.freeze
 
@@ -108,20 +108,20 @@ module Airbrake
         @regexp = Regexp.union(features)
       end
 
-      # @param [Airbrake::Query] resource
-      def call(resource)
-        return unless resource.respond_to?(:query)
+      # @param [Airbrake::Query] metric
+      def call(metric)
+        return unless metric.respond_to?(:query)
 
-        query = resource.query
+        query = metric.query
         if IGNORED_QUERIES.any? { |q| q =~ query }
-          resource.ignore!
+          metric.ignore!
           return
         end
 
         q = query.gsub(@regexp, FILTERED)
         q.gsub!(POST_FILTER, FILTERED) if q =~ POST_FILTER
         q = ERROR_MSG if UNMATCHED_PAIR[@dialect] =~ q
-        resource.query = q
+        metric.query = q
       end
     end
   end

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

@@ -83,7 +83,7 @@ module Airbrake
         when Array
           value = value.map { |elem| sanitize_value(elem) }
         when Hash
-          Hash[value.map { |k, v| [k, sanitize_value(v)] }]
+          value.transform_values { |v| sanitize_value(v) }
         else
           value.to_s
         end

data/lib/airbrake-ruby/ignorable.rb

@@ -18,11 +18,9 @@ module Airbrake
     # Checks whether the instance was ignored.
     # @return [Boolean]
     # @see #ignore!
-    # rubocop:disable Style/DoubleNegation
     def ignored?
       !!ignored
     end
-    # rubocop:enable Style/DoubleNegation
 
     # Ignores an instance. Ignored instances must never reach the Airbrake
     # dashboard.

data/lib/airbrake-ruby/monotonic_time.rb

@@ -39,7 +39,7 @@ module Airbrake
 
         def time_in_nanoseconds
           time = Time.now
-          time.to_i * (10**9) + time.nsec
+          (time.to_i * (10**9)) + time.nsec
         end
 
       end

data/lib/airbrake-ruby/notice_notifier.rb

@@ -20,14 +20,13 @@ module Airbrake
 
     def initialize
       @config = Airbrake::Config.instance
-      @context = {}
       @filter_chain = FilterChain.new
-      @async_sender = AsyncSender.new
+      @async_sender = AsyncSender.new(:post, self.class.name)
       @sync_sender = SyncSender.new
 
       DEFAULT_FILTERS.each { |filter| add_filter(filter.new) }
 
-      add_filter(Airbrake::Filters::ContextFilter.new(@context))
+      add_filter(Airbrake::Filters::ContextFilter.new)
       add_filter(Airbrake::Filters::ExceptionAttributesFilter.new)
     end
 
@@ -79,7 +78,7 @@ module Airbrake
 
     # @see Airbrake.merge_context
     def merge_context(context)
-      @context.merge!(context)
+      Airbrake::Context.current.merge!(context)
     end
 
     # @return [Boolean]

data/lib/airbrake-ruby/performance_notifier.rb

@@ -1,6 +1,6 @@
 module Airbrake
-  # QueryNotifier aggregates information about SQL queries and periodically sends
-  # collected data to Airbrake.
+  # PerformanceNotifier aggregates performance data and periodically sends it to
+  # Airbrake.
   #
   # @api public
   # @since v3.2.0
@@ -12,7 +12,7 @@ module Airbrake
     def initialize
       @config = Airbrake::Config.instance
       @flush_period = Airbrake::Config.instance.performance_stats_flush_period
-      @async_sender = AsyncSender.new(:put)
+      @async_sender = AsyncSender.new(:put, self.class.name)
       @sync_sender = SyncSender.new(:put)
       @schedule_flush = nil
       @filter_chain = FilterChain.new
@@ -21,20 +21,20 @@ module Airbrake
       @has_payload = @payload.new_cond
     end
 
-    # @param [Hash] resource
+    # @param [Hash] metric
     # @see Airbrake.notify_query
     # @see Airbrake.notify_request
-    def notify(resource)
+    def notify(metric)
       @payload.synchronize do
-        send_resource(resource, sync: false)
+        send_metric(metric, sync: false)
       end
     end
 
-    # @param [Hash] resource
+    # @param [Hash] metric
     # @since v4.10.0
     # @see Airbrake.notify_queue_sync
-    def notify_sync(resource)
-      send_resource(resource, sync: true).value
+    def notify_sync(metric)
+      send_metric(metric, sync: true).value
     end
 
     # @see Airbrake.add_performance_filter
@@ -51,7 +51,6 @@ module Airbrake
       @payload.synchronize do
         @schedule_flush.kill if @schedule_flush
         @async_sender.close
-        logger.debug("#{LOG_LABEL} performance notifier closed")
       end
     end
 
@@ -79,16 +78,16 @@ module Airbrake
       end
     end
 
-    def send_resource(resource, sync:)
-      promise = check_configuration(resource)
+    def send_metric(metric, sync:)
+      promise = check_configuration(metric)
       return promise if promise.rejected?
 
-      @filter_chain.refine(resource)
-      if resource.ignored?
-        return Promise.new.reject("#{resource.class} was ignored by a filter")
+      @filter_chain.refine(metric)
+      if metric.ignored?
+        return Promise.new.reject("#{metric.class} was ignored by a filter")
       end
 
-      update_payload(resource)
+      update_payload(metric)
       if sync || @flush_period == 0
         send(@sync_sender, @payload, promise)
       else
@@ -97,29 +96,29 @@ module Airbrake
       end
     end
 
-    def update_payload(resource)
-      if (total_stat = @payload[resource])
-        @payload.key(total_stat).merge(resource)
+    def update_payload(metric)
+      if (total_stat = @payload[metric])
+        @payload.key(total_stat).merge(metric)
       else
-        @payload[resource] = { total: Airbrake::Stat.new }
+        @payload[metric] = { total: Airbrake::Stat.new }
       end
 
-      @payload[resource][:total].increment_ms(resource.timing)
+      @payload[metric][:total].increment_ms(metric.timing)
 
-      resource.groups.each do |name, ms|
-        @payload[resource][name] ||= Airbrake::Stat.new
-        @payload[resource][name].increment_ms(ms)
+      metric.groups.each do |name, ms|
+        @payload[metric][name] ||= Airbrake::Stat.new
+        @payload[metric][name].increment_ms(ms)
       end
     end
 
-    def check_configuration(resource)
+    def check_configuration(metric)
       promise = @config.check_configuration
       return promise if promise.rejected?
 
-      promise = @config.check_performance_options(resource)
+      promise = @config.check_performance_options(metric)
       return promise if promise.rejected?
 
-      if resource.timing && resource.timing == 0
+      if metric.timing && metric.timing == 0
         return Promise.new.reject(':timing cannot be zero')
       end
 
@@ -129,47 +128,47 @@ module Airbrake
     def send(sender, payload, promise)
       raise "payload cannot be empty. Race?" if payload.none?
 
-      with_grouped_payload(payload) do |resource_hash, destination|
+      with_grouped_payload(payload) do |metric_hash, destination|
         url = URI.join(
           @config.apm_host,
           "api/v5/projects/#{@config.project_id}/#{destination}",
         )
 
         logger.debug do
-          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{resource_hash}"
+          "#{LOG_LABEL} #{self.class.name}##{__method__}: #{metric_hash}"
         end
-        sender.send(resource_hash, promise, url)
+        sender.send(metric_hash, promise, url)
       end
 
       promise
     end
 
     def with_grouped_payload(raw_payload)
-      grouped_payload = raw_payload.group_by do |resource, _stats|
-        [resource.cargo, resource.destination]
+      grouped_payload = raw_payload.group_by do |metric, _stats|
+        [metric.cargo, metric.destination]
       end
 
-      grouped_payload.each do |(cargo, destination), resources|
+      grouped_payload.each do |(cargo, destination), metrics|
         payload = {}
-        payload[cargo] = serialize_resources(resources)
+        payload[cargo] = serialize_metrics(metrics)
         payload['environment'] = @config.environment if @config.environment
 
         yield(payload, destination)
       end
     end
 
-    def serialize_resources(resources)
-      resources.map do |resource, stats|
-        resource_hash = resource.to_h.merge!(stats[:total].to_h)
+    def serialize_metrics(metrics)
+      metrics.map do |metric, stats|
+        metric_hash = metric.to_h.merge!(stats[:total].to_h)
 
-        if resource.groups.any?
+        if metric.groups.any?
           group_stats = stats.reject { |name, _stat| name == :total }
-          resource_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
+          metric_hash['groups'] = group_stats.merge(group_stats) do |_name, stat|
             stat.to_h
           end
         end
 
-        resource_hash
+        metric_hash
       end
     end
   end

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

@@ -59,7 +59,7 @@ module Airbrake
       # @return [String] where the config is stored on S3.
       def config_route(remote_config_host)
         if @data['config_route'] && !@data['config_route'].empty?
-          return remote_config_host.chomp('/') + '/' + @data['config_route']
+          return "#{remote_config_host.chomp('/')}/#{@data['config_route']}"
         end
 
         format(

data/lib/airbrake-ruby/remote_settings.rb

@@ -1,7 +1,7 @@
 module Airbrake
   # RemoteSettings polls the remote config of the passed project at fixed
   # intervals. The fetched config is yielded as a callback parameter so that the
-  # invoker can define read config values.
+  # invoker can define read config values. Supports proxies.
   #
   # @example Disable/enable error notifications based on the remote value
   #   RemoteSettings.poll do |data|
@@ -43,6 +43,7 @@ module Airbrake
       @data = SettingsData.new(project_id, {})
       @host = host
       @block = block
+      @config = Airbrake::Config.instance
       @poll = nil
     end
 
@@ -72,11 +73,16 @@ module Airbrake
     private
 
     def fetch_config
+      uri = build_config_uri
+      https = build_https(uri)
+      req = Net::HTTP::Get.new(uri.request_uri)
       response = nil
+
       begin
-        response = Net::HTTP.get_response(build_config_uri)
+        response = https.request(req)
       rescue StandardError => ex
-        logger.error(ex)
+        reason = "#{LOG_LABEL} HTTP error: #{ex}"
+        logger.error(reason)
         return {}
       end
 
@@ -101,5 +107,22 @@ module Airbrake
       uri.query = QUERY_PARAMS
       uri
     end
+
+    def build_https(uri)
+      Net::HTTP.new(uri.host, uri.port, *proxy_params).tap do |https|
+        https.use_ssl = uri.is_a?(URI::HTTPS)
+        if @config.timeout
+          https.open_timeout = @config.timeout
+          https.read_timeout = @config.timeout
+        end
+      end
+    end
+
+    def proxy_params
+      return unless @config.proxy.key?(:host)
+
+      [@config.proxy[:host], @config.proxy[:port], @config.proxy[:user],
+       @config.proxy[:password]]
+    end
   end
 end

data/lib/airbrake-ruby/stat.rb

@@ -4,7 +4,7 @@ module Airbrake
   # Stat is a data structure that allows accumulating performance data (route
   # performance, SQL query performance and such). It's powered by TDigests.
   #
-  # Usually, one Stat corresponds to one resource (route or query,
+  # Usually, one Stat corresponds to one metric (route or query,
   # etc.). Incrementing a stat means pushing new performance statistics.
   #
   # @example

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?
@@ -255,7 +256,7 @@ module Airbrake
         array = bytes[start_idx..-1].unpack("G#{size}N#{size}")
         means, counts = array.each_slice(size).to_a if array.any?
       when SMALL_ENCODING
-        means = bytes[start_idx..(start_idx + 4 * size)].unpack("g#{size}")
+        means = bytes[start_idx..(start_idx + (4 * size))].unpack("g#{size}")
         # Decode delta encoding of means
         x = 0
         means.map! do |m|
@@ -263,7 +264,7 @@ module Airbrake
           x = m
           m
         end
-        counts_bytes = bytes[(start_idx + 4 * size)..-1].unpack('C*')
+        counts_bytes = bytes[(start_idx + (4 * size))..-1].unpack('C*')
         counts = []
         # Decode variable length integer bytes
         size.times do
@@ -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
@@ -326,7 +327,7 @@ module Airbrake
 
       cumn = 0
       @centroids.each_value do |c|
-        c.mean_cumn = cumn + c.n / 2.0
+        c.mean_cumn = cumn + (c.n / 2.0)
         cumn = c.cumn = cumn + c.n
       end
       @size = @last_cumulate = cumn
@@ -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.