airbrake-ruby 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 681ed72fb1b600b723e7dbb48c607d37a58a1c71
-  data.tar.gz: 3afa4336efbf5c0aa621eeebc6d1e890a0af7254
+  metadata.gz: 25d739899ae0250aa01c5e81ab01d76bbcfac28d
+  data.tar.gz: fca6e05b839805cb5d4b4171145c1dfeb4b4890b
 SHA512:
-  metadata.gz: daadebdf259818ec34b172c694ea942416b498451461cdb09e728e28245fa0456dc8fe07fc000f01966650c6b567f7ec10cd46126c2d443e4d783c5670b29247
-  data.tar.gz: 8f2df8d80dbc8be84cf48a88678ee98ce4a538d02e995d63dfa1392dbb5acd0edd787f605b85f161b5131d20260e94345ae994fe77a3359a3c281b453bfc9804
+  metadata.gz: 13fd52e48ce2f8405640785323f2cc330d9364496b58ce0b8fb416b28baff5584a95b97ded5441ee47aca872af43cf7251ebb7cfd6d3b1660c523ee774e6a870
+  data.tar.gz: d96f9bb73da48029a993bda925ec727a945177300721eb521f5966bac962f6d9ae2941cd191b4bc2d5497c07da7764c5d7c740bf5bb7fc0a30b61c50b263c08f

data/lib/airbrake-ruby.rb

@@ -77,71 +77,9 @@ module Airbrake
   # @!macro see_public_api_method
   #   @see Airbrake.$0
 
-  # NilNoticeNotifier is a no-op notice notifier, which mimics
-  # +Airbrake::NoticeNotifier+ and serves only the purpose of making the library
-  # API easier to use.
-  #
-  # @since v2.1.0
-  class NilNoticeNotifier
-    # @macro see_public_api_method
-    def notify(_exception, _params = {}, &block); end
-
-    # @macro see_public_api_method
-    def notify_sync(_exception, _params = {}, &block); end
-
-    # @macro see_public_api_method
-    def add_filter(_filter = nil, &_block); end
-
-    # @macro see_public_api_method
-    def delete_filter(_filter_class); end
-
-    # @macro see_public_api_method
-    def build_notice(_exception, _params = {}); end
-
-    # @macro see_public_api_method
-    def close; end
-
-    # @macro see_public_api_method
-    def configured?
-      false
-    end
-
-    # @macro see_public_api_method
-    def merge_context(_context); end
-  end
-
-  # NilPerformanceNotifier is a no-op notifier, which mimics
-  # {Airbrake::PerformanceNotifier} and serves only the purpose of making the
-  # library API easier to use.
-  #
-  # @since v3.2.0
-  class NilPerformanceNotifier
-    # @see Airbrake.notify_request
-    # @see Airbrake.notify_query
-    def notify(_performance_info); end
-
-    # @see Airbrake.notify_request
-    # @see Airbrake.notify_query
-    def add_filter(_filter = nil, &_block); end
-
-    # @see Airbrake.notify_request
-    # @see Airbrake.notify_query
-    def delete_filter(_filter_class); end
-  end
-
-  # NilDeployNotifier is a no-op notifier, which mimics
-  # {Airbrake::DeployNotifier} and serves only the purpose of making the library
-  # API easier to use.
-  #
-  # @since v3.2.0
-  class NilDeployNotifier
-    # @see Airbrake.notify_deploy
-    def notify(_deploy_info); end
-  end
-
-  @notice_notifier = NilNoticeNotifier.new
-  @performance_notifier = NilPerformanceNotifier.new
-  @deploy_notifier = NilDeployNotifier.new
+  @performance_notifier = PerformanceNotifier.new
+  @notice_notifier = NoticeNotifier.new
+  @deploy_notifier = DeployNotifier.new
 
   class << self
     # Configures the Airbrake notifier.
@@ -163,13 +101,11 @@ module Airbrake
     def configure
       yield config = Airbrake::Config.instance
 
-      raise Airbrake::Error, config.validation_error_message unless config.valid?
+      if (result = config.validate).rejected?
+        raise Airbrake::Error, result.value['error']
+      end
 
       Airbrake::Loggable.instance = config.logger
-
-      @performance_notifier = PerformanceNotifier.new
-      @notice_notifier = NoticeNotifier.new
-      @deploy_notifier = DeployNotifier.new
     end
 
     # @return [Boolean] true if the notifier was configured, false otherwise
@@ -217,7 +153,7 @@ module Airbrake
     # @yield [notice] The notice to filter
     # @yieldparam [Airbrake::Notice]
     # @yieldreturn [void]
-    # @return [Hash{String=>String}] the reponse from the server
+    # @return [Airbrake::Promise] the reponse from the server
     # @see .notify
     def notify_sync(exception, params = {}, &block)
       @notice_notifier.notify_sync(exception, params, &block)

data/lib/airbrake-ruby/config.rb

@@ -108,8 +108,6 @@ module Airbrake
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
     def initialize(user_config = {})
-      @validator = Config::Validator.new(self)
-
       self.proxy = {}
       self.queue_size = 100
       self.workers = 1
@@ -169,35 +167,34 @@ module Airbrake
     # @return [Boolean] true if the config meets the requirements, false
     #   otherwise
     def valid?
-      return true if ignored_environment?
-
-      return false unless @validator.valid_project_id?
-      return false unless @validator.valid_project_key?
-      return false unless @validator.valid_environment?
+      validate.resolved?
+    end
 
-      true
+    # @return [Promise]
+    # @see Validator.validate
+    def validate
+      Validator.validate(self)
     end
 
-    def validation_error_message
-      @validator.error_message
+    # @return [Promise]
+    # @see Validator.check_notify_ability
+    def check_notify_ability
+      Validator.check_notify_ability(self)
     end
 
     # @return [Boolean] true if the config ignores current environment, false
     #   otherwise
     def ignored_environment?
-      if ignore_environments.any? && environment.nil?
-        logger.warn("#{LOG_LABEL} the 'environment' option is not set, " \
-                    "'ignore_environments' has no effect")
-      end
+      check_notify_ability.rejected?
+    end
 
-      env = environment.to_s
-      ignore_environments.any? do |pattern|
-        if pattern.is_a?(Regexp)
-          env.match(pattern)
-        else
-          env == pattern.to_s
-        end
-      end
+    # @return [Promise] resolved promise if config is valid & can notify,
+    #   rejected otherwise
+    def check_configuration
+      promise = validate
+      return promise if promise.rejected?
+
+      check_notify_ability
     end
 
     private

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

@@ -1,62 +1,90 @@
 module Airbrake
   class Config
-    # Validates values of {Airbrake::Config} options.
+    # Validator validates values of {Airbrake::Config} options. A valid config
+    # is a config that guarantees that data can be sent to Airbrake given its
+    # configuration.
     #
     # @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.
-      #
-      # @param config [Airbrake::Config] the config to validate
-      def initialize(config)
-        @config = config
-        @error_message = nil
-      end
+      class << self
+        # @param [Airbrake::Config] config
+        # @since v4.1.0
+        def validate(config)
+          promise = Airbrake::Promise.new
 
-      # @return [Boolean]
-      def valid_project_id?
-        valid = @config.project_id.to_i > 0
-        @error_message = REQUIRED_ID_MSG unless valid
-        valid
-      end
+          unless valid_project_id?(config)
+            return promise.reject(':project_id is required')
+          end
 
-      # @return [Boolean]
-      def valid_project_key?
-        valid = @config.project_key.is_a?(String) && !@config.project_key.empty?
-        @error_message = REQUIRED_KEY_MSG unless valid
-        valid
-      end
+          unless valid_project_key?(config)
+            return promise.reject(':project_key is required')
+          end
+
+          unless valid_environment?(config)
+            return promise.reject(
+              "the 'environment' option must be configured " \
+              "with a Symbol (or String), but '#{config.environment.class}' was " \
+              "provided: #{config.environment}"
+            )
+          end
+
+          promise.resolve(:ok)
+        end
+
+        # Whether the given +config+ allows sending data to Airbrake. It doesn't
+        # matter if it's valid or invalid.
+        #
+        # @param [Airbrake::Config] config
+        # @since v4.1.0
+        def check_notify_ability(config)
+          promise = Airbrake::Promise.new
 
-      # @return [Boolean]
-      def valid_environment?
-        environment = @config.environment
-        valid = VALID_ENV_TYPES.any? { |type| environment.is_a?(type) }
+          if ignored_environment?(config)
+            return promise.reject(
+              "current environment '#{config.environment}' is ignored"
+            )
+          end
 
-        unless valid
-          @error_message = format(WRONG_ENV_TYPE_MSG, environment.class, environment)
+          promise.resolve(:ok)
         end
 
-        valid
+        private
+
+        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
+
+        def valid_environment?(config)
+          VALID_ENV_TYPES.any? { |type| config.environment.is_a?(type) }
+        end
+
+        def ignored_environment?(config)
+          if config.ignore_environments.any? && config.environment.nil?
+            config.logger.warn(
+              "#{LOG_LABEL} the 'environment' option is not set, " \
+              "'ignore_environments' has no effect"
+            )
+          end
+
+          return false if config.ignore_environments.none? || !config.environment
+
+          env = config.environment.to_s
+          config.ignore_environments.any? do |pattern|
+            pattern.is_a?(Regexp) ? env.match(pattern) : env == pattern.to_s
+          end
+        end
       end
     end
   end

data/lib/airbrake-ruby/deploy_notifier.rb

@@ -18,11 +18,11 @@ module Airbrake
     end
 
     # @see Airbrake.notify_deploy
-    def notify(deploy_info, promise = Airbrake::Promise.new)
-      if @config.ignored_environment?
-        return promise.reject("The '#{@config.environment}' environment is ignored")
-      end
+    def notify(deploy_info)
+      promise = @config.check_configuration
+      return promise if promise.rejected?
 
+      promise = Airbrake::Promise.new
       deploy_info[:environment] ||= @config.environment
       @sender.send(
         deploy_info,

data/lib/airbrake-ruby/notice_notifier.rb

@@ -95,15 +95,14 @@ module Airbrake
     end
 
     def send_notice(exception, params, sender)
-      promise = Airbrake::Promise.new
-      if @config.ignored_environment?
-        return promise.reject("The '#{@config.environment}' environment is ignored")
-      end
+      promise = @config.check_configuration
+      return promise if promise.rejected?
 
       notice = build_notice(exception, params)
       yield notice if block_given?
       @filter_chain.refine(notice)
 
+      promise = Airbrake::Promise.new
       return promise.reject("#{notice} was marked as ignored") if notice.ignored?
 
       sender.send(notice, promise)

data/lib/airbrake-ruby/performance_notifier.rb

@@ -19,14 +19,13 @@ module Airbrake
     end
 
     # @param [Hash] resource
-    # @param [Airbrake::Promise] promise
     # @see Airbrake.notify_query
     # @see Airbrake.notify_request
-    def notify(resource, promise = Airbrake::Promise.new)
-      if @config.ignored_environment?
-        return promise.reject("The '#{@config.environment}' environment is ignored")
-      end
+    def notify(resource)
+      promise = @config.check_configuration
+      return promise if promise.rejected?
 
+      promise = Airbrake::Promise.new
       unless @config.performance_stats
         return promise.reject("The Performance Stats feature is disabled")
       end

data/lib/airbrake-ruby/promise.rb

@@ -7,12 +7,6 @@ module Airbrake
   # @see https://github.com/ruby-concurrency/concurrent-ruby/blob/master/lib/concurrent/promise.rb
   # @since v1.7.0
   class Promise
-    # @api private
-    # @return [Hash<String,String>] either successful response containing the
-    #   +id+ key or unsuccessful response containing the +error+ key
-    # @note This is a non-blocking call!
-    attr_reader :value
-
     def initialize
       @on_resolved = []
       @on_rejected = []
@@ -32,8 +26,8 @@ module Airbrake
     # @return [self]
     def then(&block)
       @mutex.synchronize do
-        if @value.key?('id')
-          yield(@value)
+        if @value.key?('ok')
+          yield(@value['ok'])
           return self
         end
 
@@ -64,36 +58,52 @@ module Airbrake
       self
     end
 
-    # Resolves the promise.
-    #
     # @example
     #   Airbrake::Promise.new.resolve('id' => '123')
     #
-    # @param response [Hash<String,String>]
+    # @param reason [Object]
     # @return [self]
-    def resolve(response)
+    def resolve(reason = 'resolved')
       @mutex.synchronize do
-        @value = response
-        @on_resolved.each { |callback| callback.call(response) }
+        @value['ok'] = reason
+        @on_resolved.each { |callback| callback.call(reason) }
       end
 
       self
     end
 
-    # Rejects the promise.
-    #
     # @example
     #   Airbrake::Promise.new.reject('Something went wrong')
     #
-    # @param error [String]
+    # @param reason [String]
     # @return [self]
-    def reject(error)
+    def reject(reason = 'rejected')
       @mutex.synchronize do
-        @value['error'] = error
-        @on_rejected.each { |callback| callback.call(error) }
+        @value['error'] = reason
+        @on_rejected.each { |callback| callback.call(reason) }
       end
 
       self
     end
+
+    # @return [Boolean]
+    def rejected?
+      @value.key?('error')
+    end
+
+    # @return [Boolean]
+    def resolved?
+      @value.key?('ok')
+    end
+
+    # @return [Hash<String,String>] either successful response containing the
+    #   +id+ key or unsuccessful response containing the +error+ key
+    # @note This is a non-blocking call!
+    # @todo Get rid of this method and use an accessor. The resolved guard is
+    #   needed for compatibility but it shouldn't exist in the future
+    def value
+      return @value['ok'] if resolved?
+      @value
+    end
   end
 end