airbrake-ruby 4.13.3-java → 5.0.0-java

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

@@ -18,6 +18,7 @@ module Airbrake
       # @macro call_filter
       def call(notice)
         return if notice[:context].key?(:repository)
+
         attach_repository(notice)
       end
 
@@ -39,6 +40,7 @@ module Airbrake
           end
 
         return unless @repository
+
         notice[:context][:repository] = @repository
       end
 
@@ -46,6 +48,7 @@ module Airbrake
 
       def detect_git_version
         return unless which('git')
+
         Gem::Version.new(`git --version`.split[2])
       end
 

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

@@ -30,6 +30,7 @@ module Airbrake
 
         @revision = find_revision
         return unless @revision
+
         notice[:context][:revision] = @revision
       end
 
@@ -41,6 +42,7 @@ module Airbrake
 
         head = File.read(head_path)
         return head unless head.start_with?(PREFIX)
+
         head = head.chomp[PREFIX.size..-1]
 
         ref_path = File.join(@git_path, head)

data/lib/airbrake-ruby/filters/{keys_whitelist.rb → keys_allowlist.rb}

@@ -4,7 +4,7 @@ module Airbrake
     # notice, but specified keys.
     #
     # @example
-    #   filter = Airbrake::Filters::KeysBlacklist.new(
+    #   filter = Airbrake::Filters::KeysAllowlist.new(
     #     [:email, /credit/i, 'password']
     #   )
     #   airbrake.add_filter(filter)
@@ -22,9 +22,9 @@ module Airbrake
     #   #     email: 'john@example.com',
     #   #     account_id: 42 }
     #
-    # @see KeysBlacklist
+    # @see KeysBlocklist
     # @see KeysFilter
-    class KeysWhitelist
+    class KeysAllowlist
       include KeysFilter
 
       def initialize(*)

data/lib/airbrake-ruby/filters/{keys_blacklist.rb → keys_blocklist.rb}

@@ -4,7 +4,7 @@ module Airbrake
     # list of parameters in the payload of a notice.
     #
     # @example
-    #   filter = Airbrake::Filters::KeysBlacklist.new(
+    #   filter = Airbrake::Filters::KeysBlocklist.new(
     #     [:email, /credit/i, 'password']
     #   )
     #   airbrake.add_filter(filter)
@@ -22,10 +22,10 @@ module Airbrake
     #   #     email: '[Filtered]',
     #   #     credit_card: '[Filtered]' }
     #
-    # @see KeysWhitelist
+    # @see KeysAllowlist
     # @see KeysFilter
     # @api private
-    class KeysBlacklist
+    class KeysBlocklist
       include KeysFilter
 
       def initialize(*)

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

@@ -7,8 +7,8 @@ module Airbrake
     # class that includes this module must implement.
     #
     # @see Notice
-    # @see KeysWhitelist
-    # @see KeysBlacklist
+    # @see KeysAllowlist
+    # @see KeysBlocklist
     # @api private
     module KeysFilter
       # @return [String] The label to replace real values of filtered payload
@@ -19,11 +19,11 @@ module Airbrake
       VALID_PATTERN_CLASSES = [String, Symbol, Regexp].freeze
 
       # @return [Array<Symbol>] parts of a Notice's payload that can be modified
-      #   by blacklist/whitelist filters
+      #   by blocklist/allowlist filters
       FILTERABLE_KEYS = %i[environment session params].freeze
 
       # @return [Array<Symbol>] parts of a Notice's *context* payload that can
-      #   be modified by blacklist/whitelist filters
+      #   be modified by blocklist/allowlist filters
       FILTERABLE_CONTEXT_KEYS = %i[
         user
 
@@ -42,7 +42,7 @@ module Airbrake
       # @return [Integer]
       attr_reader :weight
 
-      # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
+      # Creates a new KeysBlocklist or KeysAllowlist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
       # @param [Array<String,Regexp,Symbol>] patterns
@@ -64,10 +64,14 @@ module Airbrake
           validate_patterns
         end
 
-        FILTERABLE_KEYS.each { |key| filter_hash(notice[key]) }
+        FILTERABLE_KEYS.each do |key|
+          notice[key] = filter_hash(notice[key])
+        end
+
         FILTERABLE_CONTEXT_KEYS.each { |key| filter_context_key(notice, key) }
 
         return unless notice[:context][:url]
+
         filter_url(notice)
       end
 
@@ -81,26 +85,26 @@ module Airbrake
       def filter_hash(hash)
         return hash unless hash.is_a?(Hash)
 
+        hash_copy = hash.dup
+
         hash.each_key do |key|
           if should_filter?(key.to_s)
-            hash[key] = FILTERED
-          elsif hash[key].is_a?(Hash)
-            filter_hash(hash[key])
+            hash_copy[key] = FILTERED
+          elsif hash_copy[key].is_a?(Hash)
+            hash_copy[key] = filter_hash(hash_copy[key])
           elsif hash[key].is_a?(Array)
-            hash[key].each { |h| filter_hash(h) }
+            hash_copy[key].each_with_index do |h, i|
+              hash_copy[key][i] = filter_hash(h)
+            end
           end
         end
+
+        hash_copy
       end
 
       def filter_url_params(url)
         url.query = Hash[URI.decode_www_form(url.query)].map do |key, val|
-          # Ruby < 2.2 raises InvalidComponentError if the query contains
-          # invalid characters, so be sure to escape individual components.
-          if should_filter?(key)
-            "#{URI.encode_www_form_component(key)}=[Filtered]"
-          else
-            "#{URI.encode_www_form_component(key)}=#{URI.encode_www_form_component(val)}"
-          end
+          should_filter?(key) ? "#{key}=[Filtered]" : "#{key}=#{val}"
         end.join('&')
 
         url.to_s
@@ -114,6 +118,7 @@ module Airbrake
         end
 
         return unless url.query
+
         notice[:context][:url] = filter_url_params(url)
       end
 
@@ -122,6 +127,7 @@ module Airbrake
 
         @patterns = @patterns.flat_map do |pattern|
           next(pattern) unless pattern.respond_to?(:call)
+
           pattern.call
         end
       end
@@ -142,7 +148,9 @@ module Airbrake
       def filter_context_key(notice, key)
         return unless notice[:context][key]
         return if notice[:context][key] == FILTERED
-        return filter_hash(notice[:context][key]) unless should_filter?(key)
+        unless should_filter?(key)
+          return notice[:context][key] = filter_hash(notice[:context][key])
+        end
 
         notice[:context][key] = FILTERED
       end

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

@@ -19,6 +19,7 @@ module Airbrake
         notice[:errors].each do |error|
           error[:backtrace].each do |frame|
             next unless (file = frame[:file])
+
             file.sub!(/\A#{@root_directory}/, PROJECT_ROOT_LABEL)
           end
         end

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

@@ -23,7 +23,7 @@ module Airbrake
 
       # @return [Hash{Symbol=>Regexp}] matchers for certain features of SQL
       ALL_FEATURES = {
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
         double_quotes: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
         dollar_quotes: /(\$(?!\d)[^$]*?\$).*?(?:\1|$)/,
@@ -33,13 +33,13 @@ module Airbrake
         hexadecimal_literals: /0x[0-9a-fA-F]+/,
         comments: /(?:#|--).*?(?=\r|\n|$)/i,
         multi_line_comments: %r{/\*(?:[^/]|/[^*])*?(?:\*/|/\*.*)},
-        oracle_quoted_strings: /q'\[.*?(?:\]'|$)|q'\{.*?(?:\}'|$)|q'\<.*?(?:\>'|$)|q'\(.*?(?:\)'|$)/
-        # rubocop:enable Metrics/LineLength
+        oracle_quoted_strings: /q'\[.*?(?:\]'|$)|q'\{.*?(?:\}'|$)|q'\<.*?(?:\>'|$)|q'\(.*?(?:\)'|$)/,
+        # rubocop:enable Layout/LineLength
       }.freeze
 
       # @return [Regexp] the regexp that is applied after the feature regexps
       #   were used
-      POST_FILTER = /(?<=[values|in ]\().+(?=\))/i
+      POST_FILTER = /(?<=[values|in ]\().+(?=\))/i.freeze
 
       # @return [Hash{Symbol=>Array<Symbol>}] a set of features that corresponds
       #   to a certain dialect

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

@@ -16,6 +16,7 @@ module Airbrake
       # @macro call_filter
       def call(notice)
         return if notice[:errors].none? { |error| error[:type] == SYSTEM_EXIT_TYPE }
+
         notice.ignore!
       end
     end

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

@@ -56,6 +56,7 @@ module Airbrake
       def thread_variables(th)
         th.thread_variables.map.with_object({}) do |var, h|
           next if var.to_s.start_with?(IGNORE_PREFIX)
+
           h[var] = sanitize_value(th.thread_variable_get(var))
         end
       end
@@ -63,6 +64,7 @@ module Airbrake
       def fiber_variables(th)
         th.keys.map.with_object({}) do |key, h|
           next if key.to_s.start_with?(IGNORE_PREFIX)
+
           h[key] = sanitize_value(th[key])
         end
       end

data/lib/airbrake-ruby/ignorable.rb

@@ -38,6 +38,7 @@ module Airbrake
     # @raise [Airbrake::Error] when instance is ignored
     def raise_if_ignored
       return unless ignored?
+
       raise Airbrake::Error, "cannot access ignored #{self.class}"
     end
   end

data/lib/airbrake-ruby/notice.rb

@@ -4,19 +4,12 @@ module Airbrake
   #
   # @since v1.0.0
   class Notice
-    # @return [Hash{Symbol=>String}] the information about the notifier library
-    NOTIFIER = {
-      name: 'airbrake-ruby'.freeze,
-      version: Airbrake::AIRBRAKE_RUBY_VERSION,
-      url: 'https://github.com/airbrake/airbrake-ruby'.freeze,
-    }.freeze
-
     # @return [Hash{Symbol=>String,Hash}] the information to be displayed in the
     #   Context tab in the dashboard
     CONTEXT = {
       os: RUBY_PLATFORM,
       language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
-      notifier: NOTIFIER,
+      notifier: Airbrake::NOTIFIER_INFO,
     }.freeze
 
     # @return [Integer] the maxium size of the JSON payload in bytes

data/lib/airbrake-ruby/notice_notifier.rb

@@ -82,6 +82,12 @@ module Airbrake
       @context.merge!(context)
     end
 
+    # @return [Boolean]
+    # @since v4.14.0
+    def has_filter?(filter_class) # rubocop:disable Naming/PredicateName
+      @filter_chain.includes?(filter_class)
+    end
+
     private
 
     def convert_to_exception(ex)
@@ -129,6 +135,7 @@ module Airbrake
       # If true, then it's likely an internal library error. In this case return
       # at least some backtrace to simplify debugging.
       return caller_copy if clean_bt.empty?
+
       clean_bt
     end
   end

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -12,16 +12,13 @@ module Airbrake
     include Stashable
     include Mergeable
 
-    attr_accessor :method, :route, :response_type, :groups, :start_time,
-                  :end_time, :timing, :time
+    attr_accessor :method, :route, :response_type, :groups, :timing, :time
 
     def initialize(
       method:,
       route:,
       response_type:,
       groups:,
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -30,8 +27,6 @@ module Airbrake
       @route = route
       @response_type = response_type
       @groups = groups
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -104,7 +104,7 @@ module Airbrake
         @payload[resource] = { total: Airbrake::Stat.new }
       end
 
-      update_total(resource, @payload[resource][:total])
+      @payload[resource][:total].increment_ms(resource.timing)
 
       resource.groups.each do |name, ms|
         @payload[resource][name] ||= Airbrake::Stat.new
@@ -112,19 +112,6 @@ 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 check_configuration(resource)
       promise = @config.check_configuration
       return promise if promise.rejected?
@@ -144,7 +131,7 @@ module Airbrake
 
       with_grouped_payload(payload) do |resource_hash, destination|
         url = URI.join(
-          @config.host,
+          @config.apm_host,
           "api/v5/projects/#{@config.project_id}/#{destination}",
         )
 

data/lib/airbrake-ruby/promise.rb

@@ -103,6 +103,7 @@ module Airbrake
     #   needed for compatibility but it shouldn't exist in the future
     def value
       return @value['ok'] if resolved?
+
       @value
     end
   end

data/lib/airbrake-ruby/query.rb

@@ -12,8 +12,7 @@ module Airbrake
     include Mergeable
     include Grouppable
 
-    attr_accessor :method, :route, :query, :func, :file, :line, :start_time,
-                  :end_time, :timing, :time
+    attr_accessor :method, :route, :query, :func, :file, :line, :timing, :time
 
     def initialize(
       method:,
@@ -22,8 +21,6 @@ module Airbrake
       func: nil,
       file: nil,
       line: nil,
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -34,8 +31,6 @@ module Airbrake
       @func = func
       @file = file
       @line = line
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end

data/lib/airbrake-ruby/queue.rb

@@ -4,21 +4,17 @@ module Airbrake
   # @see Airbrake.notify_queue
   # @api public
   # @since v4.9.0
-  # rubocop:disable Metrics/ParameterLists
   class Queue
     include HashKeyable
     include Ignorable
     include Stashable
 
-    attr_accessor :queue, :error_count, :groups, :start_time, :end_time,
-                  :timing, :time
+    attr_accessor :queue, :error_count, :groups, :timing, :time
 
     def initialize(
       queue:,
       error_count:,
       groups: {},
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -26,8 +22,6 @@ module Airbrake
       @queue = queue
       @error_count = error_count
       @groups = groups
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end
@@ -68,5 +62,4 @@ module Airbrake
       ''
     end
   end
-  # rubocop:enable Metrics/ParameterLists
 end

data/lib/airbrake-ruby/remote_settings.rb

@@ -0,0 +1,145 @@
+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.
+  #
+  # @example Disable/enable error notifications based on the remote value
+  #   RemoteSettings.poll do |data|
+  #     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
+  # @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(
+      notifier_name: Airbrake::NOTIFIER_INFO[:name],
+      notifier_version: Airbrake::NOTIFIER_INFO[:version],
+      os: RUBY_PLATFORM,
+      language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
+    ).freeze
+
+    # Polls remote config of the given project.
+    #
+    # @param [Integer] project_id
+    # @param [String] host
+    # @yield [data]
+    # @yieldparam data [Airbrake::RemoteSettings::SettingsData]
+    # @return [Airbrake::RemoteSettings]
+    def self.poll(project_id, host, &block)
+      new(project_id, host, &block).poll
+    end
+
+    # @param [Integer] project_id
+    # @yield [data]
+    # @yieldparam data [Airbrake::RemoteSettings::SettingsData]
+    def initialize(project_id, host, &block)
+      @data = SettingsData.new(project_id, {})
+      @host = host
+      @block = block
+      @poll = nil
+    end
+
+    # Polls remote config of the given project in background. Loads local config
+    # first (if exists).
+    #
+    # @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
+          @block.call(@data.merge!(fetch_config))
+          sleep(@data.interval)
+        end
+      end
+
+      self
+    end
+
+    # Stops the background poller thread. Dumps current config to disk.
+    #
+    # @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
+
+    def fetch_config
+      response = nil
+      begin
+        response = Net::HTTP.get(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)
+        return {}
+      end
+
+      json = nil
+      begin
+        json = JSON.parse(response)
+      rescue JSON::ParserError => ex
+        logger.error(ex)
+        return {}
+      end
+
+      json
+    end
+
+    def build_config_uri
+      uri = URI(@data.config_route(@host))
+      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