airbrake-ruby 5.1.1 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9438fdfe9308d48989fc04e1f9873c4cab46f7c22487ae1bd3d22e917d73f60
-  data.tar.gz: '08e6b8f6af0fd1ff980e642d9ce540c6c407844d34249bb921b9a15cd5f74ad7'
+  metadata.gz: f89d6e09b27f36f4d4450eeb9dd6fb9dff228ffe095769f8b9bcc24a02413842
+  data.tar.gz: a2b4daefe2139f002a42754b6df05c6c11dca9d80b0ecf440cd0620336a2d87e
 SHA512:
-  metadata.gz: e6e892017febffa214ab8ea921fa8c09b1a27e6c2b0874d669e0dd64004b21fa27bd13ea65b750505e9c702c7248314e8d77ca6b57cb1ec4332c9157712d866d
-  data.tar.gz: c1ebc53b428eca54eb4c85e4fc094819c9c2972308b97069c6234502159d57c2b5977203fb8a60dd3865e7f8dca2f0430dd0f1500ef2df89f8f059a881433740
+  metadata.gz: 423f95e5781de19de642d880106b38feca43c98f9223956e4208b616929d6a63c56e1ca223d449115f232e60f0a84f9f0c52c140df708d2deaf20aa2dfca4a3e
+  data.tar.gz: e09266840dd038be725ad564d6db02696e5c6a0f188eae5206da30cbd2cf454eccbe56cbcf027b454821e6ef1bee29cb8fb2db7c7c61f81ffa6e0ecb1566c133

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/processor.rb

@@ -3,7 +3,7 @@ module Airbrake
     # Processor is a helper class, which is responsible for setting default
     # config values, default notifier filters and remote configuration changes.
     #
-    # @since 5.0.0
+    # @since v5.0.0
     # @api private
     class Processor
       # @param [Airbrake::Config] config
@@ -41,6 +41,7 @@ module Airbrake
 
       # @return [Airbrake::RemoteSettings]
       def process_remote_configuration
+        return unless @config.remote_config
         return unless @project_id
         return if @config.environment == 'test'
 

data/lib/airbrake-ruby/config.rb

@@ -121,15 +121,21 @@ module Airbrake
     # @return [Boolean] true if the library should send error reports to
     #   Airbrake, false otherwise
     # @api public
-    # @since 5.0.0
+    # @since v5.0.0
     attr_accessor :error_notifications
 
-    # @return [String] the host such as which should be used for fetching remote
-    #   configuration options (example: "https://bucket-name.s3.amazonaws.com")
-    # @api private
-    # @since 5.0.0
+    # @return [String] the host which should be used for fetching remote
+    #   configuration options
+    # @api public
+    # @since v5.0.0
     attr_accessor :remote_config_host
 
+    # @return [String] true if notifier should periodically fetch remote
+    #   configuration, false otherwise
+    # @api public
+    # @since v5.2.0
+    attr_accessor :remote_config
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -142,7 +148,7 @@ module Airbrake
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def initialize(user_config = {})
       self.proxy = {}
       self.queue_size = 100
@@ -173,10 +179,11 @@ module Airbrake
       self.query_stats = true
       self.job_stats = true
       self.error_notifications = true
+      self.remote_config = true
 
       merge(user_config)
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # The full URL to the Airbrake Notice API. Based on the +:error_host+ option.
     # @return [URI] the endpoint address

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/file_cache.rb

@@ -40,7 +40,7 @@ module Airbrake
       data.empty?
     end
 
-    # @since 4.7.0
+    # @since v4.7.0
     # @return [void]
     def self.reset
       @data = {}

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
 

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

@@ -41,8 +41,7 @@ module Airbrake
           thread_info[:fiber_variables] = vars
         end
 
-        # Present in Ruby 2.3+.
-        if th.respond_to?(:name) && (name = th.name)
+        if (name = th.name)
           thread_info[:name] = name
         end
 
@@ -84,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/grouppable.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Grouppable adds the `#groups` method, so that we don't need to define it in
   # all of performance models every time we add a model without groups.
   #
-  # @since 4.9.0
+  # @since v4.9.0
   # @api private
   module Grouppable
     def groups

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/mergeable.rb

@@ -2,7 +2,7 @@ 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
+  # @since v4.9.0
   # @api private
   module Mergeable
     def merge(_other)

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

@@ -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
@@ -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
 

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

@@ -4,7 +4,7 @@ module Airbrake
     # updates the local config according to the data.
     #
     # @api private
-    # @since 5.0.2
+    # @since v5.0.2
     class Callback
       def initialize(config)
         @config = config

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

@@ -11,7 +11,7 @@ module Airbrake
     #
     #   settings_data.interval #=> 600
     #
-    # @since 5.0.0
+    # @since v5.0.0
     # @api private
     class SettingsData
       # @return [Integer] how frequently we should poll the config API
@@ -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,14 +1,14 @@
 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|
   #     config.error_notifications = data.error_notifications?
   #   end
   #
-  # @since 5.0.0
+  # @since v5.0.0
   # @api private
   class RemoteSettings
     include Airbrake::Loggable
@@ -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/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.

data/lib/airbrake-ruby/thread_pool.rb

@@ -6,6 +6,7 @@ module Airbrake
   #   # Initialize a new thread pool with 5 workers and a queue size of 100. Set
   #   # the block to be run concurrently.
   #   thread_pool = ThreadPool.new(
+  #     name: 'performance-notifier',
   #     worker_size: 5,
   #     queue_size: 100,
   #     block: proc { |message| print "ECHO: #{message}..."}
@@ -24,7 +25,8 @@ module Airbrake
     # @note This is exposed for eaiser unit testing
     attr_reader :workers
 
-    def initialize(worker_size:, queue_size:, block:)
+    def initialize(worker_size:, queue_size:, block:, name: nil)
+      @name = name
       @worker_size = worker_size
       @queue_size = queue_size
       @block = block
@@ -46,11 +48,11 @@ module Airbrake
     #   false if the queue is full
     def <<(message)
       if backlog >= @queue_size
-        logger.error(
+        logger.info do
           "#{LOG_LABEL} ThreadPool has reached its capacity of " \
           "#{@queue_size} and the following message will not be " \
-          "processed: #{message.inspect}",
-        )
+          "processed: #{message.inspect}"
+        end
         return false
       end
 
@@ -102,7 +104,7 @@ module Airbrake
 
         unless @queue.empty?
           msg = "#{LOG_LABEL} waiting to process #{@queue.size} task(s)..."
-          logger.debug(msg + ' (Ctrl-C to abort)')
+          logger.debug("#{msg} (Ctrl-C to abort)")
         end
 
         @worker_size.times { @queue << :stop }
@@ -111,7 +113,7 @@ module Airbrake
       end
 
       threads.each(&:join)
-      logger.debug("#{LOG_LABEL} thread pool closed")
+      logger.debug("#{LOG_LABEL} #{@name} thread pool closed")
     end
 
     def closed?

data/lib/airbrake-ruby/timed_trace.rb

@@ -50,9 +50,7 @@ module Airbrake
 
     # @return [Hash<String=>Float>]
     def spans
-      @spans.each_with_object({}) do |(label, benchmark), new_spans|
-        new_spans[label] = benchmark.duration
-      end
+      @spans.transform_values(&:duration)
     end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -3,10 +3,10 @@
 module Airbrake
   # @return [String] the library version
   # @api public
-  AIRBRAKE_RUBY_VERSION = '5.1.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '6.0.1'.freeze
 
   # @return [Hash{Symbol=>String}] the information about the notifier library
-  # @since 5.0.0
+  # @since v5.0.0
   # @api public
   NOTIFIER_INFO = {
     name: 'airbrake-ruby'.freeze,