airbrake-ruby 4.1.0 → 5.0.0

data/spec/config_spec.rb

@@ -10,17 +10,26 @@ 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) }
   its(:environment) { is_expected.to be_nil }
   its(:ignore_environments) { is_expected.to be_empty }
   its(:timeout) { is_expected.to be_nil }
-  its(:blacklist_keys) { is_expected.to be_empty }
-  its(:whitelist_keys) { is_expected.to be_empty }
-  its(:performance_stats) { is_expected.to be_falsey }
+  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_flush_period) { is_expected.to eq(15) }
+  its(:query_stats) { is_expected.to eq(true) }
+  its(:job_stats) { is_expected.to eq(true) }
+  its(:error_notifications) { is_expected.to eq(true) }
+
+  its(:remote_config_host) do
+    is_expected.to eq('https://v1-production-notifier-configs.s3.amazonaws.com')
+  end
 
   describe "#new" do
     context "when user config is passed" do
@@ -61,13 +70,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
@@ -75,7 +84,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
@@ -106,4 +115,65 @@ RSpec.describe Airbrake::Config do
       its(:check_configuration) { is_expected.not_to be_rejected }
     end
   end
+
+  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))
+        .to be_an(Airbrake::Promise)
+    end
+
+    context "when performance stats are disabled" do
+      before { subject.performance_stats = false }
+
+      let(:resource) 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)
+        expect(promise.value).to eq(
+          'error' => "The Performance Stats feature is disabled",
+        )
+      end
+    end
+
+    context "when query stats are disabled" do
+      before { subject.query_stats = false }
+
+      let(:resource) do
+        Airbrake::Query.new(method: 'GET', route: '/foo', query: '', timing: 1)
+      end
+
+      it "returns a rejected promise" do
+        promise = subject.check_performance_options(resource)
+        expect(promise.value).to eq(
+          'error' => "The Query Stats feature is disabled",
+        )
+      end
+    end
+
+    context "when job stats are disabled" do
+      before { subject.job_stats = false }
+
+      let(:resource) 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)
+        expect(promise.value).to eq(
+          'error' => "The Job Stats feature is disabled",
+        )
+      end
+    end
+  end
+
+  describe "#logger" do
+    it "sets logger level to Logger::WARN" do
+      expect(subject.logger.level).to eq(Logger::WARN)
+    end
+  end
 end

data/spec/deploy_notifier_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Airbrake::DeployNotifier 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')
+          URI('https://api.airbrake.io/api/v4/projects/1/deploys'),
         )
         subject.notify(environment: 'barenv')
       end
@@ -39,7 +39,7 @@ RSpec.describe Airbrake::DeployNotifier 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')
+          URI('https://api.airbrake.io/api/v4/projects/1/deploys'),
         )
         subject.notify({})
       end

data/spec/{file_cache.rb → file_cache_spec.rb}

@@ -1,8 +1,6 @@
 RSpec.describe Airbrake::FileCache do
-  after do
-    %i[banana mango].each { |k| described_class.delete(k) }
-    expect(described_class).to be_empty
-  end
+  before { described_class.reset }
+  after { described_class.reset }
 
   describe ".[]=" do
     context "when cache limit isn't reached" do

data/spec/filter_chain_spec.rb

@@ -67,7 +67,7 @@ RSpec.describe Airbrake::FilterChain do
 
       foo_filter_mock = double
       expect(foo_filter_mock).to(
-        receive(:name).at_least(:once).and_return('FooFilter')
+        receive(:name).at_least(:once).and_return('FooFilter'),
       )
       subject.delete_filter(foo_filter_mock)
 
@@ -89,4 +89,31 @@ RSpec.describe Airbrake::FilterChain do
       expect(subject.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 {}
+
+        subject.add_filter(klass.new)
+        expect(subject.includes?(klass)).to eq(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)
+      end
+    end
+
+    context "when filter class is NOT included in the filter chain" do
+      it "returns false" do
+        klass = Class.new {}
+
+        subject.add_filter(proc {})
+        expect(subject.includes?(klass)).to eq(false)
+      end
+    end
+  end
 end

data/spec/filters/dependency_filter_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Airbrake::Filters::DependencyFilter do
     it "attaches loaded dependencies to context/versions/dependencies" do
       subject.call(notice)
       expect(notice[:context][:versions][:dependencies]).to include(
-        'airbrake-ruby' => Airbrake::AIRBRAKE_RUBY_VERSION
+        'airbrake-ruby' => Airbrake::AIRBRAKE_RUBY_VERSION,
       )
     end
   end

data/spec/filters/gem_root_filter_spec.rb

@@ -7,35 +7,35 @@ RSpec.describe Airbrake::Filters::GemRootFilter do
   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" }
+      { file: "#{root2}/gems/rspec-core-3.3.2/exe/rspec" },
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
     subject.call(notice)
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     expect(notice[:errors].first[:backtrace]).to(
       eq(
         [
           { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
           { file: "/GEM_ROOT/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: "/GEM_ROOT/gems/rspec-core-3.3.2/exe/rspec" }
-        ]
-      )
+          { file: "/GEM_ROOT/gems/rspec-core-3.3.2/exe/rspec" },
+        ],
+      ),
     )
-    # 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(
-      change { notice[:errors].first[:file] }
+      change { notice[:errors].first[:file] },
     )
   end
 end

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -21,24 +21,41 @@ RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
   end
 
   context "when .git directory exists" do
-    before { subject.call(notice) }
+    context "when AIRBRAKE_DEPLOY_USERNAME env variable is set" do
+      before { ENV['AIRBRAKE_DEPLOY_USERNAME'] = 'deployer' }
 
-    it "attaches last checkouted username" do
-      expect(notice[:context][:lastCheckout][:username]).not_to be_empty
+      it "attaches username from the environment" do
+        subject.call(notice)
+        expect(notice[:context][:lastCheckout][:username]).to eq('deployer')
+      end
+    end
+
+    context "when AIRBRAKE_DEPLOY_USERNAME env variable is NOT set" do
+      before { ENV['AIRBRAKE_DEPLOY_USERNAME'] = nil }
+
+      it "attaches last checkouted username" do
+        subject.call(notice)
+        username = notice[:context][:lastCheckout][:username]
+        expect(username).not_to be_empty
+        expect(username).not_to be_nil
+      end
     end
 
     it "attaches last checkouted email" do
+      subject.call(notice)
       expect(notice[:context][:lastCheckout][:email]).to(
-        match(/\A\w+[\w.-]*@\w+\.?\w+?\z/)
+        match(/\A\w+[\w.-]*@\w+\.?\w+?\z/),
       )
     end
 
     it "attaches last checkouted revision" do
+      subject.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)
       expect(notice[:context][:lastCheckout][:time]).not_to be_empty
       expect(notice[:context][:lastCheckout][:time].size).to eq(25)
     end

data/spec/filters/git_repository_filter.rb

@@ -46,7 +46,7 @@ RSpec.describe Airbrake::Filters::GitRepositoryFilter do
     it "attaches context/repository" do
       subject.call(notice)
       expect(notice[:context][:repository]).to eq(
-        'ssh://git@github.com/airbrake/airbrake-ruby.git'
+        'ssh://git@github.com/airbrake/airbrake-ruby.git',
       )
     end
   end

data/spec/filters/git_revision_filter_spec.rb

@@ -1,7 +1,9 @@
 RSpec.describe Airbrake::Filters::GitRevisionFilter do
   subject { described_class.new('root/dir') }
 
-  let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
+  # 'let!', not 'let' to make sure Notice doesn't call File.exist? with
+  # unexpected arguments.
+  let!(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
   context "when context/revision is defined" do
     it "doesn't attach anything to context/revision" do
@@ -42,7 +44,7 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
       context "and also when HEAD doesn't start with 'ref: '" do
         before do
           expect(File).to(
-            receive(:read).with('root/dir/.git/HEAD').and_return('refs/foo')
+            receive(:read).with('root/dir/.git/HEAD').and_return('refs/foo'),
           )
         end
 
@@ -55,17 +57,17 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
       context "and also when HEAD starts with 'ref: " do
         before do
           expect(File).to(
-            receive(:read).with('root/dir/.git/HEAD').and_return("ref: refs/foo\n")
+            receive(:read).with('root/dir/.git/HEAD').and_return("ref: refs/foo\n"),
           )
         end
 
         context "when the ref exists" do
           before do
             expect(File).to(
-              receive(:exist?).with('root/dir/.git/refs/foo').and_return(true)
+              receive(:exist?).with('root/dir/.git/refs/foo').and_return(true),
             )
             expect(File).to(
-              receive(:read).with('root/dir/.git/refs/foo').and_return("d34db33f\n")
+              receive(:read).with('root/dir/.git/refs/foo').and_return("d34db33f\n"),
             )
           end
 
@@ -78,14 +80,14 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
         context "when the ref doesn't exist" do
           before do
             expect(File).to(
-              receive(:exist?).with('root/dir/.git/refs/foo').and_return(false)
+              receive(:exist?).with('root/dir/.git/refs/foo').and_return(false),
             )
           end
 
           context "and when '.git/packed-refs' exists" do
             before do
               expect(File).to(
-                receive(:exist?).with('root/dir/.git/packed-refs').and_return(true)
+                receive(:exist?).with('root/dir/.git/packed-refs').and_return(true),
               )
               expect(File).to(
                 receive(:readlines).with('root/dir/.git/packed-refs').and_return(
@@ -93,9 +95,9 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
                     "# pack-refs with: peeled fully-peeled\n",
                     "ccb316eecff79c7528d1ad43e5fa165f7a44d52e refs/tags/v3.0.30\n",
                     "^d358900f73ee5bfd6ca3a592cf23ac6e82df83c1",
-                    "d34db33f refs/foo\n"
-                  ]
-                )
+                    "d34db33f refs/foo\n",
+                  ],
+                ),
               )
             end
 
@@ -108,7 +110,7 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
           context "and when '.git/packed-refs' doesn't exist" do
             before do
               expect(File).to(
-                receive(:exist?).with('root/dir/.git/packed-refs').and_return(false)
+                receive(:exist?).with('root/dir/.git/packed-refs').and_return(false),
               )
             end
 

data/spec/filters/{keys_whitelist_spec.rb → keys_allowlist_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Airbrake::Filters::KeysWhitelist do
+RSpec.describe Airbrake::Filters::KeysAllowlist do
   subject { described_class.new(patterns) }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
@@ -19,8 +19,8 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
       [/\Abin/],
       [
         { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-        { bingo: 'bango', bongo: '[Filtered]', bash: '[Filtered]' }
-      ]
+        { bingo: 'bango', bongo: '[Filtered]', bash: '[Filtered]' },
+      ],
     )
   end
 
@@ -30,8 +30,8 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
       [:bongo],
       [
         { bongo: 'bish', bash: 'bosh', bbashh: 'bboshh' },
-        { bongo: 'bish', bash: '[Filtered]', bbashh: '[Filtered]' }
-      ]
+        { bongo: 'bish', bash: '[Filtered]', bbashh: '[Filtered]' },
+      ],
     )
   end
 
@@ -41,8 +41,8 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
       ['bash'],
       [
         { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-        { bingo: '[Filtered]', bongo: '[Filtered]', bash: 'bosh' }
-      ]
+        { bingo: '[Filtered]', bongo: '[Filtered]', bash: 'bosh' },
+      ],
     )
   end
 
@@ -53,8 +53,8 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
         [proc { 'bongo' }, :bash],
         [
           { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-          { bingo: '[Filtered]', bongo: 'bish', bash: 'bosh' }
-        ]
+          { bingo: '[Filtered]', bongo: 'bish', bash: 'bosh' },
+        ],
       )
     end
 
@@ -64,16 +64,16 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
         [proc { Object.new }],
         [
           { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-          { bingo: '[Filtered]', bongo: '[Filtered]', bash: '[Filtered]' }
-        ]
+          { bingo: '[Filtered]', bongo: '[Filtered]', bash: '[Filtered]' },
+        ],
       )
 
       it "logs an error" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /KeysWhitelist is invalid.+patterns: \[#<Object:.+>\]/
+          /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
         )
-        keys_whitelist = described_class.new(patterns)
-        keys_whitelist.call(notice)
+        keys_allowlist = described_class.new(patterns)
+        keys_allowlist.call(notice)
       end
     end
 
@@ -83,10 +83,10 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
       context "and when the filter is called once" do
         it "logs an error" do
           expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /KeysWhitelist is invalid.+patterns: \[#<Proc:.+>\]/
+            /KeysAllowlist is invalid.+patterns: \[#<Proc:.+>\]/,
           )
-          keys_whitelist = described_class.new(patterns)
-          keys_whitelist.call(notice)
+          keys_allowlist = described_class.new(patterns)
+          keys_allowlist.call(notice)
         end
 
         include_examples(
@@ -94,8 +94,8 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
           [proc { proc { ['bingo'] } }],
           [
             { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-            { bingo: '[Filtered]', bongo: '[Filtered]', bash: '[Filtered]' }
-          ]
+            { bingo: '[Filtered]', bongo: '[Filtered]', bash: '[Filtered]' },
+          ],
         )
       end
     end
@@ -107,16 +107,16 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
       [Object.new],
       [
         { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-        { bingo: '[Filtered]', bongo: '[Filtered]', bash: '[Filtered]' }
-      ]
+        { bingo: '[Filtered]', bongo: '[Filtered]', bash: '[Filtered]' },
+      ],
     )
 
     it "logs an error" do
       expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /KeysWhitelist is invalid.+patterns: \[#<Object:.+>\]/
+        /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
       )
-      keys_whitelist = described_class.new(patterns)
-      keys_whitelist.call(notice)
+      keys_allowlist = described_class.new(patterns)
+      keys_allowlist.call(notice)
     end
   end
 
@@ -127,8 +127,8 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
         %w[bongo bish],
         [
           { bingo: 'bango', bongo: { bish: 'bash' } },
-          { bingo: '[Filtered]', bongo: { bish: 'bash' } }
-        ]
+          { bingo: '[Filtered]', bongo: { bish: 'bash' } },
+        ],
       )
     end
 
@@ -151,6 +151,7 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
           # thing. One is a Java exception, the other is a Ruby exception.
           # Likely a bug: https://github.com/jruby/jruby/issues/1903
           raise ex unless RUBY_ENGINE == 'jruby'
+
           expect { subject.call(notice) }.to raise_error(java.lang.StackOverflowError)
         end
       end
@@ -166,7 +167,7 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
           notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash'
           subject.call(notice)
           expect(notice[:context][:url]).to(
-            eq('http://localhost:3000/crash?foo=[Filtered]&baz=[Filtered]&bish=bash')
+            eq('http://localhost:3000/crash?foo=[Filtered]&baz=[Filtered]&bish=bash'),
           )
         end
       end
@@ -177,7 +178,7 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
             'http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash'
           subject.call(notice)
           expect(notice[:context][:url]).to(
-            eq('http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash')
+            eq('http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash'),
           )
         end
       end