airbrake-ruby 4.15.0 → 6.0.2

data/spec/filters/git_repository_filter.rb

@@ -1,5 +1,5 @@
 RSpec.describe Airbrake::Filters::GitRepositoryFilter do
-  subject { described_class.new('.') }
+  subject(:git_repository_filter) { described_class.new('.') }
 
   let(:notice) do
     Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
@@ -9,42 +9,42 @@ RSpec.describe Airbrake::Filters::GitRepositoryFilter do
     it "parses standard git version" do
       allow_any_instance_of(Kernel)
         .to receive(:`).and_return('git version 2.18.0')
-      expect { subject }.not_to raise_error
+      expect { git_repository_filter }.not_to raise_error
     end
 
     it "parses release candidate git version" do
       allow_any_instance_of(Kernel)
         .to receive(:`).and_return('git version 2.21.0-rc0')
-      expect { subject }.not_to raise_error
+      expect { git_repository_filter }.not_to raise_error
     end
 
     it "parses git version with brackets" do
       allow_any_instance_of(Kernel)
         .to receive(:`).and_return('git version 2.17.2 (Apple Git-113)')
-      expect { subject }.not_to raise_error
+      expect { git_repository_filter }.not_to raise_error
     end
   end
 
   context "when context/repository is defined" do
     it "doesn't attach anything to context/repository" do
       notice[:context][:repository] = 'git@github.com:kyrylo/test.git'
-      subject.call(notice)
+      git_repository_filter.call(notice)
       expect(notice[:context][:repository]).to eq('git@github.com:kyrylo/test.git')
     end
   end
 
   context "when .git directory doesn't exist" do
-    subject { described_class.new('root/dir') }
+    git_repository_filter { described_class.new('root/dir') }
 
     it "doesn't attach anything to context/repository" do
-      subject.call(notice)
+      git_repository_filter.call(notice)
       expect(notice[:context][:repository]).to be_nil
     end
   end
 
   context "when .git directory exists" do
     it "attaches context/repository" do
-      subject.call(notice)
+      git_repository_filter.call(notice)
       expect(notice[:context][:repository]).to eq(
         'ssh://git@github.com/airbrake/airbrake-ruby.git',
       )
@@ -54,7 +54,7 @@ RSpec.describe Airbrake::Filters::GitRepositoryFilter do
   context "when git is not in PATH" do
     it "does not attach context/repository" do
       ENV['PATH'] = ''
-      subject.call(notice)
+      git_repository_filter.call(notice)
       expect(notice[:context][:repository]).to be_nil
     end
   end

data/spec/filters/git_revision_filter_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Airbrake::Filters::GitRevisionFilter do
-  subject { described_class.new('root/dir') }
+  subject(:git_revision_filter) { described_class.new('root/dir') }
 
   # 'let!', not 'let' to make sure Notice doesn't call File.exist? with
   # unexpected arguments.
@@ -8,88 +8,88 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
   context "when context/revision is defined" do
     it "doesn't attach anything to context/revision" do
       notice[:context][:revision] = '1.2.3'
-      subject.call(notice)
+      git_revision_filter.call(notice)
       expect(notice[:context][:revision]).to eq('1.2.3')
     end
   end
 
   context "when .git directory doesn't exist" do
     it "doesn't attach anything to context/revision" do
-      subject.call(notice)
+      git_revision_filter.call(notice)
       expect(notice[:context][:revision]).to be_nil
     end
   end
 
   context "when .git directory exists" do
     before do
-      expect(File).to receive(:exist?).with('root/dir/.git').and_return(true)
+      allow(File).to receive(:exist?).with('root/dir/.git').and_return(true)
     end
 
     context "and when HEAD doesn't exist" do
       before do
-        expect(File).to receive(:exist?).with('root/dir/.git/HEAD').and_return(false)
+        allow(File).to receive(:exist?).with('root/dir/.git/HEAD').and_return(false)
       end
 
       it "doesn't attach anything to context/revision" do
-        subject.call(notice)
+        git_revision_filter.call(notice)
         expect(notice[:context][:revision]).to be_nil
       end
     end
 
     context "and when HEAD exists" do
       before do
-        expect(File).to receive(:exist?).with('root/dir/.git/HEAD').and_return(true)
+        allow(File).to receive(:exist?).with('root/dir/.git/HEAD').and_return(true)
       end
 
       context "and also when HEAD doesn't start with 'ref: '" do
         before do
-          expect(File).to(
+          allow(File).to(
             receive(:read).with('root/dir/.git/HEAD').and_return('refs/foo'),
           )
         end
 
         it "attaches the content of HEAD to context/revision" do
-          subject.call(notice)
+          git_revision_filter.call(notice)
           expect(notice[:context][:revision]).to eq('refs/foo')
         end
       end
 
-      context "and also when HEAD starts with 'ref: " do
+      context "and also when HEAD starts with 'ref: '" do
         before do
-          expect(File).to(
+          allow(File).to(
             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(
+            allow(File).to(
               receive(:exist?).with('root/dir/.git/refs/foo').and_return(true),
             )
-            expect(File).to(
+            allow(File).to(
               receive(:read).with('root/dir/.git/refs/foo').and_return("d34db33f\n"),
             )
           end
 
           it "attaches the revision from the ref to context/revision" do
-            subject.call(notice)
+            git_revision_filter.call(notice)
             expect(notice[:context][:revision]).to eq('d34db33f')
           end
         end
 
         context "when the ref doesn't exist" do
           before do
-            expect(File).to(
+            allow(File).to(
               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(
+              allow(File).to(
                 receive(:exist?).with('root/dir/.git/packed-refs').and_return(true),
               )
-              expect(File).to(
+              allow(File).to(
                 receive(:readlines).with('root/dir/.git/packed-refs').and_return(
                   [
                     "# pack-refs with: peeled fully-peeled\n",
@@ -102,20 +102,20 @@ RSpec.describe Airbrake::Filters::GitRevisionFilter do
             end
 
             it "attaches the revision from 'packed-refs' to context/revision" do
-              subject.call(notice)
+              git_revision_filter.call(notice)
               expect(notice[:context][:revision]).to eq('d34db33f')
             end
           end
 
           context "and when '.git/packed-refs' doesn't exist" do
             before do
-              expect(File).to(
+              allow(File).to(
                 receive(:exist?).with('root/dir/.git/packed-refs').and_return(false),
               )
             end
 
             it "attaches the content of HEAD to context/revision" do
-              subject.call(notice)
+              git_revision_filter.call(notice)
               expect(notice[:context][:revision]).to eq('refs/foo')
             end
           end

data/spec/filters/keys_allowlist_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Airbrake::Filters::KeysAllowlist do
-  subject { described_class.new(patterns) }
+  subject(:keys_allowlist_filter) { described_class.new(patterns) }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
@@ -8,11 +8,15 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
 
     it "filters out the matching values" do
       notice[:params] = params.first
-      subject.call(notice)
+      keys_allowlist_filter.call(notice)
       expect(notice[:params]).to eq(params.last)
     end
   end
 
+  before do
+    allow(Airbrake::Loggable.instance).to receive(:error)
+  end
+
   context "when a pattern is a Regexp" do
     include_examples(
       'pattern matching',
@@ -69,11 +73,12 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
       )
 
       it "logs an error" do
-        expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
-        )
         keys_allowlist = described_class.new(patterns)
         keys_allowlist.call(notice)
+
+        expect(Airbrake::Loggable.instance).to have_received(:error).with(
+          /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
+        )
       end
     end
 
@@ -82,11 +87,12 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
 
       context "and when the filter is called once" do
         it "logs an error" do
-          expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /KeysAllowlist is invalid.+patterns: \[#<Proc:.+>\]/,
-          )
           keys_allowlist = described_class.new(patterns)
           keys_allowlist.call(notice)
+
+          expect(Airbrake::Loggable.instance).to have_received(:error).with(
+            /KeysAllowlist is invalid.+patterns: \[#<Proc:.+>\]/,
+          )
         end
 
         include_examples(
@@ -112,11 +118,12 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
     )
 
     it "logs an error" do
-      expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
-      )
       keys_allowlist = described_class.new(patterns)
       keys_allowlist.call(notice)
+
+      expect(Airbrake::Loggable.instance).to have_received(:error).with(
+        /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
+      )
     end
   end
 
@@ -145,13 +152,16 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
         notice[:params] = bongo
 
         begin
-          expect { subject.call(notice) }.to raise_error(SystemStackError)
+          expect { keys_allowlist_filter.call(notice) }.to raise_error(SystemStackError)
         rescue RSpec::Expectations::ExpectationNotMetError => ex
           # JRuby might raise two different exceptions, which represent the same
           # 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)
+
+          expect do
+            keys_allowlist_filter.call(notice)
+          end.to raise_error(java.lang.StackOverflowError)
         end
       end
     end
@@ -164,7 +174,7 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
       context "when it contains query params" do
         it "filters the params" do
           notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash'
-          subject.call(notice)
+          keys_allowlist_filter.call(notice)
           expect(notice[:context][:url]).to(
             eq('http://localhost:3000/crash?foo=[Filtered]&baz=[Filtered]&bish=bash'),
           )
@@ -175,7 +185,7 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
         it "leaves the URL unfiltered" do
           notice[:context][:url] =
             'http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash'
-          subject.call(notice)
+          keys_allowlist_filter.call(notice)
           expect(notice[:context][:url]).to(
             eq('http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash'),
           )
@@ -185,7 +195,7 @@ RSpec.describe Airbrake::Filters::KeysAllowlist do
       context "when it is without a query" do
         it "leaves the URL untouched" do
           notice[:context][:url] = 'http://localhost:3000/crash'
-          subject.call(notice)
+          keys_allowlist_filter.call(notice)
           expect(notice[:context][:url]).to(eq('http://localhost:3000/crash'))
         end
       end

data/spec/filters/keys_blocklist_spec.rb

@@ -1,5 +1,5 @@
 RSpec.describe Airbrake::Filters::KeysBlocklist do
-  subject { described_class.new(patterns) }
+  subject(:keys_blocklist_filter) { described_class.new(patterns) }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
@@ -8,11 +8,15 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
 
     it "filters out the matching values" do
       notice[:params] = params.first
-      subject.call(notice)
+      keys_blocklist_filter.call(notice)
       expect(notice[:params]).to eq(params.last)
     end
   end
 
+  before do
+    allow(Airbrake::Loggable.instance).to receive(:error)
+  end
+
   context "when a pattern is a Regexp" do
     include_examples(
       'pattern matching',
@@ -29,7 +33,7 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
       # https://github.com/airbrake/airbrake/issues/739
       it "doesn't fail" do
         notice[:params] = { bingo: { {} => 'unfiltered' } }
-        expect { subject.call(notice) }.not_to raise_error
+        expect { keys_blocklist_filter.call(notice) }.not_to raise_error
       end
     end
   end
@@ -90,11 +94,12 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
       )
 
       it "logs an error" do
-        expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
-        )
         keys_blocklist = described_class.new(patterns)
         keys_blocklist.call(notice)
+
+        expect(Airbrake::Loggable.instance).to have_received(:error).with(
+          /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
+        )
       end
     end
 
@@ -103,18 +108,19 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
 
       context "and when the filter is called once" do
         it "logs an error" do
-          expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /KeysBlocklist is invalid.+patterns: \[#<Proc:.+>\]/,
-          )
           keys_blocklist = described_class.new(patterns)
           keys_blocklist.call(notice)
+
+          expect(Airbrake::Loggable.instance).to have_received(:error).with(
+            /KeysBlocklist is invalid.+patterns: \[#<Proc:.+>\]/,
+          )
         end
       end
 
       context "and when the filter is called twice" do
         it "unwinds procs and filters keys" do
           notice[:params] = { bingo: 'bango', bongo: 'bish' }
-          2.times { subject.call(notice) }
+          2.times { keys_blocklist_filter.call(notice) }
           expect(notice[:params]).to eq(bingo: '[Filtered]', bongo: 'bish')
         end
       end
@@ -132,11 +138,12 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
     )
 
     it "logs an error" do
-      expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
-      )
       keys_blocklist = described_class.new(patterns)
       keys_blocklist.call(notice)
+
+      expect(Airbrake::Loggable.instance).to have_received(:error).with(
+        /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
+      )
     end
   end
 
@@ -150,6 +157,16 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
           { bongo: { bish: '[Filtered]' } },
         ],
       )
+
+      it "doesn't mutate the original hash" do
+        params = { bongo: { bish: 'bash' } }
+        notice[:params] = params
+
+        blocklist = described_class.new([:bish])
+        blocklist.call(notice)
+
+        expect(params[:bongo][:bish]).to eq('bash')
+      end
     end
 
     context "and it is recursive" do
@@ -175,7 +192,7 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
         notice[:context][:url] =
           'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash&color=%23FFAAFF'
 
-        subject.call(notice)
+        keys_blocklist_filter.call(notice)
         expect(notice[:context][:url]).to(
           eq('http://localhost:3000/crash?foo=bar&baz=bongo&bish=[Filtered]&color=%23FFAAFF'),
         )
@@ -187,7 +204,7 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
 
       it "filters out the user" do
         notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-        subject.call(notice)
+        keys_blocklist_filter.call(notice)
         expect(notice[:context][:user]).to eq('[Filtered]')
       end
     end
@@ -197,7 +214,7 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
 
       it "filters out individual user fields" do
         notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-        subject.call(notice)
+        keys_blocklist_filter.call(notice)
         expect(notice[:context][:user][:name]).to eq('[Filtered]')
       end
     end
@@ -208,7 +225,7 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
 
     it "filters out the headers" do
       notice[:context][:headers] = { 'HTTP_COOKIE' => 'banana' }
-      subject.call(notice)
+      keys_blocklist_filter.call(notice)
       expect(notice[:context][:headers]).to eq('[Filtered]')
     end
 
@@ -217,7 +234,7 @@ RSpec.describe Airbrake::Filters::KeysBlocklist do
 
       it "filters out individual header fields" do
         notice[:context][:headers] = { 'HTTP_COOKIE' => 'banana' }
-        subject.call(notice)
+        keys_blocklist_filter.call(notice)
         expect(notice[:context][:headers]['HTTP_COOKIE']).to eq('[Filtered]')
       end
     end

data/spec/filters/root_directory_filter_spec.rb

@@ -1,22 +1,22 @@
 RSpec.describe Airbrake::Filters::RootDirectoryFilter do
-  subject { described_class.new(root_directory) }
+  subject(:root_directory_filter) { described_class.new(root_directory) }
 
   let(:root_directory) { '/var/www/project' }
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
   it "replaces root directory 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: "#{root_directory}/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: "#{root_directory}/gems/rspec-core-3.3.2/exe/rspec" },
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
-    subject.call(notice)
+    root_directory_filter.call(notice)
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     expect(notice[:errors].first[:backtrace]).to(
       eq(
         [
@@ -27,12 +27,12 @@ RSpec.describe Airbrake::Filters::RootDirectoryFilter 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 { root_directory_filter.call(notice) }.not_to(
       change { notice[:errors].first[:file] },
     )
   end