airbrake-ruby 4.6.0 → 6.2.2

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

@@ -27,7 +27,7 @@ module Airbrake
       @sender.send(
         deploy_info,
         promise,
-        URI.join(@config.host, "api/v4/projects/#{@config.project_id}/deploys")
+        URI.join(@config.error_host, "api/v4/projects/#{@config.project_id}/deploys"),
       )
 
       promise

data/lib/airbrake-ruby/file_cache.rb

@@ -40,6 +40,12 @@ module Airbrake
       data.empty?
     end
 
+    # @since v4.7.0
+    # @return [void]
+    def self.reset
+      @data = {}
+    end
+
     def self.data
       @data ||= {}
     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
 
@@ -70,13 +72,14 @@ module Airbrake
     def refine(notice)
       @filters.each do |filter|
         break if notice.ignored?
+
         filter.call(notice)
       end
     end
 
     # @return [String] customized inspect to lessen the amount of clutter
     def inspect
-      @filters.map(&:class).to_s
+      filter_classes.to_s
     end
 
     # @return [String] {#inspect} for PrettyPrint
@@ -91,5 +94,19 @@ module Airbrake
       end
       q.text(']')
     end
+
+    # @param [Class] filter_class
+    # @return [Boolean] true if the current chain has an instance of the given
+    #   class, false otherwise
+    # @since v4.14.0
+    def includes?(filter_class)
+      filter_classes.include?(filter_class)
+    end
+
+    private
+
+    def filter_classes
+      @filters.map(&:class)
+    end
   end
 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/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/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)
 
@@ -22,13 +22,13 @@ module Airbrake
           attributes = exception.to_airbrake
         rescue StandardError => ex
           logger.error(
-            "#{LOG_LABEL} #{exception.class}#to_airbrake failed. #{ex.class}: #{ex}"
+            "#{LOG_LABEL} #{exception.class}#to_airbrake failed. #{ex.class}: #{ex}",
           )
         end
 
         unless attributes.is_a?(Hash)
           logger.error(
-            "#{LOG_LABEL} #{self.class}: wanted Hash, got #{attributes.class}"
+            "#{LOG_LABEL} #{self.class}: wanted Hash, got #{attributes.class}",
           )
           return
         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

@@ -27,6 +27,7 @@ module Airbrake
         @git_path = File.join(root_directory, '.git')
         @weight = 116
         @last_checkout = nil
+        @deploy_username = ENV.fetch('AIRBRAKE_DEPLOY_USERNAME', nil)
       end
 
       # @macro call_filter
@@ -40,39 +41,38 @@ 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)
 
-        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}"
+            "#{LOG_LABEL} Airbrake::#{self.class.name}: can't parse line: #{line}",
           )
           return
         end
 
         author = parts[2..-4]
         @last_checkout = {
-          username: author[0..1].join(' '),
+          username: @deploy_username || author[0..1].join(' '),
           email: parts[-3][1..-2],
           revision: parts[1],
-          time: timestamp(parts[-2].to_i)
+          time: timestamp(parts[-2].to_i),
         }
       end
-      # rubocop:enable Metrics/AbcSize
 
       def last_checkout_line
         head_path = File.join(@git_path, 'logs', 'HEAD')
         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

@@ -18,6 +18,7 @@ module Airbrake
       # @macro call_filter
       def call(notice)
         return if notice[:context].key?(:repository)
+
         attach_repository(notice)
       end
 
@@ -35,10 +36,11 @@ 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
+
         notice[:context][:repository] = @repository
       end
 
@@ -46,7 +48,14 @@ module Airbrake
 
       def detect_git_version
         return unless which('git')
-        Gem::Version.new(`git --version`.split[2])
+
+        begin
+          Gem::Version.new(`git --version`.split[2])
+        rescue Errno::EAGAIN
+          # Bugfix for the case when the system cannot allocate memory for
+          # a fork() call: https://github.com/airbrake/airbrake-ruby/issues/680
+          nil
+        end
       end
 
       # Cross-platform way to tell if an executable is accessible.

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)
@@ -55,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_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,19 +19,30 @@ 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
-      FILTERABLE_CONTEXT_KEYS = %i[user headers].freeze
+      #   be modified by blocklist/allowlist filters
+      FILTERABLE_CONTEXT_KEYS = %i[
+        user
+
+        # Provided by Airbrake::Rack::HttpHeadersFilter
+        headers
+        referer
+        httpMethod
+
+        # Provided by Airbrake::Rack::ContextFilter
+        userAddr
+        userAgent
+      ].freeze
 
       include Loggable
 
       # @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
@@ -53,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
 
@@ -67,29 +82,29 @@ 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
+
         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
+        url.query = URI.decode_www_form(url.query).to_h.map do |key, val|
+          should_filter?(key) ? "#{key}=[Filtered]" : "#{key}=#{val}"
         end.join('&')
 
         url.to_s
@@ -103,6 +118,7 @@ module Airbrake
         end
 
         return unless url.query
+
         notice[:context][:url] = filter_url_params(url)
       end
 
@@ -111,6 +127,7 @@ module Airbrake
 
         @patterns = @patterns.flat_map do |pattern|
           next(pattern) unless pattern.respond_to?(:call)
+
           pattern.call
         end
       end
@@ -124,14 +141,16 @@ module Airbrake
 
         logger.error(
           "#{LOG_LABEL} one of the patterns in #{self.class} is invalid. " \
-          "Known patterns: #{@patterns}"
+          "Known patterns: #{@patterns}",
         )
       end
 
       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,20 +23,24 @@ 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|$)/,
-        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'\(.*?(?:\)'|$)/
-        # 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.freeze
+
       # @return [Hash{Symbol=>Array<Symbol>}] a set of features that corresponds
       #   to a certain dialect
       DIALECT_FEATURES = {
@@ -60,7 +64,7 @@ module Airbrake
         cassandra: %i[
           single_quotes uuids numeric_literals boolean_literals
           hexadecimal_literals comments multi_line_comments
-        ].freeze
+        ].freeze,
       }.freeze
 
       # @return [Hash{Symbol=>Regexp}] a set of regexps to check for unmatches
@@ -72,9 +76,22 @@ module Airbrake
         sqlite: %r{'|/\*|\*/},
         cassandra: %r{'|/\*|\*/},
         oracle: %r{'|/\*|\*/},
-        oracle_enhanced: %r{'|/\*|\*/}
+        oracle_enhanced: %r{'|/\*|\*/},
       }.freeze
 
+      # @return [Array<Regexp>] the list of queries to be ignored
+      IGNORED_QUERIES = [
+        /\ACOMMIT/i,
+        /\ABEGIN/i,
+        /\ASET/i,
+        /\ASHOW/i,
+        /\AWITH/i,
+        /FROM pg_attribute/i,
+        /FROM pg_index/i,
+        /FROM pg_class/i,
+        /FROM pg_type/i,
+      ].freeze
+
       def initialize(dialect)
         @dialect =
           case dialect
@@ -91,13 +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 = metric.query
+        if IGNORED_QUERIES.any? { |q| q =~ query }
+          metric.ignore!
+          return
+        end
 
-        q = resource.query.gsub(@regexp, FILTERED)
+        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/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

@@ -16,7 +16,7 @@ module Airbrake
         String,
         Symbol,
         Regexp,
-        Numeric
+        Numeric,
       ].freeze
 
       # Variables starting with this prefix are not attached to a notice.
@@ -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
 
@@ -56,6 +55,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 +63,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
@@ -72,7 +73,7 @@ module Airbrake
         thread_info[:group] = th.group.list.map(&:inspect)
         thread_info[:priority] = th.priority
 
-        thread_info[:safe_level] = th.safe_level unless Airbrake::JRUBY
+        thread_info[:safe_level] = th.safe_level if Airbrake::HAS_SAFE_LEVEL
       end
 
       def sanitize_value(value)
@@ -82,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

@@ -0,0 +1,12 @@
+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 v4.9.0
+  # @api private
+  module Grouppable
+    def groups
+      {}
+    end
+  end
+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.
@@ -38,6 +36,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