airbrake-ruby 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25d739899ae0250aa01c5e81ab01d76bbcfac28d
-  data.tar.gz: fca6e05b839805cb5d4b4171145c1dfeb4b4890b
+SHA256:
+  metadata.gz: e98183a856071ce3d105c36adc9aa22a8ee7071b93958fd70fb673d2735b3977
+  data.tar.gz: 80464931a1362c4d845ffee737ed7aa1e46693136023b1f08006c49de98e62eb
 SHA512:
-  metadata.gz: 13fd52e48ce2f8405640785323f2cc330d9364496b58ce0b8fb416b28baff5584a95b97ded5441ee47aca872af43cf7251ebb7cfd6d3b1660c523ee774e6a870
-  data.tar.gz: d96f9bb73da48029a993bda925ec727a945177300721eb521f5966bac962f6d9ae2941cd191b4bc2d5497c07da7764c5d7c740bf5bb7fc0a30b61c50b263c08f
+  metadata.gz: 8c32fc631e3af6348a871094dde31452d4a6fdef834596933e179d2acdbbd4935751715007fa7c4dcfce3639ebbd55f61b15f06428015647e4cbcac590ef7aaf
+  data.tar.gz: 23968940c6f1dfb500be5ab479c1d524cdc9f80e40808b4ff08d7f4b03c97baad603d97504c58a5300ddfa7ec9b1a4b5bd44a24a6a4a15776a82778ef2a0c324

data/lib/airbrake-ruby/async_sender.rb

@@ -1,7 +1,5 @@
 module Airbrake
-  # Responsible for sending notices to Airbrake asynchronously. The class
-  # supports an unlimited number of worker threads and an unlimited queue size
-  # (both values are configurable).
+  # Responsible for sending notices to Airbrake asynchronously.
   #
   # @see SyncSender
   # @api private
@@ -9,123 +7,51 @@ module Airbrake
   class AsyncSender
     include Loggable
 
-    # @return [ThreadGroup] the list of workers
-    # @note This is exposed for eaiser unit testing
-    # @since v4.0.0
-    attr_reader :workers
-
-    # @return [Array<[Airbrake::Notice,Airbrake::Promise]>] the list of unsent
-    #   payload
-    # @note This is exposed for eaiser unit testing
-    # @since v4.0.0
-    attr_reader :unsent
-
-    def initialize
+    def initialize(method = :post)
       @config = Airbrake::Config.instance
-      @unsent = SizedQueue.new(Airbrake::Config.instance.queue_size)
-      @sender = SyncSender.new
-      @closed = false
-      @workers = ThreadGroup.new
-      @mutex = Mutex.new
-      @pid = nil
+      @method = method
     end
 
     # Asynchronously sends a notice to Airbrake.
     #
-    # @param [Airbrake::Notice] notice A notice that was generated by the
-    #   library
+    # @param [Hash] payload Whatever needs to be sent
     # @return [Airbrake::Promise]
-    def send(notice, promise)
-      return will_not_deliver(notice) if @unsent.size >= @unsent.max
+    def send(payload, promise, endpoint = @config.error_endpoint)
+      unless thread_pool << [payload, promise, endpoint]
+        return promise.reject(
+          "AsyncSender has reached its capacity of #{@config.queue_size}",
+        )
+      end
 
-      @unsent << [notice, promise]
       promise
     end
 
-    # Closes the instance making it a no-op (it shut downs all worker
-    # threads). Before closing, waits on all unsent notices to be sent.
-    #
     # @return [void]
-    # @raise [Airbrake::Error] when invoked more than one time
     def close
-      threads = @mutex.synchronize do
-        raise Airbrake::Error, 'attempted to close already closed sender' if closed?
-
-        unless @unsent.empty?
-          msg = "#{LOG_LABEL} waiting to send #{@unsent.size} unsent notice(s)..."
-          logger.debug(msg + ' (Ctrl-C to abort)')
-        end
-
-        @config.workers.times { @unsent << [:stop, Airbrake::Promise.new] }
-        @closed = true
-        @workers.list.dup
-      end
-
-      threads.each(&:join)
-      logger.debug("#{LOG_LABEL} closed")
+      thread_pool.close
     end
 
-    # Checks whether the sender is closed and thus usable.
     # @return [Boolean]
     def closed?
-      @closed
+      thread_pool.closed?
     end
 
-    # Checks if an active sender has any workers. A sender doesn't have any
-    # workers only in two cases: when it was closed or when all workers
-    # crashed. An *active* sender doesn't have any workers only when something
-    # went wrong.
-    #
-    # Workers are expected to crash when you +fork+ the process the workers are
-    # living in. In this case we detect a +fork+ and try to revive them here.
-    #
-    # Another possible scenario that crashes workers is when you close the
-    # instance on +at_exit+, but some other +at_exit+ hook prevents the process
-    # from exiting.
-    #
-    # @return [Boolean] true if an instance wasn't closed, but has no workers
-    # @see https://goo.gl/oydz8h Example of at_exit that prevents exit
+    # @return [Boolean]
     def has_workers?
-      @mutex.synchronize do
-        return false if @closed
-
-        if @pid != Process.pid && @workers.list.empty?
-          @pid = Process.pid
-          spawn_workers
-        end
-
-        !@closed && @workers.list.any?
-      end
+      thread_pool.has_workers?
     end
 
     private
 
-    def spawn_workers
-      @workers = ThreadGroup.new
-      @config.workers.times { @workers.add(spawn_worker) }
-      @workers.enclose
-    end
-
-    def spawn_worker
-      Thread.new do
-        while (message = @unsent.pop)
-          break if message.first == :stop
-          @sender.send(*message)
-        end
-      end
-    end
-
-    def will_not_deliver(notice)
-      backtrace = notice[:errors][0][:backtrace].map do |line|
-        "#{line[:file]}:#{line[:line]} in `#{line[:function]}'"
+    def thread_pool
+      @thread_pool ||= begin
+        sender = SyncSender.new(@method)
+        ThreadPool.new(
+          worker_size: @config.workers,
+          queue_size: @config.queue_size,
+          block: proc { |args| sender.send(*args) },
+        )
       end
-      logger.error(
-        "#{LOG_LABEL} AsyncSender has reached its capacity of "                   \
-        "#{@unsent.max} and the following notice will not be delivered "          \
-        "Error: #{notice[:errors][0][:type]} - #{notice[:errors][0][:message]}\n" \
-        "Backtrace: \n" + backtrace.join("\n")
-      )
-      nil
     end
   end
 end

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
 
@@ -147,13 +148,13 @@ module Airbrake
           return {
             file: match[:file],
             line: (Integer(match[:line]) if match[:line]),
-            function: match[:function]
+            function: match[:function],
           }
         end
 
         logger.error(
           "can't parse '#{stackframe}' (please file an issue so we can fix " \
-          "it: https://github.com/airbrake/airbrake-ruby/issues/new)"
+          "it: https://github.com/airbrake/airbrake-ruby/issues/new)",
         )
         { file: nil, line: nil, function: stackframe }
       end

data/lib/airbrake-ruby/benchmark.rb

@@ -0,0 +1,39 @@
+module Airbrake
+  # Benchmark benchmarks Ruby code.
+  #
+  # @since v4.2.4
+  # @api public
+  class Benchmark
+    # Measures monotonic time for the given operation.
+    #
+    # @yieldreturn [void]
+    def self.measure
+      benchmark = new
+
+      yield
+
+      benchmark.stop
+      benchmark.duration
+    end
+
+    # @return [Float]
+    attr_reader :duration
+
+    # @since v4.3.0
+    def initialize
+      @start = MonotonicTime.time_in_ms
+      @duration = 0.0
+    end
+
+    # Stops the benchmark and stores `duration`.
+    #
+    # @since v4.3.0
+    # @return [Boolean] true for the first invocation, false in all other cases
+    def stop
+      return false if @duration > 0.0
+
+      @duration = MonotonicTime.time_in_ms - @start
+      true
+    end
+  end
+end

data/lib/airbrake-ruby/code_hunk.rb

@@ -30,7 +30,7 @@ module Airbrake
       Airbrake::FileCache[file] ||= File.foreach(file)
     rescue StandardError => ex
       logger.error(
-        "#{self.class.name}: can't read code hunk for #{file}: #{ex}"
+        "#{self.class.name}: can't read code hunk for #{file}: #{ex}",
       )
       nil
     end

data/lib/airbrake-ruby/config/processor.rb

@@ -0,0 +1,84 @@
+module Airbrake
+  class Config
+    # Processor is a helper class, which is responsible for setting default
+    # config values, default notifier filters and remote configuration changes.
+    #
+    # @since 5.0.0
+    # @api private
+    class Processor
+      # @param [Airbrake::Config] config
+      # @return [Airbrake::Config::Processor]
+      def self.process(config)
+        new(config).process
+      end
+
+      # @param [Airbrake::Config] config
+      def initialize(config)
+        @config = config
+        @blocklist_keys = @config.blocklist_keys
+        @allowlist_keys = @config.allowlist_keys
+        @project_id = @config.project_id
+      end
+
+      # @param [Airbrake::NoticeNotifier] notifier
+      # @return [void]
+      def process_blocklist(notifier)
+        return if @blocklist_keys.none?
+
+        blocklist = Airbrake::Filters::KeysBlocklist.new(@blocklist_keys)
+        notifier.add_filter(blocklist)
+      end
+
+      # @param [Airbrake::NoticeNotifier] notifier
+      # @return [void]
+      def process_allowlist(notifier)
+        return if @allowlist_keys.none?
+
+        allowlist = Airbrake::Filters::KeysAllowlist.new(@allowlist_keys)
+        notifier.add_filter(allowlist)
+      end
+
+      # @return [Airbrake::RemoteSettings]
+      def process_remote_configuration
+        return unless @project_id
+
+        RemoteSettings.poll(
+          @project_id,
+          @config.remote_config_host,
+          &method(:poll_callback)
+        )
+      end
+
+      # @param [Airbrake::NoticeNotifier] notifier
+      # @return [void]
+      def add_filters(notifier)
+        return unless @config.root_directory
+
+        [
+          Airbrake::Filters::RootDirectoryFilter,
+          Airbrake::Filters::GitRevisionFilter,
+          Airbrake::Filters::GitRepositoryFilter,
+          Airbrake::Filters::GitLastCheckoutFilter,
+        ].each do |filter|
+          next if notifier.has_filter?(filter)
+
+          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

@@ -29,7 +29,7 @@ module Airbrake
             return promise.reject(
               "the 'environment' option must be configured " \
               "with a Symbol (or String), but '#{config.environment.class}' was " \
-              "provided: #{config.environment}"
+              "provided: #{config.environment}",
             )
           end
 
@@ -44,9 +44,13 @@ module Airbrake
         def check_notify_ability(config)
           promise = Airbrake::Promise.new
 
+          unless config.error_notifications
+            return promise.reject('error notifications are disabled')
+          end
+
           if ignored_environment?(config)
             return promise.reject(
-              "current environment '#{config.environment}' is ignored"
+              "current environment '#{config.environment}' is ignored",
             )
           end
 
@@ -57,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
 
@@ -74,7 +80,7 @@ module Airbrake
           if config.ignore_environments.any? && config.environment.nil?
             config.logger.warn(
               "#{LOG_LABEL} the 'environment' option is not set, " \
-              "'ignore_environments' has no effect"
+              "'ignore_environments' has no effect",
             )
           end
 

data/lib/airbrake-ruby/config.rb

@@ -46,6 +46,17 @@ module Airbrake
     # @api public
     attr_accessor :host
 
+    # @since v5.0.0
+    alias error_host host
+    # @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 v5.0.0
+    attr_accessor :apm_host
+
     # @return [String, Pathname] the working directory of your project
     # @api public
     attr_accessor :root_directory
@@ -68,14 +79,14 @@ module Airbrake
     # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since v1.2.0
-    attr_accessor :blacklist_keys
+    # @since v4.15.0
+    attr_accessor :allowlist_keys
 
-    # @return [Array<String, Symbol, Regexp>] the keys, which shouldn't be
+    # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since v1.2.0
-    attr_accessor :whitelist_keys
+    # @since v4.15.0
+    attr_accessor :blocklist_keys
 
     # @return [Boolean] true if the library should attach code hunks to each
     #   frame in a backtrace, false otherwise
@@ -83,20 +94,42 @@ module Airbrake
     # @since v2.5.0
     attr_accessor :code_hunks
 
-    # @return [Boolean] true if the library should send performance stats
-    #   information to Airbrake (routes, SQL queries), false otherwise
+    # @return [Boolean] true if the library should send route performance stats
+    #   to Airbrake, false otherwise
     # @api public
     # @since v3.2.0
     attr_accessor :performance_stats
 
     # @return [Integer] how many seconds to wait before sending collected route
     #   stats
-    # @api public
+    # @api private
     # @since v3.2.0
     attr_accessor :performance_stats_flush_period
 
+    # @return [Boolean] true if the library should send SQL stats to Airbrake,
+    #   false otherwise
+    # @api public
+    # @since v4.6.0
+    attr_accessor :query_stats
+
+    # @return [Boolean] true if the library should send job/queue/worker stats
+    #   to Airbrake, false otherwise
+    # @api public
+    # @since v4.12.0
+    attr_accessor :job_stats
+
+    # @return [Boolean] true if the library should send error reports to
+    #   Airbrake, false otherwise
+    # @api public
+    # @since 5.0.0
+    attr_accessor :error_notifications
+
+    # @return [String] the host such as which should be used for fetching remote
+    #   configuration options (example: "https://bucket-name.s3.amazonaws.com")
+    attr_accessor :remote_config_host
+
     class << self
-      # @param [Config] new_instance
+      # @return [Config]
       attr_writer :instance
 
       # @return [Config]
@@ -107,43 +140,50 @@ 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 = {})
       self.proxy = {}
       self.queue_size = 100
       self.workers = 1
       self.code_hunks = true
-      self.logger = ::Logger.new(File::NULL)
+      self.logger = ::Logger.new(File::NULL).tap { |l| l.level = Logger::WARN }
       self.project_id = user_config[:project_id]
       self.project_key = user_config[:project_key]
-      self.host = 'https://api.airbrake.io'
+      self.error_host = 'https://api.airbrake.io'
+      self.apm_host = 'https://api.airbrake.io'
+      self.remote_config_host = 'https://v1-production-notifier-configs.s3.amazonaws.com'
 
       self.ignore_environments = []
 
       self.timeout = user_config[:timeout]
 
-      self.blacklist_keys = []
-      self.whitelist_keys = []
+      self.blocklist_keys = []
+      self.allowlist_keys = []
 
       self.root_directory = File.realpath(
         (defined?(Bundler) && Bundler.root) ||
-        Dir.pwd
+        Dir.pwd,
       )
 
       self.versions = {}
-      self.performance_stats = false
+      self.performance_stats = true
       self.performance_stats_flush_period = 15
+      self.query_stats = true
+      self.job_stats = true
+      self.error_notifications = true
 
       merge(user_config)
     end
+    # rubocop:enable Metrics/AbcSize
 
-    # The full URL to the Airbrake Notice API. Based on the +:host+ option.
+    # The full URL to the Airbrake Notice API. Based on the +:error_host+ option.
     # @return [URI] the endpoint address
-    def endpoint
-      @endpoint ||=
+    def error_endpoint
+      @error_endpoint ||=
         begin
-          self.host = ('https://' << host) if host !~ %r{\Ahttps?://}
+          self.error_host = ('https://' << error_host) if error_host !~ %r{\Ahttps?://}
           api = "api/v3/projects/#{project_id}/notices"
-          URI.join(host, api)
+          URI.join(error_host, api)
         end
     end
 
@@ -197,6 +237,22 @@ module Airbrake
       check_notify_ability
     end
 
+    # @return [Promise] resolved promise if neither of the performance options
+    #   reject it, false otherwise
+    def check_performance_options(resource)
+      promise = Airbrake::Promise.new
+
+      if !performance_stats
+        promise.reject("The Performance Stats feature is disabled")
+      elsif resource.is_a?(Airbrake::Query) && !query_stats
+        promise.reject("The Query Stats feature is disabled")
+      elsif resource.is_a?(Airbrake::Queue) && !job_stats
+        promise.reject("The Job Stats feature is disabled")
+      else
+        promise
+      end
+    end
+
     private
 
     def set_option(option, value)

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.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 4.7.0
+    # @return [void]
+    def self.reset
+      @data = {}
+    end
+
     def self.data
       @data ||= {}
     end

data/lib/airbrake-ruby/filter_chain.rb

@@ -70,13 +70,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 +92,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/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

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