airbrake-ruby 4.1.0 → 5.0.0

data/lib/airbrake-ruby/timed_trace.rb

@@ -0,0 +1,58 @@
+module Airbrake
+  # TimedTrace represents a chunk of code performance of which was measured and
+  # stored under a label. The chunk is called a "span".
+  #
+  # @example
+  #   timed_trace = TimedTrace.new
+  #   timed_trace.span('http request') do
+  #     http.get('example.com')
+  #   end
+  #   timed_trace.spans #=> { 'http request' => 0.123 }
+  #
+  # @api public
+  # @since v4.3.0
+  class TimedTrace
+    # @param [String] label
+    # @return [Airbrake::TimedTrace]
+    def self.span(label, &block)
+      new.tap { |timed_trace| timed_trace.span(label, &block) }
+    end
+
+    def initialize
+      @spans = {}
+    end
+
+    # @param [String] label
+    # @return [Boolean]
+    def span(label)
+      start_span(label)
+      yield
+      stop_span(label)
+    end
+
+    # @param [String] label
+    # @return [Boolean]
+    def start_span(label)
+      return false if @spans.key?(label)
+
+      @spans[label] = Airbrake::Benchmark.new
+      true
+    end
+
+    # @param [String] label
+    # @return [Boolean]
+    def stop_span(label)
+      return false unless @spans.key?(label)
+
+      @spans[label].stop
+      true
+    end
+
+    # @return [Hash<String=>Float>]
+    def spans
+      @spans.each_with_object({}) do |(label, benchmark), new_spans|
+        new_spans[label] = benchmark.duration
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/truncator.rb

@@ -12,6 +12,10 @@ module Airbrake
     #   strings with +ENCODING_OPTIONS+
     TEMP_ENCODING = 'utf-16'.freeze
 
+    # @return [Array<Encoding>] encodings that are eligible for fixing invalid
+    #   characters
+    SUPPORTED_ENCODINGS = [Encoding::UTF_8, Encoding::ASCII].freeze
+
     # @return [String] what to append when something is a circular reference
     CIRCULAR = '[Circular]'.freeze
 
@@ -35,6 +39,7 @@ module Airbrake
     def truncate(object, seen = Set.new)
       if seen.include?(object.object_id)
         return CIRCULAR if CIRCULAR_TYPES.any? { |t| object.is_a?(t) }
+
         return object
       end
       truncate_object(object, seen << object.object_id)
@@ -63,6 +68,7 @@ module Airbrake
     def truncate_string(str)
       fixed_str = replace_invalid_characters(str)
       return fixed_str if fixed_str.length <= @max_size
+
       (fixed_str.slice(0, @max_size) + TRUNCATED).freeze
     end
 
@@ -76,6 +82,7 @@ module Airbrake
       truncated_hash = {}
       hash.each_with_index do |(key, val), idx|
         break if idx + 1 > @max_size
+
         truncated_hash[key] = truncate(val, seen)
       end
 
@@ -103,13 +110,12 @@ module Airbrake
     # @return [String] a UTF-8 encoded string
     # @see https://github.com/flori/json/commit/3e158410e81f94dbbc3da6b7b35f4f64983aa4e3
     def replace_invalid_characters(str)
-      encoding = str.encoding
-      utf8_string = (encoding == Encoding::UTF_8 || encoding == Encoding::ASCII)
+      utf8_string = SUPPORTED_ENCODINGS.include?(str.encoding)
       return str if utf8_string && str.valid_encoding?
 
       temp_str = str.dup
-      temp_str.encode!(TEMP_ENCODING, ENCODING_OPTIONS) if utf8_string
-      temp_str.encode!('utf-8', ENCODING_OPTIONS)
+      temp_str.encode!(TEMP_ENCODING, **ENCODING_OPTIONS) if utf8_string
+      temp_str.encode!('utf-8', **ENCODING_OPTIONS)
     end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,15 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.1.0'.freeze
+  # @api public
+  AIRBRAKE_RUBY_VERSION = '5.0.0'.freeze
+
+  # @return [Hash{Symbol=>String}] the information about the notifier library
+  # @since 5.0.0
+  # @api public
+  NOTIFIER_INFO = {
+    name: 'airbrake-ruby'.freeze,
+    version: Airbrake::AIRBRAKE_RUBY_VERSION,
+    url: 'https://github.com/airbrake/airbrake-ruby'.freeze,
+  }.freeze
 end

data/lib/airbrake-ruby.rb

@@ -1,16 +1,22 @@
 require 'net/https'
 require 'logger'
 require 'json'
-require 'thread'
 require 'set'
 require 'socket'
 require 'time'
 
 require 'airbrake-ruby/version'
 require 'airbrake-ruby/loggable'
+require 'airbrake-ruby/stashable'
+require 'airbrake-ruby/mergeable'
+require 'airbrake-ruby/grouppable'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
+require 'airbrake-ruby/config/processor'
+require 'airbrake-ruby/remote_settings/settings_data'
+require 'airbrake-ruby/remote_settings'
 require 'airbrake-ruby/promise'
+require 'airbrake-ruby/thread_pool'
 require 'airbrake-ruby/sync_sender'
 require 'airbrake-ruby/async_sender'
 require 'airbrake-ruby/response'
@@ -21,8 +27,8 @@ require 'airbrake-ruby/notice'
 require 'airbrake-ruby/backtrace'
 require 'airbrake-ruby/truncator'
 require 'airbrake-ruby/filters/keys_filter'
-require 'airbrake-ruby/filters/keys_whitelist'
-require 'airbrake-ruby/filters/keys_blacklist'
+require 'airbrake-ruby/filters/keys_allowlist'
+require 'airbrake-ruby/filters/keys_blocklist'
 require 'airbrake-ruby/filters/gem_root_filter'
 require 'airbrake-ruby/filters/system_exit_filter'
 require 'airbrake-ruby/filters/root_directory_filter'
@@ -46,6 +52,11 @@ require 'airbrake-ruby/time_truncate'
 require 'airbrake-ruby/tdigest'
 require 'airbrake-ruby/query'
 require 'airbrake-ruby/request'
+require 'airbrake-ruby/performance_breakdown'
+require 'airbrake-ruby/benchmark'
+require 'airbrake-ruby/monotonic_time'
+require 'airbrake-ruby/timed_trace'
+require 'airbrake-ruby/queue'
 
 # Airbrake is a thin wrapper around instances of the notifier classes (such as
 # notice, performance & deploy notifiers). It creates a way to access them via a
@@ -63,6 +74,7 @@ require 'airbrake-ruby/request'
 #
 # @since v1.0.0
 # @api public
+# rubocop:disable Metrics/ModuleLength
 module Airbrake
   # The general error that this library uses when it wants to raise.
   Error = Class.new(StandardError)
@@ -74,14 +86,26 @@ module Airbrake
   #  special cases where we need to work around older implementations
   JRUBY = (RUBY_ENGINE == 'jruby')
 
-  # @!macro see_public_api_method
-  #   @see Airbrake.$0
-
-  @performance_notifier = PerformanceNotifier.new
-  @notice_notifier = NoticeNotifier.new
-  @deploy_notifier = DeployNotifier.new
+  # @return [Boolean] true if this Ruby supports safe levels and tainting,
+  #  to guard against using deprecated or unsupported features.
+  HAS_SAFE_LEVEL = (
+    RUBY_ENGINE == 'ruby' &&
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
+  )
 
   class << self
+    # @since v4.2.3
+    # @api private
+    attr_writer :performance_notifier
+
+    # @since v4.2.3
+    # @api private
+    attr_writer :notice_notifier
+
+    # @since v4.2.3
+    # @api private
+    attr_writer :deploy_notifier
+
     # Configures the Airbrake notifier.
     #
     # @example
@@ -90,28 +114,45 @@ module Airbrake
     #     c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
     #   end
     #
-    # @yield [config] The configuration object
+    # @yield [config]
     # @yieldparam config [Airbrake::Config]
     # @return [void]
-    # @raise [Airbrake::Error] when trying to reconfigure already
-    #   existing notifier
-    # @raise [Airbrake::Error] when either +project_id+ or +project_key+
-    #   is missing (or both)
-    # @note There's no way to read config values outside of this library
     def configure
       yield config = Airbrake::Config.instance
+      Airbrake::Loggable.instance = config.logger
 
-      if (result = config.validate).rejected?
-        raise Airbrake::Error, result.value['error']
-      end
+      config_processor = Airbrake::Config::Processor.new(config)
 
-      Airbrake::Loggable.instance = config.logger
+      config_processor.process_blocklist(notice_notifier)
+      config_processor.process_allowlist(notice_notifier)
+
+      @remote_settings ||= config_processor.process_remote_configuration
+
+      config_processor.add_filters(notice_notifier)
+    end
+
+    # @since v4.2.3
+    # @api private
+    def performance_notifier
+      @performance_notifier ||= PerformanceNotifier.new
+    end
+
+    # @since v4.2.3
+    # @api private
+    def notice_notifier
+      @notice_notifier ||= NoticeNotifier.new
+    end
+
+    # @since v4.2.3
+    # @api private
+    def deploy_notifier
+      @deploy_notifier ||= DeployNotifier.new
     end
 
     # @return [Boolean] true if the notifier was configured, false otherwise
     # @since v2.3.0
     def configured?
-      @notice_notifier.configured?
+      @notice_notifier && @notice_notifier.configured?
     end
 
     # Sends an exception to Airbrake asynchronously.
@@ -136,7 +177,7 @@ module Airbrake
     # @return [Airbrake::Promise]
     # @see .notify_sync
     def notify(exception, params = {}, &block)
-      @notice_notifier.notify(exception, params, &block)
+      notice_notifier.notify(exception, params, &block)
     end
 
     # Sends an exception to Airbrake synchronously.
@@ -156,7 +197,7 @@ module Airbrake
     # @return [Airbrake::Promise] the reponse from the server
     # @see .notify
     def notify_sync(exception, params = {}, &block)
-      @notice_notifier.notify_sync(exception, params, &block)
+      notice_notifier.notify_sync(exception, params, &block)
     end
 
     # Runs a callback before {.notify} or {.notify_sync} kicks in. This is
@@ -184,7 +225,7 @@ module Airbrake
     # @yieldreturn [void]
     # @return [void]
     def add_filter(filter = nil, &block)
-      @notice_notifier.add_filter(filter, &block)
+      notice_notifier.add_filter(filter, &block)
     end
 
     # Deletes a filter added via {Airbrake#add_filter}.
@@ -201,7 +242,7 @@ module Airbrake
     # @since v3.1.0
     # @note This method cannot delete filters assigned via the Proc form.
     def delete_filter(filter_class)
-      @notice_notifier.delete_filter(filter_class)
+      notice_notifier.delete_filter(filter_class)
     end
 
     # Builds an Airbrake notice. This is useful, if you want to add or modify a
@@ -219,7 +260,7 @@ module Airbrake
     # @return [Airbrake::Notice] the notice built with help of the given
     #   arguments
     def build_notice(exception, params = {})
-      @notice_notifier.build_notice(exception, params)
+      notice_notifier.build_notice(exception, params)
     end
 
     # Makes the notice notifier a no-op, which means you cannot use the
@@ -230,10 +271,24 @@ module Airbrake
     #   Airbrake.close
     #   Airbrake.notify('App crashed!') #=> raises Airbrake::Error
     #
-    # @return [void]
+    # @return [nil]
+    # rubocop:disable Style/IfUnlessModifier, Metrics/CyclomaticComplexity
     def close
-      @notice_notifier.close
+      if defined?(@notice_notifier) && @notice_notifier
+        @notice_notifier.close
+      end
+
+      if defined?(@performance_notifier) && @performance_notifier
+        @performance_notifier.close
+      end
+
+      if defined?(@remote_settings) && @remote_settings
+        @remote_settings.stop_polling
+      end
+
+      nil
     end
+    # rubocop:enable Style/IfUnlessModifier, Metrics/CyclomaticComplexity
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy.
     #
@@ -245,7 +300,7 @@ module Airbrake
     # @option deploy_info [Symbol] :version
     # @return [void]
     def notify_deploy(deploy_info)
-      @deploy_notifier.notify(deploy_info)
+      deploy_notifier.notify(deploy_info)
     end
 
     # Merges +context+ with the current context.
@@ -293,12 +348,11 @@ module Airbrake
     # @param [Hash{Symbol=>Object}] context
     # @return [void]
     def merge_context(context)
-      @notice_notifier.merge_context(context)
+      notice_notifier.merge_context(context)
     end
 
-    # Increments request statistics of a certain +route+ that was invoked on
-    # +start_time+ and ended on +end_time+ with +method+, and returned
-    # +status_code+.
+    # Increments request statistics of a certain +route+ invoked with +method+,
+    # which returned +status_code+.
     #
     # After a certain amount of time (n seconds) the aggregated route
     # information will be sent to Airbrake.
@@ -311,8 +365,7 @@ module Airbrake
     #     func: 'do_stuff',
     #     file: 'app/models/foo.rb',
     #     line: 452,
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] request_info
@@ -326,18 +379,31 @@ module Airbrake
     #   called the query (optional)
     # @option request_info [Integer] :line The line that executes the query
     #   (optional)
-    # @option request_info [Date] :start_time When the request started
-    # @option request_info [Time] :end_time When the request ended (optional)
+    # @option request_info [Float] :timing  How much time it took to process the
+    #   request (in ms)
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
     # @return [void]
     # @since v3.0.0
     # @see Airbrake::PerformanceNotifier#notify
-    def notify_request(request_info)
-      @performance_notifier.notify(Request.new(request_info))
+    def notify_request(request_info, stash = {})
+      request = Request.new(**request_info)
+      request.stash.merge!(stash)
+      performance_notifier.notify(request)
+    end
+
+    # Synchronously increments request statistics of a certain +route+ invoked
+    # with +method+, which returned +status_code+.
+    # @since v4.10.0
+    # @see .notify_request
+    def notify_request_sync(request_info, stash = {})
+      request = Request.new(**request_info)
+      request.stash.merge!(stash)
+      performance_notifier.notify_sync(request)
     end
 
-    # Increments SQL statistics of a certain +query+ that was invoked on
-    # +start_time+ and finished on +end_time+. When +method+ and +route+ are
-    # provided, the query is grouped by these parameters.
+    # Increments SQL statistics of a certain +query+. When +method+ and +route+
+    # are provided, the query is grouped by these parameters.
     #
     # After a certain amount of time (n seconds) the aggregated query
     # information will be sent to Airbrake.
@@ -347,24 +413,112 @@ module Airbrake
     #     method: 'GET',
     #     route: '/things',
     #     query: 'SELECT * FROM things',
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] query_info
-    # @option request_info [String] :environment (optional)
-    # @option request_info [String] :method The HTTP method that triggered this
+    # @option query_info [String] :method The HTTP method that triggered this
     #   SQL query (optional)
-    # @option request_info [String] :route The route that triggered this SQL
+    # @option query_info [String] :route The route that triggered this SQL
     #    query (optional)
-    # @option request_info [String] :query The query that was executed
-    # @option request_info [Date] :start_time When the query started executing
-    # @option request_info [Time] :end_time When the query finished (optional)
+    # @option query_info [String] :query The query that was executed
+    # @option query_info [Float] :timing How much time it took to process the
+    #   query (in ms)
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
     # @return [void]
     # @since v3.2.0
     # @see Airbrake::PerformanceNotifier#notify
-    def notify_query(query_info)
-      @performance_notifier.notify(Query.new(query_info))
+    def notify_query(query_info, stash = {})
+      query = Query.new(**query_info)
+      query.stash.merge!(stash)
+      performance_notifier.notify(query)
+    end
+
+    # Synchronously increments SQL statistics of a certain +query+. When
+    # +method+ and +route+ are provided, the query is grouped by these
+    # parameters.
+    # @since v4.10.0
+    # @see .notify_query
+    def notify_query_sync(query_info, stash = {})
+      query = Query.new(**query_info)
+      query.stash.merge!(stash)
+      performance_notifier.notify_sync(query)
+    end
+
+    # Increments performance breakdown statistics of a certain route.
+    #
+    # @example
+    #   Airbrake.notify_request(
+    #     method: 'POST',
+    #     route: '/thing/:id/create',
+    #     response_type: 'json',
+    #     groups: { db: 24.0, view: 0.4 }, # ms
+    #     timing: 123.45 # ms
+    #   )
+    #
+    # @param [Hash{Symbol=>Object}] breakdown_info
+    # @option breakdown_info [String] :method HTTP method
+    # @option breakdown_info [String] :route
+    # @option breakdown_info [String] :response_type
+    # @option breakdown_info [Array<Hash{Symbol=>Float}>] :groups
+    # @option breakdown_info [Float] :timing How much time it took to process
+    #   the performance breakdown (in ms)
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
+    # @return [void]
+    # @since v4.2.0
+    def notify_performance_breakdown(breakdown_info, stash = {})
+      performance_breakdown = PerformanceBreakdown.new(**breakdown_info)
+      performance_breakdown.stash.merge!(stash)
+      performance_notifier.notify(performance_breakdown)
+    end
+
+    # Increments performance breakdown statistics of a certain route
+    # synchronously.
+    # @since v4.10.0
+    # @see .notify_performance_breakdown
+    def notify_performance_breakdown_sync(breakdown_info, stash = {})
+      performance_breakdown = PerformanceBreakdown.new(**breakdown_info)
+      performance_breakdown.stash.merge!(stash)
+      performance_notifier.notify_sync(performance_breakdown)
+    end
+
+    # Increments statistics of a certain queue (worker).
+    #
+    # @example
+    #   Airbrake.notify_queue(
+    #     queue: 'emails',
+    #     error_count: 1,
+    #     groups: { redis: 24.0, sql: 0.4 } # ms
+    #   )
+    #
+    # @param [Hash{Symbol=>Object}] queue_info
+    # @option queue_info [String] :queue The name of the queue/worker
+    # @option queue_info [Integer] :error_count How many times this worker
+    #   failed
+    # @option queue_info [Array<Hash{Symbol=>Float}>] :groups Where the job
+    #   spent its time
+    # @option breakdown_info [Float] :timing How much time it took to process
+    #   the queue (in ms)
+    # @param [Hash] stash What needs to be appended to the stash, so it's
+    #   available in filters
+    # @return [void]
+    # @since v4.9.0
+    # @see .notify_queue_sync
+    def notify_queue(queue_info, stash = {})
+      queue = Queue.new(**queue_info)
+      queue.stash.merge!(stash)
+      performance_notifier.notify(queue)
+    end
+
+    # Increments statistics of a certain queue (worker) synchronously.
+    # @since v4.10.0
+    # @see .notify_queue
+    def notify_queue_sync(queue_info, stash = {})
+      queue = Queue.new(**queue_info)
+      queue.stash.merge!(stash)
+      performance_notifier.notify_sync(queue)
     end
 
     # Runs a callback before {.notify_request} or {.notify_query} kicks in. This
@@ -399,7 +553,7 @@ module Airbrake
     # @since v3.2.0
     # @see Airbrake::PerformanceNotifier#add_filter
     def add_performance_filter(filter = nil, &block)
-      @performance_notifier.add_filter(filter, &block)
+      performance_notifier.add_filter(filter, &block)
     end
 
     # Deletes a filter added via {Airbrake#add_performance_filter}.
@@ -417,7 +571,19 @@ module Airbrake
     # @note This method cannot delete filters assigned via the Proc form.
     # @see Airbrake::PerformanceNotifier#delete_filter
     def delete_performance_filter(filter_class)
-      @performance_notifier.delete_filter(filter_class)
+      performance_notifier.delete_filter(filter_class)
+    end
+
+    # Resets all notifiers, including its filters
+    # @return [void]
+    # @since v4.2.2
+    def reset
+      close
+
+      self.performance_notifier = PerformanceNotifier.new
+      self.notice_notifier = NoticeNotifier.new
+      self.deploy_notifier = DeployNotifier.new
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength