airbrake-ruby 4.15.0 → 6.1.0

data/spec/config_spec.rb

@@ -1,4 +1,6 @@
 RSpec.describe Airbrake::Config do
+  subject(:config) { described_class.new }
+
   let(:resolved_promise) { Airbrake::Promise.new.resolve }
   let(:rejected_promise) { Airbrake::Promise.new.reject }
 
@@ -10,7 +12,9 @@ RSpec.describe Airbrake::Config do
   its(:app_version) { is_expected.to be_nil }
   its(:versions) { is_expected.to be_empty }
   its(:host) { is_expected.to eq('https://api.airbrake.io') }
-  its(:endpoint) { is_expected.not_to be_nil }
+  its(:error_host) { is_expected.to eq('https://api.airbrake.io') }
+  its(:apm_host) { is_expected.to eq('https://api.airbrake.io') }
+  its(:error_endpoint) { is_expected.not_to be_nil }
   its(:workers) { is_expected.to eq(1) }
   its(:queue_size) { is_expected.to eq(100) }
   its(:root_directory) { is_expected.to eq(Bundler.root.realpath.to_s) }
@@ -19,26 +23,36 @@ RSpec.describe Airbrake::Config do
   its(:timeout) { is_expected.to be_nil }
   its(:blocklist_keys) { is_expected.to be_empty }
   its(:allowlist_keys) { is_expected.to be_empty }
-  its(:performance_stats) { is_expected.to eq(true) }
+  its(:performance_stats) { is_expected.to be(true) }
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
-  its(:query_stats) { is_expected.to eq(true) }
-  its(:job_stats) { is_expected.to eq(true) }
+  its(:query_stats) { is_expected.to be(true) }
+  its(:job_stats) { is_expected.to be(true) }
+  its(:error_notifications) { is_expected.to be(true) }
+  its(:remote_config) { is_expected.to be(true) }
+
+  its(:remote_config_host) do
+    is_expected.to eq('https://notifier-configs.airbrake.io')
+  end
 
   describe "#new" do
     context "when user config is passed" do
       subject { described_class.new(logger: StringIO.new) }
+
       its(:logger) { is_expected.to be_a(StringIO) }
     end
   end
 
   describe "#valid?" do
-    context "when #validate returns a resolved promise" do
-      before { expect(subject).to receive(:validate).and_return(resolved_promise) }
+    context "when the config is valid" do
+      before do
+        config.project_id = 123
+        config.project_key = 'abc'
+      end
+
       it { is_expected.to be_valid }
     end
 
-    context "when #validate returns a rejected promise" do
-      before { expect(subject).to receive(:validate).and_return(rejected_promise) }
+    context "when the config is invalid" do
       it { is_expected.not_to be_valid }
     end
   end
@@ -46,7 +60,7 @@ RSpec.describe Airbrake::Config do
   describe "#ignored_environment?" do
     context "when Validator returns a resolved promise" do
       before do
-        expect(Airbrake::Config::Validator).to receive(:check_notify_ability)
+        allow(Airbrake::Config::Validator).to receive(:check_notify_ability)
           .and_return(resolved_promise)
       end
 
@@ -55,7 +69,7 @@ RSpec.describe Airbrake::Config do
 
     context "when Validator returns a rejected promise" do
       before do
-        expect(Airbrake::Config::Validator).to receive(:check_notify_ability)
+        allow(Airbrake::Config::Validator).to receive(:check_notify_ability)
           .and_return(rejected_promise)
       end
 
@@ -63,13 +77,13 @@ RSpec.describe Airbrake::Config do
     end
   end
 
-  describe "#endpoint" do
+  describe "#error_endpoint" do
     subject { described_class.new(valid_params.merge(user_config)) }
 
     context "when host ends with a URL with a slug with a trailing slash" do
       let(:user_config) { { host: 'https://localhost/bingo/' } }
 
-      its(:endpoint) do
+      its(:error_endpoint) do
         is_expected.to eq(URI('https://localhost/bingo/api/v3/projects/1/notices'))
       end
     end
@@ -77,7 +91,7 @@ RSpec.describe Airbrake::Config do
     context "when host ends with a URL with a slug without a trailing slash" do
       let(:user_config) { { host: 'https://localhost/bingo' } }
 
-      its(:endpoint) do
+      its(:error_endpoint) do
         is_expected.to eq(URI('https://localhost/api/v3/projects/1/notices'))
       end
     end
@@ -88,19 +102,21 @@ RSpec.describe Airbrake::Config do
   end
 
   describe "#check_configuration" do
-    let(:user_config) { {} }
-
     subject { described_class.new(valid_params.merge(user_config)) }
 
+    let(:user_config) { {} }
+
     its(:check_configuration) { is_expected.to be_an(Airbrake::Promise) }
 
     context "when config is invalid" do
       let(:user_config) { { project_id: nil } }
+
       its(:check_configuration) { is_expected.to be_rejected }
     end
 
     context "when current environment is ignored" do
       let(:user_config) { { environment: 'test', ignore_environments: ['test'] } }
+
       its(:check_configuration) { is_expected.to be_rejected }
     end
 
@@ -111,22 +127,22 @@ RSpec.describe Airbrake::Config do
 
   describe "#check_performance_options" do
     it "returns a promise" do
-      resource = Airbrake::Query.new(method: '', route: '', query: '', timing: 1)
-      expect(subject.check_performance_options(resource))
+      metric = Airbrake::Query.new(method: '', route: '', query: '', timing: 1)
+      expect(config.check_performance_options(metric))
         .to be_an(Airbrake::Promise)
     end
 
     context "when performance stats are disabled" do
-      before { subject.performance_stats = false }
+      before { config.performance_stats = false }
 
-      let(:resource) do
+      let(:metric) do
         Airbrake::Request.new(
           method: 'GET', route: '/foo', status_code: 200, timing: 1,
         )
       end
 
       it "returns a rejected promise" do
-        promise = subject.check_performance_options(resource)
+        promise = config.check_performance_options(metric)
         expect(promise.value).to eq(
           'error' => "The Performance Stats feature is disabled",
         )
@@ -134,14 +150,14 @@ RSpec.describe Airbrake::Config do
     end
 
     context "when query stats are disabled" do
-      before { subject.query_stats = false }
+      before { config.query_stats = false }
 
-      let(:resource) do
+      let(:metric) do
         Airbrake::Query.new(method: 'GET', route: '/foo', query: '', timing: 1)
       end
 
       it "returns a rejected promise" do
-        promise = subject.check_performance_options(resource)
+        promise = config.check_performance_options(metric)
         expect(promise.value).to eq(
           'error' => "The Query Stats feature is disabled",
         )
@@ -149,14 +165,14 @@ RSpec.describe Airbrake::Config do
     end
 
     context "when job stats are disabled" do
-      before { subject.job_stats = false }
+      before { config.job_stats = false }
 
-      let(:resource) do
+      let(:metric) do
         Airbrake::Queue.new(queue: 'foo_queue', error_count: 0, timing: 1)
       end
 
       it "returns a rejected promise" do
-        promise = subject.check_performance_options(resource)
+        promise = config.check_performance_options(metric)
         expect(promise.value).to eq(
           'error' => "The Job Stats feature is disabled",
         )
@@ -166,35 +182,7 @@ RSpec.describe Airbrake::Config do
 
   describe "#logger" do
     it "sets logger level to Logger::WARN" do
-      expect(subject.logger.level).to eq(Logger::WARN)
-    end
-  end
-
-  describe "#blacklist_keys=" do
-    before { allow(Kernel).to receive(:warn) }
-
-    it "sets blocklist_keys instead" do
-      subject.blacklist_keys = [1, 2, 3]
-      expect(subject.blocklist_keys).to eq([1, 2, 3])
-    end
-
-    it "prints a warning" do
-      expect(Kernel).to receive(:warn).with(/use blocklist_keys= instead/)
-      subject.blacklist_keys = [1, 2, 3]
-    end
-  end
-
-  describe "#whitelist_keys=" do
-    before { allow(Kernel).to receive(:warn) }
-
-    it "sets allowlist_keys instead" do
-      subject.whitelist_keys = [1, 2, 3]
-      expect(subject.allowlist_keys).to eq([1, 2, 3])
-    end
-
-    it "prints a warning" do
-      expect(Kernel).to receive(:warn).with(/use allowlist_keys= instead/)
-      subject.whitelist_keys = [1, 2, 3]
+      expect(config.logger.level).to eq(Logger::WARN)
     end
   end
 end

data/spec/context_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe Airbrake::Context do
+  subject(:context) { described_class.current }
+
+  before { described_class.current.clear }
+
+  after { described_class.current.clear }
+
+  describe "#merge!" do
+    it "merges the given context with the current one" do
+      context.merge!(apples: 'oranges')
+      expect(context.to_h).to match(apples: 'oranges')
+    end
+  end
+
+  describe "#clear" do
+    it "clears the context" do
+      context.merge!(apples: 'oranges')
+      context.clear
+      expect(context.to_h).to be_empty
+    end
+  end
+
+  describe "#to_h" do
+    it "returns a hash representation of the context" do
+      expect(context.to_h).to be_a(Hash)
+    end
+  end
+
+  describe "#empty?" do
+    context "when the context has data" do
+      it "returns true" do
+        context.merge!(apples: 'oranges')
+        expect(context).not_to be_empty
+      end
+    end
+
+    context "when the context has NO data" do
+      it "returns false" do
+        expect(context).to be_empty
+      end
+    end
+  end
+
+  context "when another thread is spawned" do
+    it "doesn't clash with other threads' contexts" do
+      described_class.current.merge!(apples: 'oranges')
+      th = Thread.new do
+        described_class.current.merge!(foos: 'bars')
+      end
+      th.join
+      expect(described_class.current.to_h).to match(apples: 'oranges')
+    end
+  end
+end

data/spec/deploy_notifier_spec.rb

@@ -4,17 +4,19 @@ RSpec.describe Airbrake::DeployNotifier do
   end
 
   describe "#notify" do
+    subject(:deploy_notifier) { described_class.new }
+
     it "returns a promise" do
       stub_request(:post, 'https://api.airbrake.io/api/v4/projects/1/deploys')
         .to_return(status: 201, body: '{}')
-      expect(subject.notify({})).to be_an(Airbrake::Promise)
+      expect(deploy_notifier.notify({})).to be_an(Airbrake::Promise)
     end
 
     context "when config is invalid" do
       before { Airbrake::Config.instance.merge(project_id: nil) }
 
       it "returns a rejected promise" do
-        promise = subject.notify({})
+        promise = deploy_notifier.notify({})
         expect(promise).to be_rejected
       end
     end
@@ -28,7 +30,7 @@ RSpec.describe Airbrake::DeployNotifier do
           instance_of(Airbrake::Promise),
           URI('https://api.airbrake.io/api/v4/projects/1/deploys'),
         )
-        subject.notify(environment: 'barenv')
+        deploy_notifier.notify(environment: 'barenv')
       end
     end
 
@@ -41,7 +43,7 @@ RSpec.describe Airbrake::DeployNotifier do
           instance_of(Airbrake::Promise),
           URI('https://api.airbrake.io/api/v4/projects/1/deploys'),
         )
-        subject.notify({})
+        deploy_notifier.notify({})
       end
     end
   end

data/spec/file_cache_spec.rb

@@ -1,5 +1,6 @@
 RSpec.describe Airbrake::FileCache do
   before { described_class.reset }
+
   after { described_class.reset }
 
   describe ".[]=" do

data/spec/filter_chain_spec.rb

@@ -1,4 +1,6 @@
 RSpec.describe Airbrake::FilterChain do
+  subject(:filter_chain) { described_class.new }
+
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
   describe "#refine" do
@@ -19,24 +21,27 @@ RSpec.describe Airbrake::FilterChain do
     it "executes filters from heaviest to lightest" do
       notice[:params][:bingo] = []
 
-      (0...3).reverse_each { |i| subject.add_filter(filter.new(i)) }
-      subject.refine(notice)
+      (0...3).reverse_each { |i| filter_chain.add_filter(filter.new(i)) }
+      filter_chain.refine(notice)
 
       expect(notice[:params][:bingo]).to eq([2, 1, 0])
     end
 
     it "stops execution once a notice was ignored" do
       f2 = filter.new(2)
-      expect(f2).to receive(:call)
+      allow(f2).to receive(:call)
 
       f1 = proc { |notice| notice.ignore! }
 
       f0 = filter.new(-1)
-      expect(f0).not_to receive(:call)
+      allow(f0).to receive(:call)
+
+      [f2, f1, f0].each { |f| filter_chain.add_filter(f) }
 
-      [f2, f1, f0].each { |f| subject.add_filter(f) }
+      filter_chain.refine(notice)
 
-      subject.refine(notice)
+      expect(f2).to have_received(:call)
+      expect(f0).not_to have_received(:call)
     end
   end
 
@@ -63,56 +68,56 @@ RSpec.describe Airbrake::FilterChain do
       notice[:params][:foo] = []
 
       f1 = filter.new(1)
-      subject.add_filter(f1)
+      filter_chain.add_filter(f1)
 
       foo_filter_mock = double
-      expect(foo_filter_mock).to(
-        receive(:name).at_least(:once).and_return('FooFilter'),
-      )
-      subject.delete_filter(foo_filter_mock)
+      allow(foo_filter_mock).to receive(:name).at_least(:once).and_return('FooFilter')
+      filter_chain.delete_filter(foo_filter_mock)
+
+      expect(foo_filter_mock).to have_received(:name)
 
       f2 = filter.new(2)
-      subject.add_filter(f2)
+      filter_chain.add_filter(f2)
 
-      subject.refine(notice)
+      filter_chain.refine(notice)
       expect(notice[:params][:foo]).to eq([2])
     end
   end
 
   describe "#inspect" do
     it "returns a string representation of an empty FilterChain" do
-      expect(subject.inspect).to eq('[]')
+      expect(filter_chain.inspect).to eq('[]')
     end
 
     it "returns a string representation of a non-empty FilterChain" do
-      subject.add_filter(proc {})
-      expect(subject.inspect).to eq('[Proc]')
+      filter_chain.add_filter(proc {})
+      expect(filter_chain.inspect).to eq('[Proc]')
     end
   end
 
   describe "#includes?" do
     context "when a custom filter class is included in the filter chain" do
       it "returns true" do
-        klass = Class.new {}
+        klass = Class.new
 
-        subject.add_filter(klass.new)
-        expect(subject.includes?(klass)).to eq(true)
+        filter_chain.add_filter(klass.new)
+        expect(filter_chain.includes?(klass)).to be(true)
       end
     end
 
     context "when Proc filter class is included in the filter chain" do
       it "returns true" do
-        subject.add_filter(proc {})
-        expect(subject.includes?(Proc)).to eq(true)
+        filter_chain.add_filter(proc {})
+        expect(filter_chain.includes?(Proc)).to be(true)
       end
     end
 
     context "when filter class is NOT included in the filter chain" do
       it "returns false" do
-        klass = Class.new {}
+        klass = Class.new
 
-        subject.add_filter(proc {})
-        expect(subject.includes?(klass)).to eq(false)
+        filter_chain.add_filter(proc {})
+        expect(filter_chain.includes?(klass)).to be(false)
       end
     end
   end

data/spec/filters/context_filter_spec.rb

@@ -3,21 +3,30 @@ RSpec.describe Airbrake::Filters::ContextFilter do
 
   context "when the current context is empty" do
     it "doesn't merge anything with params" do
-      described_class.new({}).call(notice)
+      described_class.new.call(notice)
       expect(notice[:params]).to be_empty
     end
   end
 
   context "when the current context has some data" do
     it "merges the data with params" do
-      described_class.new(apples: 'oranges').call(notice)
+      Airbrake.merge_context(apples: 'oranges')
+      described_class.new.call(notice)
       expect(notice[:params]).to eq(airbrake_context: { apples: 'oranges' })
     end
 
-    it "clears the data from the provided context" do
+    it "clears the data from the current context" do
       context = { apples: 'oranges' }
-      described_class.new(context).call(notice)
-      expect(context).to be_empty
+      Airbrake.merge_context(context)
+      described_class.new.call(notice)
+      expect(Airbrake::Context.current).to be_empty
+    end
+
+    it "does not mutate the provided context object" do
+      context = { apples: 'oranges' }
+      Airbrake.merge_context(context)
+      described_class.new.call(notice)
+      expect(context).to match(apples: 'oranges')
     end
   end
 end

data/spec/filters/dependency_filter_spec.rb

@@ -1,9 +1,11 @@
 RSpec.describe Airbrake::Filters::DependencyFilter do
+  subject(:dependency_filter) { described_class.new }
+
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
   describe "#call" do
     it "attaches loaded dependencies to context/versions/dependencies" do
-      subject.call(notice)
+      dependency_filter.call(notice)
       expect(notice[:context][:versions][:dependencies]).to include(
         'airbrake-ruby' => Airbrake::AIRBRAKE_RUBY_VERSION,
       )

data/spec/filters/exception_attributes_filter_spec.rb

@@ -1,4 +1,6 @@
 RSpec.describe Airbrake::Filters::ExceptionAttributesFilter do
+  subject(:exception_attributes_filter) { described_class.new }
+
   describe "#call" do
     let(:notice) { Airbrake::Notice.new(ex) }
 
@@ -12,7 +14,7 @@ RSpec.describe Airbrake::Filters::ExceptionAttributesFilter do
       end
 
       it "doesn't raise" do
-        expect { subject.call(notice) }.not_to raise_error
+        expect { exception_attributes_filter.call(notice) }.not_to raise_error
         expect(notice[:params]).to be_empty
       end
     end
@@ -27,7 +29,7 @@ RSpec.describe Airbrake::Filters::ExceptionAttributesFilter do
       end
 
       it "doesn't raise" do
-        expect { subject.call(notice) }.not_to raise_error
+        expect { exception_attributes_filter.call(notice) }.not_to raise_error
         expect(notice[:params]).to be_empty
       end
     end
@@ -42,7 +44,7 @@ RSpec.describe Airbrake::Filters::ExceptionAttributesFilter do
       end
 
       it "merges parameters with the notice" do
-        subject.call(notice)
+        exception_attributes_filter.call(notice)
         expect(notice[:params]).to eq(foo: '1')
       end
     end

data/spec/filters/gem_root_filter_spec.rb

@@ -1,24 +1,27 @@
 RSpec.describe Airbrake::Filters::GemRootFilter do
+  subject(:gem_root_filter) { described_class.new }
+
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
   let(:root1) { '/my/gem/root' }
   let(:root2) { '/my/other/gem/root' }
 
   before { Gem.path << root1 << root2 }
+
   after { 2.times { Gem.path.pop } }
 
   it "replaces gem root in the backtrace with a label" do
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     notice[:errors].first[:backtrace] = [
       { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
       { file: "#{root1}/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb" },
       { file: "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb" },
       { file: "#{root2}/gems/rspec-core-3.3.2/exe/rspec" },
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
-    subject.call(notice)
+    gem_root_filter.call(notice)
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     expect(notice[:errors].first[:backtrace]).to(
       eq(
         [
@@ -29,12 +32,12 @@ RSpec.describe Airbrake::Filters::GemRootFilter do
         ],
       ),
     )
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   it "does not filter file when it is nil" do
     expect(notice[:errors].first[:file]).to be_nil
-    expect { subject.call(notice) }.not_to(
+    expect { gem_root_filter.call(notice) }.not_to(
       change { notice[:errors].first[:file] },
     )
   end

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -1,21 +1,21 @@
 RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
-  subject { described_class.new('.') }
+  subject(:git_last_checkout_filter) { described_class.new('.') }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
   context "when context/lastCheckout is defined" do
     it "doesn't attach anything to context/lastCheckout" do
       notice[:context][:lastCheckout] = '123'
-      subject.call(notice)
+      git_last_checkout_filter.call(notice)
       expect(notice[:context][:lastCheckout]).to eq('123')
     end
   end
 
   context "when .git directory doesn't exist" do
-    subject { described_class.new('root/dir') }
+    subject(:git_last_checkout_without_git_dir_filter) { described_class.new('root/dir') }
 
     it "doesn't attach anything to context/lastCheckout" do
-      subject.call(notice)
+      git_last_checkout_without_git_dir_filter.call(notice)
       expect(notice[:context][:lastCheckout]).to be_nil
     end
   end
@@ -25,7 +25,7 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
       before { ENV['AIRBRAKE_DEPLOY_USERNAME'] = 'deployer' }
 
       it "attaches username from the environment" do
-        subject.call(notice)
+        git_last_checkout_filter.call(notice)
         expect(notice[:context][:lastCheckout][:username]).to eq('deployer')
       end
     end
@@ -34,7 +34,7 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
       before { ENV['AIRBRAKE_DEPLOY_USERNAME'] = nil }
 
       it "attaches last checkouted username" do
-        subject.call(notice)
+        git_last_checkout_filter.call(notice)
         username = notice[:context][:lastCheckout][:username]
         expect(username).not_to be_empty
         expect(username).not_to be_nil
@@ -42,20 +42,18 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
     end
 
     it "attaches last checkouted email" do
-      subject.call(notice)
-      expect(notice[:context][:lastCheckout][:email]).to(
-        match(/\A\w+[\w.-]*@\w+\.?\w+?\z/),
-      )
+      git_last_checkout_filter.call(notice)
+      expect(notice[:context][:lastCheckout][:email]).to(match(/\A\w+@[\w\-.]+\z/))
     end
 
     it "attaches last checkouted revision" do
-      subject.call(notice)
+      git_last_checkout_filter.call(notice)
       expect(notice[:context][:lastCheckout][:revision]).not_to be_empty
       expect(notice[:context][:lastCheckout][:revision].size).to eq(40)
     end
 
     it "attaches last checkouted time" do
-      subject.call(notice)
+      git_last_checkout_filter.call(notice)
       expect(notice[:context][:lastCheckout][:time]).not_to be_empty
       expect(notice[:context][:lastCheckout][:time].size).to eq(25)
     end