bugsnag 6.14.0 → 6.15.0

data/spec/stacktrace_spec.rb

@@ -15,10 +15,10 @@ describe Bugsnag::Stacktrace do
         Bugsnag.notify(e)
       end
 
-      expect(Bugsnag).to have_sent_notification{ |payload, headers|
-        exception = get_exception_from_payload(payload)
-        starting_line = __LINE__ - 13
-        expect(exception["stacktrace"][0]["code"]).to eq({
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        starting_line = __LINE__ - 12
+
+        expect(get_code_from_payload(payload).to_a).to eq({
           (starting_line + 0).to_s => '        _a = 1',
           (starting_line + 1).to_s => '        _b = 2',
           (starting_line + 2).to_s => '        _c = 3',
@@ -26,7 +26,7 @@ describe Bugsnag::Stacktrace do
           (starting_line + 4).to_s => '        _d = 4',
           (starting_line + 5).to_s => '        _e = 5',
           (starting_line + 6).to_s => '        _f = 6'
-          })
+        }.to_a)
       }
     end
 
@@ -35,19 +35,16 @@ describe Bugsnag::Stacktrace do
 
       notify_test_exception
 
-      expect(Bugsnag).to have_sent_notification{ |payload, headers|
-        exception = get_exception_from_payload(payload)
-        expect(exception["stacktrace"][1]["code"]).to eq(nil)
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        expect(get_code_from_payload(payload)).to eq(nil)
       }
     end
 
     it 'should send the first 7 lines of the file for exceptions near the top' do
       load 'spec/fixtures/crashes/start_of_file.rb' rescue Bugsnag.notify $!
 
-      expect(Bugsnag).to have_sent_notification{ |payload, headers|
-        exception = get_exception_from_payload(payload)
-
-        expect(exception["stacktrace"][0]["code"]).to eq({
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        expect(get_code_from_payload(payload).to_a).to eq({
           "1" => "#",
           "2" => "raise 'hell'",
           "3" => "#",
@@ -55,17 +52,15 @@ describe Bugsnag::Stacktrace do
           "5" => "#",
           "6" => "#",
           "7" => "#"
-        })
+        }.to_a)
       }
     end
 
     it 'should send the last 7 lines of the file for exceptions near the bottom' do
       load 'spec/fixtures/crashes/end_of_file.rb' rescue Bugsnag.notify $!
 
-      expect(Bugsnag).to have_sent_notification{ |payload, headers|
-        exception = get_exception_from_payload(payload)
-
-        expect(exception["stacktrace"][0]["code"]).to eq({
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        expect(get_code_from_payload(payload)).to eq({
           "3" => "#",
           "4" => "#",
           "5" => "#",
@@ -77,17 +72,226 @@ describe Bugsnag::Stacktrace do
       }
     end
 
-    it 'should send the last 7 lines of the file for exceptions near the bottom' do
+    it 'should send every line of a very short file' do
       load 'spec/fixtures/crashes/short_file.rb' rescue Bugsnag.notify $!
 
-      expect(Bugsnag).to have_sent_notification{ |payload, headers|
-        exception = get_exception_from_payload(payload)
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        expect(get_code_from_payload(payload).to_a).to eq({
+          "1" => "#",
+          "2" => "raise 'hell'",
+          "3" => "#"
+        }.to_a)
+      }
+    end
 
-        expect(exception["stacktrace"][0]["code"]).to eq({
-          "1" => "raise 'hell'"
-        })
+    it 'should send code for each line in the stacktrace' do
+      load 'spec/fixtures/crashes/functions.rb' rescue Bugsnag.notify $!
+
+      expected_code = [
+        # The topmost frame is centered on where the exception was raised
+        {
+          "11" => "end",
+          "12" => "",
+          "13" => "def xyz",
+          "14" => "  raise 'uh oh'",
+          "15" => "end",
+          "16" => "",
+          "17" => "def abc"
+        },
+        # then we get 'baz' which is where 'xyz' was called
+        {
+          "7" => "end",
+          "8" => "",
+          "9" => "def baz",
+          "10" => "  xyz",
+          "11" => "end",
+          "12" => "",
+          "13" => "def xyz"
+        },
+        # then we get 'bar' which is where 'baz' was called
+        {
+          "3" => "end",
+          "4" => "",
+          "5" => "def bar",
+          "6" => "  baz",
+          "7" => "end",
+          "8" => "",
+          "9" => "def baz"
+        },
+        # then we get 'foo' which is where 'bar' was called - this is the first
+        # 7 lines because the call to 'bar' is on line 2
+        {
+          "1" => "def foo",
+          "2" => "  bar",
+          "3" => "end",
+          "4" => "",
+          "5" => "def bar",
+          "6" => "  baz",
+          "7" => "end"
+        },
+        # finally we get the call to 'foo' - this is the last 7 lines because
+        # the call is on the last line of the file
+        {
+          "23" => "end",
+          "24" => "",
+          "25" => "def abcdefghi",
+          "26" => "  puts 'abcdefghi'",
+          "27" => "end",
+          "28" => "",
+          "29" => "foo"
+        }
+      ]
+
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        (0...expected_code.size).each do |index|
+          expect(get_code_from_payload(payload, index).to_a).to eq(expected_code[index].to_a)
+        end
+      }
+    end
+
+    it 'should send code for each line in the stacktrace when split over multiple files' do
+      load 'spec/fixtures/crashes/file1.rb' rescue Bugsnag.notify $!
+
+      expected_code = [
+        {
+          "8" => "  end",
+          "9" => "",
+          "10" => "  def self.baz2",
+          "11" => "    raise 'uh oh'",
+          "12" => "  end",
+          "13" => "",
+          "14" => "  def self.abc2"
+        },
+        {
+          "10" => "  end",
+          "11" => "",
+          "12" => "  def self.baz1",
+          "13" => "    File2.baz2",
+          "14" => "  end",
+          "15" => "",
+          "16" => "  def self.abc1"
+        },
+        {
+          "4" => "  end",
+          "5" => "",
+          "6" => "  def self.bar2",
+          "7" => "    File1.baz1",
+          "8" => "  end",
+          "9" => "",
+          "10" => "  def self.baz2"
+        },
+        {
+          "6" => "  end",
+          "7" => "",
+          "8" => "  def self.bar1",
+          "9" => "    File2.bar2",
+          "10" => "  end",
+          "11" => "",
+          "12" => "  def self.baz1",
+        },
+        {
+          "1" => "module File2",
+          "2" => "  def self.foo2",
+          "3" => "    File1.bar1",
+          "4" => "  end",
+          "5" => "",
+          "6" => "  def self.bar2",
+          "7" => "    File1.baz1"
+        },
+        {
+          "2" => "",
+          "3" => "module File1",
+          "4" => "  def self.foo1",
+          "5" => "    File2.foo2",
+          "6" => "  end",
+          "7" => "",
+          "8" => "  def self.bar1"
+        },
+        {
+          "23" => "",
+          "24" => "  def self.abcdefghi1",
+          "25" => "    puts 'abcdefghi1'",
+          "26" => "  end",
+          "27" => "end",
+          "28" => "",
+          "29" => "File1.foo1"
+        }
+      ]
+
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        (0...expected_code.size).each do |index|
+          expect(get_code_from_payload(payload, index).to_a).to eq(expected_code[index].to_a)
+        end
       }
     end
+
+    it "can extract code from paths that will be mangled by the project root" do
+      # Set the project root to a nested directory, which will then be stripped
+      # from the file paths in the API call. This ensures that we read the files
+      # based off of the original path, rather than the final file path, e.g.
+      # "spec/fixtures/crashes/file1.rb" will be "file1.rb" in the API call, which
+      # isn't a path that's possible to read
+      project_root = "#{File.dirname(File.dirname(__FILE__))}/spec/fixtures/crashes"
+
+      configuration = Bugsnag::Configuration.new
+      configuration.project_root = project_root
+
+      backtrace = [
+        "spec/fixtures/crashes/file1.rb:13:in `baz1'",
+        "./spec/fixtures/crashes/functions.rb:17:in `abc'",
+        "#{project_root}/file2.rb:19:in `abcdef2'",
+      ]
+
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
+
+      expect(stacktrace).to eq([
+        {
+          file: "file1.rb",
+          lineNumber: 13,
+          method: "baz1",
+          inProject: true,
+          code: {
+            10 => "  end",
+            11 => "",
+            12 => "  def self.baz1",
+            13 => "    File2.baz2",
+            14 => "  end",
+            15 => "",
+            16 => "  def self.abc1"
+          }
+        },
+        {
+          file: "functions.rb",
+          lineNumber: 17,
+          method: "abc",
+          inProject: true,
+          code: {
+            14 => "  raise 'uh oh'",
+            15 => "end",
+            16 => "",
+            17 => "def abc",
+            18 => "  puts 'abc'",
+            19 => "end",
+            20 => ""
+          },
+        },
+        {
+          file: "file2.rb",
+          lineNumber: 19,
+          method: "abcdef2",
+          inProject: true,
+          code: {
+            16 => "  end",
+            17 => "",
+            18 => "  def self.abcdef2",
+            19 => "    puts 'abcdef2'",
+            20 => "  end",
+            21 => "",
+            22 => "  def self.abcdefghi2"
+          },
+        },
+      ])
+    end
   end
 
   context "file paths" do
@@ -102,7 +306,7 @@ describe Bugsnag::Stacktrace do
         "/foo/bar/.bundle/lib/ignore_me.rb:4:in `to_s'",
       ]
 
-      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration).to_a
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
 
       expect(stacktrace).to eq([
         { file: "/foo/bar/app/models/user.rb", lineNumber: 1, method: "something" },
@@ -122,7 +326,7 @@ describe Bugsnag::Stacktrace do
         "abc.rb:1:in `defg'",
       ]
 
-      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration).to_a
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
 
       expect(stacktrace).to eq([
         { code: nil, file: "./foo/bar/baz.rb", lineNumber: 1, method: "something" },
@@ -145,7 +349,7 @@ describe Bugsnag::Stacktrace do
         "#{dir}/../spec/stacktrace_spec.rb:5:in `something_else'",
       ]
 
-      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration).to_a
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
 
       expect(stacktrace).to eq([
         { file: "#{dir}/spec_helper.rb", lineNumber: 1, method: "something" },
@@ -154,6 +358,48 @@ describe Bugsnag::Stacktrace do
         { file: "#{dir}/stacktrace_spec.rb", lineNumber: 5, method: "something_else" },
       ])
     end
+
+    it "ignores lines in backtrace that it can't parse" do
+      configuration = Bugsnag::Configuration.new
+      configuration.send_code = false
+
+      backtrace = [
+        "/foo/bar/baz.rb:2:in `to_s'",
+        "this is not formatted correctly :O",
+        "/abc/xyz.rb:4:in `to_s'",
+      ]
+
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
+
+      expect(stacktrace).to eq([
+        { file: "/foo/bar/baz.rb", lineNumber: 2, method: "to_s" },
+        { file: "/abc/xyz.rb", lineNumber: 4, method: "to_s" },
+      ])
+    end
+
+    it "trims Gem prefix from paths" do
+      gem_path = Gem.path.first
+
+      # Sanity check that we have a gem path to strip
+      expect(gem_path).not_to be_empty
+
+      configuration = Bugsnag::Configuration.new
+      configuration.send_code = false
+
+      backtrace = [
+        "/foo/bar/baz.rb:2:in `to_s'",
+        "#{gem_path}/abc/xyz.rb:4:in `to_s'",
+        "/not/gem/path/but/has/gem.rb:6:in `to_s'"
+      ]
+
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
+
+      expect(stacktrace).to eq([
+        { file: "/foo/bar/baz.rb", lineNumber: 2, method: "to_s" },
+        { file: "abc/xyz.rb", lineNumber: 4, method: "to_s" },
+        { file: "/not/gem/path/but/has/gem.rb", lineNumber: 6, method: "to_s" },
+      ])
+    end
   end
 
   context "with configurable vendor_path" do
@@ -173,13 +419,13 @@ describe Bugsnag::Stacktrace do
     end
 
     def out_project_trace(stacktrace)
-      stacktrace.to_a.map do |trace_line|
-        trace_line[:file] if !trace_line[:inProject]
+      stacktrace.map do |trace_line|
+        trace_line[:file] unless trace_line[:inProject]
       end.compact
     end
 
     it "marks vendor/ and .bundle/ as out-project by default" do
-      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration)
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
 
       expect(out_project_trace(stacktrace)).to eq([
         "vendor/lib/ignore_me.rb",
@@ -189,7 +435,7 @@ describe Bugsnag::Stacktrace do
 
     it "allows vendor_path to be configured and filters out backtrace file paths" do
       configuration.vendor_path = /other_vendor\//
-      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration)
+      stacktrace = Bugsnag::Stacktrace.process(backtrace, configuration)
 
       expect(out_project_trace(stacktrace)).to eq(["other_vendor/lib/dont.rb"])
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.14.0
+  version: 6.15.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -175,7 +175,9 @@ files:
 - features/fixtures/plain/app/report_modification/ignore_report.rb
 - features/fixtures/plain/app/report_modification/initiators/handled_before_notify.rb
 - features/fixtures/plain/app/report_modification/initiators/handled_block.rb
+- features/fixtures/plain/app/report_modification/initiators/handled_on_error.rb
 - features/fixtures/plain/app/report_modification/initiators/unhandled_before_notify.rb
+- features/fixtures/plain/app/report_modification/initiators/unhandled_on_error.rb
 - features/fixtures/plain/app/report_modification/modify_api_key.rb
 - features/fixtures/plain/app/report_modification/modify_severity.rb
 - features/fixtures/plain/app/report_modification/remove_user_details.rb
@@ -183,7 +185,9 @@ files:
 - features/fixtures/plain/app/report_modification/set_user_details.rb
 - features/fixtures/plain/app/stack_frame_modification/initiators/handled_before_notify.rb
 - features/fixtures/plain/app/stack_frame_modification/initiators/handled_block.rb
+- features/fixtures/plain/app/stack_frame_modification/initiators/handled_on_error.rb
 - features/fixtures/plain/app/stack_frame_modification/initiators/unhandled_before_notify.rb
+- features/fixtures/plain/app/stack_frame_modification/initiators/unhandled_on_error.rb
 - features/fixtures/plain/app/stack_frame_modification/mark_frames_in_project.rb
 - features/fixtures/plain/app/stack_frame_modification/remove_stack_frame.rb
 - features/fixtures/plain/app/unhandled/bad_syntax.rb
@@ -600,6 +604,7 @@ files:
 - features/rails_features/ignore_classes.feature
 - features/rails_features/meta_data_filters.feature
 - features/rails_features/mongo_breadcrumbs.feature
+- features/rails_features/on_error.feature
 - features/rails_features/project_root.feature
 - features/rails_features/release_stage.feature
 - features/rails_features/send_code.feature
@@ -615,6 +620,7 @@ files:
 - lib/bugsnag/breadcrumbs/breadcrumbs.rb
 - lib/bugsnag/breadcrumbs/validator.rb
 - lib/bugsnag/cleaner.rb
+- lib/bugsnag/code_extractor.rb
 - lib/bugsnag/configuration.rb
 - lib/bugsnag/delivery.rb
 - lib/bugsnag/delivery/synchronous.rb
@@ -651,6 +657,7 @@ files:
 - lib/bugsnag/middleware/suggestion_data.rb
 - lib/bugsnag/middleware/warden_user.rb
 - lib/bugsnag/middleware_stack.rb
+- lib/bugsnag/on_error_callbacks.rb
 - lib/bugsnag/report.rb
 - lib/bugsnag/session_tracker.rb
 - lib/bugsnag/stacktrace.rb
@@ -663,6 +670,7 @@ files:
 - spec/breadcrumbs/validator_spec.rb
 - spec/bugsnag_spec.rb
 - spec/cleaner_spec.rb
+- spec/code_extractor_spec.rb
 - spec/configuration_spec.rb
 - spec/fixtures/apps/rails-initializer-config/Gemfile
 - spec/fixtures/apps/rails-initializer-config/config.ru
@@ -677,6 +685,10 @@ files:
 - spec/fixtures/apps/scripts/configure_key.rb
 - spec/fixtures/apps/scripts/no_config.rb
 - spec/fixtures/crashes/end_of_file.rb
+- spec/fixtures/crashes/file1.rb
+- spec/fixtures/crashes/file2.rb
+- spec/fixtures/crashes/file_with_long_lines.rb
+- spec/fixtures/crashes/functions.rb
 - spec/fixtures/crashes/short_file.rb
 - spec/fixtures/crashes/start_of_file.rb
 - spec/fixtures/middleware/internal_info_setter.rb
@@ -699,6 +711,7 @@ files:
 - spec/middleware/exception_meta_data_spec.rb
 - spec/middleware_spec.rb
 - spec/middleware_stack_spec.rb
+- spec/on_error_spec.rb
 - spec/report_spec.rb
 - spec/session_tracker_spec.rb
 - spec/spec_helper.rb