airbrake-ruby 3.2.6 → 4.0.0

data/lib/airbrake-ruby/code_hunk.rb

@@ -9,9 +9,7 @@ module Airbrake
     # @return [Integer] how many lines should be read around the base line
     NLINES = 2
 
-    def initialize(config)
-      @config = config
-    end
+    include Loggable
 
     # @param [String] file The file to read
     # @param [Integer] line The base line in the file
@@ -31,7 +29,7 @@ module Airbrake
     def get_from_cache(file)
       Airbrake::FileCache[file] ||= File.foreach(file)
     rescue StandardError => ex
-      @config.logger.error(
+      logger.error(
         "#{self.class.name}: can't read code hunk for #{file}: #{ex}"
       )
       nil

data/lib/airbrake-ruby/config.rb

@@ -5,6 +5,13 @@ module Airbrake
   # @api public
   # @since v1.0.0
   class Config
+    @instance = new
+
+    class << self
+      # @return [Config]
+      attr_accessor :instance
+    end
+
     # @return [Integer] the project identificator. This value *must* be set.
     # @api public
     attr_accessor :project_id
@@ -97,7 +104,6 @@ module Airbrake
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
-    # rubocop:disable Metrics/AbcSize
     def initialize(user_config = {})
       @validator = Config::Validator.new(self)
 
@@ -105,10 +111,7 @@ module Airbrake
       self.queue_size = 100
       self.workers = 1
       self.code_hunks = true
-
-      self.logger = Logger.new(STDOUT)
-      logger.level = Logger::WARN
-
+      self.logger = ::Logger.new(File::NULL)
       self.project_id = user_config[:project_id]
       self.project_key = user_config[:project_key]
       self.host = 'https://api.airbrake.io'
@@ -131,7 +134,6 @@ module Airbrake
 
       merge(user_config)
     end
-    # rubocop:enable Metrics/AbcSize
 
     # The full URL to the Airbrake Notice API. Based on the +:host+ option.
     # @return [URI] the endpoint address
@@ -195,38 +197,6 @@ module Airbrake
       end
     end
 
-    def route_stats
-      logger.warn(
-        "#{LOG_LABEL} the 'route_stats' option is deprecated. " \
-        "Use 'performance_stats' instead"
-      )
-      @performance_stats
-    end
-
-    def route_stats=(value)
-      logger.warn(
-        "#{LOG_LABEL} the 'route_stats' option is deprecated. " \
-        "Use 'performance_stats' instead"
-      )
-      @performance_stats = value
-    end
-
-    def route_stats_flush_period
-      logger.warn(
-        "#{LOG_LABEL} the 'route_stats_flush_period' option is deprecated. " \
-        "Use 'performance_stats_flush_period' instead"
-      )
-      @performance_stats_flush_period
-    end
-
-    def route_stats_flush_period=(value)
-      logger.warn(
-        "#{LOG_LABEL} the 'route_stats_flush_period' option is deprecated. " \
-        "Use 'performance_stats' instead"
-      )
-      @performance_stats_flush_period = value
-    end
-
     private
 
     def set_option(option, value)

data/lib/airbrake-ruby/deploy_notifier.rb

@@ -12,25 +12,12 @@ module Airbrake
   class DeployNotifier
     include Inspectable
 
-    # @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)
+    def initialize
+      @config = Airbrake::Config.instance
+      @sender = SyncSender.new
     end
 
-    # @see Airbrake.create_deploy
+    # @see Airbrake.notify_deploy
     def notify(deploy_info, promise = Airbrake::Promise.new)
       if @config.ignored_environment?
         return promise.reject("The '#{@config.environment}' environment is ignored")

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

@@ -6,8 +6,9 @@ module Airbrake
     # @api private
     # @since v2.10.0
     class ExceptionAttributesFilter
-      def initialize(logger)
-        @logger = logger
+      include Loggable
+
+      def initialize
         @weight = 118
       end
 
@@ -20,13 +21,13 @@ module Airbrake
         begin
           attributes = exception.to_airbrake
         rescue StandardError => ex
-          @logger.error(
+          logger.error(
             "#{LOG_LABEL} #{exception.class}#to_airbrake failed. #{ex.class}: #{ex}"
           )
         end
 
         unless attributes.is_a?(Hash)
-          @logger.error(
+          logger.error(
             "#{LOG_LABEL} #{self.class}: wanted Hash, got #{attributes.class}"
           )
           return

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

@@ -20,11 +20,11 @@ module Airbrake
       #   file (checkout information is omitted)
       MIN_HEAD_COLS = 6
 
-      # @param [Logger] logger
+      include Loggable
+
       # @param [String] root_directory
-      def initialize(logger, root_directory)
+      def initialize(root_directory)
         @git_path = File.join(root_directory, '.git')
-        @logger = logger
         @weight = 116
         @last_checkout = nil
       end
@@ -45,12 +45,13 @@ module Airbrake
 
       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(
+          logger.error(
             "#{LOG_LABEL} Airbrake::#{self.class.name}: can't parse line: #{line}"
           )
           return
@@ -64,6 +65,7 @@ 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/keys_blacklist.rb

@@ -5,7 +5,6 @@ module Airbrake
     #
     # @example
     #   filter = Airbrake::Filters::KeysBlacklist.new(
-    #     Logger.new(STDOUT),
     #     [:email, /credit/i, 'password']
     #   )
     #   airbrake.add_filter(filter)

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

@@ -26,16 +26,16 @@ module Airbrake
       #   be modified by blacklist/whitelist filters
       FILTERABLE_CONTEXT_KEYS = %i[user headers].freeze
 
+      include Loggable
+
       # @return [Integer]
       attr_reader :weight
 
       # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
-      # @param [Logger, #error] logger
       # @param [Array<String,Regexp,Symbol>] patterns
-      def initialize(logger, patterns)
-        @logger = logger
+      def initialize(patterns)
         @patterns = patterns
         @valid_patterns = false
       end
@@ -122,7 +122,7 @@ module Airbrake
 
         return if @valid_patterns
 
-        @logger.error(
+        logger.error(
           "#{LOG_LABEL} one of the patterns in #{self.class} is invalid. " \
           "Known patterns: #{@patterns}"
         )

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

@@ -5,7 +5,6 @@ module Airbrake
     #
     # @example
     #   filter = Airbrake::Filters::KeysBlacklist.new(
-    #     Logger.new(STDOUT),
     #     [:email, /credit/i, 'password']
     #   )
     #   airbrake.add_filter(filter)

data/lib/airbrake-ruby/loggable.rb

@@ -0,0 +1,31 @@
+module Airbrake
+  # Loggable is included into any class that wants to be able to log.
+  #
+  # By default, Loggable defines a null logger that doesn't do anything. You are
+  # supposed to overwrite it via the {instance} method before calling {logger}.
+  #
+  # @example
+  #   class A
+  #     include Loggable
+  #
+  #     def initialize
+  #       logger.debug('Initialized A')
+  #     end
+  #   end
+  #
+  # @since v4.0.0
+  # @api private
+  module Loggable
+    @instance = ::Logger.new(File::NULL)
+
+    class << self
+      # @return [Logger]
+      attr_accessor :instance
+    end
+
+    # @return [Logger] standard Ruby logger object
+    def logger
+      Loggable.instance
+    end
+  end
+end

data/lib/airbrake-ruby/nested_exception.rb

@@ -9,8 +9,7 @@ module Airbrake
     #   can unwrap. Exceptions that have a longer cause chain will be ignored
     MAX_NESTED_EXCEPTIONS = 3
 
-    def initialize(config, exception)
-      @config = config
+    def initialize(exception)
       @exception = exception
     end
 
@@ -18,7 +17,7 @@ module Airbrake
       unwind_exceptions.map do |exception|
         { type: exception.class.name,
           message: exception.message,
-          backtrace: Backtrace.parse(@config, exception) }
+          backtrace: Backtrace.parse(exception) }
       end
     end
 

data/lib/airbrake-ruby/notice.rb

@@ -50,6 +50,7 @@ module Airbrake
     DEFAULT_SEVERITY = 'error'.freeze
 
     include Ignorable
+    include Loggable
 
     # @since v1.7.0
     # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
@@ -57,11 +58,10 @@ module Airbrake
     attr_reader :stash
 
     # @api private
-    def initialize(config, exception, params = {})
-      @config = config
-
+    def initialize(exception, params = {})
+      @config = Airbrake::Config.instance
       @payload = {
-        errors: NestedException.new(config, exception).as_json,
+        errors: NestedException.new(exception).as_json,
         context: context,
         environment: {
           program_name: $PROGRAM_NAME
@@ -84,7 +84,7 @@ module Airbrake
         begin
           json = @payload.to_json
         rescue *JSON_EXCEPTIONS => ex
-          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")
+          logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")
         else
           return json if json && json.bytesize <= MAX_NOTICE_SIZE
         end
@@ -152,7 +152,7 @@ module Airbrake
 
       new_max_size = @truncator.reduce_max_size
       if new_max_size == 0
-        @config.logger.error(
+        logger.error(
           "#{LOG_LABEL} truncation failed. File an issue at " \
           "https://github.com/airbrake/airbrake-ruby " \
           "and attach the following payload: #{@payload}"

data/lib/airbrake-ruby/notice_notifier.rb

@@ -5,7 +5,6 @@ module Airbrake
   # @see Airbrake::Config The list of options
   # @since v1.0.0
   # @api public
-  # rubocop:disable Metrics/ClassLength
   class NoticeNotifier
     # @return [Array<Class>] filters to be executed first
     DEFAULT_FILTERS = [
@@ -17,35 +16,14 @@ module Airbrake
     ].freeze
 
     include Inspectable
+    include Loggable
 
-    # Creates a new notice notifier with the given config options.
-    #
-    # @example
-    #   config = Airbrake::Config.new
-    #   config.project_id = 123
-    #   config.project_key = '321'
-    #   notice_notifier = Airbrake::NoticeNotifier.new(config)
-    #
-    # @param [Airbrake::Config] config
-    def initialize(config, perf_notifier = nil)
-      @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
-
+    def initialize
+      @config = Airbrake::Config.instance
       @context = {}
       @filter_chain = FilterChain.new
-      @async_sender = AsyncSender.new(@config)
-      @sync_sender = SyncSender.new(@config)
-      @perf_notifier = perf_notifier
+      @async_sender = AsyncSender.new
+      @sync_sender = SyncSender.new
 
       add_default_filters
     end
@@ -60,15 +38,6 @@ module Airbrake
       send_notice(exception, params, @sync_sender, &block).value
     end
 
-    # @deprecated Update the airbrake gem to v8.1.0 or higher
-    def notify_request(request_info, promise = Promise.new)
-      @config.logger.info(
-        "#{LOG_LABEL} #{self.class}##{__method__} is deprecated. Update " \
-        'the airbrake gem to v8.1.0 or higher'
-      )
-      @perf_notifier.notify(Request.new(request_info), promise)
-    end
-
     # @macro see_public_api_method
     def add_filter(filter = nil, &block)
       @filter_chain.add_filter(block_given? ? block : filter)
@@ -90,7 +59,7 @@ module Airbrake
         exception[:params].merge!(params)
         exception
       else
-        Notice.new(@config, convert_to_exception(exception), params.dup)
+        Notice.new(convert_to_exception(exception), params.dup)
       end
     end
 
@@ -143,7 +112,7 @@ module Airbrake
     def default_sender
       return @async_sender if @async_sender.has_workers?
 
-      @config.logger.warn(
+      logger.warn(
         "#{LOG_LABEL} falling back to sync delivery because there are no " \
         "running async workers"
       )
@@ -165,19 +134,15 @@ module Airbrake
       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)
-        )
+        add_filter(Airbrake::Filters::KeysWhitelist.new(whitelist_keys))
       end
 
       if (blacklist_keys = @config.blacklist_keys).any?
-        add_filter(
-          Airbrake::Filters::KeysBlacklist.new(@config.logger, blacklist_keys)
-        )
+        add_filter(Airbrake::Filters::KeysBlacklist.new(blacklist_keys))
       end
 
       add_filter(Airbrake::Filters::ContextFilter.new(@context))
-      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new(@config.logger))
+      add_filter(Airbrake::Filters::ExceptionAttributesFilter.new)
 
       return unless (root_directory = @config.root_directory)
       [
@@ -189,10 +154,9 @@ module Airbrake
       end
 
       add_filter(
-        Airbrake::Filters::GitLastCheckoutFilter.new(@config.logger, root_directory)
+        Airbrake::Filters::GitLastCheckoutFilter.new(root_directory)
       )
     end
     # rubocop:enable Metrics/AbcSize
   end
-  # rubocop:enable Metrics/ClassLength
 end