airbrake-ruby 4.8.0 → 5.2.0

data/spec/remote_settings_spec.rb

@@ -0,0 +1,187 @@
+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!(:stub) do
+    stub_request(:get, Regexp.new(endpoint))
+      .to_return(status: 200, body: body.to_json)
+  end
+
+  describe ".poll" do
+    describe "config loading" do
+      let(:settings_data) { described_class::SettingsData.new(project_id, body) }
+
+      before do
+        allow(described_class::SettingsData).to receive(:new).and_return(settings_data)
+      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
+    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_response).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 a non-200 response" do
+      let!(:stub) do
+        stub_request(:get, Regexp.new(endpoint))
+          .to_return(status: 201, body: body.to_json)
+      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
+
+      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
+      let(:new_config_route) do
+        '213/config/111/config.json'
+      end
+
+      let(:body) do
+        { 'config_route' => new_config_route, 'poll_sec' => 0.1 }
+      end
+
+      let!(:new_stub) do
+        stub_request(:get, Regexp.new(new_config_route))
+          .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
+end

data/spec/request_spec.rb

@@ -1,9 +1,7 @@
 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) }

data/spec/response_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Airbrake::Response do
       context "when response code is #{code}" do
         it "logs response body" do
           expect(Airbrake::Loggable.instance).to receive(:debug).with(
-            /Airbrake::Response \(#{code}\): {}/
+            /Airbrake::Response \(#{code}\): {}/,
           )
           described_class.parse(OpenStruct.new(code: code, body: '{}'))
         end
@@ -15,10 +15,10 @@ RSpec.describe Airbrake::Response do
       context "when response code is #{code}" do
         it "logs response message" do
           expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /Airbrake: foo/
+            /Airbrake: foo/,
           )
           described_class.parse(
-            OpenStruct.new(code: code, body: '{"message":"foo"}')
+            OpenStruct.new(code: code, body: '{"message":"foo"}'),
           )
         end
       end
@@ -29,7 +29,7 @@ RSpec.describe Airbrake::Response do
 
       it "logs response message" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /Airbrake: rate limited/
+          /Airbrake: rate limited/,
         )
         described_class.parse(response)
       end
@@ -41,7 +41,7 @@ RSpec.describe Airbrake::Response do
         resp = described_class.parse(response)
         expect(resp).to include(
           'error' => '**Airbrake: rate limited',
-          'rate_limit_reset' => time
+          'rate_limit_reset' => time,
         )
       end
     end
@@ -51,7 +51,7 @@ RSpec.describe Airbrake::Response do
 
       it "logs response body" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /Airbrake: unexpected code \(500\)\. Body: foo/
+          /Airbrake: unexpected code \(500\)\. Body: foo/,
         )
         described_class.parse(response)
       end
@@ -73,14 +73,14 @@ RSpec.describe Airbrake::Response do
 
       it "logs response body" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /Airbrake: error while parsing body \(.*unexpected token.*\)\. Body: foo/
+          /Airbrake: error while parsing body \(.*unexpected token.*\)\. Body: foo/,
         )
         described_class.parse(response)
       end
 
       it "returns an error message" do
         expect(described_class.parse(response)['error']).to match(
-          /\A#<JSON::ParserError.+>/
+          /\A#<JSON::ParserError.+>/,
         )
       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'",
@@ -47,9 +47,9 @@ class AirbrakeTestError < RuntimeError
       "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:88:in `run'",
       "/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb:73:in `run'",
       "/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>'"
+      "/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)",
@@ -78,9 +78,9 @@ class JavaAirbrakeTestError < AirbrakeTestError
       "opt.rubies.jruby_minus_9_dot_0_dot_0_dot_0.bin.irb.RUBY$script(/opt/rubies/jruby-9.0.0.0/bin/irb:13)",
       "org.jruby.ir.Compiler$1.load(Compiler.java:111)",
       "org.jruby.Main.run(Main.java:225)",
-      "org.jruby.Main.main(Main.java:197)"
+      "org.jruby.Main.main(Main.java:197)",
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   def is_a?(*)

data/spec/stat_spec.rb

@@ -5,24 +5,14 @@ RSpec.describe Airbrake::Stat do
         'count' => 0,
         'sum' => 0.0,
         'sumsq' => 0.0,
-        'tdigest' => 'AAAAAkA0AAAAAAAAAAAAAA=='
+        'tdigest' => 'AAAAAkA0AAAAAAAAAAAAAA==',
       )
     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) }
 
-    its(:count) { is_expected.to eq(1) }
     its(:sum) { is_expected.to eq(1000) }
     its(:sumsq) { is_expected.to eq(1000000) }
 
@@ -34,7 +24,7 @@ RSpec.describe Airbrake::Stat do
   describe "#inspect" do
     it "provides custom inspect output" do
       expect(subject.inspect).to eq(
-        '#<struct Airbrake::Stat count=0, sum=0.0, sumsq=0.0>'
+        '#<struct Airbrake::Stat count=0, sum=0.0, sumsq=0.0>',
       )
     end
   end

data/spec/sync_sender_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Airbrake::SyncSender do
   before do
     Airbrake::Config.instance = Airbrake::Config.new(
-      project_id: 1, project_key: 'banana'
+      project_id: 1, project_key: 'banana',
     )
   end
 
@@ -17,8 +17,8 @@ RSpec.describe Airbrake::SyncSender do
       subject.send({}, promise)
       expect(
         a_request(:post, endpoint).with(
-          headers: { 'Content-Type' => 'application/json' }
-        )
+          headers: { 'Content-Type' => 'application/json' },
+        ),
       ).to have_been_made.once
     end
 
@@ -27,9 +27,11 @@ 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
     end
 
@@ -37,8 +39,8 @@ RSpec.describe Airbrake::SyncSender do
       subject.send({}, promise)
       expect(
         a_request(:post, endpoint).with(
-          headers: { 'Authorization' => 'Bearer banana' }
-        )
+          headers: { 'Authorization' => 'Bearer banana' },
+        ),
       ).to have_been_made.once
     end
 
@@ -47,7 +49,7 @@ RSpec.describe Airbrake::SyncSender do
       allow(subject).to receive(:build_https).and_return(https)
       allow(https).to receive(:request).and_raise(StandardError.new('foo'))
       expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /HTTP error: foo/
+        /HTTP error: foo/,
       )
       expect(subject.send({}, promise)).to be_an(Airbrake::Promise)
       expect(promise.value).to eq('error' => '**Airbrake: HTTP error: foo')
@@ -69,10 +71,10 @@ RSpec.describe Airbrake::SyncSender do
         notice = Airbrake::Notice.new(ex)
 
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /data was not sent/
+          /data was not sent/,
         )
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /truncation failed/
+          /truncation failed/,
         )
         expect(subject.send(notice, promise)).to be_an(Airbrake::Promise)
         expect(promise.value)
@@ -87,7 +89,7 @@ RSpec.describe Airbrake::SyncSender do
         stub_request(:post, endpoint).to_return(
           status: 429,
           body: '{"message":"IP is rate limited"}',
-          headers: { 'X-RateLimit-Delay' => '1' }
+          headers: { 'X-RateLimit-Delay' => '1' },
         )
       end
 

data/spec/tdigest_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Airbrake::TDigest do
       new_tdigest = described_class.from_bytes(bytes)
       # Expect some rounding error due to compression
       expect(new_tdigest.percentile(0.9).round(5)).to eq(
-        subject.percentile(0.9).round(5)
+        subject.percentile(0.9).round(5),
       )
       expect(new_tdigest.as_small_bytes).to eq(bytes)
     end
@@ -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
@@ -126,8 +126,8 @@ RSpec.describe Airbrake::TDigest do
           113270270.27027026,
           154459459.45945945,
           123829787.23404256,
-          103191489.36170213
-        ]
+          103191489.36170213,
+        ],
       )
     end
 
@@ -166,13 +166,13 @@ RSpec.describe Airbrake::TDigest do
       it "has the parameters of the left argument (the calling tdigest)" do
         new_tdigest = subject + @other
         expect(new_tdigest.instance_variable_get(:@delta)).to eq(
-          subject.instance_variable_get(:@delta)
+          subject.instance_variable_get(:@delta),
         )
         expect(new_tdigest.instance_variable_get(:@k)).to eq(
-          subject.instance_variable_get(:@k)
+          subject.instance_variable_get(:@k),
         )
         expect(new_tdigest.instance_variable_get(:@cx)).to eq(
-          subject.instance_variable_get(:@cx)
+          subject.instance_variable_get(:@cx),
         )
       end