airbrake-ruby 4.14.1-java → 5.0.1-java

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

@@ -0,0 +1,121 @@
+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 5.0.0
+    # @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 path to poll
+      CONFIG_ROUTE_PATTERN =
+        "%<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'.freeze,
+        apm: 'apm'.freeze,
+      }.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
+
+      # @param [String] remote_config_host
+      # @return [String] where the config is stored on S3.
+      def config_route(remote_config_host)
+        if @data.key?('config_route') &&
+           @data['config_route'] && !@data['config_route'].empty?
+          return format(
+            CONFIG_ROUTE_PATTERN,
+            host: @data['config_route'].chomp('/'),
+            project_id: @project_id,
+          )
+        end
+
+        format(
+          CONFIG_ROUTE_PATTERN,
+          host: remote_config_host.chomp('/'),
+          project_id: @project_id,
+        )
+      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

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

data/lib/airbrake-ruby/stat.rb

@@ -9,7 +9,7 @@ module Airbrake
   #
   # @example
   #   stat = Airbrake::Stat.new
-  #   stat.increment(Time.now - 200)
+  #   stat.increment_ms(2000)
   #   stat.to_h # Pack and serialize data so it can be transmitted.
   #
   # @since v3.2.0
@@ -41,17 +41,6 @@ module Airbrake
       end
     end
 
-    # Increments tdigest timings and updates tdigest with the difference between
-    # +end_time+ and +start_time+.
-    #
-    # @param [Date] start_time
-    # @param [Date] end_time
-    # @return [void]
-    def increment(start_time, end_time = nil)
-      end_time ||= Time.new
-      increment_ms((end_time - start_time) * 1000)
-    end
-
     # Increments tdigest timings and updates tdigest with given +ms+ value.
     #
     # @param [Float] ms

data/lib/airbrake-ruby/sync_sender.rb

@@ -23,7 +23,7 @@ module Airbrake
     # @param [#to_json] data
     # @param [URI::HTTPS] endpoint
     # @return [Hash{String=>String}] the parsed HTTP response
-    def send(data, promise, endpoint = @config.endpoint)
+    def send(data, promise, endpoint = @config.error_endpoint)
       return promise if rate_limited_ip?(promise)
 
       response = nil
@@ -47,6 +47,7 @@ module Airbrake
       end
 
       return promise.reject(parsed_resp['error']) if parsed_resp.key?('error')
+
       promise.resolve(parsed_resp)
     end
 
@@ -79,7 +80,7 @@ module Airbrake
       req['Authorization'] = "Bearer #{@config.project_key}"
       req['Content-Type'] = CONTENT_TYPE
       req['User-Agent'] =
-        "#{Airbrake::Notice::NOTIFIER[:name]}/#{Airbrake::AIRBRAKE_RUBY_VERSION}" \
+        "#{Airbrake::NOTIFIER_INFO[:name]}/#{Airbrake::AIRBRAKE_RUBY_VERSION}" \
         " Ruby/#{RUBY_VERSION}"
 
       req

data/lib/airbrake-ruby/tdigest.rb

@@ -200,6 +200,7 @@ module Airbrake
         unless (0..1).cover?(item)
           raise ArgumentError, "p should be in [0,1], got #{item}"
         end
+
         if size == 0
           nil
         else
@@ -271,6 +272,7 @@ module Airbrake
           shift = 7
           while (v & 0x80) != 0
             raise 'Shift too large in decode' if shift > 28
+
             v = counts_bytes.shift || 0
             z += (v & 0x7f) << shift
             shift += 7

data/lib/airbrake-ruby/thread_pool.rb

@@ -129,6 +129,7 @@ module Airbrake
       Thread.new do
         while (message = @queue.pop)
           break if message == :stop
+
           @block.call(message)
         end
       end

data/lib/airbrake-ruby/truncator.rb

@@ -12,6 +12,10 @@ module Airbrake
     #   strings with +ENCODING_OPTIONS+
     TEMP_ENCODING = 'utf-16'.freeze
 
+    # @return [Array<Encoding>] encodings that are eligible for fixing invalid
+    #   characters
+    SUPPORTED_ENCODINGS = [Encoding::UTF_8, Encoding::ASCII].freeze
+
     # @return [String] what to append when something is a circular reference
     CIRCULAR = '[Circular]'.freeze
 
@@ -35,6 +39,7 @@ module Airbrake
     def truncate(object, seen = Set.new)
       if seen.include?(object.object_id)
         return CIRCULAR if CIRCULAR_TYPES.any? { |t| object.is_a?(t) }
+
         return object
       end
       truncate_object(object, seen << object.object_id)
@@ -63,6 +68,7 @@ module Airbrake
     def truncate_string(str)
       fixed_str = replace_invalid_characters(str)
       return fixed_str if fixed_str.length <= @max_size
+
       (fixed_str.slice(0, @max_size) + TRUNCATED).freeze
     end
 
@@ -76,6 +82,7 @@ module Airbrake
       truncated_hash = {}
       hash.each_with_index do |(key, val), idx|
         break if idx + 1 > @max_size
+
         truncated_hash[key] = truncate(val, seen)
       end
 
@@ -103,8 +110,7 @@ module Airbrake
     # @return [String] a UTF-8 encoded string
     # @see https://github.com/flori/json/commit/3e158410e81f94dbbc3da6b7b35f4f64983aa4e3
     def replace_invalid_characters(str)
-      encoding = str.encoding
-      utf8_string = (encoding == Encoding::UTF_8 || encoding == Encoding::ASCII)
+      utf8_string = SUPPORTED_ENCODINGS.include?(str.encoding)
       return str if utf8_string && str.valid_encoding?
 
       temp_str = str.dup

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,15 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.14.1'.freeze
+  # @api public
+  AIRBRAKE_RUBY_VERSION = '5.0.1'.freeze
+
+  # @return [Hash{Symbol=>String}] the information about the notifier library
+  # @since 5.0.0
+  # @api public
+  NOTIFIER_INFO = {
+    name: 'airbrake-ruby'.freeze,
+    version: Airbrake::AIRBRAKE_RUBY_VERSION,
+    url: 'https://github.com/airbrake/airbrake-ruby'.freeze,
+  }.freeze
 end

data/spec/airbrake_spec.rb

@@ -1,4 +1,13 @@
 RSpec.describe Airbrake do
+  let(:remote_settings) { instance_double(Airbrake::RemoteSettings) }
+
+  before do
+    allow(Airbrake::RemoteSettings).to receive(:poll).and_return(remote_settings)
+    allow(remote_settings).to receive(:stop_polling)
+  end
+
+  after { described_class.instance_variable_set(:@remote_settings, nil) }
+
   it "gets initialized with a performance notifier" do
     expect(described_class.performance_notifier).not_to be_nil
   end
@@ -99,41 +108,41 @@ RSpec.describe Airbrake do
       end
     end
 
-    context "when blacklist_keys gets configured" do
-      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+    context "when blocklist_keys gets configured" do
+      before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
-      it "adds blacklist filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysBlacklist))
-        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      it "adds blocklist filter" do
+        expect(described_class.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysBlocklist))
+        described_class.configure { |c| c.blocklist_keys = %w[password] }
       end
 
-      it "initializes blacklist with specified parameters" do
-        expect(Airbrake::Filters::KeysBlacklist).to receive(:new).with(%w[password])
-        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      it "initializes blocklist with specified parameters" do
+        expect(Airbrake::Filters::KeysBlocklist).to receive(:new).with(%w[password])
+        described_class.configure { |c| c.blocklist_keys = %w[password] }
       end
     end
 
-    context "when whitelist_keys gets configured" do
-      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+    context "when allowlist_keys gets configured" do
+      before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
-      it "adds whitelist filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysWhitelist))
-        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      it "adds allowlist filter" do
+        expect(described_class.notice_notifier).to receive(:add_filter)
+          .with(an_instance_of(Airbrake::Filters::KeysAllowlist))
+        described_class.configure { |c| c.allowlist_keys = %w[banana] }
       end
 
-      it "initializes whitelist with specified parameters" do
-        expect(Airbrake::Filters::KeysWhitelist).to receive(:new).with(%w[banana])
-        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      it "initializes allowlist with specified parameters" do
+        expect(Airbrake::Filters::KeysAllowlist).to receive(:new).with(%w[banana])
+        described_class.configure { |c| c.allowlist_keys = %w[banana] }
       end
     end
 
     context "when root_directory gets configured" do
-      before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
+      before { allow(described_class.notice_notifier).to receive(:add_filter) }
 
       it "adds root directory filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        expect(described_class.notice_notifier).to receive(:add_filter)
           .with(an_instance_of(Airbrake::Filters::RootDirectoryFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
       end
@@ -145,7 +154,7 @@ RSpec.describe Airbrake do
       end
 
       it "adds git revision filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        expect(described_class.notice_notifier).to receive(:add_filter)
           .with(an_instance_of(Airbrake::Filters::GitRevisionFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
       end
@@ -157,7 +166,7 @@ RSpec.describe Airbrake do
       end
 
       it "adds git repository filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        expect(described_class.notice_notifier).to receive(:add_filter)
           .with(an_instance_of(Airbrake::Filters::GitRepositoryFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
       end
@@ -169,7 +178,7 @@ RSpec.describe Airbrake do
       end
 
       it "adds git last checkout filter" do
-        expect(Airbrake.notice_notifier).to receive(:add_filter)
+        expect(described_class.notice_notifier).to receive(:add_filter)
           .with(an_instance_of(Airbrake::Filters::GitLastCheckoutFilter))
         described_class.configure { |c| c.root_directory = '/my/path' }
       end
@@ -182,7 +191,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_request" do
+  describe ".notify_request" do
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the request" do
         expect(described_class.performance_notifier).to receive(:notify) do |request|
@@ -217,7 +226,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_request_sync" do
+  describe ".notify_request_sync" do
     it "notifies request synchronously" do
       expect(described_class.performance_notifier).to receive(:notify_sync)
 
@@ -233,7 +242,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_query" do
+  describe ".notify_query" do
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the query" do
         expect(described_class.performance_notifier).to receive(:notify) do |query|
@@ -268,7 +277,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_query_sync" do
+  describe ".notify_query_sync" do
     it "notifies query synchronously" do
       expect(described_class.performance_notifier).to receive(:notify_sync)
 
@@ -284,7 +293,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_performance_breakdown" do
+  describe ".notify_performance_breakdown" do
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the performance breakdown" do
         expect(described_class.performance_notifier).to receive(:notify) do |query|
@@ -322,7 +331,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_performance_breakdown_sync" do
+  describe ".notify_performance_breakdown_sync" do
     it "notifies performance breakdown synchronously" do
       expect(described_class.performance_notifier).to receive(:notify_sync)
 
@@ -339,7 +348,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_queue" do
+  describe ".notify_queue" do
     context "when :stash key is not provided" do
       it "doesn't add anything to the stash of the queue" do
         expect(described_class.performance_notifier).to receive(:notify) do |queue|
@@ -370,7 +379,7 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe "#notify_queue_sync" do
+  describe ".notify_queue_sync" do
     it "notifies queue synchronously" do
       expect(described_class.performance_notifier).to receive(:notify_sync)
 
@@ -404,33 +413,47 @@ RSpec.describe Airbrake do
   end
 
   describe ".close" do
-    after { Airbrake.reset }
+    after { described_class.reset }
 
     context "when notice_notifier is defined" do
       it "gets closed" do
-        expect(Airbrake.notice_notifier).to receive(:close)
+        expect(described_class.notice_notifier).to receive(:close)
       end
     end
 
     context "when notice_notifier is undefined" do
       it "doesn't get closed (because it wasn't initialized)" do
-        Airbrake.instance_variable_set(:@notice_notifier, nil)
+        described_class.instance_variable_set(:@notice_notifier, nil)
         expect_any_instance_of(Airbrake::NoticeNotifier).not_to receive(:close)
       end
     end
 
     context "when performance_notifier is defined" do
       it "gets closed" do
-        expect(Airbrake.performance_notifier).to receive(:close)
+        expect(described_class.performance_notifier).to receive(:close)
       end
     end
 
     context "when perforance_notifier is undefined" do
       it "doesn't get closed (because it wasn't initialized)" do
-        Airbrake.instance_variable_set(:@performance_notifier, nil)
+        described_class.instance_variable_set(:@performance_notifier, nil)
         expect_any_instance_of(Airbrake::PerformanceNotifier)
           .not_to receive(:close)
       end
     end
+
+    context "when remote settings are defined" do
+      it "stops polling" do
+        described_class.instance_variable_set(:@remote_settings, remote_settings)
+        expect(remote_settings).to receive(:stop_polling)
+      end
+    end
+
+    context "when remote settings are undefined" do
+      it "doesn't stop polling (because they weren't initialized)" do
+        described_class.instance_variable_set(:@remote_settings, nil)
+        expect(remote_settings).not_to receive(:stop_polling)
+      end
+    end
   end
 end