airbrake-ruby 5.0.1 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773b982037081f5d6dfb045378a35b2854a251d9e238cd58dd0b1216c75e86c5
-  data.tar.gz: a7177673edea3b8f05055683972b918bf43255ad68fc21688317ec5ed56dbb7b
+  metadata.gz: 6a073eaf249f96805546ce1d9cc45f45ca3a3a09c36bb2c5cbe8b4f145c03fca
+  data.tar.gz: 714f8424b206e2842237c5417833118d2960e1eb0a1c4ff7d16ad75467b9bfc1
 SHA512:
-  metadata.gz: 6e377bdd85f7aa912cc9341834f9413ec5a89b71bbe2acf561118be97a911baef6c7cc210fa2430e286d135ce829ca7009110180c5938ac7017a403d7be239de
-  data.tar.gz: b9e6812ed5d2734c7fd3ffd83b14e5d366594366c5460244e43d13375ede211c56d4e1a3b4c79b613de0d480493d9950a833670bb2f59161f1d0db051936b0a1
+  metadata.gz: 605bcaf8e438ae77a781d2ae6bc03b4525003e5faa0572cb007aa4f6ae07413518b77eea1cbf947599f1151eff27e35a1ee47e9864c83768ee409795d748f116
+  data.tar.gz: af89bef16ed1f0f64b1e65484d680cdd5204905d5981c7a1310d19c9d875cf4ce702b06d51b4c508985b5e1cc7d0a87b33c7cc8a002d673bad11dffa4fc0f248

data/lib/airbrake-ruby.rb

@@ -13,6 +13,7 @@ require 'airbrake-ruby/grouppable'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
 require 'airbrake-ruby/config/processor'
+require 'airbrake-ruby/remote_settings/callback'
 require 'airbrake-ruby/remote_settings/settings_data'
 require 'airbrake-ruby/remote_settings'
 require 'airbrake-ruby/promise'
@@ -57,6 +58,7 @@ require 'airbrake-ruby/benchmark'
 require 'airbrake-ruby/monotonic_time'
 require 'airbrake-ruby/timed_trace'
 require 'airbrake-ruby/queue'
+require 'airbrake-ruby/context'
 
 # Airbrake is a thin wrapper around instances of the notifier classes (such as
 # notice, performance & deploy notifiers). It creates a way to access them via a
@@ -272,7 +274,7 @@ module Airbrake
     #   Airbrake.notify('App crashed!') #=> raises Airbrake::Error
     #
     # @return [nil]
-    # rubocop:disable Style/IfUnlessModifier, Metrics/CyclomaticComplexity
+    # rubocop:disable Style/IfUnlessModifier
     def close
       if defined?(@notice_notifier) && @notice_notifier
         @notice_notifier.close
@@ -288,7 +290,7 @@ module Airbrake
 
       nil
     end
-    # rubocop:enable Style/IfUnlessModifier, Metrics/CyclomaticComplexity
+    # rubocop:enable Style/IfUnlessModifier
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy.
     #

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

@@ -121,13 +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")
+    # @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
@@ -140,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
@@ -151,7 +159,7 @@ module Airbrake
       self.project_key = user_config[:project_key]
       self.error_host = 'https://api.airbrake.io'
       self.apm_host = 'https://api.airbrake.io'
-      self.remote_config_host = 'https://v1-production-notifier-configs.s3.amazonaws.com'
+      self.remote_config_host = 'https://notifier-configs.airbrake.io'
 
       self.ignore_environments = []
 
@@ -171,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/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
@@ -18,6 +18,7 @@ module Airbrake
         @blocklist_keys = @config.blocklist_keys
         @allowlist_keys = @config.allowlist_keys
         @project_id = @config.project_id
+        @poll_callback = Airbrake::RemoteSettings::Callback.new(config)
       end
 
       # @param [Airbrake::NoticeNotifier] notifier
@@ -40,13 +41,13 @@ module Airbrake
 
       # @return [Airbrake::RemoteSettings]
       def process_remote_configuration
+        return unless @config.remote_config
         return unless @project_id
+        return if @config.environment == 'test'
 
-        RemoteSettings.poll(
-          @project_id,
-          @config.remote_config_host,
-          &method(:poll_callback)
-        )
+        RemoteSettings.poll(@project_id, @config.remote_config_host) do |data|
+          @poll_callback.call(data)
+        end
       end
 
       # @param [Airbrake::NoticeNotifier] notifier
@@ -65,20 +66,6 @@ module Airbrake
           notifier.add_filter(filter.new(@config.root_directory))
         end
       end
-
-      # @param [Airbrake::RemoteSettings::SettingsData] data
-      # @return [void]
-      def poll_callback(data)
-        @config.logger.debug(
-          "#{LOG_LABEL} applying remote settings: #{data.to_h}",
-        )
-
-        @config.error_host = data.error_host if data.error_host
-        @config.apm_host = data.apm_host if data.apm_host
-
-        @config.error_notifications = data.error_notifications?
-        @config.performance_stats = data.performance_stats?
-      end
     end
   end
 end

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}",

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

@@ -8,22 +8,11 @@ module Airbrake
   #     config.error_notifications = data.error_notifications?
   #   end
   #
-  # When {#poll} is called, it will try to load remote settings from disk, so
-  # that it doesn't wait on the result from the API call.
-  #
-  # When {#stop_polling} is called, the current config will be dumped to disk.
-  #
-  # @since 5.0.0
+  # @since v5.0.0
   # @api private
   class RemoteSettings
     include Airbrake::Loggable
 
-    # @return [String] the path to the persistent config
-    CONFIG_DUMP_PATH = File.join(
-      File.expand_path(__dir__),
-      '../../config/config.json',
-    ).freeze
-
     # @return [Hash{Symbol=>String}] metadata to be attached to every GET
     #   request
     QUERY_PARAMS = URI.encode_www_form(
@@ -33,6 +22,9 @@ module Airbrake
       language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
     ).freeze
 
+    # @return [String]
+    HTTP_OK = '200'.freeze
+
     # Polls remote config of the given project.
     #
     # @param [Integer] project_id
@@ -54,18 +46,11 @@ module Airbrake
       @poll = nil
     end
 
-    # Polls remote config of the given project in background. Loads local config
-    # first (if exists).
+    # Polls remote config of the given project in background.
     #
     # @return [self]
     def poll
       @poll ||= Thread.new do
-        begin
-          load_config
-        rescue StandardError => ex
-          logger.error("#{LOG_LABEL} config loading failed: #{ex}")
-        end
-
         @block.call(@data)
 
         loop do
@@ -77,17 +62,11 @@ module Airbrake
       self
     end
 
-    # Stops the background poller thread. Dumps current config to disk.
+    # Stops the background poller thread.
     #
     # @return [void]
     def stop_polling
       @poll.kill if @poll
-
-      begin
-        dump_config
-      rescue StandardError => ex
-        logger.error("#{LOG_LABEL} config dumping failed: #{ex}")
-      end
     end
 
     private
@@ -95,22 +74,20 @@ module Airbrake
     def fetch_config
       response = nil
       begin
-        response = Net::HTTP.get(build_config_uri)
+        response = Net::HTTP.get_response(build_config_uri)
       rescue StandardError => ex
         logger.error(ex)
         return {}
       end
 
-      # AWS S3 API returns XML when request is not valid. In this case we just
-      # print the returned body and exit the method.
-      if response.start_with?('<?xml ')
-        logger.error(response)
+      unless response.code == HTTP_OK
+        logger.error(response.body)
         return {}
       end
 
       json = nil
       begin
-        json = JSON.parse(response)
+        json = JSON.parse(response.body)
       rescue JSON::ParserError => ex
         logger.error(ex)
         return {}
@@ -124,22 +101,5 @@ module Airbrake
       uri.query = QUERY_PARAMS
       uri
     end
-
-    def load_config
-      config_dir = File.dirname(CONFIG_DUMP_PATH)
-      Dir.mkdir(config_dir) unless File.directory?(config_dir)
-
-      return unless File.exist?(CONFIG_DUMP_PATH)
-
-      config = File.read(CONFIG_DUMP_PATH)
-      @data.merge!(JSON.parse(config))
-    end
-
-    def dump_config
-      config_dir = File.dirname(CONFIG_DUMP_PATH)
-      Dir.mkdir(config_dir) unless File.directory?(config_dir)
-
-      File.write(CONFIG_DUMP_PATH, JSON.dump(@data.to_h))
-    end
   end
 end