airbrake-ruby 4.1.0 → 5.0.0

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['AIRBRAKE_DEPLOY_USERNAME']
       end
 
       # @macro call_filter
@@ -40,32 +41,31 @@ 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(' ')
         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')

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,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
 
@@ -70,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
@@ -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,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,10 +33,14 @@ 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.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
@@ -95,7 +112,14 @@ module Airbrake
       def call(resource)
         return unless resource.respond_to?(:query)
 
-        q = resource.query.gsub(@regexp, FILTERED)
+        query = resource.query
+        if IGNORED_QUERIES.any? { |q| q =~ query }
+          resource.ignore!
+          return
+        end
+
+        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
       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.
@@ -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
@@ -72,7 +74,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)

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 4.9.0
+  # @api private
+  module Grouppable
+    def groups
+      {}
+    end
+  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/inspectable.rb

@@ -21,7 +21,7 @@ module Airbrake
         project_id: @config.project_id,
         project_key: @config.project_key,
         host: @config.host,
-        filter_chain: @filter_chain.inspect
+        filter_chain: @filter_chain.inspect,
       )
     end
 
@@ -30,7 +30,7 @@ module Airbrake
       q.text("#<#{self.class}:0x#{(object_id << 1).to_s(16).rjust(16, '0')} ")
       q.text(
         "project_id=\"#{@config.project_id}\" project_key=\"#{@config.project_key}\" " \
-        "host=\"#{@config.host}\" filter_chain="
+        "host=\"#{@config.host}\" filter_chain=",
       )
       q.pp(@filter_chain)
       q.text('>')

data/lib/airbrake-ruby/loggable.rb

@@ -17,12 +17,12 @@ module Airbrake
   # @api private
   module Loggable
     class << self
-      # @param [Logger] logger
+      # @return [Logger]
       attr_writer :instance
 
       # @return [Logger]
       def instance
-        @instance ||= ::Logger.new(File::NULL)
+        @instance ||= ::Logger.new(File::NULL).tap { |l| l.level = ::Logger::WARN }
       end
     end
 

data/lib/airbrake-ruby/mergeable.rb

@@ -0,0 +1,12 @@
+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
+  # @api private
+  module Mergeable
+    def merge(_other)
+      nil
+    end
+  end
+end

data/lib/airbrake-ruby/monotonic_time.rb

@@ -0,0 +1,48 @@
+module Airbrake
+  # MonotonicTime is a helper for getting monotonic time suitable for
+  # performance measurements. It guarantees that the time is strictly linearly
+  # increasing (unlike realtime).
+  #
+  # @example
+  #   MonotonicTime.time_in_ms #=> 287138801.144576
+  #
+  # @see http://pubs.opengroup.org/onlinepubs/9699919799/functions/clock_getres.html
+  # @since v4.2.4
+  # @api private
+  module MonotonicTime
+    class << self
+      # @return [Integer] current monotonic time in milliseconds
+      def time_in_ms
+        time_in_nanoseconds / (10.0**6)
+      end
+
+      # @return [Integer] current monotonic time in seconds
+      def time_in_s
+        time_in_nanoseconds / (10.0**9)
+      end
+
+      private
+
+      if defined?(Process::CLOCK_MONOTONIC)
+
+        def time_in_nanoseconds
+          Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+        end
+
+      elsif RUBY_ENGINE == 'jruby'
+
+        def time_in_nanoseconds
+          java.lang.System.nanoTime
+        end
+
+      else
+
+        def time_in_nanoseconds
+          time = Time.now
+          time.to_i * (10**9) + time.nsec
+        end
+
+      end
+    end
+  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
@@ -32,7 +25,7 @@ module Airbrake
       IOError,
       NotImplementedError,
       JSON::GeneratorError,
-      Encoding::UndefinedConversionError
+      Encoding::UndefinedConversionError,
     ].freeze
 
     # @return [Array<Symbol>] the list of keys that can be be overwritten with
@@ -51,11 +44,7 @@ module Airbrake
 
     include Ignorable
     include Loggable
-
-    # @since v1.7.0
-    # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
-    #   in filters
-    attr_reader :stash
+    include Stashable
 
     # @api private
     def initialize(exception, params = {})
@@ -64,13 +53,14 @@ module Airbrake
         errors: NestedException.new(exception).as_json,
         context: context,
         environment: {
-          program_name: $PROGRAM_NAME
+          program_name: $PROGRAM_NAME,
         },
         session: {},
-        params: params
+        params: params,
       }
-      @stash = { exception: exception }
       @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
+
+      stash[:exception] = exception
     end
 
     # Converts the notice to JSON. Calls +to_json+ on each object inside
@@ -79,7 +69,7 @@ module Airbrake
     #
     # @return [Hash{String=>String}, nil]
     # @api private
-    def to_json
+    def to_json(*_args)
       loop do
         begin
           json = @payload.to_json
@@ -141,7 +131,7 @@ module Airbrake
         # Make sure we always send hostname.
         hostname: HOSTNAME,
 
-        severity: DEFAULT_SEVERITY
+        severity: DEFAULT_SEVERITY,
       }.merge(CONTEXT).delete_if { |_key, val| val.nil? || val.empty? }
     end
 
@@ -155,7 +145,7 @@ module Airbrake
         logger.error(
           "#{LOG_LABEL} truncation failed. File an issue at " \
           "https://github.com/airbrake/airbrake-ruby " \
-          "and attach the following payload: #{@payload}"
+          "and attach the following payload: #{@payload}",
         )
       end