airbrake-ruby 5.0.0.rc.2 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36bf29e9b0f7ccd10afe2fdc47ec434c02941e8ad0f82e7806280b731db96bcf
-  data.tar.gz: bcc5563ebce4151570184bf9ed9248eb21684fbc4cf5911fbea687f47e4587e4
+  metadata.gz: a9438fdfe9308d48989fc04e1f9873c4cab46f7c22487ae1bd3d22e917d73f60
+  data.tar.gz: '08e6b8f6af0fd1ff980e642d9ce540c6c407844d34249bb921b9a15cd5f74ad7'
 SHA512:
-  metadata.gz: edf639bcf65ab8686114b93c920498605f6cfabce2ef6a6d4c364bd507076c0da80bd26358ce2414dfcf65c24b13f6665e0718a453d0e0e50f483077c2237e77
-  data.tar.gz: 9967e9fa9ddef2d7a3be67aa0fc1cc44eca5a0c89945b0fa69bf4510733e827f164a70c7a12e36426d4a5b6f239fdd072a64de886aca42d93355ad18b5d96b66
+  metadata.gz: e6e892017febffa214ab8ea921fa8c09b1a27e6c2b0874d669e0dd64004b21fa27bd13ea65b750505e9c702c7248314e8d77ca6b57cb1ec4332c9157712d866d
+  data.tar.gz: c1ebc53b428eca54eb4c85e4fc094819c9c2972308b97069c6234502159d57c2b5977203fb8a60dd3865e7f8dca2f0430dd0f1500ef2df89f8f059a881433740

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'

data/lib/airbrake-ruby/backtrace.rb

@@ -22,7 +22,7 @@ module Airbrake
         (?<line>\d+)      # Matches '43'
         :in\s
         `(?<function>.*)' # Matches "`block (3 levels) in <top (required)>'"
-      \z}x
+      \z}x.freeze
 
       # @return [Regexp] the pattern that matches JRuby Java stack frames, such
       #  as org.jruby.ast.NewlineNode.interpret(NewlineNode.java:105)
@@ -39,7 +39,7 @@ module Airbrake
           :?
           (?<line>\d+)?  # Matches '105'
         \)
-      \z}x
+      \z}x.freeze
 
       # @return [Regexp] the pattern that tries to assume what a generic stack
       #   frame might look like, when exception's backtrace is set manually.
@@ -53,7 +53,7 @@ module Airbrake
         |
           :in\s(?<function>.+)   # Matches ":in func"
         )?                       # ... or nothing
-      \z}x
+      \z}x.freeze
 
       # @return [Regexp] the pattern that matches exceptions from PL/SQL such as
       #   ORA-06512: at "STORE.LI_LICENSES_PACK", line 1945
@@ -67,7 +67,7 @@ module Airbrake
         |
           #{GENERIC}
         )
-      \z/x
+      \z/x.freeze
 
       # @return [Regexp] the pattern that matches CoffeeScript backtraces
       #   usually coming from Rails & ExecJS
@@ -82,7 +82,7 @@ module Airbrake
           # Matches the Ruby part of the backtrace
           #{RUBY}
         )
-      \z/x
+      \z/x.freeze
     end
 
     # @return [Integer] how many first frames should include code hunks
@@ -95,6 +95,7 @@ module Airbrake
     # @return [Array<Hash{Symbol=>String,Integer}>] the parsed backtrace
     def self.parse(exception)
       return [] if exception.backtrace.nil? || exception.backtrace.none?
+
       parse_backtrace(exception)
     end
 

data/lib/airbrake-ruby/config.rb

@@ -4,7 +4,6 @@ module Airbrake
   #
   # @api public
   # @since v1.0.0
-  # rubocop:disable Metrics/ClassLength
   class Config
     # @return [Integer] the project identificator. This value *must* be set.
     # @api public
@@ -47,15 +46,15 @@ module Airbrake
     # @api public
     attr_accessor :host
 
-    # @since v?.?.?
+    # @since v5.0.0
     alias error_host host
-    # @since v?.?.?
+    # @since v5.0.0
     alias error_host= host=
 
     # @return [String] the host, which provides the API endpoint to which
     #   APM data should be sent
     # @api public
-    # @since v?.?.?
+    # @since v5.0.0
     attr_accessor :apm_host
 
     # @return [String, Pathname] the working directory of your project
@@ -83,18 +82,12 @@ module Airbrake
     # @since v4.15.0
     attr_accessor :allowlist_keys
 
-    # @deprecated Use allowlist_keys instead
-    alias whitelist_keys allowlist_keys
-
     # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
     # @since v4.15.0
     attr_accessor :blocklist_keys
 
-    # @deprecated Use blocklist_keys instead
-    alias blacklist_keys blocklist_keys
-
     # @return [Boolean] true if the library should attach code hunks to each
     #   frame in a backtrace, false otherwise
     # @api public
@@ -128,14 +121,14 @@ module Airbrake
     # @return [Boolean] true if the library should send error reports to
     #   Airbrake, false otherwise
     # @api public
-    # @since ?.?.?
+    # @since 5.0.0
     attr_accessor :error_notifications
 
-    # @note Not for public use!
-    # @return [Boolean]
+    # @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 ?.?.?
-    attr_accessor :__remote_configuration
+    # @since 5.0.0
+    attr_accessor :remote_config_host
 
     class << self
       # @return [Config]
@@ -160,6 +153,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://notifier-configs.airbrake.io'
 
       self.ignore_environments = []
 
@@ -179,30 +173,11 @@ module Airbrake
       self.query_stats = true
       self.job_stats = true
       self.error_notifications = true
-      self.__remote_configuration = false
 
       merge(user_config)
     end
     # rubocop:enable Metrics/AbcSize
 
-    def blacklist_keys=(keys)
-      loc = caller_locations(1..1).first
-      Kernel.warn(
-        "#{loc.path}:#{loc.lineno}: warning: blacklist_keys= is deprecated " \
-        "use blocklist_keys= instead",
-      )
-      self.blocklist_keys = keys
-    end
-
-    def whitelist_keys=(keys)
-      loc = caller_locations(1..1).first
-      Kernel.warn(
-        "#{loc.path}:#{loc.lineno}: warning: whitelist_keys= is deprecated " \
-        "use allowlist_keys= instead",
-      )
-      self.allowlist_keys = keys
-    end
-
     # The full URL to the Airbrake Notice API. Based on the +:error_host+ option.
     # @return [URI] the endpoint address
     def error_endpoint
@@ -288,5 +263,4 @@ module Airbrake
       raise Airbrake::Error, "unknown option '#{option}'"
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

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 v?.?.?
+    # @since 5.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,9 +41,12 @@ module Airbrake
 
       # @return [Airbrake::RemoteSettings]
       def process_remote_configuration
-        return if !@project_id || !@config.__remote_configuration
+        return unless @project_id
+        return if @config.environment == 'test'
 
-        RemoteSettings.poll(@project_id, &method(:poll_callback))
+        RemoteSettings.poll(@project_id, @config.remote_config_host) do |data|
+          @poll_callback.call(data)
+        end
       end
 
       # @param [Airbrake::NoticeNotifier] notifier
@@ -61,20 +65,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/config/validator.rb

@@ -61,12 +61,14 @@ module Airbrake
 
         def valid_project_id?(config)
           return true if config.project_id.to_i > 0
+
           false
         end
 
         def valid_project_key?(config)
           return false unless config.project_key.is_a?(String)
           return false if config.project_key.empty?
+
           true
         end
 

data/lib/airbrake-ruby/file_cache.rb

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

data/lib/airbrake-ruby/filter_chain.rb

@@ -70,6 +70,7 @@ module Airbrake
     def refine(notice)
       @filters.each do |filter|
         break if notice.ignored?
+
         filter.call(notice)
       end
     end

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

@@ -24,6 +24,7 @@ module Airbrake
 
       def git_version(spec)
         return unless spec.respond_to?(:git_version) || spec.git_version
+
         spec.git_version.to_s
       end
     end

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

@@ -23,6 +23,7 @@ module Airbrake
               # If the frame is unparseable, then 'file' is nil, thus nothing to
               # filter (all frame's data is in 'function' instead).
               next unless (file = frame[:file])
+
               frame[:file] = file.sub(/\A#{gem_path}/, GEM_ROOT_LABEL)
             end
           end

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

@@ -41,12 +41,12 @@ module Airbrake
 
         return unless File.exist?(@git_path)
         return unless (checkout = last_checkout)
+
         notice[:context][:lastCheckout] = checkout
       end
 
       private
 
-      # rubocop:disable Metrics/AbcSize
       def last_checkout
         return unless (line = last_checkout_line)
 
@@ -66,7 +66,6 @@ module Airbrake
           time: timestamp(parts[-2].to_i),
         }
       end
-      # rubocop:enable Metrics/AbcSize
 
       def last_checkout_line
         head_path = File.join(@git_path, 'logs', 'HEAD')

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

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