airbrake-ruby 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773b982037081f5d6dfb045378a35b2854a251d9e238cd58dd0b1216c75e86c5
-  data.tar.gz: a7177673edea3b8f05055683972b918bf43255ad68fc21688317ec5ed56dbb7b
+  metadata.gz: 43ac92e6db1b50d6cba741b6e3d2270e101bed02fa1779967f142a9a64b7bbb4
+  data.tar.gz: 9f0debfc7e2eb97bd2dd0e263d1e40f81e3c8132d009dfc18a9cfcabf66fe31f
 SHA512:
-  metadata.gz: 6e377bdd85f7aa912cc9341834f9413ec5a89b71bbe2acf561118be97a911baef6c7cc210fa2430e286d135ce829ca7009110180c5938ac7017a403d7be239de
-  data.tar.gz: b9e6812ed5d2734c7fd3ffd83b14e5d366594366c5460244e43d13375ede211c56d4e1a3b4c79b613de0d480493d9950a833670bb2f59161f1d0db051936b0a1
+  metadata.gz: 8287f643e7ba4af54d5f6a4ee74b03c412c0a8a8fb2b8b7f8b9e2599cc1a1d38081c85877b554cb75a5e040d06c2d415af293d41f7692d4c1bfc29aef2df4285
+  data.tar.gz: dc8eacdeda076da7adffa1a469ed2ffe65e3d78a810cbf38b2e5a55ba584144f343a9cfa9a3c2b1cc036eabe79198045c4dc5e8239dd948c7292f3fba1a3e3fc

data/lib/airbrake-ruby.rb

@@ -13,6 +13,7 @@ require 'airbrake-ruby/grouppable'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
 require 'airbrake-ruby/config/processor'
+require 'airbrake-ruby/remote_settings/callback'
 require 'airbrake-ruby/remote_settings/settings_data'
 require 'airbrake-ruby/remote_settings'
 require 'airbrake-ruby/promise'

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

@@ -18,6 +18,7 @@ module Airbrake
         @blocklist_keys = @config.blocklist_keys
         @allowlist_keys = @config.allowlist_keys
         @project_id = @config.project_id
+        @poll_callback = Airbrake::RemoteSettings::Callback.new(config)
       end
 
       # @param [Airbrake::NoticeNotifier] notifier
@@ -42,11 +43,9 @@ module Airbrake
       def process_remote_configuration
         return unless @project_id
 
-        RemoteSettings.poll(
-          @project_id,
-          @config.remote_config_host,
-          &method(:poll_callback)
-        )
+        RemoteSettings.poll(@project_id, @config.remote_config_host) do |data|
+          @poll_callback.call(data)
+        end
       end
 
       # @param [Airbrake::NoticeNotifier] notifier
@@ -65,20 +64,6 @@ module Airbrake
           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/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(
+          "#{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
+
+        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

@@ -58,13 +58,8 @@ module Airbrake
       # @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,
-          )
+        if @data['config_route'] && !@data['config_route'].empty?
+          return remote_config_host.chomp('/') + '/' + @data['config_route']
         end
 
         format(

data/lib/airbrake-ruby/version.rb

@@ -3,7 +3,7 @@
 module Airbrake
   # @return [String] the library version
   # @api public
-  AIRBRAKE_RUBY_VERSION = '5.0.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '5.0.2'.freeze
 
   # @return [Hash{Symbol=>String}] the information about the notifier library
   # @since 5.0.0

data/spec/config/processor_spec.rb

@@ -122,88 +122,4 @@ RSpec.describe Airbrake::Config::Processor do
       end
     end
   end
-
-  describe "#poll_callback" do
-    let(:logger) { Logger.new(File::NULL) }
-
-    let(:config) do
-      Airbrake::Config.new(
-        project_id: 123,
-        logger: logger,
-      )
-    end
-
-    let(:data) do
-      instance_double(Airbrake::RemoteSettings::SettingsData)
-    end
-
-    before do
-      allow(data).to receive(:to_h)
-      allow(data).to receive(:error_host)
-      allow(data).to receive(:apm_host)
-      allow(data).to receive(:error_notifications?)
-      allow(data).to receive(:performance_stats?)
-    end
-
-    it "logs given data" do
-      expect(logger).to receive(:debug).with(/applying remote settings/)
-      described_class.new(config).poll_callback(data)
-    end
-
-    it "sets the error_notifications option" do
-      config.error_notifications = false
-      expect(data).to receive(:error_notifications?).and_return(true)
-
-      described_class.new(config).poll_callback(data)
-      expect(config.error_notifications).to eq(true)
-    end
-
-    it "sets the performance_stats option" do
-      config.performance_stats = false
-      expect(data).to receive(:performance_stats?).and_return(true)
-
-      described_class.new(config).poll_callback(data)
-      expect(config.performance_stats).to eq(true)
-    end
-
-    context "when error_host returns a value" do
-      it "sets the error_host option" do
-        config.error_host = 'http://api.airbrake.io'
-        allow(data).to receive(:error_host).and_return('https://api.example.com')
-
-        described_class.new(config).poll_callback(data)
-        expect(config.error_host).to eq('https://api.example.com')
-      end
-    end
-
-    context "when error_host returns nil" do
-      it "doesn't modify the error_host option" do
-        config.error_host = 'http://api.airbrake.io'
-        allow(data).to receive(:error_host).and_return(nil)
-
-        described_class.new(config).poll_callback(data)
-        expect(config.error_host).to eq('http://api.airbrake.io')
-      end
-    end
-
-    context "when apm_host returns a value" do
-      it "sets the apm_host option" do
-        config.apm_host = 'http://api.airbrake.io'
-        allow(data).to receive(:apm_host).and_return('https://api.example.com')
-
-        described_class.new(config).poll_callback(data)
-        expect(config.apm_host).to eq('https://api.example.com')
-      end
-    end
-
-    context "when apm_host returns nil" do
-      it "doesn't modify the apm_host option" do
-        config.apm_host = 'http://api.airbrake.io'
-        allow(data).to receive(:apm_host).and_return(nil)
-
-        described_class.new(config).poll_callback(data)
-        expect(config.apm_host).to eq('http://api.airbrake.io')
-      end
-    end
-  end
 end

data/spec/remote_settings/callback_spec.rb

@@ -0,0 +1,141 @@
+RSpec.describe Airbrake::RemoteSettings::Callback do
+  describe "#call" do
+    let(:logger) { Logger.new(File::NULL) }
+
+    let(:config) do
+      Airbrake::Config.new(
+        project_id: 123,
+        logger: logger,
+      )
+    end
+
+    let(:data) do
+      instance_double(Airbrake::RemoteSettings::SettingsData)
+    end
+
+    before do
+      allow(data).to receive(:to_h)
+      allow(data).to receive(:error_host)
+      allow(data).to receive(:apm_host)
+      allow(data).to receive(:error_notifications?)
+      allow(data).to receive(:performance_stats?)
+    end
+
+    it "logs given data" do
+      expect(logger).to receive(:debug).with(/applying remote settings/)
+      described_class.new(config).call(data)
+    end
+
+    context "when the config disables error notifications" do
+      before do
+        config.error_notifications = false
+        allow(data).to receive(:error_notifications?).and_return(true)
+      end
+
+      it "keeps the option disabled forever" do
+        callback = described_class.new(config)
+
+        callback.call(data)
+        expect(config.error_notifications).to eq(false)
+
+        callback.call(data)
+        expect(config.error_notifications).to eq(false)
+
+        callback.call(data)
+        expect(config.error_notifications).to eq(false)
+      end
+    end
+
+    context "when the config enables error notifications" do
+      before { config.error_notifications = true }
+
+      it "can disable and enable error notifications" do
+        expect(data).to receive(:error_notifications?).and_return(false)
+
+        callback = described_class.new(config)
+        callback.call(data)
+        expect(config.error_notifications).to eq(false)
+
+        expect(data).to receive(:error_notifications?).and_return(true)
+        callback.call(data)
+        expect(config.error_notifications).to eq(true)
+      end
+    end
+
+    context "when the config disables performance_stats" do
+      before do
+        config.performance_stats = false
+        allow(data).to receive(:performance_stats?).and_return(true)
+      end
+
+      it "keeps the option disabled forever" do
+        callback = described_class.new(config)
+
+        callback.call(data)
+        expect(config.performance_stats).to eq(false)
+
+        callback.call(data)
+        expect(config.performance_stats).to eq(false)
+
+        callback.call(data)
+        expect(config.performance_stats).to eq(false)
+      end
+    end
+
+    context "when the config enables performance stats" do
+      before { config.performance_stats = true }
+
+      it "can disable and enable performance_stats" do
+        expect(data).to receive(:performance_stats?).and_return(false)
+
+        callback = described_class.new(config)
+        callback.call(data)
+        expect(config.performance_stats).to eq(false)
+
+        expect(data).to receive(:performance_stats?).and_return(true)
+        callback.call(data)
+        expect(config.performance_stats).to eq(true)
+      end
+    end
+
+    context "when error_host returns a value" do
+      it "sets the error_host option" do
+        config.error_host = 'http://api.airbrake.io'
+        allow(data).to receive(:error_host).and_return('https://api.example.com')
+
+        described_class.new(config).call(data)
+        expect(config.error_host).to eq('https://api.example.com')
+      end
+    end
+
+    context "when error_host returns nil" do
+      it "doesn't modify the error_host option" do
+        config.error_host = 'http://api.airbrake.io'
+        allow(data).to receive(:error_host).and_return(nil)
+
+        described_class.new(config).call(data)
+        expect(config.error_host).to eq('http://api.airbrake.io')
+      end
+    end
+
+    context "when apm_host returns a value" do
+      it "sets the apm_host option" do
+        config.apm_host = 'http://api.airbrake.io'
+        allow(data).to receive(:apm_host).and_return('https://api.example.com')
+
+        described_class.new(config).call(data)
+        expect(config.apm_host).to eq('https://api.example.com')
+      end
+    end
+
+    context "when apm_host returns nil" do
+      it "doesn't modify the apm_host option" do
+        config.apm_host = 'http://api.airbrake.io'
+        allow(data).to receive(:apm_host).and_return(nil)
+
+        described_class.new(config).call(data)
+        expect(config.apm_host).to eq('http://api.airbrake.io')
+      end
+    end
+  end
+end

data/spec/remote_settings/settings_data_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Airbrake::RemoteSettings::SettingsData do
 
       expect(settings_data.interval).to eq(123)
       expect(settings_data.config_route(''))
-        .to eq('abc/2020-06-18/config/123/config.json')
+        .to eq('/abc')
     end
   end
 
@@ -60,78 +60,48 @@ RSpec.describe Airbrake::RemoteSettings::SettingsData do
   end
 
   describe "#config_route" do
-    let(:host) { 'https://v1-production-notifier-configs.s3.amazonaws.com' }
+    let(:host) { 'http://example.com/' }
 
-    context "when given a remote host through the remote config" do
-      context "and when the remote host ends with a slash" do
-        let(:data) do
-          { 'config_route' => 'http://example.com/' }
-        end
-
-        it "returns the route with the host" do
-          expect(described_class.new(project_id, data).config_route(host)).to eq(
-            "http://example.com/2020-06-18/config/#{project_id}/config.json",
-          )
-        end
+    context "when remote config specifies a config route" do
+      let(:data) do
+        { 'config_route' => '123/cfg/321/cfg.json' }
       end
 
-      context "and when the remote host doesn't with a slash" do
-        let(:data) do
-          { 'config_route' => 'http://example.com' }
-        end
-
-        it "returns the route with the host" do
-          expect(described_class.new(project_id, data).config_route(host)).to eq(
-            "http://example.com/2020-06-18/config/#{project_id}/config.json",
-          )
-        end
+      it "returns the config route with the provided location" do
+        expect(described_class.new(project_id, data).config_route(host)).to eq(
+          'http://example.com/123/cfg/321/cfg.json',
+        )
       end
     end
 
-    context "when given a remote host through local configuration" do
-      context "and when the remote host ends with a slash" do
-        let(:host) { 'http://example.com/' }
-
-        it "returns the route with the host" do
-          expect(described_class.new(project_id, {}).config_route(host)).to eq(
-            "http://example.com/2020-06-18/config/#{project_id}/config.json",
-          )
-        end
-      end
-
-      context "and when the remote host doesn't with a slash" do
-        let(:host) { 'http://example.com' }
-
-        it "returns the route with the given host" do
-          expect(described_class.new(project_id, {}).config_route(host)).to eq(
-            "http://example.com/2020-06-18/config/#{project_id}/config.json",
-          )
-        end
+    context "when remote config DOES NOT specify a config route" do
+      it "returns the config route with the default location" do
+        expect(described_class.new(project_id, {}).config_route(host)).to eq(
+          "http://example.com/2020-06-18/config/#{project_id}/config.json",
+        )
       end
     end
 
-    context "when the given remote host in the remote config is nil" do
+    context "when a config route is specified but is set to nil" do
       let(:data) do
         { 'config_route' => nil }
       end
 
-      it "returns the route with the given host instead" do
+      it "returns the config route with the default location" do
         expect(described_class.new(project_id, data).config_route(host)).to eq(
-          'https://v1-production-notifier-configs.s3.amazonaws.com/' \
-          "2020-06-18/config/#{project_id}/config.json",
+          "http://example.com/2020-06-18/config/#{project_id}/config.json",
         )
       end
     end
 
-    context "when the given remote host in the remote config is an empty string" do
+    context "when a config route is specified but is set to an empty string" do
       let(:data) do
         { 'config_route' => '' }
       end
 
       it "returns the route with the default instead" do
         expect(described_class.new(project_id, data).config_route(host)).to eq(
-          'https://v1-production-notifier-configs.s3.amazonaws.com/' \
-          "2020-06-18/config/#{project_id}/config.json",
+          "http://example.com/2020-06-18/config/#{project_id}/config.json",
         )
       end
     end

data/spec/remote_settings_spec.rb

@@ -175,16 +175,16 @@ RSpec.describe Airbrake::RemoteSettings do
     end
 
     context "when a config route is specified in the returned data" do
-      let(:new_endpoint) do
-        "http://example.com"
+      let(:new_config_route) do
+        '213/config/111/config.json'
       end
 
       let(:body) do
-        { 'config_route' => new_endpoint, 'poll_sec' => 0.1 }
+        { 'config_route' => new_config_route, 'poll_sec' => 0.1 }
       end
 
       let!(:new_stub) do
-        stub_request(:get, Regexp.new(new_endpoint))
+        stub_request(:get, Regexp.new(new_config_route))
           .to_return(status: 200, body: body.to_json)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -79,6 +79,7 @@ files:
 - lib/airbrake-ruby/query.rb
 - lib/airbrake-ruby/queue.rb
 - lib/airbrake-ruby/remote_settings.rb
+- lib/airbrake-ruby/remote_settings/callback.rb
 - lib/airbrake-ruby/remote_settings/settings_data.rb
 - lib/airbrake-ruby/request.rb
 - lib/airbrake-ruby/response.rb
@@ -135,6 +136,7 @@ files:
 - spec/promise_spec.rb
 - spec/query_spec.rb
 - spec/queue_spec.rb
+- spec/remote_settings/callback_spec.rb
 - spec/remote_settings/settings_data_spec.rb
 - spec/remote_settings_spec.rb
 - spec/request_spec.rb
@@ -215,6 +217,7 @@ test_files:
 - spec/notice_notifier/options_spec.rb
 - spec/filter_chain_spec.rb
 - spec/remote_settings/settings_data_spec.rb
+- spec/remote_settings/callback_spec.rb
 - spec/response_spec.rb
 - spec/queue_spec.rb
 - spec/code_hunk_spec.rb