airbrake-ruby 5.0.2 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ac92e6db1b50d6cba741b6e3d2270e101bed02fa1779967f142a9a64b7bbb4
-  data.tar.gz: 9f0debfc7e2eb97bd2dd0e263d1e40f81e3c8132d009dfc18a9cfcabf66fe31f
+  metadata.gz: 8102082d97168a2204b3e730fc2085d30d06d4ab501e6207d91ce9d67bd91584
+  data.tar.gz: cf2234bd6fc61e439796b0f664163a12fdd4c39c4256a1c469f06dd1f8132de3
 SHA512:
-  metadata.gz: 8287f643e7ba4af54d5f6a4ee74b03c412c0a8a8fb2b8b7f8b9e2599cc1a1d38081c85877b554cb75a5e040d06c2d415af293d41f7692d4c1bfc29aef2df4285
-  data.tar.gz: dc8eacdeda076da7adffa1a469ed2ffe65e3d78a810cbf38b2e5a55ba584144f343a9cfa9a3c2b1cc036eabe79198045c4dc5e8239dd948c7292f3fba1a3e3fc
+  metadata.gz: d5b353597aa2bf9d59fa454f8a6a87fadcdc71685a7e21ef3ec9f74e57b20268e5d6cad2d6d0fe061bdcdbe02e65cf2e5761d4e92c6370ea1d1316972da9d9af
+  data.tar.gz: d13b77d0f959ff3a5326f054b8df67c9402b216038afd25672df8b6803623ac135bb5366739687fc5c234ae2e127d075828f747bb945d9ba4d48f3f354775f17

data/lib/airbrake-ruby/config.rb

@@ -121,13 +121,21 @@ module Airbrake
     # @return [Boolean] true if the library should send error reports to
     #   Airbrake, false otherwise
     # @api public
-    # @since 5.0.0
+    # @since v5.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")
+    # @return [String] the host which should be used for fetching remote
+    #   configuration options
+    # @api public
+    # @since v5.0.0
     attr_accessor :remote_config_host
 
+    # @return [String] true if notifier should periodically fetch remote
+    #   configuration, false otherwise
+    # @api public
+    # @since v5.2.0
+    attr_accessor :remote_config
+
     class << self
       # @return [Config]
       attr_writer :instance
@@ -140,7 +148,7 @@ module Airbrake
 
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def initialize(user_config = {})
       self.proxy = {}
       self.queue_size = 100
@@ -151,7 +159,7 @@ module Airbrake
       self.project_key = user_config[:project_key]
       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.remote_config_host = 'https://notifier-configs.airbrake.io'
 
       self.ignore_environments = []
 
@@ -171,10 +179,11 @@ module Airbrake
       self.query_stats = true
       self.job_stats = true
       self.error_notifications = true
+      self.remote_config = true
 
       merge(user_config)
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # The full URL to the Airbrake Notice API. Based on the +:error_host+ option.
     # @return [URI] the endpoint address

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

@@ -3,7 +3,7 @@ module Airbrake
     # Processor is a helper class, which is responsible for setting default
     # config values, default notifier filters and remote configuration changes.
     #
-    # @since 5.0.0
+    # @since v5.0.0
     # @api private
     class Processor
       # @param [Airbrake::Config] config
@@ -41,7 +41,9 @@ module Airbrake
 
       # @return [Airbrake::RemoteSettings]
       def process_remote_configuration
+        return unless @config.remote_config
         return unless @project_id
+        return if @config.environment == 'test'
 
         RemoteSettings.poll(@project_id, @config.remote_config_host) do |data|
           @poll_callback.call(data)

data/lib/airbrake-ruby/file_cache.rb

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

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

@@ -41,8 +41,7 @@ module Airbrake
           thread_info[:fiber_variables] = vars
         end
 
-        # Present in Ruby 2.3+.
-        if th.respond_to?(:name) && (name = th.name)
+        if (name = th.name)
           thread_info[:name] = name
         end
 

data/lib/airbrake-ruby/grouppable.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Grouppable adds the `#groups` method, so that we don't need to define it in
   # all of performance models every time we add a model without groups.
   #
-  # @since 4.9.0
+  # @since v4.9.0
   # @api private
   module Grouppable
     def groups

data/lib/airbrake-ruby/mergeable.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Mergeable adds the `#merge` method, so that we don't need to define it in
   # all of performance models every time we add a model.
   #
-  # @since 4.9.0
+  # @since v4.9.0
   # @api private
   module Mergeable
     def merge(_other)

data/lib/airbrake-ruby/remote_settings.rb

@@ -8,22 +8,11 @@ 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 5.0.0
+  # @since v5.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',
-    ).freeze
-
     # @return [Hash{Symbol=>String}] metadata to be attached to every GET
     #   request
     QUERY_PARAMS = URI.encode_www_form(
@@ -33,6 +22,9 @@ module Airbrake
       language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
     ).freeze
 
+    # @return [String]
+    HTTP_OK = '200'.freeze
+
     # Polls remote config of the given project.
     #
     # @param [Integer] project_id
@@ -54,18 +46,11 @@ module Airbrake
       @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
@@ -77,17 +62,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
@@ -95,22 +74,20 @@ module Airbrake
     def fetch_config
       response = nil
       begin
-        response = Net::HTTP.get(build_config_uri)
+        response = Net::HTTP.get_response(build_config_uri)
       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)
+      unless response.code == HTTP_OK
+        logger.error(response.body)
         return {}
       end
 
       json = nil
       begin
-        json = JSON.parse(response)
+        json = JSON.parse(response.body)
       rescue JSON::ParserError => ex
         logger.error(ex)
         return {}
@@ -124,22 +101,5 @@ module Airbrake
       uri.query = QUERY_PARAMS
       uri
     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/callback.rb

@@ -4,7 +4,7 @@ module Airbrake
     # updates the local config according to the data.
     #
     # @api private
-    # @since 5.0.2
+    # @since v5.0.2
     class Callback
       def initialize(config)
         @config = config
@@ -15,9 +15,9 @@ module Airbrake
       # @param [Airbrake::RemoteSettings::SettingsData] data
       # @return [void]
       def call(data)
-        @config.logger.debug(
-          "#{LOG_LABEL} applying remote settings: #{data.to_h}",
-        )
+        @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

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

@@ -11,7 +11,7 @@ module Airbrake
     #
     #   settings_data.interval #=> 600
     #
-    # @since 5.0.0
+    # @since v5.0.0
     # @api private
     class SettingsData
       # @return [Integer] how frequently we should poll the config API

data/lib/airbrake-ruby/version.rb

@@ -3,10 +3,10 @@
 module Airbrake
   # @return [String] the library version
   # @api public
-  AIRBRAKE_RUBY_VERSION = '5.0.2'.freeze
+  AIRBRAKE_RUBY_VERSION = '5.2.0'.freeze
 
   # @return [Hash{Symbol=>String}] the information about the notifier library
-  # @since 5.0.0
+  # @since v5.0.0
   # @api public
   NOTIFIER_INFO = {
     name: 'airbrake-ruby'.freeze,

data/spec/config/processor_spec.rb

@@ -53,9 +53,18 @@ RSpec.describe Airbrake::Config::Processor do
       end
     end
 
+    context "when the config sets environment to 'test'" do
+      let(:config) { Airbrake::Config.new(project_id: 123, environment: 'test') }
+
+      it "doesn't set remote settings" do
+        expect(Airbrake::RemoteSettings).not_to receive(:poll)
+        described_class.new(config).process_remote_configuration
+      end
+    end
+
     context "when the config defines a project_id" do
       let(:config) do
-        Airbrake::Config.new(project_id: 123)
+        Airbrake::Config.new(project_id: 123, environment: 'not-test')
       end
 
       it "sets remote settings" do
@@ -63,6 +72,15 @@ RSpec.describe Airbrake::Config::Processor do
         described_class.new(config).process_remote_configuration
       end
     end
+
+    context "when the config disables the remote_config option" do
+      let(:config) { Airbrake::Config.new(project_id: 123, remote_config: false) }
+
+      it "doesn't set remote settings" do
+        expect(Airbrake::RemoteSettings).not_to receive(:poll)
+        described_class.new(config).process_remote_configuration
+      end
+    end
   end
 
   describe "#add_filters" do

data/spec/config_spec.rb

@@ -26,9 +26,10 @@ RSpec.describe Airbrake::Config do
   its(:query_stats) { is_expected.to eq(true) }
   its(:job_stats) { is_expected.to eq(true) }
   its(:error_notifications) { is_expected.to eq(true) }
+  its(:remote_config) { is_expected.to eq(true) }
 
   its(:remote_config_host) do
-    is_expected.to eq('https://v1-production-notifier-configs.s3.amazonaws.com')
+    is_expected.to eq('https://notifier-configs.airbrake.io')
   end
 
   describe "#new" do

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
     it "attaches last checkouted email" do
       subject.call(notice)
       expect(notice[:context][:lastCheckout][:email]).to(
-        match(/\A\w+[\w.-]*@\w+\.?\w+?\z/),
+        match(/\A\w+[\w.-]*@(\w+\.)*\w+\z/),
       )
     end
 

data/spec/filters/thread_filter_spec.rb

@@ -234,7 +234,7 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     end
   end
 
-  it "appends name", skip: !Thread.current.respond_to?(:name) do
+  it "appends name" do
     new_thread do |th|
       th.name = 'bingo'
       subject.call(notice)

data/spec/remote_settings/callback_spec.rb

@@ -22,7 +22,9 @@ RSpec.describe Airbrake::RemoteSettings::Callback do
     end
 
     it "logs given data" do
-      expect(logger).to receive(:debug).with(/applying remote settings/)
+      expect(logger).to receive(:debug) do |&block|
+        expect(block.call).to match(/applying remote settings/)
+      end
       described_class.new(config).call(data)
     end
 

data/spec/remote_settings_spec.rb

@@ -22,42 +22,19 @@ RSpec.describe Airbrake::RemoteSettings do
     }
   end
 
-  let(:config_path) { described_class::CONFIG_DUMP_PATH }
-  let(:config_dir) { File.dirname(config_path) }
-
   let!(:stub) do
     stub_request(:get, Regexp.new(endpoint))
       .to_return(status: 200, body: body.to_json)
   end
 
-  before do
-    # Do not create config dumps on disk.
-    allow(Dir).to receive(:mkdir).with(config_dir)
-    allow(File).to receive(:write).with(config_path, anything)
-  end
-
   describe ".poll" do
     describe "config loading" do
       let(:settings_data) { described_class::SettingsData.new(project_id, body) }
 
       before do
-        allow(File).to receive(:exist?).with(config_path).and_return(true)
-        allow(File).to receive(:read).with(config_path).and_return(body.to_json)
-
         allow(described_class::SettingsData).to receive(:new).and_return(settings_data)
       end
 
-      it "loads the config from disk" do
-        expect(File).to receive(:read).with(config_path)
-        expect(settings_data).to receive(:merge!).with(body).twice
-
-        remote_settings = described_class.poll(project_id, host) {}
-        sleep(0.2)
-        remote_settings.stop_polling
-
-        expect(stub).to have_been_requested.once
-      end
-
       it "yields the config to the block twice" do
         block = proc {}
         expect(block).to receive(:call).twice
@@ -68,21 +45,6 @@ RSpec.describe Airbrake::RemoteSettings do
 
         expect(stub).to have_been_requested.once
       end
-
-      context "when config loading fails" do
-        it "logs an error" do
-          expect(File).to receive(:read).and_raise(StandardError)
-          expect(Airbrake::Loggable.instance).to receive(:error).with(
-            '**Airbrake: config loading failed: StandardError',
-          )
-
-          remote_settings = described_class.poll(project_id, host) {}
-          sleep(0.2)
-          remote_settings.stop_polling
-
-          expect(stub).to have_been_requested.once
-        end
-      end
     end
 
     context "when no errors are raised" do
@@ -121,7 +83,7 @@ RSpec.describe Airbrake::RemoteSettings do
 
     context "when an error is raised while making a HTTP request" do
       before do
-        allow(Net::HTTP).to receive(:get).and_raise(StandardError)
+        allow(Net::HTTP).to receive(:get_response).and_raise(StandardError)
       end
 
       it "doesn't fetch remote settings" do
@@ -155,10 +117,10 @@ RSpec.describe Airbrake::RemoteSettings do
       end
     end
 
-    context "when API returns an XML response" do
+    context "when API returns a non-200 response" do
       let!(:stub) do
         stub_request(:get, Regexp.new(endpoint))
-          .to_return(status: 200, body: '<?xml ...')
+          .to_return(status: 201, body: body.to_json)
       end
 
       it "doesn't update settings data" do
@@ -172,6 +134,29 @@ RSpec.describe Airbrake::RemoteSettings do
         expect(stub).to have_been_requested.once
         expect(settings.interval).to eq(600)
       end
+
+      it "logs error" do
+        expect(Airbrake::Loggable.instance).to receive(:error).with(body.to_json)
+
+        remote_settings = described_class.poll(project_id, host) {}
+        sleep(0.1)
+        remote_settings.stop_polling
+      end
+    end
+
+    context "when API returns a 200 response" do
+      let!(:stub) do
+        stub_request(:get, Regexp.new(endpoint))
+          .to_return(status: 200, body: body.to_json)
+      end
+
+      it "doesn't log errors" do
+        expect(Airbrake::Loggable.instance).not_to receive(:error)
+
+        remote_settings = described_class.poll(project_id, host) {}
+        sleep(0.1)
+        remote_settings.stop_polling
+      end
     end
 
     context "when a config route is specified in the returned data" do
@@ -199,32 +184,4 @@ RSpec.describe Airbrake::RemoteSettings do
       end
     end
   end
-
-  describe "#stop_polling" do
-    it "dumps config data to disk" do
-      expect(Dir).to receive(:mkdir).with(config_dir)
-      expect(File).to receive(:write).with(config_path, body.to_json)
-
-      remote_settings = described_class.poll(project_id, host) {}
-      sleep(0.2)
-      remote_settings.stop_polling
-
-      expect(stub).to have_been_requested.once
-    end
-
-    context "when config dumping fails" do
-      it "logs an error" do
-        expect(File).to receive(:write).and_raise(StandardError)
-        expect(Airbrake::Loggable.instance).to receive(:error).with(
-          '**Airbrake: config dumping failed: StandardError',
-        )
-
-        remote_settings = described_class.poll(project_id, host) {}
-        sleep(0.2)
-        remote_settings.stop_polling
-
-        expect(stub).to have_been_requested.once
-      end
-    end
-  end
 end

data/spec/tdigest_spec.rb

@@ -86,7 +86,7 @@ RSpec.describe Airbrake::TDigest do
           maxerr = [maxerr, (i - q).abs].max
         end
 
-        expect(maxerr).to be < 0.01
+        expect(maxerr).to be < 0.02
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.2.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3