airbrake-ruby 4.8.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6fd7fd474a31d89d2b532d467f5c319399b183a5805488bbb57789bc502bef
-  data.tar.gz: 83493c7a39f6eea49668f7c94fc202c90d55efcc1d4822864a70cca03c96134f
+  metadata.gz: 8102082d97168a2204b3e730fc2085d30d06d4ab501e6207d91ce9d67bd91584
+  data.tar.gz: cf2234bd6fc61e439796b0f664163a12fdd4c39c4256a1c469f06dd1f8132de3
 SHA512:
-  metadata.gz: 149075c2e3a3cd9f43f19f7309f8b9e46aa36bde2994bc48b80c8b66a4c675d1fef2989e2020e5bc81dc55a8e8490f18aa445307dd2212f7c2467a3186fb1c8d
-  data.tar.gz: 030edc9303bd0f1042a6aa3f3ec5b672ab58598fee90a71e6d7f6a6fed84716d2043afab9edf46b3bdd6ee9939ef6b979ad78dc37575be774663ac84e8af73a7
+  metadata.gz: d5b353597aa2bf9d59fa454f8a6a87fadcdc71685a7e21ef3ec9f74e57b20268e5d6cad2d6d0fe061bdcdbe02e65cf2e5761d4e92c6370ea1d1316972da9d9af
+  data.tar.gz: d13b77d0f959ff3a5326f054b8df67c9402b216038afd25672df8b6803623ac135bb5366739687fc5c234ae2e127d075828f747bb945d9ba4d48f3f354775f17

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,8 +8,14 @@ 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/sync_sender'
@@ -23,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'
@@ -52,6 +57,7 @@ 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
@@ -69,6 +75,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)
@@ -80,6 +87,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
@@ -107,7 +121,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
@@ -131,7 +153,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.
@@ -250,11 +272,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
-      performance_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.
     #
@@ -317,9 +352,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.
@@ -332,8 +366,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
@@ -347,22 +380,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, 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.
@@ -372,29 +414,39 @@ 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] :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, 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
@@ -403,8 +455,7 @@ module Airbrake
     #     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
@@ -412,17 +463,65 @@ 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
 
+    # 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
     # is useful if you want to ignore specific resources or filter the data the
     # resource contains.
@@ -480,36 +579,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

data/lib/airbrake-ruby/async_sender.rb

@@ -7,12 +7,6 @@ module Airbrake
   class AsyncSender
     include Loggable
 
-    # @return [String]
-    WILL_NOT_DELIVER_MSG =
-      "%<log_label>s AsyncSender has reached its capacity of %<capacity>s " \
-      "and the following notice will not be delivered " \
-      "Error: %<type>s - %<message>s\nBacktrace: %<backtrace>s\n".freeze
-
     def initialize(method = :post)
       @config = Airbrake::Config.instance
       @method = method
@@ -20,12 +14,13 @@ module Airbrake
 
     # 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, endpoint = @config.endpoint)
-      unless thread_pool << [notice, promise, endpoint]
-        return will_not_deliver(notice, promise)
+    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
 
       promise
@@ -54,27 +49,9 @@ module Airbrake
         ThreadPool.new(
           worker_size: @config.workers,
           queue_size: @config.queue_size,
-          block: proc { |args| sender.send(*args) }
+          block: proc { |args| sender.send(*args) },
         )
       end
     end
-
-    def will_not_deliver(notice, promise)
-      error = notice[:errors].first
-
-      logger.error(
-        format(
-          WILL_NOT_DELIVER_MSG,
-          log_label: LOG_LABEL,
-          capacity: @config.queue_size,
-          type: error[:type],
-          message: error[:message],
-          backtrace: error[:backtrace].map do |line|
-            "#{line[:file]}:#{line[:line]} in `#{line[:function]}'"
-          end.join("\n")
-        )
-      )
-      promise.reject("AsyncSender has reached its capacity of #{@config.queue_size}")
-    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