airbrake-ruby 2.2.3 → 2.2.4

data/spec/filters/root_directory_filter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Filters::RootDirectoryFilter do
+  subject { described_class.new(root_directory) }
+
+  let(:root_directory) { '/var/www/project' }
+
+  let(:notice) do
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+  end
+
+  it "replaces root directory in the backtrace with a label" do
+    # rubocop:disable Metrics/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
+
+    subject.call(notice)
+
+    # rubocop:disable Metrics/LineLength
+    expect(notice[:errors].first[:backtrace]).to(
+      eq(
+        [
+          { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
+          { file: "[PROJECT_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: "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec" }
+        ]
+      )
+    )
+    # rubocop:enable Metrics/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] }
+    )
+  end
+end

data/spec/filters/system_exit_filter_spec.rb

@@ -0,0 +1,16 @@
+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)
+    expect { subject.call(notice) }.to(
+      change { notice.ignored? }.from(false).to(true)
+    )
+  end
+
+  it "doesn't mark non SystemExit exceptions as ignored" do
+    notice = Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+    expect(notice).not_to be_ignored
+    expect { subject.call(notice) }.not_to(change { notice.ignored? })
+  end
+end

data/spec/filters/thread_filter_spec.rb

@@ -16,38 +16,214 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     end.join
   end
 
-  shared_examples "fiber variable ignore" do |key|
-    it "ignores the :#{key} fiber variable" do
-      new_thread do |th|
-        th[key] = :bingo
-        subject.call(notice)
+  describe "thread variables" do
+    shared_examples "expected thread variable" do |var|
+      it "attaches the thread variable" do
+        new_thread do |th|
+          th.thread_variable_set(:bingo, var)
+          subject.call(notice)
+        end
+
+        expect(notice[:params][:thread][:thread_variables][:bingo]).to eq(var)
       end
+    end
 
-      fiber_variables = notice[:params][:thread][:fiber_variables]
-      expect(fiber_variables[key]).to be_nil
+    context "given nil" do
+      include_examples "expected thread variable", nil
     end
-  end
 
-  %i[__recursive_key__ __rspec].each do |key|
-    include_examples "fiber variable ignore", key
-  end
+    context "given true" do
+      include_examples "expected thread variable", true
+    end
 
-  it "appends thread variables" do
-    new_thread do |th|
-      th.thread_variable_set(:bingo, :bango)
-      subject.call(notice)
+    context "given false" do
+      include_examples "expected thread variable", false
+    end
+
+    context "given a String" do
+      include_examples "expected thread variable", 'bango'
+    end
+
+    context "given a Symbol" do
+      include_examples "expected thread variable", :bango
+    end
+
+    context "given a Regexp" do
+      include_examples "expected thread variable", /bango/
+    end
+
+    context "given an Integer" do
+      include_examples "expected thread variable", 1
+    end
+
+    context "given a Float" do
+      include_examples "expected thread variable", 1.01
     end
 
-    expect(notice[:params][:thread][:thread_variables][:bingo]).to eq(:bango)
+    context "given an Object" do
+      it "converts it to a String and attaches" do
+        new_thread do |th|
+          th.thread_variable_set(:bingo, Object.new)
+          subject.call(notice)
+        end
+
+        vars = notice[:params][:thread][:thread_variables]
+        expect(vars[:bingo]).to match(/\A#<Object:.+>\z/)
+      end
+    end
+
+    context "given an Array of nested Hashes with complex objects" do
+      let(:var) do
+        [
+          {
+            bango: {
+              bongo: [
+                {
+                  bish: {
+                    bash: 'foo',
+                    bosh: Object.new
+                  }
+                }
+              ]
+            }
+          },
+          123
+        ]
+      end
+
+      it "converts objects to a safe objects" do
+        new_thread do |th|
+          th.thread_variable_set(:bingo, var)
+          subject.call(notice)
+        end
+
+        vars = notice[:params][:thread][:thread_variables]
+        expect(vars[:bingo]).to(
+          match(
+            [
+              {
+                bango: {
+                  bongo: [
+                    {
+                      bish: {
+                        bash: 'foo',
+                        bosh: /\A#<Object:.+>\z/
+                      }
+                    }
+                  ]
+                }
+              },
+              123
+            ]
+          )
+        )
+      end
+    end
   end
 
-  it "appends fiber variables" do
-    new_thread do |th|
-      th[:bingo] = :bango
-      subject.call(notice)
+  describe "fiber variables" do
+    shared_examples "expected fiber variable" do |var|
+      it "attaches the fiber variable" do
+        new_thread do |th|
+          th[:bingo] = var
+          subject.call(notice)
+        end
+
+        expect(notice[:params][:thread][:fiber_variables][:bingo]).to eq(var)
+      end
+    end
+
+    context "given nil" do
+      include_examples "expected fiber variable", nil
+    end
+
+    context "given true" do
+      include_examples "expected fiber variable", true
     end
 
-    expect(notice[:params][:thread][:fiber_variables][:bingo]).to eq(:bango)
+    context "given false" do
+      include_examples "expected fiber variable", false
+    end
+
+    context "given a String" do
+      include_examples "expected fiber variable", 'bango'
+    end
+
+    context "given a Symbol" do
+      include_examples "expected fiber variable", :bango
+    end
+
+    context "given a Regexp" do
+      include_examples "expected fiber variable", /bango/
+    end
+
+    context "given an Integer" do
+      include_examples "expected fiber variable", 1
+    end
+
+    context "given a Float" do
+      include_examples "expected fiber variable", 1.01
+    end
+
+    context "given an Object" do
+      it "converts it to a String and attaches" do
+        new_thread do |th|
+          th[:bingo] = Object.new
+          subject.call(notice)
+        end
+
+        vars = notice[:params][:thread][:fiber_variables]
+        expect(vars[:bingo]).to match(/\A#<Object:.+>\z/)
+      end
+    end
+
+    context "given an Array of nested Hashes with complex objects" do
+      let(:var) do
+        [
+          {
+            bango: {
+              bongo: [
+                {
+                  bish: {
+                    bash: 'foo',
+                    bosh: Object.new
+                  }
+                }
+              ]
+            }
+          },
+          123
+        ]
+      end
+
+      it "converts objects to a safe objects" do
+        new_thread do |th|
+          th[:bingo] = var
+          subject.call(notice)
+        end
+
+        vars = notice[:params][:thread][:fiber_variables]
+        expect(vars[:bingo]).to(
+          match(
+            [
+              {
+                bango: {
+                  bongo: [
+                    {
+                      bish: {
+                        bash: 'foo',
+                        bosh: /\A#<Object:.+>\z/
+                      }
+                    }
+                  ]
+                }
+              },
+              123
+            ]
+          )
+        )
+      end
+    end
   end
 
   it "appends name", skip: !Thread.current.respond_to?(:name) do
@@ -78,34 +254,4 @@ RSpec.describe Airbrake::Filters::ThreadFilter do
     subject.call(notice)
     expect(notice[:params][:thread][:safe_level]).to eq(0)
   end
-
-  context "when an IO-like object is stored" do
-    let(:io_obj) do
-      Class.new(IO) do
-        def initialize; end
-      end.new
-    end
-
-    before do
-      expect(io_obj).to be_is_a(IO)
-    end
-
-    it "doesn't append the IO object to thread variables" do
-      new_thread do |th|
-        th.thread_variable_set(:io, io_obj)
-        subject.call(notice)
-      end
-
-      expect(notice[:params][:thread][:thread_variables]).to be_nil
-    end
-
-    it "doesn't append the IO object to thread variables" do
-      new_thread do |th|
-        th[:io] = io_obj
-        subject.call(notice)
-      end
-
-      expect(notice[:params][:thread][:fiber_variables][:io]).to be_nil
-    end
-  end
 end

data/spec/notice_spec.rb

@@ -136,7 +136,7 @@ RSpec.describe Airbrake::Notice do
 
       context "when truncation failed" do
         it "returns nil" do
-          expect_any_instance_of(Airbrake::PayloadTruncator).
+          expect_any_instance_of(Airbrake::Truncator).
             to receive(:reduce_max_size).and_return(0)
 
           encoded = Base64.encode64("\xD3\xE6\xBC\x9D\xBA").encode!('ASCII-8BIT')

data/spec/sync_sender_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Airbrake::SyncSender do
 
     context "when request body is nil" do
       it "doesn't send a notice" do
-        expect_any_instance_of(Airbrake::PayloadTruncator).
+        expect_any_instance_of(Airbrake::Truncator).
           to receive(:reduce_max_size).and_return(0)
 
         encoded = Base64.encode64("\xD3\xE6\xBC\x9D\xBA").encode!('ASCII-8BIT')

data/spec/{payload_truncator_spec.rb → truncator_spec.rb}

@@ -2,32 +2,28 @@
 
 require 'spec_helper'
 
-RSpec.describe Airbrake::PayloadTruncator do
+RSpec.describe Airbrake::Truncator do
   let(:max_size) { 1000 }
   let(:truncated_len) { '[Truncated]'.length }
   let(:max_len) { max_size + truncated_len }
 
   before do
-    @truncator = described_class.new(max_size, Logger.new('/dev/null'))
+    @truncator = described_class.new(max_size)
   end
 
-  describe "#truncate_error" do
-    let(:error) do
-      { type: 'AirbrakeTestError', message: 'App crashed!', backtrace: [] }
-    end
-
-    before do
-      @stdout = StringIO.new
-    end
-
+  describe "#truncate_object" do
     describe "error backtrace" do
+      let(:error) do
+        { type: 'AirbrakeTestError', message: 'App crashed!', backtrace: [] }
+      end
+
       before do
         backtrace = Array.new(size) do
           { file: 'foo.rb', line: 23, function: '<main>' }
         end
 
         @error = error.merge(backtrace: backtrace)
-        described_class.new(max_size, Logger.new(@stdout)).truncate_error(@error)
+        described_class.new(max_size).truncate_object(@error)
       end
 
       context "when long" do
@@ -36,11 +32,6 @@ RSpec.describe Airbrake::PayloadTruncator do
         it "truncates the backtrace to the max size" do
           expect(@error[:backtrace].size).to eq(1000)
         end
-
-        it "logs the about the number of truncated frames" do
-          expect(@stdout.string).
-            to match(/INFO -- .+ dropped 1003 frame\(s\) from AirbrakeTestError/)
-        end
       end
 
       context "when short" do
@@ -49,17 +40,17 @@ RSpec.describe Airbrake::PayloadTruncator do
         it "does not truncate the backtrace" do
           expect(@error[:backtrace].size).to eq(size)
         end
-
-        it "doesn't log anything" do
-          expect(@stdout.string).to be_empty
-        end
       end
     end
 
     describe "error message" do
+      let(:error) do
+        { type: 'AirbrakeTestError', message: 'App crashed!', backtrace: [] }
+      end
+
       before do
         @error = error.merge(message: message)
-        described_class.new(max_size, Logger.new(@stdout)).truncate_error(@error)
+        described_class.new(max_size).truncate_object(@error)
       end
 
       context "when long" do
@@ -68,11 +59,6 @@ RSpec.describe Airbrake::PayloadTruncator do
         it "truncates the message" do
           expect(@error[:message].length).to eq(max_len)
         end
-
-        it "logs about the truncated string" do
-          expect(@stdout.string).
-            to match(/INFO -- .+ truncated the message of AirbrakeTestError/)
-        end
       end
 
       context "when short" do
@@ -82,15 +68,9 @@ RSpec.describe Airbrake::PayloadTruncator do
         it "doesn't truncate the message" do
           expect(@error[:message].length).to eq(msg_len)
         end
-
-        it "doesn't log about the truncated string" do
-          expect(@stdout.string).to be_empty
-        end
       end
     end
-  end
 
-  describe "#truncate_object" do
     describe "given a hash with short values" do
       let(:params) do
         { bingo: 'bango', bongo: 'bish', bash: 'bosh' }
@@ -270,7 +250,7 @@ RSpec.describe Airbrake::PayloadTruncator do
 
           context "with strings that equal to max_size" do
             before do
-              @truncator = described_class.new(max_size, Logger.new('/dev/null'))
+              @truncator = described_class.new(max_size)
             end
 
             let(:params) { { unicode: '1111' } }
@@ -399,7 +379,7 @@ RSpec.describe Airbrake::PayloadTruncator do
 
     describe "unicode payload" do
       before do
-        @truncator = described_class.new(max_size - 1, Logger.new('/dev/null'))
+        @truncator = described_class.new(max_size - 1)
       end
 
       describe "truncation" do