airbrake-ruby 4.15.0 → 5.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9737dfd8078f14a0150525e1c8b226bcaa5bb87e7627542d7a1a25a27d3c191d
-  data.tar.gz: 653ff8929bc7199a77c59ead004167a38d214741157282d93e947c3d5ca8ecd6
+  metadata.gz: f8307b88b3240291a93fa8e8590997aca70032e424edff8f3ef2cd8c7220c4b3
+  data.tar.gz: 53a68e1f1bab4158d773593ad201dce948a0df60c0fd1b80a27451a96dc5596c
 SHA512:
-  metadata.gz: 21d60bd1415bec1e0ed3b89891f5b35e56f019b09dcb50c05f1e55b2176a2976a566c95e0a3fc4cdce2601a1b4b0e786b1ddbcc67188da6df51bd5c94188e54d
-  data.tar.gz: 3c3b2312b7945685c6199ecd21f23601b752e1d4234d35461db2f4c7cf0318c24ee263df2536e9cffb7e107002a5a5be10af1cf7eecc16ac65e07cd948f2c68e
+  metadata.gz: fa9bcb8eac54050e2065c850ce7056a219c7e6a3992bac5b2eeab36d95a39d861bfbd4a9e81ba6d377b55e32679723f013cbcbc213ab6f6a29715f544a719259
+  data.tar.gz: '08fdf62186815e85696acd66641f60bfeca556c2a3e30c0b7d7c49c3f02bdd208d795aceee9af65a4683773580682f8efa96a61434a716118a8a85346432d41f'

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'
@@ -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.blocklist_keys.any?
-        blocklist = Airbrake::Filters::KeysBlocklist.new(config.blocklist_keys)
-        notice_notifier.add_filter(blocklist)
-      end
-
-      if config.allowlist_keys.any?
-        allowlist = Airbrake::Filters::KeysAllowlist.new(config.allowlist_keys)
-        notice_notifier.add_filter(allowlist)
-      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/config.rb

@@ -4,6 +4,7 @@ module Airbrake
   #
   # @api public
   # @since v1.0.0
+  # rubocop:disable Metrics/ClassLength
   class Config
     # @return [Integer] the project identificator. This value *must* be set.
     # @api public
@@ -46,6 +47,17 @@ module Airbrake
     # @api public
     attr_accessor :host
 
+    # @since v?.?.?
+    alias error_host host
+    # @since v?.?.?
+    alias error_host= host=
+
+    # @return [String] the host, which provides the API endpoint to which
+    #   APM data should be sent
+    # @api public
+    # @since v?.?.?
+    attr_accessor :apm_host
+
     # @return [String, Pathname] the working directory of your project
     # @api public
     attr_accessor :root_directory
@@ -113,6 +125,18 @@ 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 ?.?.?
+    attr_accessor :error_notifications
+
+    # @note Not for public use!
+    # @return [Boolean]
+    # @api private
+    # @since ?.?.?
+    attr_accessor :__remote_configuration
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -134,7 +158,8 @@ 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.ignore_environments = []
 
@@ -153,6 +178,8 @@ module Airbrake
       self.performance_stats_flush_period = 15
       self.query_stats = true
       self.job_stats = true
+      self.error_notifications = true
+      self.__remote_configuration = false
 
       merge(user_config)
     end
@@ -176,14 +203,14 @@ module Airbrake
       self.allowlist_keys = keys
     end
 
-    # 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
 
@@ -261,4 +288,5 @@ module Airbrake
       raise Airbrake::Error, "unknown option '#{option}'"
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

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

@@ -0,0 +1,80 @@
+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 v?.?.?
+    # @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 if !@project_id || !@config.__remote_configuration
+
+        RemoteSettings.poll(@project_id, &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",

data/lib/airbrake-ruby/performance_notifier.rb

@@ -144,7 +144,7 @@ module Airbrake
 
       with_grouped_payload(payload) do |resource_hash, destination|
         url = URI.join(
-          @config.host,
+          @config.apm_host,
           "api/v5/projects/#{@config.project_id}/#{destination}",
         )
 

data/lib/airbrake-ruby/remote_settings.rb

@@ -0,0 +1,128 @@
+module Airbrake
+  # RemoteSettings polls the remote config of the passed project at fixed
+  # intervals. The fetched config is yielded as a callback parameter so that the
+  # invoker can define read config values.
+  #
+  # @example Disable/enable error notifications based on the remote value
+  #   RemoteSettings.poll do |data|
+  #     config.error_notifications = data.error_notifications?
+  #   end
+  #
+  # When {#poll} is called, it will try to load remote settings from disk, so
+  # that it doesn't wait on the result from the API call.
+  #
+  # When {#stop_polling} is called, the current config will be dumped to disk.
+  #
+  # @since ?.?.?
+  # @api private
+  class RemoteSettings
+    include Airbrake::Loggable
+
+    # @return [String] the path to the persistent config
+    CONFIG_DUMP_PATH = File.join(
+      File.expand_path(__dir__),
+      '../../config/config.json',
+    ).freeze
+
+    # Polls remote config of the given project.
+    #
+    # @param [Integer] project_id
+    # @yield [data]
+    # @yieldparam data [Airbrake::RemoteSettings::SettingsData]
+    # @return [Airbrake::RemoteSettings]
+    def self.poll(project_id, &block)
+      new(project_id, &block).poll
+    end
+
+    # @param [Integer] project_id
+    # @yield [data]
+    # @yieldparam data [Airbrake::RemoteSettings::SettingsData]
+    def initialize(project_id, &block)
+      @data = SettingsData.new(project_id, {})
+      @block = block
+      @poll = nil
+    end
+
+    # Polls remote config of the given project in background. Loads local config
+    # first (if exists).
+    #
+    # @return [self]
+    def poll
+      @poll ||= Thread.new do
+        begin
+          load_config
+        rescue StandardError => ex
+          logger.error("#{LOG_LABEL} config loading failed: #{ex}")
+        end
+
+        @block.call(@data)
+
+        loop do
+          @block.call(@data.merge!(fetch_config))
+          sleep(@data.interval)
+        end
+      end
+
+      self
+    end
+
+    # Stops the background poller thread. Dumps current config to disk.
+    #
+    # @return [void]
+    def stop_polling
+      @poll.kill if @poll
+
+      begin
+        dump_config
+      rescue StandardError => ex
+        logger.error("#{LOG_LABEL} config dumping failed: #{ex}")
+      end
+    end
+
+    private
+
+    def fetch_config
+      response = nil
+      begin
+        response = Net::HTTP.get(URI(@data.config_route))
+      rescue StandardError => ex
+        logger.error(ex)
+        return {}
+      end
+
+      # AWS S3 API returns XML when request is not valid. In this case we just
+      # print the returned body and exit the method.
+      if response.start_with?('<?xml ')
+        logger.error(response)
+        return {}
+      end
+
+      json = nil
+      begin
+        json = JSON.parse(response)
+      rescue JSON::ParserError => ex
+        logger.error(ex)
+        return {}
+      end
+
+      json
+    end
+
+    def load_config
+      config_dir = File.dirname(CONFIG_DUMP_PATH)
+      Dir.mkdir(config_dir) unless File.directory?(config_dir)
+
+      return unless File.exist?(CONFIG_DUMP_PATH)
+
+      config = File.read(CONFIG_DUMP_PATH)
+      @data.merge!(JSON.parse(config))
+    end
+
+    def dump_config
+      config_dir = File.dirname(CONFIG_DUMP_PATH)
+      Dir.mkdir(config_dir) unless File.directory?(config_dir)
+
+      File.write(CONFIG_DUMP_PATH, JSON.dump(@data.to_h))
+    end
+  end
+end

data/lib/airbrake-ruby/remote_settings/settings_data.rb

@@ -0,0 +1,116 @@
+module Airbrake
+  class RemoteSettings
+    # SettingsData is a container, which wraps JSON payload returned by the
+    # remote settings API. It exposes the payload via convenient methods and
+    # also ensures that in case some data from the payload is missing, a default
+    # value would be returned instead.
+    #
+    # @example
+    #   # Create the object and pass initial data (empty hash).
+    #   settings_data = SettingsData.new({})
+    #
+    #   settings_data.interval #=> 600
+    #
+    # @since ?.?.?
+    # @api private
+    class SettingsData
+      # @return [Integer] how frequently we should poll the config API
+      DEFAULT_INTERVAL = 600
+
+      # @return [String] API version of the S3 API to poll
+      API_VER = '2020-06-18'.freeze
+
+      # @return [String] what URL to poll
+      CONFIG_ROUTE_PATTERN =
+        'https://%<bucket>s.s3.amazonaws.com/' \
+        "#{API_VER}/config/%<project_id>s/config.json".freeze
+
+      # @return [Hash{Symbol=>String}] the hash of all supported settings where
+      #   the value is the name of the setting returned by the API
+      SETTINGS = {
+        errors: 'errors',
+        apm: 'apm',
+      }.freeze
+
+      # @param [Integer] project_id
+      # @param [Hash{String=>Object}] data
+      def initialize(project_id, data)
+        @project_id = project_id
+        @data = data
+      end
+
+      # Merges the given +hash+ with internal data.
+      #
+      # @param [Hash{String=>Object}] hash
+      # @return [self]
+      def merge!(hash)
+        @data.merge!(hash)
+
+        self
+      end
+
+      # @return [Integer] how frequently we should poll for the config
+      def interval
+        return DEFAULT_INTERVAL if !@data.key?('poll_sec') || !@data['poll_sec']
+
+        @data['poll_sec'] > 0 ? @data['poll_sec'] : DEFAULT_INTERVAL
+      end
+
+      # @return [String] where the config is stored on S3.
+      def config_route
+        if !@data.key?('config_route') || !@data['config_route']
+          return format(
+            CONFIG_ROUTE_PATTERN,
+            bucket: 'staging-notifier-configs',
+            project_id: @project_id,
+          )
+        end
+
+        @data['config_route']
+      end
+
+      # @return [Boolean] whether error notifications are enabled
+      def error_notifications?
+        return true unless (s = find_setting(SETTINGS[:errors]))
+
+        s['enabled']
+      end
+
+      # @return [Boolean] whether APM is enabled
+      def performance_stats?
+        return true unless (s = find_setting(SETTINGS[:apm]))
+
+        s['enabled']
+      end
+
+      # @return [String, nil] the host, which provides the API endpoint to which
+      #   exceptions should be sent
+      def error_host
+        return unless (s = find_setting(SETTINGS[:errors]))
+
+        s['endpoint']
+      end
+
+      # @return [String, nil] the host, which provides the API endpoint to which
+      #   APM data should be sent
+      def apm_host
+        return unless (s = find_setting(SETTINGS[:apm]))
+
+        s['endpoint']
+      end
+
+      # @return [Hash{String=>Object}] raw representation of JSON payload
+      def to_h
+        @data.dup
+      end
+
+      private
+
+      def find_setting(name)
+        return unless @data.key?('settings')
+
+        @data['settings'].find { |s| s['name'] == name }
+      end
+    end
+  end
+end