airbrake-ruby 5.0.0.rc.1 → 5.1.0

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

@@ -16,6 +16,7 @@ module Airbrake
       # @macro call_filter
       def call(notice)
         return if notice[:errors].none? { |error| error[:type] == SYSTEM_EXIT_TYPE }
+
         notice.ignore!
       end
     end

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

@@ -56,6 +56,7 @@ module Airbrake
       def thread_variables(th)
         th.thread_variables.map.with_object({}) do |var, h|
           next if var.to_s.start_with?(IGNORE_PREFIX)
+
           h[var] = sanitize_value(th.thread_variable_get(var))
         end
       end
@@ -63,6 +64,7 @@ module Airbrake
       def fiber_variables(th)
         th.keys.map.with_object({}) do |key, h|
           next if key.to_s.start_with?(IGNORE_PREFIX)
+
           h[key] = sanitize_value(th[key])
         end
       end

data/lib/airbrake-ruby/ignorable.rb

@@ -38,6 +38,7 @@ module Airbrake
     # @raise [Airbrake::Error] when instance is ignored
     def raise_if_ignored
       return unless ignored?
+
       raise Airbrake::Error, "cannot access ignored #{self.class}"
     end
   end

data/lib/airbrake-ruby/notice.rb

@@ -4,19 +4,12 @@ module Airbrake
   #
   # @since v1.0.0
   class Notice
-    # @return [Hash{Symbol=>String}] the information about the notifier library
-    NOTIFIER = {
-      name: 'airbrake-ruby'.freeze,
-      version: Airbrake::AIRBRAKE_RUBY_VERSION,
-      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 = {
       os: RUBY_PLATFORM,
       language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
-      notifier: NOTIFIER,
+      notifier: Airbrake::NOTIFIER_INFO,
     }.freeze
 
     # @return [Integer] the maxium size of the JSON payload in bytes

data/lib/airbrake-ruby/notice_notifier.rb

@@ -135,6 +135,7 @@ module Airbrake
       # If true, then it's likely an internal library error. In this case return
       # at least some backtrace to simplify debugging.
       return caller_copy if clean_bt.empty?
+
       clean_bt
     end
   end

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -12,16 +12,13 @@ module Airbrake
     include Stashable
     include Mergeable
 
-    attr_accessor :method, :route, :response_type, :groups, :start_time,
-                  :end_time, :timing, :time
+    attr_accessor :method, :route, :response_type, :groups, :timing, :time
 
     def initialize(
       method:,
       route:,
       response_type:,
       groups:,
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -30,8 +27,6 @@ module Airbrake
       @route = route
       @response_type = response_type
       @groups = groups
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end

data/lib/airbrake-ruby/performance_notifier.rb

@@ -104,7 +104,7 @@ module Airbrake
         @payload[resource] = { total: Airbrake::Stat.new }
       end
 
-      update_total(resource, @payload[resource][:total])
+      @payload[resource][:total].increment_ms(resource.timing)
 
       resource.groups.each do |name, ms|
         @payload[resource][name] ||= Airbrake::Stat.new
@@ -112,19 +112,6 @@ module Airbrake
       end
     end
 
-    def update_total(resource, total)
-      if resource.timing
-        total.increment_ms(resource.timing)
-      else
-        loc = caller_locations(6..6).first
-        Kernel.warn(
-          "#{loc.path}:#{loc.lineno}: warning: :start_time and :end_time are " \
-          "deprecated. Use :timing & :time instead",
-        )
-        total.increment(resource.start_time, resource.end_time)
-      end
-    end
-
     def check_configuration(resource)
       promise = @config.check_configuration
       return promise if promise.rejected?

data/lib/airbrake-ruby/promise.rb

@@ -103,6 +103,7 @@ module Airbrake
     #   needed for compatibility but it shouldn't exist in the future
     def value
       return @value['ok'] if resolved?
+
       @value
     end
   end

data/lib/airbrake-ruby/query.rb

@@ -12,8 +12,7 @@ module Airbrake
     include Mergeable
     include Grouppable
 
-    attr_accessor :method, :route, :query, :func, :file, :line, :start_time,
-                  :end_time, :timing, :time
+    attr_accessor :method, :route, :query, :func, :file, :line, :timing, :time
 
     def initialize(
       method:,
@@ -22,8 +21,6 @@ module Airbrake
       func: nil,
       file: nil,
       line: nil,
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -34,8 +31,6 @@ module Airbrake
       @func = func
       @file = file
       @line = line
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end

data/lib/airbrake-ruby/queue.rb

@@ -4,21 +4,17 @@ module Airbrake
   # @see Airbrake.notify_queue
   # @api public
   # @since v4.9.0
-  # rubocop:disable Metrics/ParameterLists
   class Queue
     include HashKeyable
     include Ignorable
     include Stashable
 
-    attr_accessor :queue, :error_count, :groups, :start_time, :end_time,
-                  :timing, :time
+    attr_accessor :queue, :error_count, :groups, :timing, :time
 
     def initialize(
       queue:,
       error_count:,
       groups: {},
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -26,8 +22,6 @@ module Airbrake
       @queue = queue
       @error_count = error_count
       @groups = groups
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end
@@ -68,5 +62,4 @@ module Airbrake
       ''
     end
   end
-  # rubocop:enable Metrics/ParameterLists
 end

data/lib/airbrake-ruby/remote_settings.rb

@@ -8,53 +8,46 @@ module Airbrake
   #     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 ?.?.?
+  # @since 5.0.0
   # @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',
+    # @return [Hash{Symbol=>String}] metadata to be attached to every GET
+    #   request
+    QUERY_PARAMS = URI.encode_www_form(
+      notifier_name: Airbrake::NOTIFIER_INFO[:name],
+      notifier_version: Airbrake::NOTIFIER_INFO[:version],
+      os: RUBY_PLATFORM,
+      language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
     ).freeze
 
     # Polls remote config of the given project.
     #
     # @param [Integer] project_id
+    # @param [String] host
     # @yield [data]
     # @yieldparam data [Airbrake::RemoteSettings::SettingsData]
     # @return [Airbrake::RemoteSettings]
-    def self.poll(project_id, &block)
-      new(project_id, &block).poll
+    def self.poll(project_id, host, &block)
+      new(project_id, host, &block).poll
     end
 
     # @param [Integer] project_id
     # @yield [data]
     # @yieldparam data [Airbrake::RemoteSettings::SettingsData]
-    def initialize(project_id, &block)
+    def initialize(project_id, host, &block)
       @data = SettingsData.new(project_id, {})
+      @host = host
       @block = block
       @poll = nil
     end
 
-    # Polls remote config of the given project in background. Loads local config
-    # first (if exists).
+    # Polls remote config of the given project in background.
     #
     # @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
@@ -66,17 +59,11 @@ module Airbrake
       self
     end
 
-    # Stops the background poller thread. Dumps current config to disk.
+    # Stops the background poller thread.
     #
     # @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
@@ -84,7 +71,7 @@ module Airbrake
     def fetch_config
       response = nil
       begin
-        response = Net::HTTP.get(URI(@data.config_route))
+        response = Net::HTTP.get(build_config_uri)
       rescue StandardError => ex
         logger.error(ex)
         return {}
@@ -108,21 +95,10 @@ module Airbrake
       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))
+    def build_config_uri
+      uri = URI(@data.config_route(@host))
+      uri.query = QUERY_PARAMS
+      uri
     end
   end
 end

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

@@ -0,0 +1,44 @@
+module Airbrake
+  class RemoteSettings
+    # Callback is a class that provides a callback for the config poller, which
+    # updates the local config according to the data.
+    #
+    # @api private
+    # @since 5.0.2
+    class Callback
+      def initialize(config)
+        @config = config
+        @orig_error_notifications = config.error_notifications
+        @orig_performance_stats = config.performance_stats
+      end
+
+      # @param [Airbrake::RemoteSettings::SettingsData] data
+      # @return [void]
+      def call(data)
+        @config.logger.debug do
+          "#{LOG_LABEL} applying remote settings: #{data.to_h}"
+        end
+
+        @config.error_host = data.error_host if data.error_host
+        @config.apm_host = data.apm_host if data.apm_host
+
+        process_error_notifications(data)
+        process_performance_stats(data)
+      end
+
+      private
+
+      def process_error_notifications(data)
+        return unless @orig_error_notifications
+
+        @config.error_notifications = data.error_notifications?
+      end
+
+      def process_performance_stats(data)
+        return unless @orig_performance_stats
+
+        @config.performance_stats = data.performance_stats?
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Airbrake
     #
     #   settings_data.interval #=> 600
     #
-    # @since ?.?.?
+    # @since 5.0.0
     # @api private
     class SettingsData
       # @return [Integer] how frequently we should poll the config API
@@ -20,16 +20,15 @@ module Airbrake
       # @return [String] API version of the S3 API to poll
       API_VER = '2020-06-18'.freeze
 
-      # @return [String] what URL to poll
+      # @return [String] what path to poll
       CONFIG_ROUTE_PATTERN =
-        'https://%<bucket>s.s3.amazonaws.com/' \
-        "#{API_VER}/config/%<project_id>s/config.json".freeze
+        "%<host>s/#{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',
+        errors: 'errors'.freeze,
+        apm: 'apm'.freeze,
       }.freeze
 
       # @param [Integer] project_id
@@ -56,17 +55,18 @@ module Airbrake
         @data['poll_sec'] > 0 ? @data['poll_sec'] : DEFAULT_INTERVAL
       end
 
+      # @param [String] remote_config_host
       # @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,
-          )
+      def config_route(remote_config_host)
+        if @data['config_route'] && !@data['config_route'].empty?
+          return remote_config_host.chomp('/') + '/' + @data['config_route']
         end
 
-        @data['config_route']
+        format(
+          CONFIG_ROUTE_PATTERN,
+          host: remote_config_host.chomp('/'),
+          project_id: @project_id,
+        )
       end
 
       # @return [Boolean] whether error notifications are enabled

data/lib/airbrake-ruby/request.rb

@@ -4,7 +4,6 @@ module Airbrake
   # @see Airbrake.notify_request
   # @api public
   # @since v3.2.0
-  # rubocop:disable Metrics/ParameterLists
   class Request
     include HashKeyable
     include Ignorable
@@ -12,15 +11,12 @@ module Airbrake
     include Mergeable
     include Grouppable
 
-    attr_accessor :method, :route, :status_code, :start_time, :end_time,
-                  :timing, :time
+    attr_accessor :method, :route, :status_code, :timing, :time
 
     def initialize(
       method:,
       route:,
       status_code:,
-      start_time: Time.now,
-      end_time: start_time + 1,
       timing: nil,
       time: Time.now
     )
@@ -28,8 +24,6 @@ module Airbrake
       @method = method
       @route = route
       @status_code = status_code
-      @start_time = start_time
-      @end_time = end_time
       @timing = timing
       @time = time
     end
@@ -51,5 +45,4 @@ module Airbrake
       }.delete_if { |_key, val| val.nil? }
     end
   end
-  # rubocop:enable Metrics/ParameterLists
 end