airbrake-ruby 4.14.1 → 5.0.1

data/spec/remote_settings_spec.rb

@@ -0,0 +1,230 @@
+RSpec.describe Airbrake::RemoteSettings do
+  let(:project_id) { 123 }
+  let(:host) { 'https://v1-production-notifier-configs.s3.amazonaws.com' }
+
+  let(:endpoint) do
+    "#{host}/2020-06-18/config/#{project_id}/config.json"
+  end
+
+  let(:body) do
+    {
+      'poll_sec' => 1,
+      'settings' => [
+        {
+          'name' => 'apm',
+          'enabled' => false,
+        },
+        {
+          'name' => 'errors',
+          'enabled' => true,
+        },
+      ],
+    }
+  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
+
+        remote_settings = described_class.poll(project_id, host, &block)
+        sleep(0.2)
+        remote_settings.stop_polling
+
+        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
+      it "makes a request to AWS S3" do
+        remote_settings = described_class.poll(project_id, host) {}
+        sleep(0.1)
+        remote_settings.stop_polling
+
+        expect(stub).to have_been_requested.at_least_once
+      end
+
+      it "sends params about the environment with the request" do
+        remote_settings = described_class.poll(project_id, host) {}
+        sleep(0.1)
+        remote_settings.stop_polling
+
+        stub_with_query_params = stub.with(
+          query: URI.decode_www_form(described_class::QUERY_PARAMS).to_h,
+        )
+        expect(stub_with_query_params).to have_been_requested.at_least_once
+      end
+
+      it "fetches remote settings" do
+        settings = nil
+        remote_settings = described_class.poll(project_id, host) do |data|
+          settings = data
+        end
+        sleep(0.1)
+        remote_settings.stop_polling
+
+        expect(settings.error_notifications?).to eq(true)
+        expect(settings.performance_stats?).to eq(false)
+        expect(settings.interval).to eq(1)
+      end
+    end
+
+    context "when an error is raised while making a HTTP request" do
+      before do
+        allow(Net::HTTP).to receive(:get).and_raise(StandardError)
+      end
+
+      it "doesn't fetch remote settings" do
+        settings = nil
+        remote_settings = described_class.poll(project_id, host) do |data|
+          settings = data
+        end
+        sleep(0.1)
+        remote_settings.stop_polling
+
+        expect(stub).not_to have_been_requested
+        expect(settings.interval).to eq(600)
+      end
+    end
+
+    context "when an error is raised while parsing returned JSON" do
+      before do
+        allow(JSON).to receive(:parse).and_raise(JSON::ParserError)
+      end
+
+      it "doesn't update settings data" do
+        settings = nil
+        remote_settings = described_class.poll(project_id, host) do |data|
+          settings = data
+        end
+        sleep(0.1)
+        remote_settings.stop_polling
+
+        expect(stub).to have_been_requested.once
+        expect(settings.interval).to eq(600)
+      end
+    end
+
+    context "when API returns an XML response" do
+      let!(:stub) do
+        stub_request(:get, Regexp.new(endpoint))
+          .to_return(status: 200, body: '<?xml ...')
+      end
+
+      it "doesn't update settings data" do
+        settings = nil
+        remote_settings = described_class.poll(project_id, host) do |data|
+          settings = data
+        end
+        sleep(0.1)
+        remote_settings.stop_polling
+
+        expect(stub).to have_been_requested.once
+        expect(settings.interval).to eq(600)
+      end
+    end
+
+    context "when a config route is specified in the returned data" do
+      let(:new_endpoint) do
+        "http://example.com"
+      end
+
+      let(:body) do
+        { 'config_route' => new_endpoint, 'poll_sec' => 0.1 }
+      end
+
+      let!(:new_stub) do
+        stub_request(:get, Regexp.new(new_endpoint))
+          .to_return(status: 200, body: body.to_json)
+      end
+
+      it "makes the next request to the specified config route" do
+        remote_settings = described_class.poll(project_id, host) {}
+        sleep(0.2)
+
+        remote_settings.stop_polling
+
+        expect(stub).to have_been_requested.once
+        expect(new_stub).to have_been_requested.once
+      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/request_spec.rb

@@ -1,21 +1,9 @@
 RSpec.describe Airbrake::Request do
   describe "#stash" do
     subject do
-      described_class.new(
-        method: 'GET', route: '/', status_code: 200, start_time: Time.now,
-      )
+      described_class.new(method: 'GET', route: '/', status_code: 200)
     end
 
     it { is_expected.to respond_to(:stash) }
   end
-
-  describe "#end_time" do
-    it "is always equal to start_time + 1 second by default" do
-      time = Time.now
-      request = described_class.new(
-        method: 'GET', route: '/', status_code: 200, start_time: time,
-      )
-      expect(request.end_time).to eq(time + 1)
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -33,7 +33,7 @@ class AirbrakeTestError < RuntimeError
 
   def initialize(*)
     super
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     @backtrace = [
       "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb:23:in `<top (required)>'",
       "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'",
@@ -49,7 +49,7 @@ class AirbrakeTestError < RuntimeError
       "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:41:in `invoke'",
       "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/exe/rspec:4:in `<main>'",
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   # rubocop:disable Naming/AccessorMethodName
@@ -66,7 +66,7 @@ end
 class JavaAirbrakeTestError < AirbrakeTestError
   def initialize(*)
     super
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     @backtrace = [
       "org.jruby.java.invokers.InstanceMethodInvoker.call(InstanceMethodInvoker.java:26)",
       "org.jruby.ir.interpreter.Interpreter.INTERPRET_EVAL(Interpreter.java:126)",
@@ -80,7 +80,7 @@ class JavaAirbrakeTestError < AirbrakeTestError
       "org.jruby.Main.run(Main.java:225)",
       "org.jruby.Main.main(Main.java:197)",
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   def is_a?(*)

data/spec/stat_spec.rb

@@ -10,15 +10,6 @@ RSpec.describe Airbrake::Stat do
     end
   end
 
-  describe "#increment" do
-    let(:start_time) { Time.new(2018, 1, 1, 0, 0, 20, 0) }
-    let(:end_time) { Time.new(2018, 1, 1, 0, 0, 22, 0) }
-
-    before { subject.increment(start_time, end_time) }
-
-    its(:sum) { is_expected.to eq(2000) }
-  end
-
   describe "#increment_ms" do
     before { subject.increment_ms(1000) }
 

data/spec/sync_sender_spec.rb

@@ -27,7 +27,9 @@ RSpec.describe Airbrake::SyncSender do
       expect(
         a_request(:post, endpoint).with(
           headers: {
-            'User-Agent' => %r{airbrake-ruby/\d+\.\d+\.\d+ Ruby/\d+\.\d+\.\d+},
+            'User-Agent' => %r{
+              airbrake-ruby/\d+\.\d+\.\d+(\.rc\.\d+)?\sRuby/\d+\.\d+\.\d+
+            }x,
           },
         ),
       ).to have_been_made.once

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.14.1
+  version: 5.0.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -44,6 +44,7 @@ files:
 - lib/airbrake-ruby/benchmark.rb
 - lib/airbrake-ruby/code_hunk.rb
 - lib/airbrake-ruby/config.rb
+- lib/airbrake-ruby/config/processor.rb
 - lib/airbrake-ruby/config/validator.rb
 - lib/airbrake-ruby/deploy_notifier.rb
 - lib/airbrake-ruby/file_cache.rb
@@ -55,9 +56,9 @@ files:
 - lib/airbrake-ruby/filters/git_last_checkout_filter.rb
 - lib/airbrake-ruby/filters/git_repository_filter.rb
 - lib/airbrake-ruby/filters/git_revision_filter.rb
-- lib/airbrake-ruby/filters/keys_blacklist.rb
+- lib/airbrake-ruby/filters/keys_allowlist.rb
+- lib/airbrake-ruby/filters/keys_blocklist.rb
 - lib/airbrake-ruby/filters/keys_filter.rb
-- lib/airbrake-ruby/filters/keys_whitelist.rb
 - lib/airbrake-ruby/filters/root_directory_filter.rb
 - lib/airbrake-ruby/filters/sql_filter.rb
 - lib/airbrake-ruby/filters/system_exit_filter.rb
@@ -77,6 +78,8 @@ files:
 - lib/airbrake-ruby/promise.rb
 - lib/airbrake-ruby/query.rb
 - lib/airbrake-ruby/queue.rb
+- lib/airbrake-ruby/remote_settings.rb
+- lib/airbrake-ruby/remote_settings/settings_data.rb
 - lib/airbrake-ruby/request.rb
 - lib/airbrake-ruby/response.rb
 - lib/airbrake-ruby/stashable.rb
@@ -93,6 +96,7 @@ files:
 - spec/backtrace_spec.rb
 - spec/benchmark_spec.rb
 - spec/code_hunk_spec.rb
+- spec/config/processor_spec.rb
 - spec/config/validator_spec.rb
 - spec/config_spec.rb
 - spec/deploy_notifier_spec.rb
@@ -105,8 +109,8 @@ files:
 - spec/filters/git_last_checkout_filter_spec.rb
 - spec/filters/git_repository_filter.rb
 - spec/filters/git_revision_filter_spec.rb
-- spec/filters/keys_blacklist_spec.rb
-- spec/filters/keys_whitelist_spec.rb
+- spec/filters/keys_allowlist_spec.rb
+- spec/filters/keys_blocklist_spec.rb
 - spec/filters/root_directory_filter_spec.rb
 - spec/filters/sql_filter_spec.rb
 - spec/filters/system_exit_filter_spec.rb
@@ -131,6 +135,8 @@ files:
 - spec/promise_spec.rb
 - spec/query_spec.rb
 - spec/queue_spec.rb
+- spec/remote_settings/settings_data_spec.rb
+- spec/remote_settings_spec.rb
 - spec/request_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
@@ -146,7 +152,7 @@ homepage: https://airbrake.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -162,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby notifier for https://airbrake.io
 test_files:
@@ -172,14 +178,14 @@ test_files:
 - spec/filters/exception_attributes_filter_spec.rb
 - spec/filters/root_directory_filter_spec.rb
 - spec/filters/sql_filter_spec.rb
-- spec/filters/keys_whitelist_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
+- spec/filters/keys_allowlist_spec.rb
 - spec/filters/dependency_filter_spec.rb
 - spec/filters/context_filter_spec.rb
 - spec/filters/git_last_checkout_filter_spec.rb
 - spec/filters/git_revision_filter_spec.rb
-- spec/filters/keys_blacklist_spec.rb
+- spec/filters/keys_blocklist_spec.rb
 - spec/filters/gem_root_filter_spec.rb
 - spec/filters/git_repository_filter.rb
 - spec/spec_helper.rb
@@ -196,6 +202,7 @@ test_files:
 - spec/promise_spec.rb
 - spec/thread_pool_spec.rb
 - spec/config/validator_spec.rb
+- spec/config/processor_spec.rb
 - spec/sync_sender_spec.rb
 - spec/ignorable_spec.rb
 - spec/deploy_notifier_spec.rb
@@ -207,6 +214,7 @@ test_files:
 - spec/request_spec.rb
 - spec/notice_notifier/options_spec.rb
 - spec/filter_chain_spec.rb
+- spec/remote_settings/settings_data_spec.rb
 - spec/response_spec.rb
 - spec/queue_spec.rb
 - spec/code_hunk_spec.rb
@@ -220,3 +228,4 @@ test_files:
 - spec/inspectable_spec.rb
 - spec/stashable_spec.rb
 - spec/query_spec.rb
+- spec/remote_settings_spec.rb