airbrake-ruby 4.6.0 → 6.2.2

data/lib/airbrake-ruby.rb

@@ -1,7 +1,6 @@
 require 'net/https'
 require 'logger'
 require 'json'
-require 'thread'
 require 'set'
 require 'socket'
 require 'time'
@@ -9,12 +8,19 @@ 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/callback'
+require 'airbrake-ruby/remote_settings/settings_data'
+require 'airbrake-ruby/remote_settings'
 require 'airbrake-ruby/promise'
+require 'airbrake-ruby/thread_pool'
+require 'airbrake-ruby/response'
 require 'airbrake-ruby/sync_sender'
 require 'airbrake-ruby/async_sender'
-require 'airbrake-ruby/response'
 require 'airbrake-ruby/nested_exception'
 require 'airbrake-ruby/ignorable'
 require 'airbrake-ruby/inspectable'
@@ -22,8 +28,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'
@@ -51,6 +57,9 @@ require 'airbrake-ruby/performance_breakdown'
 require 'airbrake-ruby/benchmark'
 require 'airbrake-ruby/monotonic_time'
 require 'airbrake-ruby/timed_trace'
+require 'airbrake-ruby/queue'
+require 'airbrake-ruby/context'
+require 'airbrake-ruby/backlog'
 
 # 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
@@ -68,6 +77,7 @@ require 'airbrake-ruby/timed_trace'
 #
 # @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)
@@ -79,6 +89,13 @@ module Airbrake
   #  special cases where we need to work around older implementations
   JRUBY = (RUBY_ENGINE == 'jruby')
 
+  # @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
@@ -106,7 +123,15 @@ module Airbrake
     def configure
       yield config = Airbrake::Config.instance
       Airbrake::Loggable.instance = config.logger
-      process_config_options(config)
+
+      config_processor = Airbrake::Config::Processor.new(config)
+
+      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
@@ -130,7 +155,7 @@ module Airbrake
     # @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.
@@ -249,10 +274,24 @@ module Airbrake
     #   Airbrake.close
     #   Airbrake.notify('App crashed!') #=> raises Airbrake::Error
     #
-    # @return [void]
+    # @return [nil]
+    # rubocop:disable Style/IfUnlessModifier
     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
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy.
     #
@@ -315,9 +354,8 @@ module Airbrake
       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.
@@ -327,40 +365,39 @@ module Airbrake
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     status_code: 200,
-    #     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
     # @option request_info [String] :method The HTTP method that was invoked
     # @option request_info [String] :route The route that was invoked
-    # @option request_info [Integer] :status_code The respose code that the
+    # @option request_info [Integer] :status_code The response code that the
     #   route returned
-    # @option request_info [String] :func The function that called the query
-    #   (optional)
-    # @option request_info [String] :file The file that has the function that
-    #   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, stash = {})
-      request = Request.new(request_info)
+      request = Request.new(**request_info)
       request.stash.merge!(stash)
       performance_notifier.notify(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.
+    # 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+. 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.
@@ -370,39 +407,57 @@ module Airbrake
     #     method: 'GET',
     #     route: '/things',
     #     query: 'SELECT * FROM things',
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     func: 'do_stuff',
+    #     file: 'app/models/foo.rb',
+    #     line: 452,
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] query_info
-    # @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 request_info [String] :func The function that called the query
+    #   (optional)
+    # @option request_info [String] :file The file that has the function that
+    #   called the query (optional)
+    # @option request_info [Integer] :line The line that executes the query
+    #   (optional)
+    # @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, stash = {})
-      query = Query.new(query_info)
+      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(
+    #   Airbrake.notify_performance_breakdown(
     #     method: 'POST',
     #     route: '/thing/:id/create',
     #     response_type: 'json',
     #     groups: { db: 24.0, view: 0.4 }, # ms
-    #     start_time: timestamp,
-    #     end_time: Time.now
+    #     timing: 123.45 # ms
     #   )
     #
     # @param [Hash{Symbol=>Object}] breakdown_info
@@ -410,35 +465,83 @@ module Airbrake
     # @option breakdown_info [String] :route
     # @option breakdown_info [String] :response_type
     # @option breakdown_info [Array<Hash{Symbol=>Float}>] :groups
-    # @option breakdown_info [Date] :start_time
+    # @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 = PerformanceBreakdown.new(**breakdown_info)
       performance_breakdown.stash.merge!(stash)
       performance_notifier.notify(performance_breakdown)
     end
 
-    # Runs a callback before {.notify_request} or {.notify_query} kicks in. This
-    # is useful if you want to ignore specific resources or filter the data the
-    # resource contains.
+    # 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}, {.notify_query}, {.notify_queue}
+    # or {.notify_performance_breakdown} kicks in. This is useful if you want to
+    # ignore specific metrics or filter the data the metric contains.
     #
-    # @example Ignore all resources
+    # @example Ignore all metrics
     #   Airbrake.add_performance_filter(&:ignore!)
     # @example Filter sensitive data
-    #   Airbrake.add_performance_filter do |resource|
-    #     case resource
+    #   Airbrake.add_performance_filter do |metric|
+    #     case metric
     #     when Airbrake::Query
-    #       resource.route = '[Filtered]'
+    #       metric.route = '[Filtered]'
     #     when Airbrake::Request
-    #       resource.query = '[Filtered]'
+    #       metric.query = '[Filtered]'
     #     end
     #   end
     # @example Filter with help of a class
     #   class MyFilter
-    #     def call(resource)
+    #     def call(metric)
     #       # ...
     #     end
     #   end
@@ -446,7 +549,7 @@ module Airbrake
     #   Airbrake.add_performance_filter(MyFilter.new)
     #
     # @param [#call] filter The filter object
-    # @yield [resource] The resource to filter
+    # @yield [metric] The metric to filter
     # @yieldparam [Airbrake::Query, Airbrake::Request]
     # @yieldreturn [void]
     # @return [void]
@@ -478,36 +581,12 @@ module Airbrake
     # @return [void]
     # @since v4.2.2
     def reset
-      close if notice_notifier && configured?
+      close
 
       self.performance_notifier = PerformanceNotifier.new
       self.notice_notifier = NoticeNotifier.new
       self.deploy_notifier = DeployNotifier.new
     end
-
-    private
-
-    def process_config_options(config)
-      if config.blacklist_keys.any?
-        blacklist = Airbrake::Filters::KeysBlacklist.new(config.blacklist_keys)
-        notice_notifier.add_filter(blacklist)
-      end
-
-      if config.whitelist_keys.any?
-        whitelist = Airbrake::Filters::KeysWhitelist.new(config.whitelist_keys)
-        notice_notifier.add_filter(whitelist)
-      end
-
-      return unless config.root_directory
-
-      [
-        Airbrake::Filters::RootDirectoryFilter,
-        Airbrake::Filters::GitRevisionFilter,
-        Airbrake::Filters::GitRepositoryFilter,
-        Airbrake::Filters::GitLastCheckoutFilter
-      ].each do |filter|
-        notice_notifier.add_filter(filter.new(config.root_directory))
-      end
-    end
   end
 end
+# rubocop:enable Metrics/ModuleLength