airbrake-ruby 4.14.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b246c5d84c2bc6ff22b535260b416d37bbc2fca17fff01ae3705156ce68a74b
-  data.tar.gz: 743b3190115223bf043cf8ecf7e9b5a8bb32b40206c146967d86489514247d99
+  metadata.gz: e98183a856071ce3d105c36adc9aa22a8ee7071b93958fd70fb673d2735b3977
+  data.tar.gz: 80464931a1362c4d845ffee737ed7aa1e46693136023b1f08006c49de98e62eb
 SHA512:
-  metadata.gz: c798358c9215c8ba703fd81163378bcd828200a71cc2ad026f9569684ca654ac094d01f38548c2fe5919ad744456c7a42bd58304d961b5c1997b00e4a4df0f8f
-  data.tar.gz: b7ed80303a34c3b0f58b51037063428384b4680273729f88062fd22146fcccfc55989a0f77ddc88a502859d234661a1243853d98fc1abc05f951a703962ec6af
+  metadata.gz: 8c32fc631e3af6348a871094dde31452d4a6fdef834596933e179d2acdbbd4935751715007fa7c4dcfce3639ebbd55f61b15f06428015647e4cbcac590ef7aaf
+  data.tar.gz: 23968940c6f1dfb500be5ab479c1d524cdc9f80e40808b4ff08d7f4b03c97baad603d97504c58a5300ddfa7ec9b1a4b5bd44a24a6a4a15776a82778ef2a0c324

data/lib/airbrake-ruby.rb

@@ -12,6 +12,9 @@ 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'
@@ -24,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'
@@ -117,7 +120,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
@@ -260,8 +271,8 @@ module Airbrake
     #   Airbrake.close
     #   Airbrake.notify('App crashed!') #=> raises Airbrake::Error
     #
-    # @return [void]
-    # rubocop:disable Style/GuardClause, Style/IfUnlessModifier
+    # @return [nil]
+    # rubocop:disable Style/IfUnlessModifier, Metrics/CyclomaticComplexity
     def close
       if defined?(@notice_notifier) && @notice_notifier
         @notice_notifier.close
@@ -270,8 +281,14 @@ module Airbrake
       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/GuardClause, Style/IfUnlessModifier
+    # rubocop:enable Style/IfUnlessModifier, Metrics/CyclomaticComplexity
 
     # Pings the Airbrake Deploy API endpoint about the occurred deploy.
     #
@@ -567,35 +584,6 @@ module Airbrake
       self.notice_notifier = NoticeNotifier.new
       self.deploy_notifier = DeployNotifier.new
     end
-
-    private
-
-    # rubocop:disable Metrics/AbcSize
-    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|
-        next if notice_notifier.has_filter?(filter)
-
-        notice_notifier.add_filter(filter.new(config.root_directory))
-      end
-    end
-    # rubocop:enable Metrics/AbcSize
   end
 end
 # rubocop:enable Metrics/ModuleLength

data/lib/airbrake-ruby/async_sender.rb

@@ -16,7 +16,7 @@ module Airbrake
     #
     # @param [Hash] payload Whatever needs to be sent
     # @return [Airbrake::Promise]
-    def send(payload, promise, endpoint = @config.endpoint)
+    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}",

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
 

data/lib/airbrake-ruby/config.rb

@@ -46,6 +46,17 @@ module Airbrake
     # @api public
     attr_accessor :host
 
+    # @since v5.0.0
+    alias error_host host
+    # @since v5.0.0
+    alias error_host= host=
+
+    # @return [String] the host, which provides the API endpoint to which
+    #   APM data should be sent
+    # @api public
+    # @since v5.0.0
+    attr_accessor :apm_host
+
     # @return [String, Pathname] the working directory of your project
     # @api public
     attr_accessor :root_directory
@@ -68,14 +79,14 @@ module Airbrake
     # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since v1.2.0
-    attr_accessor :blacklist_keys
+    # @since v4.15.0
+    attr_accessor :allowlist_keys
 
-    # @return [Array<String, Symbol, Regexp>] the keys, which shouldn't be
+    # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since v1.2.0
-    attr_accessor :whitelist_keys
+    # @since v4.15.0
+    attr_accessor :blocklist_keys
 
     # @return [Boolean] true if the library should attach code hunks to each
     #   frame in a backtrace, false otherwise
@@ -107,6 +118,16 @@ module Airbrake
     # @since v4.12.0
     attr_accessor :job_stats
 
+    # @return [Boolean] true if the library should send error reports to
+    #   Airbrake, false otherwise
+    # @api public
+    # @since 5.0.0
+    attr_accessor :error_notifications
+
+    # @return [String] the host such as which should be used for fetching remote
+    #   configuration options (example: "https://bucket-name.s3.amazonaws.com")
+    attr_accessor :remote_config_host
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -128,14 +149,16 @@ module Airbrake
       self.logger = ::Logger.new(File::NULL).tap { |l| l.level = Logger::WARN }
       self.project_id = user_config[:project_id]
       self.project_key = user_config[:project_key]
-      self.host = 'https://api.airbrake.io'
+      self.error_host = 'https://api.airbrake.io'
+      self.apm_host = 'https://api.airbrake.io'
+      self.remote_config_host = 'https://v1-production-notifier-configs.s3.amazonaws.com'
 
       self.ignore_environments = []
 
       self.timeout = user_config[:timeout]
 
-      self.blacklist_keys = []
-      self.whitelist_keys = []
+      self.blocklist_keys = []
+      self.allowlist_keys = []
 
       self.root_directory = File.realpath(
         (defined?(Bundler) && Bundler.root) ||
@@ -147,19 +170,20 @@ module Airbrake
       self.performance_stats_flush_period = 15
       self.query_stats = true
       self.job_stats = true
+      self.error_notifications = true
 
       merge(user_config)
     end
     # rubocop:enable Metrics/AbcSize
 
-    # The full URL to the Airbrake Notice API. Based on the +:host+ option.
+    # The full URL to the Airbrake Notice API. Based on the +:error_host+ option.
     # @return [URI] the endpoint address
-    def endpoint
-      @endpoint ||=
+    def error_endpoint
+      @error_endpoint ||=
         begin
-          self.host = ('https://' << host) if host !~ %r{\Ahttps?://}
+          self.error_host = ('https://' << error_host) if error_host !~ %r{\Ahttps?://}
           api = "api/v3/projects/#{project_id}/notices"
-          URI.join(host, api)
+          URI.join(error_host, api)
         end
     end
 

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

@@ -0,0 +1,84 @@
+module Airbrake
+  class Config
+    # Processor is a helper class, which is responsible for setting default
+    # config values, default notifier filters and remote configuration changes.
+    #
+    # @since 5.0.0
+    # @api private
+    class Processor
+      # @param [Airbrake::Config] config
+      # @return [Airbrake::Config::Processor]
+      def self.process(config)
+        new(config).process
+      end
+
+      # @param [Airbrake::Config] config
+      def initialize(config)
+        @config = config
+        @blocklist_keys = @config.blocklist_keys
+        @allowlist_keys = @config.allowlist_keys
+        @project_id = @config.project_id
+      end
+
+      # @param [Airbrake::NoticeNotifier] notifier
+      # @return [void]
+      def process_blocklist(notifier)
+        return if @blocklist_keys.none?
+
+        blocklist = Airbrake::Filters::KeysBlocklist.new(@blocklist_keys)
+        notifier.add_filter(blocklist)
+      end
+
+      # @param [Airbrake::NoticeNotifier] notifier
+      # @return [void]
+      def process_allowlist(notifier)
+        return if @allowlist_keys.none?
+
+        allowlist = Airbrake::Filters::KeysAllowlist.new(@allowlist_keys)
+        notifier.add_filter(allowlist)
+      end
+
+      # @return [Airbrake::RemoteSettings]
+      def process_remote_configuration
+        return unless @project_id
+
+        RemoteSettings.poll(
+          @project_id,
+          @config.remote_config_host,
+          &method(:poll_callback)
+        )
+      end
+
+      # @param [Airbrake::NoticeNotifier] notifier
+      # @return [void]
+      def add_filters(notifier)
+        return unless @config.root_directory
+
+        [
+          Airbrake::Filters::RootDirectoryFilter,
+          Airbrake::Filters::GitRevisionFilter,
+          Airbrake::Filters::GitRepositoryFilter,
+          Airbrake::Filters::GitLastCheckoutFilter,
+        ].each do |filter|
+          next if notifier.has_filter?(filter)
+
+          notifier.add_filter(filter.new(@config.root_directory))
+        end
+      end
+
+      # @param [Airbrake::RemoteSettings::SettingsData] data
+      # @return [void]
+      def poll_callback(data)
+        @config.logger.debug(
+          "#{LOG_LABEL} applying remote settings: #{data.to_h}",
+        )
+
+        @config.error_host = data.error_host if data.error_host
+        @config.apm_host = data.apm_host if data.apm_host
+
+        @config.error_notifications = data.error_notifications?
+        @config.performance_stats = data.performance_stats?
+      end
+    end
+  end
+end

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

@@ -44,6 +44,10 @@ module Airbrake
         def check_notify_ability(config)
           promise = Airbrake::Promise.new
 
+          unless config.error_notifications
+            return promise.reject('error notifications are disabled')
+          end
+
           if ignored_environment?(config)
             return promise.reject(
               "current environment '#{config.environment}' is ignored",
@@ -57,12 +61,14 @@ module Airbrake
 
         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
 

data/lib/airbrake-ruby/file_cache.rb

@@ -40,7 +40,7 @@ module Airbrake
       data.empty?
     end
 
-    # @since ?.?.?
+    # @since 4.7.0
     # @return [void]
     def self.reset
       @data = {}

data/lib/airbrake-ruby/filter_chain.rb

@@ -70,6 +70,7 @@ module Airbrake
     def refine(notice)
       @filters.each do |filter|
         break if notice.ignored?
+
         filter.call(notice)
       end
     end

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

@@ -24,6 +24,7 @@ module Airbrake
 
       def git_version(spec)
         return unless spec.respond_to?(:git_version) || spec.git_version
+
         spec.git_version.to_s
       end
     end

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

@@ -23,6 +23,7 @@ module Airbrake
               # If the frame is unparseable, then 'file' is nil, thus nothing to
               # filter (all frame's data is in 'function' instead).
               next unless (file = frame[:file])
+
               frame[:file] = file.sub(/\A#{gem_path}/, GEM_ROOT_LABEL)
             end
           end

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

@@ -41,12 +41,12 @@ module Airbrake
 
         return unless File.exist?(@git_path)
         return unless (checkout = last_checkout)
+
         notice[:context][:lastCheckout] = checkout
       end
 
       private
 
-      # rubocop:disable Metrics/AbcSize
       def last_checkout
         return unless (line = last_checkout_line)
 
@@ -66,7 +66,6 @@ module Airbrake
           time: timestamp(parts[-2].to_i),
         }
       end
-      # rubocop:enable Metrics/AbcSize
 
       def last_checkout_line
         head_path = File.join(@git_path, 'logs', 'HEAD')

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

@@ -18,6 +18,7 @@ module Airbrake
       # @macro call_filter
       def call(notice)
         return if notice[:context].key?(:repository)
+
         attach_repository(notice)
       end
 
@@ -39,6 +40,7 @@ module Airbrake
           end
 
         return unless @repository
+
         notice[:context][:repository] = @repository
       end
 
@@ -46,6 +48,7 @@ module Airbrake
 
       def detect_git_version
         return unless which('git')
+
         Gem::Version.new(`git --version`.split[2])
       end