airbrake-ruby 3.1.0 → 3.2.0

data/lib/airbrake-ruby/deploy_notifier.rb

@@ -0,0 +1,47 @@
+module Airbrake
+  # DeployNotifier sends deploy information to Airbrake. The information
+  # consists of:
+  # - environment
+  # - username
+  # - repository
+  # - revision
+  # - version
+  #
+  # @api public
+  # @since v3.2.0
+  class DeployNotifier
+    # @param [Airbrake::Config] config
+    def initialize(config)
+      @config =
+        if config.is_a?(Config)
+          config
+        else
+          loc = caller_locations(1..1).first
+          signature = "#{self.class.name}##{__method__}"
+          warn(
+            "#{loc.path}:#{loc.lineno}: warning: passing a Hash to #{signature} " \
+            'is deprecated. Pass `Airbrake::Config` instead'
+          )
+          Config.new(config)
+        end
+
+      @sender = SyncSender.new(@config)
+    end
+
+    # @see Airbrake.create_deploy
+    def notify(deploy_info, promise = Airbrake::Promise.new)
+      if @config.ignored_environment?
+        return promise.reject("The '#{@config.environment}' environment is ignored")
+      end
+
+      deploy_info[:environment] ||= @config.environment
+      @sender.send(
+        deploy_info,
+        promise,
+        URI.join(@config.host, "api/v4/projects/#{@config.project_id}/deploys")
+      )
+
+      promise
+    end
+  end
+end

data/lib/airbrake-ruby/filter_chain.rb

@@ -1,29 +1,44 @@
 module Airbrake
-  # Represents the mechanism for filtering notices. Defines a few default
-  # filters.
+  # FilterChain represents an ordered array of filters.
+  #
+  # A filter is an object that responds to <b>#call</b> (typically a Proc or a
+  # class that implements the call method). The <b>#call</b> method must accept
+  # exactly one argument: an object to be filtered.
+  #
+  # When you add a new filter to the chain, it gets inserted according to its
+  # <b>weight</b>. Smaller weight means the filter will be somewhere in the
+  # beginning of the array. Larger - in the end. If a filter doesn't implement
+  # weight, the chain assumes it's equal to 0.
+  #
+  # @example
+  #   class MyFilter
+  #     attr_reader :weight
+  #
+  #     def initialize
+  #       @weight = 1
+  #     end
+  #
+  #     def call(obj)
+  #       puts 'Filtering...'
+  #       obj[:data] = '[Filtered]'
+  #     end
+  #   end
+  #
+  #   filter_chain = FilterChain.new
+  #   filter_chain.add_filter(MyFilter)
+  #
+  #   filter_chain.refine(obj)
+  #   #=> Filtering...
   #
   # @see Airbrake.add_filter
   # @api private
   # @since v1.0.0
   class FilterChain
-    # @return [Array<Class>] filters to be executed first
-    DEFAULT_FILTERS = [
-      Airbrake::Filters::SystemExitFilter,
-      Airbrake::Filters::GemRootFilter
-
-      # Optional filters (must be included by users):
-      # Airbrake::Filters::ThreadFilter
-    ].freeze
-
     # @return [Integer]
     DEFAULT_WEIGHT = 0
 
-    def initialize(config, context)
-      @config = config
-      @context = context
+    def initialize
       @filters = []
-      DEFAULT_FILTERS.each { |f| add_filter(f.new) }
-      add_default_filters
     end
 
     # Adds a filter to the filter chain. Sorts filters by weight.
@@ -51,6 +66,7 @@ module Airbrake
     #
     # @param [Airbrake::Notice] notice The notice to be filtered
     # @return [void]
+    # @todo Make it work with anything, not only notices
     def refine(notice)
       @filters.each do |filter|
         break if notice.ignored?
@@ -75,39 +91,5 @@ module Airbrake
       end
       q.text(']')
     end
-
-    private
-
-    # rubocop:disable Metrics/AbcSize
-    def add_default_filters
-      if (whitelist_keys = @config.whitelist_keys).any?
-        add_filter(
-          Airbrake::Filters::KeysWhitelist.new(@config.logger, whitelist_keys)
-        )
-      end
-
-      if (blacklist_keys = @config.blacklist_keys).any?
-        add_filter(
-          Airbrake::Filters::KeysBlacklist.new(@config.logger, blacklist_keys)
-        )
-      end
-
-      add_filter(Airbrake::Filters::ContextFilter.new(@context))
-      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new(@config.logger))
-
-      return unless (root_directory = @config.root_directory)
-      [
-        Airbrake::Filters::RootDirectoryFilter,
-        Airbrake::Filters::GitRevisionFilter,
-        Airbrake::Filters::GitRepositoryFilter
-      ].each do |filter|
-        add_filter(filter.new(root_directory))
-      end
-
-      add_filter(
-        Airbrake::Filters::GitLastCheckoutFilter.new(@config.logger, root_directory)
-      )
-    end
-    # rubocop:enable Metrics/AbcSize
   end
 end

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

@@ -11,6 +11,7 @@ module Airbrake
       def initialize(root_directory)
         @git_path = File.join(root_directory, '.git')
         @repository = nil
+        @git_version = Gem::Version.new(`git --version`.split.last)
         @weight = 116
       end
 
@@ -25,7 +26,14 @@ module Airbrake
 
         return unless File.exist?(@git_path)
 
-        @repository = `cd #{@git_path} && git remote get-url origin`.chomp
+        @repository =
+          if @git_version >= Gem::Version.new('2.7.0')
+            `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+'
+          end
+
         return unless @repository
         notice[:context][:repository] = @repository
       end

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

@@ -0,0 +1,104 @@
+module Airbrake
+  module Filters
+    # SqlFilter filters out sensitive data from {Airbrake::Query}. Sensitive
+    # data is everything that is not table names or fields (e.g. column values
+    # and such).
+    #
+    # Supports the following SQL dialects:
+    # * PostgreSQL
+    # * MySQL
+    # * SQLite
+    # * Cassandra
+    # * Oracle
+    #
+    # @api private
+    # @since v3.2.0
+    class SqlFilter
+      # @return [String] the label to replace real values of filtered query
+      FILTERED = '?'.freeze
+
+      # @return [String] the string that will replace the query in case we
+      #   cannot filter it
+      ERROR_MSG = 'Error: Airbrake::Query was not filtered'.freeze
+
+      # @return [Hash{Symbol=>Regexp}] matchers for certain features of SQL
+      ALL_FEATURES = {
+        # rubocop:disable Metrics/LineLength
+        single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
+        double_quotes: /"(?:[^"]|"")*?(?:\\".*|"(?!"))/,
+        dollar_quotes: /(\$(?!\d)[^$]*?\$).*?(?:\1|$)/,
+        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
+      }.freeze
+
+      # @return [Hash{Symbol=>Array<Symbol>}] a set of features that corresponds
+      #   to a certain dialect
+      DIALECT_FEATURES = {
+        default: ALL_FEATURES.keys,
+        mysql: %i[
+          single_quotes double_quotes numeric_literals boolean_literals
+          hexadecimal_literals comments multi_line_comments
+        ].freeze,
+        postgres: %i[
+          single_quotes dollar_quotes uuids numeric_literals boolean_literals
+          comments multi_line_comments
+        ].freeze,
+        sqlite: %i[
+          single_quotes numeric_literals boolean_literals hexadecimal_literals
+          comments multi_line_comments
+        ].freeze,
+        oracle: %i[
+          single_quotes oracle_quoted_strings numeric_literals comments
+          multi_line_comments
+        ].freeze,
+        cassandra: %i[
+          single_quotes uuids numeric_literals boolean_literals
+          hexadecimal_literals comments multi_line_comments
+        ].freeze
+      }.freeze
+
+      # @return [Hash{Symbol=>Regexp}] a set of regexps to check for unmatches
+      #   quotes after filtering (should be none)
+      UNMATCHED_PAIR = {
+        mysql: %r{'|"|/\*|\*/},
+        mysql2: %r{'|"|/\*|\*/},
+        postgres: %r{'|/\*|\*/|\$(?!\?)},
+        sqlite: %r{'|/\*|\*/},
+        cassandra: %r{'|/\*|\*/},
+        oracle: %r{'|/\*|\*/},
+        oracle_enhanced: %r{'|/\*|\*/}
+      }.freeze
+
+      def initialize(dialect)
+        @dialect =
+          case dialect
+          when /mysql/i then :mysql
+          when /postgres/i then :postgres
+          when /sqlite/i then :sqlite
+          when /oracle/i then :oracle
+          when /cassandra/i then :cassandra
+          else
+            :default
+          end
+
+        features = DIALECT_FEATURES[@dialect].map { |f| ALL_FEATURES[f] }
+        @regexp = Regexp.union(features)
+      end
+
+      # @param [Airbrake::Query] resource
+      def call(resource)
+        return unless resource.respond_to?(:query)
+
+        q = resource.query.gsub(@regexp, FILTERED)
+        q = ERROR_MSG if UNMATCHED_PAIR[@dialect] =~ q
+        resource.query = q
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/hash_keyable.rb

@@ -0,0 +1,37 @@
+module Airbrake
+  # HashKeyable allows instances of the class to be used as a Hash key in a
+  # consistent manner.
+  #
+  # The class that includes it must implement *to_h*, which defines properties
+  # that all of the instances must share in order to produce the same {#hash}.
+  #
+  # @example
+  #   class C
+  #     include Airbrake::HashKeyable
+  #
+  #     def initialize(key)
+  #       @key = key
+  #     end
+  #
+  #     def to_h
+  #       { 'key' => @key }
+  #     end
+  #   end
+  #
+  #   h = {}
+  #   h[C.new('key1')] = 1
+  #   h[C.new('key1')] #=> 1
+  #   h[C.new('key2')] #=> nil
+  module HashKeyable
+    # @param [Object] other
+    # @return [Boolean]
+    def eql?(other)
+      other.is_a?(self.class) && other.hash == hash
+    end
+
+    # @return [Integer]
+    def hash
+      to_h.hash
+    end
+  end
+end

data/lib/airbrake-ruby/ignorable.rb

@@ -0,0 +1,44 @@
+module Airbrake
+  # Ignorable contains methods that allow the includee to be ignored.
+  #
+  # @example
+  #   class A
+  #     include Airbrake::Ignorable
+  #   end
+  #
+  #   a = A.new
+  #   a.ignore!
+  #   a.ignored? #=> true
+  #
+  # @since v3.2.0
+  # @api private
+  module Ignorable
+    attr_accessor :ignored
+
+    # 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.
+    # @return [void]
+    # @see #ignored?
+    def ignore!
+      self.ignored = true
+    end
+
+    private
+
+    # A method that is meant to be used as a guard.
+    # @raise [Airbrake::Error] when instance is ignored
+    def raise_if_ignored
+      return unless ignored?
+      raise Airbrake::Error, "cannot access ignored #{self.class}"
+    end
+  end
+end

data/lib/airbrake-ruby/notice.rb

@@ -49,6 +49,8 @@ module Airbrake
     # @return [String]
     DEFAULT_SEVERITY = 'error'.freeze
 
+    include Ignorable
+
     # @since v1.7.0
     # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
     #   in filters
@@ -91,23 +93,6 @@ module Airbrake
       end
     end
 
-    # Ignores a notice. Ignored notices never reach the Airbrake dashboard.
-    #
-    # @return [void]
-    # @see #ignored?
-    # @note Ignored noticed can't be unignored
-    def ignore!
-      @payload = nil
-    end
-
-    # Checks whether the notice was ignored.
-    #
-    # @return [Boolean]
-    # @see #ignore!
-    def ignored?
-      @payload.nil?
-    end
-
     # Reads a value from notice's payload.
     #
     # @return [Object]
@@ -160,11 +145,6 @@ module Airbrake
       }.merge(CONTEXT).delete_if { |_key, val| val.nil? || val.empty? }
     end
 
-    def raise_if_ignored
-      return unless ignored?
-      raise Airbrake::Error, 'cannot access ignored notice'
-    end
-
     def truncate
       TRUNCATABLE_KEYS.each do |key|
         @payload[key] = @truncator.truncate(@payload[key])

data/lib/airbrake-ruby/{notifier.rb → notice_notifier.rb}

@@ -1,12 +1,12 @@
 module Airbrake
-  # This class is reponsible for sending notices to Airbrake. It supports
+  # NoticeNotifier is reponsible for sending notices to Airbrake. It supports
   # synchronous and asynchronous delivery.
   #
   # @see Airbrake::Config The list of options
   # @since v1.0.0
-  # @api private
+  # @api public
   # rubocop:disable Metrics/ClassLength
-  class Notifier
+  class NoticeNotifier
     # @return [String] the label to be prepended to the log output
     LOG_LABEL = '**Airbrake:'.freeze
 
@@ -16,31 +16,44 @@ module Airbrake
       "project_key=\"%<project_key>s\" " \
       "host=\"%<host>s\" filter_chain=%<filter_chain>s>".freeze
 
-    # Creates a new Airbrake notifier with the given config options.
-    #
-    # @example Configuring with a Hash
-    #   airbrake = Airbrake.new(project_id: 123, project_key: '321')
+    # @return [Array<Class>] filters to be executed first
+    DEFAULT_FILTERS = [
+      Airbrake::Filters::SystemExitFilter,
+      Airbrake::Filters::GemRootFilter
+
+      # Optional filters (must be included by users):
+      # Airbrake::Filters::ThreadFilter
+    ].freeze
+
+    # Creates a new notice notifier with the given config options.
     #
-    # @example Configuring with an Airbrake::Config
+    # @example
     #   config = Airbrake::Config.new
     #   config.project_id = 123
     #   config.project_key = '321'
-    #   airbake = Airbrake.new(config)
+    #   notice_notifier = Airbrake::NoticeNotifier.new(config)
     #
-    # @param [Hash, Airbrake::Config] user_config The config that contains
-    #   information about how the notifier should operate
-    # @raise [Airbrake::Error] when either +project_id+ or +project_key+
-    #   is missing (or both)
-    def initialize(user_config)
-      @config = (user_config.is_a?(Config) ? user_config : Config.new(user_config))
-
-      raise Airbrake::Error, @config.validation_error_message unless @config.valid?
+    # @param [Airbrake::Config] config
+    def initialize(config)
+      @config =
+        if config.is_a?(Config)
+          config
+        else
+          loc = caller_locations(1..1).first
+          signature = "#{self.class.name}##{__method__}"
+          warn(
+            "#{loc.path}:#{loc.lineno}: warning: passing a Hash to #{signature} " \
+            'is deprecated. Pass `Airbrake::Config` instead'
+          )
+          Config.new(config)
+        end
 
       @context = {}
-      @filter_chain = FilterChain.new(@config, @context)
+      @filter_chain = FilterChain.new
       @async_sender = AsyncSender.new(@config)
       @sync_sender = SyncSender.new(@config)
-      @route_sender = RouteSender.new(@config)
+
+      add_default_filters
     end
 
     # @macro see_public_api_method
@@ -83,18 +96,6 @@ module Airbrake
       @async_sender.close
     end
 
-    # @macro see_public_api_method
-    def create_deploy(deploy_params)
-      deploy_params[:environment] ||= @config.environment
-      promise = Airbrake::Promise.new
-      @sync_sender.send(
-        deploy_params,
-        promise,
-        URI.join(@config.host, "api/v4/projects/#{@config.project_id}/deploys")
-      )
-      promise
-    end
-
     # @macro see_public_api_method
     def configured?
       @config.valid?
@@ -105,21 +106,6 @@ module Airbrake
       @context.merge!(context)
     end
 
-    # @macro see_public_api_method
-    def notify_request(request_info)
-      promise = Airbrake::Promise.new
-
-      if @config.ignored_environment?
-        return promise.reject("The '#{@config.environment}' environment is ignored")
-      end
-
-      unless @config.route_stats
-        return promise.reject("The Route Stats feature is disabled")
-      end
-
-      @route_sender.notify_request(request_info, promise)
-    end
-
     # @return [String] customized inspect to lessen the amount of clutter
     def inspect
       format(
@@ -193,6 +179,40 @@ module Airbrake
       return caller_copy if clean_bt.empty?
       clean_bt
     end
+
+    # rubocop:disable Metrics/AbcSize
+    def add_default_filters
+      DEFAULT_FILTERS.each { |f| add_filter(f.new) }
+
+      if (whitelist_keys = @config.whitelist_keys).any?
+        add_filter(
+          Airbrake::Filters::KeysWhitelist.new(@config.logger, whitelist_keys)
+        )
+      end
+
+      if (blacklist_keys = @config.blacklist_keys).any?
+        add_filter(
+          Airbrake::Filters::KeysBlacklist.new(@config.logger, blacklist_keys)
+        )
+      end
+
+      add_filter(Airbrake::Filters::ContextFilter.new(@context))
+      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new(@config.logger))
+
+      return unless (root_directory = @config.root_directory)
+      [
+        Airbrake::Filters::RootDirectoryFilter,
+        Airbrake::Filters::GitRevisionFilter,
+        Airbrake::Filters::GitRepositoryFilter
+      ].each do |filter|
+        add_filter(filter.new(root_directory))
+      end
+
+      add_filter(
+        Airbrake::Filters::GitLastCheckoutFilter.new(@config.logger, root_directory)
+      )
+    end
+    # rubocop:enable Metrics/AbcSize
   end
   # rubocop:enable Metrics/ClassLength
 end