airbrake-ruby 2.9.0 → 2.10.0

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

@@ -1,36 +1,29 @@
 module Airbrake
   class Config
-    ##
     # Validates values of {Airbrake::Config} options.
     #
     # @api private
     # @since v1.5.0
     class Validator
-      ##
       # @return [String]
       REQUIRED_KEY_MSG = ':project_key is required'.freeze
 
-      ##
       # @return [String]
       REQUIRED_ID_MSG = ':project_id is required'.freeze
 
-      ##
       # @return [String]
       WRONG_ENV_TYPE_MSG = "the 'environment' option must be configured " \
                            "with a Symbol (or String), but '%s' was provided: " \
                            '%s'.freeze
 
-      ##
       # @return [Array<Class>] the list of allowed types to configure the
       #   environment option
       VALID_ENV_TYPES = [NilClass, String, Symbol].freeze
 
-      ##
       # @return [String] error message, if validator was able to find any errors
       #   in the config
       attr_reader :error_message
 
-      ##
       # Validates given config and stores error message, if any errors were
       # found.
       #
@@ -40,7 +33,6 @@ module Airbrake
         @error_message = nil
       end
 
-      ##
       # @return [Boolean]
       def valid_project_id?
         valid = @config.project_id.to_i > 0
@@ -48,7 +40,6 @@ module Airbrake
         valid
       end
 
-      ##
       # @return [Boolean]
       def valid_project_key?
         valid = @config.project_key.is_a?(String) && !@config.project_key.empty?
@@ -56,7 +47,6 @@ module Airbrake
         valid
       end
 
-      ##
       # @return [Boolean]
       def valid_environment?
         environment = @config.environment

data/lib/airbrake-ruby/file_cache.rb

@@ -1,19 +1,15 @@
 module Airbrake
-  ##
   # Extremely simple global cache.
   #
   # @api private
   # @since v2.4.1
   module FileCache
-    ##
     # @return [Integer]
     MAX_SIZE = 50
 
-    ##
     # @return [Mutex]
     MUTEX = Mutex.new
 
-    ##
     # Associates the value given by +value+ with the key given by +key+. Deletes
     # entries that exceed +MAX_SIZE+.
     #
@@ -27,7 +23,6 @@ module Airbrake
       end
     end
 
-    ##
     # Retrieve an object from the cache.
     #
     # @param [Object] key
@@ -38,7 +33,6 @@ module Airbrake
       end
     end
 
-    ##
     # Checks whether the cache is empty. Needed only for the test suite.
     #
     # @return [Boolean]

data/lib/airbrake-ruby/filter_chain.rb

@@ -1,5 +1,4 @@
 module Airbrake
-  ##
   # Represents the mechanism for filtering notices. Defines a few default
   # filters.
   #
@@ -7,7 +6,6 @@ module Airbrake
   # @api private
   # @since v1.0.0
   class FilterChain
-    ##
     # @return [Array<Class>] filters to be executed first
     DEFAULT_FILTERS = [
       Airbrake::Filters::SystemExitFilter,
@@ -17,7 +15,6 @@ module Airbrake
       # Airbrake::Filters::ThreadFilter
     ].freeze
 
-    ##
     # @return [Integer]
     DEFAULT_WEIGHT = 0
 
@@ -26,7 +23,6 @@ module Airbrake
       DEFAULT_FILTERS.each { |f| add_filter(f.new) }
     end
 
-    ##
     # Adds a filter to the filter chain. Sorts filters by weight.
     #
     # @param [#call] filter The filter object (proc, class, module, etc)
@@ -37,7 +33,6 @@ module Airbrake
       end.reverse!
     end
 
-    ##
     # Applies all the filters in the filter chain to the given notice. Does not
     # filter ignored notices.
     #

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

@@ -15,6 +15,7 @@ module Airbrake
         @mutex = Mutex.new
       end
 
+      # @macro call_filter
       def call(notice)
         @mutex.synchronize do
           return if @context.empty?

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

@@ -0,0 +1,31 @@
+module Airbrake
+  module Filters
+    # Attaches loaded dependencies to the notice object.
+    #
+    # @api private
+    # @since v2.10.0
+    class DependencyFilter
+      def initialize
+        @weight = 117
+      end
+
+      # @macro call_filter
+      def call(notice)
+        deps = {}
+        Gem.loaded_specs.map.with_object(deps) do |(name, spec), h|
+          h[name] = "#{spec.version}#{git_version(spec)}"
+        end
+
+        notice[:context][:versions] = {} unless notice[:context].key?(:versions)
+        notice[:context][:versions][:dependencies] = deps
+      end
+
+      private
+
+      def git_version(spec)
+        return unless spec.respond_to?(:git_version) || spec.git_version
+        spec.git_version.to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Airbrake
+  module Filters
+    # ExceptionAttributesFilter attempts to call `#to_airbrake` on the stashed
+    # exception and attaches returned data to the notice object.
+    #
+    # @api private
+    # @since v2.10.0
+    class ExceptionAttributesFilter
+      def initialize(logger)
+        @logger = logger
+        @weight = 118
+      end
+
+      # @macro call_filter
+      def call(notice)
+        exception = notice.stash[:exception]
+        return unless exception.respond_to?(:to_airbrake)
+
+        attributes = nil
+        begin
+          attributes = exception.to_airbrake
+        rescue StandardError => ex
+          @logger.error(
+            "#{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}"
+          )
+          return
+        end
+
+        attributes.each do |key, attrs|
+          if notice[key]
+            notice[key].merge!(attrs)
+          else
+            notice[key] = attrs
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,13 +1,11 @@
 module Airbrake
   module Filters
-    ##
     # Replaces paths to gems with a placeholder.
+    # @api private
     class GemRootFilter
-      ##
       # @return [String]
       GEM_ROOT_LABEL = '/GEM_ROOT'.freeze
 
-      ##
       # @return [Integer]
       attr_reader :weight
 
@@ -15,6 +13,7 @@ module Airbrake
         @weight = 120
       end
 
+      # @macro call_filter
       def call(notice)
         return unless defined?(Gem)
 

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

@@ -1,6 +1,5 @@
 module Airbrake
   module Filters
-    ##
     # A default Airbrake notice filter. Filters only specific keys listed in the
     # list of parameters in the payload of a notice.
     #
@@ -26,6 +25,7 @@ module Airbrake
     #
     # @see KeysWhitelist
     # @see KeysFilter
+    # @api private
     class KeysBlacklist
       include KeysFilter
 
@@ -34,7 +34,6 @@ module Airbrake
         @weight = -110
       end
 
-      ##
       # @return [Boolean] true if the key matches at least one pattern, false
       #   otherwise
       def should_filter?(key)

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

@@ -1,6 +1,7 @@
 module Airbrake
+  # Namespace for all standard filters. Custom filters can also go under this
+  # namespace.
   module Filters
-    ##
     # This is a filter helper that endows a class ability to filter notices'
     # payload based on the return value of the +should_filter?+ method that a
     # class that includes this module must implement.
@@ -8,31 +9,26 @@ module Airbrake
     # @see Notice
     # @see KeysWhitelist
     # @see KeysBlacklist
+    # @api private
     module KeysFilter
-      ##
       # @return [String] The label to replace real values of filtered payload
       FILTERED = '[Filtered]'.freeze
 
-      ##
       # @return [Array<String,Symbol,Regexp>] the array of classes instances of
       #   which can compared with payload keys
       VALID_PATTERN_CLASSES = [String, Symbol, Regexp].freeze
 
-      ##
       # @return [Array<Symbol>] parts of a Notice's payload that can be modified
       #   by blacklist/whitelist filters
       FILTERABLE_KEYS = %i[environment session params].freeze
 
-      ##
       # @return [Array<Symbol>] parts of a Notice's *context* payload that can
       #   be modified by blacklist/whitelist filters
       FILTERABLE_CONTEXT_KEYS = %i[user headers].freeze
 
-      ##
       # @return [Integer]
       attr_reader :weight
 
-      ##
       # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
@@ -44,13 +40,13 @@ module Airbrake
         @valid_patterns = false
       end
 
-      ##
-      # This is a mandatory method required by any filter integrated with
-      # FilterChain.
+      # @!macro call_filter
+      #   This is a mandatory method required by any filter integrated with
+      #   FilterChain.
       #
-      # @param [Notice] notice the notice to be filtered
-      # @return [void]
-      # @see FilterChain
+      #   @param [Notice] notice the notice to be filtered
+      #   @return [void]
+      #   @see FilterChain
       def call(notice)
         unless @valid_patterns
           eval_proc_patterns!
@@ -64,7 +60,6 @@ module Airbrake
         filter_url(notice)
       end
 
-      ##
       # @raise [NotImplementedError] if called directly
       def should_filter?(_key)
         raise NotImplementedError, 'method must be implemented in the included class'

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

@@ -1,6 +1,5 @@
 module Airbrake
   module Filters
-    ##
     # A default Airbrake notice filter. Filters everything in the payload of a
     # notice, but specified keys.
     #
@@ -34,7 +33,6 @@ module Airbrake
         @weight = -100
       end
 
-      ##
       # @return [Boolean] true if the key doesn't match any pattern, false
       #   otherwise.
       def should_filter?(key)

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

@@ -1,13 +1,11 @@
 module Airbrake
   module Filters
-    ##
     # Replaces root directory with a label.
+    # @api private
     class RootDirectoryFilter
-      ##
       # @return [String]
       PROJECT_ROOT_LABEL = '/PROJECT_ROOT'.freeze
 
-      ##
       # @return [Integer]
       attr_reader :weight
 
@@ -16,6 +14,7 @@ module Airbrake
         @weight = 100
       end
 
+      # @macro call_filter
       def call(notice)
         notice[:errors].each do |error|
           error[:backtrace].each do |frame|

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

@@ -1,13 +1,11 @@
 module Airbrake
   module Filters
-    ##
     # Skip over SystemExit exceptions, because they're just noise.
+    # @api private
     class SystemExitFilter
-      ##
       # @return [String]
       SYSTEM_EXIT_TYPE = 'SystemExit'.freeze
 
-      ##
       # @return [Integer]
       attr_reader :weight
 
@@ -15,6 +13,7 @@ module Airbrake
         @weight = 130
       end
 
+      # @macro call_filter
       def call(notice)
         return if notice[:errors].none? { |error| error[:type] == SYSTEM_EXIT_TYPE }
         notice.ignore!

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

@@ -1,14 +1,12 @@
 module Airbrake
   module Filters
-    ##
     # Attaches thread & fiber local variables along with general thread
     # information.
+    # @api private
     class ThreadFilter
-      ##
       # @return [Integer]
       attr_reader :weight
 
-      ##
       # @return [Array<Class>] the list of classes that can be safely converted
       #   to JSON
       SAFE_CLASSES = [
@@ -21,7 +19,6 @@ module Airbrake
         Numeric
       ].freeze
 
-      ##
       # Variables starting with this prefix are not attached to a notice.
       # @see https://github.com/airbrake/airbrake-ruby/issues/229
       # @return [String]
@@ -31,6 +28,7 @@ module Airbrake
         @weight = 110
       end
 
+      # @macro call_filter
       def call(notice)
         th = Thread.current
         thread_info = {}

data/lib/airbrake-ruby/nested_exception.rb

@@ -1,12 +1,10 @@
 module Airbrake
-  ##
   # A class that is capable of unwinding nested exceptions and representing them
   # as JSON-like hash.
   #
   # @api private
   # @since v1.0.4
   class NestedException
-    ##
     # @return [Integer] the maximum number of nested exceptions that a notice
     #   can unwrap. Exceptions that have a longer cause chain will be ignored
     MAX_NESTED_EXCEPTIONS = 3

data/lib/airbrake-ruby/notice.rb

@@ -1,11 +1,9 @@
 module Airbrake
-  ##
   # Represents a chunk of information that is meant to be either sent to
   # Airbrake or ignored completely.
   #
   # @since v1.0.0
   class Notice
-    ##
     # @return [Hash{Symbol=>String}] the information about the notifier library
     NOTIFIER = {
       name: 'airbrake-ruby'.freeze,
@@ -13,7 +11,6 @@ module Airbrake
       url: 'https://github.com/airbrake/airbrake-ruby'.freeze
     }.freeze
 
-    ##
     # @return [Hash{Symbol=>String,Hash}] the information to be displayed in the
     #   Context tab in the dashboard
     CONTEXT = {
@@ -22,16 +19,13 @@ module Airbrake
       notifier: NOTIFIER
     }.freeze
 
-    ##
     # @return [Integer] the maxium size of the JSON payload in bytes
     MAX_NOTICE_SIZE = 64000
 
-    ##
     # @return [Integer] the maximum size of hashes, arrays and strings in the
     #   notice.
     PAYLOAD_MAX_SIZE = 10000
 
-    ##
     # @return [Array<StandardError>] the list of possible exceptions that might
     #   be raised when an object is converted to JSON
     JSON_EXCEPTIONS = [
@@ -45,25 +39,22 @@ module Airbrake
     #   {Airbrake::Notice#[]=}
     WRITABLE_KEYS = %i[notifier context environment session params].freeze
 
-    ##
     # @return [Array<Symbol>] parts of a Notice's payload that can be modified
     #   by the truncator
     TRUNCATABLE_KEYS = %i[errors environment session params].freeze
 
-    ##
     # @return [String] the name of the host machine
     HOSTNAME = Socket.gethostname.freeze
 
-    ##
     # @return [String]
     DEFAULT_SEVERITY = 'error'.freeze
 
-    ##
     # @since v1.7.0
     # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
     #   in filters
     attr_reader :stash
 
+    # @api private
     def initialize(config, exception, params = {})
       @config = config
 
@@ -78,16 +69,14 @@ module Airbrake
       }
       @stash = { exception: exception }
       @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
-
-      extract_custom_attributes(exception)
     end
 
-    ##
     # Converts the notice to JSON. Calls +to_json+ on each object inside
     # notice's payload. Truncates notices, JSON representation of which is
     # bigger than {MAX_NOTICE_SIZE}.
     #
     # @return [Hash{String=>String}, nil]
+    # @api private
     def to_json
       loop do
         begin
@@ -102,7 +91,6 @@ module Airbrake
       end
     end
 
-    ##
     # Ignores a notice. Ignored notices never reach the Airbrake dashboard.
     #
     # @return [void]
@@ -112,7 +100,6 @@ module Airbrake
       @payload = nil
     end
 
-    ##
     # Checks whether the notice was ignored.
     #
     # @return [Boolean]
@@ -121,19 +108,17 @@ module Airbrake
       @payload.nil?
     end
 
-    ##
     # Reads a value from notice's payload.
-    # @return [Object]
     #
+    # @return [Object]
     # @raise [Airbrake::Error] if the notice is ignored
     def [](key)
       raise_if_ignored
       @payload[key]
     end
 
-    ##
-    # Writes a value to the payload hash. Restricts unrecognized
-    # writes.
+    # Writes a value to the payload hash. Restricts unrecognized writes.
+    #
     # @example
     #   notice[:params][:my_param] = 'foobar'
     #
@@ -161,6 +146,7 @@ module Airbrake
     def context
       {
         version: @config.app_version,
+        versions: @config.versions,
         # We ensure that root_directory is always a String, so it can always be
         # converted to JSON in a predictable manner (when it's a Pathname and in
         # Rails environment, it converts to unexpected JSON).
@@ -195,29 +181,5 @@ module Airbrake
 
       new_max_size
     end
-
-    def extract_custom_attributes(exception)
-      return unless exception.respond_to?(:to_airbrake)
-      attributes = nil
-
-      begin
-        attributes = exception.to_airbrake
-      rescue StandardError => ex
-        @config.logger.error(
-          "#{LOG_LABEL} #{exception.class}#to_airbrake failed: #{ex.class}: #{ex}"
-        )
-      end
-
-      return unless attributes
-
-      begin
-        @payload.merge!(attributes)
-      rescue TypeError
-        @config.logger.error(
-          "#{LOG_LABEL} #{exception.class}#to_airbrake failed:" \
-          " #{attributes} must be a Hash"
-        )
-      end
-    end
   end
 end