airbrake-ruby 3.1.0 → 3.2.0

data/spec/filters/system_exit_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::SystemExitFilter do
   it "marks SystemExit exceptions as ignored" do
     notice = Airbrake::Notice.new(Airbrake::Config.new, SystemExit.new)

data/spec/filters/thread_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::ThreadFilter do
   let(:notice) do
     Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)

data/spec/ignorable_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe Airbrake::Ignorable do
+  let(:klass) do
+    mod = subject
+    Class.new { include(mod) }
+  end
+
+  it "ignores includee" do
+    instance = klass.new
+    expect(instance).not_to be_ignored
+
+    instance.ignore!
+    expect(instance).to be_ignored
+  end
+end

data/spec/nested_exception_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::NestedException do
   let(:config) { Airbrake::Config.new }
 

data/spec/{notifier_spec.rb → notice_notifier_spec.rb}

@@ -1,17 +1,17 @@
-require 'spec_helper'
-
 # rubocop:disable Layout/DotPosition
-RSpec.describe Airbrake::Notifier do
+RSpec.describe Airbrake::NoticeNotifier do
   let(:user_params) do
     {
       project_id: 1,
       project_key: 'abc',
       logger: Logger.new('/dev/null'),
-      route_stats: true
+      performance_stats: true
     }
   end
 
-  subject { described_class.new(user_params) }
+  let(:params) { {} }
+  let(:config) { Airbrake::Config.new(user_params.merge(params)) }
+  subject { described_class.new(config) }
 
   describe "#new" do
     describe "default filter addition" do
@@ -20,20 +20,22 @@ RSpec.describe Airbrake::Notifier do
       it "appends the context filter" do
         expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
           .with(instance_of(Airbrake::Filters::ContextFilter))
-        described_class.new(user_params)
+        subject
       end
 
       it "appends the exception attributes filter" do
         expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
           .with(instance_of(Airbrake::Filters::ExceptionAttributesFilter))
-        described_class.new(user_params)
+        subject
       end
 
       context "when user config has some whitelist keys" do
+        let(:params) { { whitelist_keys: %w[foo] } }
+
         it "appends the whitelist filter" do
           expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
             .with(instance_of(Airbrake::Filters::KeysWhitelist))
-          described_class.new(user_params.merge(whitelist_keys: ['foo']))
+          described_class.new(config)
         end
       end
 
@@ -41,15 +43,17 @@ RSpec.describe Airbrake::Notifier do
         it "doesn't append the whitelist filter" do
           expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
             .with(instance_of(Airbrake::Filters::KeysWhitelist))
-          described_class.new(user_params)
+          described_class.new(config)
         end
       end
 
       context "when user config has some blacklist keys" do
+        let(:params) { { blacklist_keys: %w[bar] } }
+
         it "appends the blacklist filter" do
           expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
             .with(instance_of(Airbrake::Filters::KeysBlacklist))
-          described_class.new(user_params.merge(blacklist_keys: ['bar']))
+          described_class.new(config)
         end
       end
 
@@ -57,15 +61,17 @@ RSpec.describe Airbrake::Notifier do
         it "doesn't append the blacklist filter" do
           expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
             .with(instance_of(Airbrake::Filters::KeysBlacklist))
-          described_class.new(user_params)
+          described_class.new(config)
         end
       end
 
       context "when user config specifies a root directory" do
+        let(:params) { { root_directory: '/foo' } }
+
         it "appends the root directory filter" do
           expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
             .with(instance_of(Airbrake::Filters::RootDirectoryFilter))
-          described_class.new(user_params.merge(root_directory: '/foo'))
+          described_class.new(config)
         end
       end
 
@@ -75,34 +81,16 @@ RSpec.describe Airbrake::Notifier do
             .and_return(nil)
           expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
             .with(instance_of(Airbrake::Filters::RootDirectoryFilter))
-          described_class.new(user_params)
+          described_class.new(config)
         end
       end
     end
-
-    context "when user config doesn't contain a project id" do
-      let(:user_config) { { project_id: nil } }
-
-      it "raises error" do
-        expect { described_class.new(user_config) }
-          .to raise_error(Airbrake::Error, ':project_id is required')
-      end
-    end
-
-    context "when user config doesn't contain a project key" do
-      let(:user_config) { { project_id: 1, project_key: nil } }
-
-      it "raises error" do
-        expect { described_class.new(user_config) }
-          .to raise_error(Airbrake::Error, ':project_key is required')
-      end
-    end
   end
 
   describe "#notify" do
     let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/1/notices' }
 
-    subject { described_class.new(user_params) }
+    subject { described_class.new(Airbrake::Config.new(user_params)) }
 
     let(:body) do
       {
@@ -173,11 +161,7 @@ RSpec.describe Airbrake::Notifier do
     end
 
     context "when the provided environment is ignored" do
-      subject do
-        described_class.new(
-          user_params.merge(environment: 'test', ignore_environments: ['test'])
-        )
-      end
+      let(:user_params) { { environment: 'test', ignore_environments: %w[test] } }
 
       it "doesn't send an notice" do
         expect_any_instance_of(Airbrake::AsyncSender).not_to receive(:send)
@@ -257,11 +241,7 @@ RSpec.describe Airbrake::Notifier do
     end
 
     context "when the provided environment is ignored" do
-      subject do
-        described_class.new(
-          user_params.merge(environment: 'test', ignore_environments: ['test'])
-        )
-      end
+      let(:params) { { environment: 'test', ignore_environments: %w[test] } }
 
       it "doesn't send an notice" do
         expect_any_instance_of(Airbrake::SyncSender).not_to receive(:send)
@@ -412,38 +392,6 @@ RSpec.describe Airbrake::Notifier do
     end
   end
 
-  describe "#create_deploy" do
-    it "returns a promise" do
-      stub_request(:post, 'https://api.airbrake.io/api/v4/projects/1/deploys')
-        .to_return(status: 201, body: '')
-      expect(subject.create_deploy({})).to be_an(Airbrake::Promise)
-    end
-
-    context "when environment is configured" do
-      it "prefers the passed environment to the config env" do
-        expect_any_instance_of(Airbrake::SyncSender).to receive(:send).with(
-          { environment: 'barenv' },
-          instance_of(Airbrake::Promise),
-          URI('https://api.airbrake.io/api/v4/projects/1/deploys')
-        )
-        described_class.new(
-          user_params.merge(environment: 'fooenv')
-        ).create_deploy(environment: 'barenv')
-      end
-    end
-
-    context "when environment is not configured" do
-      it "sets the environment from the config" do
-        expect_any_instance_of(Airbrake::SyncSender).to receive(:send).with(
-          { environment: 'fooenv' },
-          instance_of(Airbrake::Promise),
-          URI('https://api.airbrake.io/api/v4/projects/1/deploys')
-        )
-        subject.create_deploy(environment: 'fooenv')
-      end
-    end
-  end
-
   describe "#configured?" do
     it { is_expected.to be_configured }
   end
@@ -455,48 +403,10 @@ RSpec.describe Airbrake::Notifier do
     end
   end
 
-  describe "#notify_request" do
-    let(:params) do
-      {
-        method: 'GET',
-        route: '/foo',
-        status_code: 200,
-        start_time: Time.new(2018, 1, 1, 0, 20, 0, 0),
-        end_time: Time.new(2018, 1, 1, 0, 19, 0, 0)
-      }
-    end
-
-    it "forwards 'notify_request' to RouteSender" do
-      expect_any_instance_of(Airbrake::RouteSender)
-        .to receive(:notify_request).with(params, instance_of(Airbrake::Promise))
-      subject.notify_request(params)
-    end
-
-    context "when route stats are disabled" do
-      it "doesn't send route stats" do
-        notifier = described_class.new(user_params.merge(route_stats: false))
-        expect_any_instance_of(Airbrake::RouteSender)
-          .not_to receive(:notify_request)
-        notifier.notify_request(params)
-      end
-    end
-
-    context "when current environment is ignored" do
-      it "doesn't send route stats" do
-        notifier = described_class.new(
-          user_params.merge(environment: 'test', ignore_environments: %w[test])
-        )
-        expect_any_instance_of(Airbrake::RouteSender)
-          .not_to receive(:notify_request)
-        notifier.notify_request(params)
-      end
-    end
-  end
-
   describe "#inspect" do
     it "displays object information" do
       expect(subject.inspect).to match(/
-        #<Airbrake::Notifier:0x\w+\s
+        #<Airbrake::NoticeNotifier:0x\w+\s
           project_id="\d+"\s
           project_key=".+"\s
           host="http.+"\s
@@ -514,7 +424,7 @@ RSpec.describe Airbrake::Notifier do
       q.guard_inspect_key { subject.pretty_print(q) }
 
       expect(q.output).to match(/
-        #<Airbrake::Notifier:0x\w+\s
+        #<Airbrake::NoticeNotifier:0x\w+\s
           project_id="\d+"\s
           project_key=".+"\s
           host="http.+"\s

data/spec/{notifier_spec → notice_notifier_spec}/options_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-RSpec.describe Airbrake::Notifier do
+RSpec.describe Airbrake::NoticeNotifier do
   def expect_a_request_with_body(body)
     expect(a_request(:post, endpoint).with(body: body)).to have_been_made.once
   end
@@ -13,27 +11,31 @@ RSpec.describe Airbrake::Notifier do
     "https://api.airbrake.io/api/v3/projects/#{project_id}/notices"
   end
 
-  let(:airbrake_params) do
+  let(:user_params) do
     { project_id: project_id,
       project_key: project_key,
       logger: Logger.new(StringIO.new) }
   end
 
+  let(:params) { {} }
   let(:ex) { AirbrakeTestError.new }
+  let(:config) { Airbrake::Config.new(user_params.merge(params)) }
+
+  subject { described_class.new(config) }
 
   before do
     stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-    @airbrake = described_class.new(airbrake_params)
   end
 
   describe "options" do
     describe ":host" do
       context "when custom" do
         shared_examples 'endpoint' do |host, endpoint, title|
+          let(:params) { { host: host } }
+
           example(title) do
             stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-            @airbrake = described_class.new(airbrake_params.merge(host: host))
-            @airbrake.notify_sync(ex)
+            subject.notify_sync(ex)
 
             expect(a_request(:post, endpoint)).to have_been_made.once
           end
@@ -68,9 +70,10 @@ RSpec.describe Airbrake::Notifier do
     end
 
     describe ":root_directory" do
+      let(:params) { { root_directory: '/home/kyrylo/code' } }
+
       it "filters out frames" do
-        params = airbrake_params.merge(root_directory: '/home/kyrylo/code')
-        airbrake = described_class.new(params)
+        airbrake = described_class.new(config)
         airbrake.notify_sync(ex)
 
         expect(
@@ -81,11 +84,10 @@ RSpec.describe Airbrake::Notifier do
 
       context "when present and is a" do
         shared_examples 'root directory' do |dir|
-          it "being included into the notice's payload" do
-            params = airbrake_params.merge(root_directory: dir)
-            airbrake = described_class.new(params)
-            airbrake.notify_sync(ex)
+          let(:params) { { root_directory: dir } }
 
+          it "being included into the notice's payload" do
+            subject.notify_sync(ex)
             expect(
               a_request(:post, endpoint).
               with(body: %r{"rootDirectory":"/bingo/bango"})
@@ -121,6 +123,13 @@ RSpec.describe Airbrake::Notifier do
           password: 'password' }
       end
 
+      let(:params) do
+        {
+          proxy: proxy_params,
+          host: "http://localhost:#{proxy.config[:Port]}"
+        }
+      end
+
       before do
         proxy.mount_proc '/' do |req, res|
           requests << req
@@ -129,13 +138,6 @@ RSpec.describe Airbrake::Notifier do
         end
 
         Thread.new { proxy.start }
-
-        params = airbrake_params.merge(
-          proxy: proxy_params,
-          host: "http://localhost:#{proxy.config[:Port]}"
-        )
-
-        @airbrake = described_class.new(params)
       end
 
       after { proxy.stop }
@@ -147,7 +149,7 @@ RSpec.describe Airbrake::Notifier do
             "safe to run this test on 2.6+ once we upgrade to Webmock 3.5+"
           )
         end
-        @airbrake.notify_sync(ex)
+        subject.notify_sync(ex)
 
         proxied_request = requests.pop(true)
 
@@ -163,11 +165,10 @@ RSpec.describe Airbrake::Notifier do
 
     describe ":environment" do
       context "when present" do
-        it "being included into the notice's payload" do
-          params = airbrake_params.merge(environment: :production)
-          airbrake = described_class.new(params)
-          airbrake.notify_sync(ex)
+        let(:params) { { environment: :production } }
 
+        it "being included into the notice's payload" do
+          subject.notify_sync(ex)
           expect(
             a_request(:post, endpoint).
             with(body: /"context":{.*"environment":"production".*}/)
@@ -178,19 +179,19 @@ RSpec.describe Airbrake::Notifier do
 
     describe ":ignore_environments" do
       shared_examples 'sent notice' do |params|
-        it "sends a notice" do
-          airbrake = described_class.new(airbrake_params.merge(params))
-          airbrake.notify_sync(ex)
+        let(:params) { params }
 
+        it "sends a notice" do
+          subject.notify_sync(ex)
           expect(a_request(:post, endpoint)).to have_been_made
         end
       end
 
       shared_examples 'ignored notice' do |params|
-        it "ignores exceptions occurring in envs that were not configured" do
-          airbrake = described_class.new(airbrake_params.merge(params))
-          airbrake.notify_sync(ex)
+        let(:params) { params }
 
+        it "ignores exceptions occurring in envs that were not configured" do
+          subject.notify_sync(ex)
           expect(a_request(:post, endpoint)).not_to have_been_made
         end
       end
@@ -213,10 +214,8 @@ RSpec.describe Airbrake::Notifier do
         include_examples 'ignored notice', params
 
         it "returns early and doesn't try to parse the given exception" do
-          airbrake = described_class.new(airbrake_params.merge(params))
-
           expect(Airbrake::Notice).not_to receive(:new)
-          expect(airbrake.notify_sync(ex)).
+          expect(subject.notify_sync(ex)).
             to eq('error' => "The 'development' environment is ignored")
           expect(a_request(:post, endpoint)).not_to have_been_made
         end
@@ -246,15 +245,17 @@ RSpec.describe Airbrake::Notifier do
       # Fixes https://github.com/airbrake/airbrake-ruby/issues/276
       context "when specified along with :whitelist_keys" do
         context "and when context payload is present" do
-          it "sends a notice" do
-            params = {
+          let(:params) do
+            {
               blacklist_keys: %i[password password_confirmation],
               whitelist_keys: [:email, /user/i, 'account_id']
             }
-            airbrake = described_class.new(airbrake_params.merge(params))
-            notice = airbrake.build_notice(ex)
+          end
+
+          it "sends a notice" do
+            notice = subject.build_notice(ex)
             notice[:context][:headers] = 'banana'
-            airbrake.notify_sync(notice)
+            subject.notify_sync(notice)
 
             expect(a_request(:post, endpoint)).to have_been_made
           end