Mark Bugsnag frames as out of project

features/fixtures/plain/app/stack_frame_modification/initiators/handled_before_notify.rb

@@ -21,5 +21,9 @@ def step_three
 end
 
 def crash
-  Bugsnag.notify(RuntimeError.new("oh no"))
+  begin
+    "Test".insrt(-1, "!")
+  rescue Exception => e
+    Bugsnag.notify(e)
+  end
 end

features/plain_features/handled_errors.feature

@@ -17,8 +17,8 @@ Scenario Outline: A handled error sends a report
   And the event "severity" equals "warning"
   And the event "severityReason.type" equals "handledException"
   And the exception "errorClass" equals "RuntimeError"
-  And the "file" of stack frame 0 equals "/usr/src/app/handled/<file>.rb"
-  And the "lineNumber" of stack frame 0 equals <lineNumber>
+  And the "file" of the top project stackframe equals "/usr/src/app/handled/<file>.rb"
+  And the "lineNumber" of the top project stackframe equals <lineNumber>
 
   Examples:
   | ruby version | file                | lineNumber |
@@ -67,8 +67,8 @@ Scenario Outline: A handled error can attach metadata in a block
   And the event "severity" equals "warning"
   And the event "severityReason.type" equals "handledException"
   And the exception "errorClass" equals "RuntimeError"
-  And the "file" of stack frame 0 equals "/usr/src/app/handled/block_metadata.rb"
-  And the "lineNumber" of stack frame 0 equals 6
+  And the "file" of the top project stackframe equals "/usr/src/app/handled/block_metadata.rb"
+  And the "lineNumber" of the top project stackframe equals 6
   And the event "metaData.account.id" equals "1234abcd"
   And the event "metaData.account.name" equals "Acme Co"
   And the event "metaData.account.support" is true

features/plain_features/report_stack_frames.feature

@@ -14,8 +14,8 @@ Scenario Outline: Stack frames can be removed
   And the request used the "Ruby Bugsnag Notifier" notifier
   And the request used payload v4 headers
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the "file" of stack frame 0 equals "/usr/src/app/stack_frame_modification/initiators/<initiator>.rb"
-  And the "lineNumber" of stack frame 0 equals <lineNumber>
+  And the "file" of the top project stackframe equals "/usr/src/app/stack_frame_modification/initiators/<initiator>.rb"
+  And the "lineNumber" of the top project stackframe equals <lineNumber>
 
   Examples:
   | ruby version | initiator               | lineNumber |
@@ -51,7 +51,7 @@ Scenario Outline: Stack frames can be marked as in project
   And the request used the "Ruby Bugsnag Notifier" notifier
   And the request used payload v4 headers
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the "file" of stack frame 0 equals "/usr/src/app/stack_frame_modification/initiators/<initiator>.rb"
+  And the "file" of the top project stackframe equals "/usr/src/app/stack_frame_modification/initiators/<initiator>.rb"
   And the event "exceptions.0.stacktrace.0.inProject" is null
   And the event "exceptions.0.stacktrace.1.inProject" is true
   And the event "exceptions.0.stacktrace.2.inProject" is true

features/rails_features/project_root.feature

@@ -18,7 +18,7 @@ Scenario Outline: Project_root should default to Rails.root
   And the exception "errorClass" equals "RuntimeError"
   And the exception "message" starts with "handled string"
   And the event "metaData.request.url" ends with "/project_root/default"
-  And the "file" of stack frame 0 equals "app/controllers/project_root_controller.rb"
+  And the "file" of the top project stackframe equals "app/controllers/project_root_controller.rb"
 
   Examples:
     | ruby_version | rails_version |
@@ -49,7 +49,7 @@ Scenario Outline: Project_root can be set in an initializer
   And the exception "errorClass" equals "RuntimeError"
   And the exception "message" starts with "handled string"
   And the event "metaData.request.url" ends with "/project_root/initializer"
-  And the "file" of stack frame 0 equals "/usr/src/app/controllers/project_root_controller.rb"
+  And the "file" of the top project stackframe equals "/usr/src/app/controllers/project_root_controller.rb"
 
   Examples:
     | ruby_version | rails_version |
@@ -79,7 +79,7 @@ Scenario Outline: Project_root can be set after an initializer
   And the exception "errorClass" equals "RuntimeError"
   And the exception "message" starts with "handled string"
   And the event "metaData.request.url" ends with "/project_root/after"
-  And the "file" of stack frame 0 equals "/usr/src/app/controllers/project_root_controller.rb"
+  And the "file" of the top project stackframe equals "/usr/src/app/controllers/project_root_controller.rb"
 
   Examples:
     | ruby_version | rails_version |

features/steps/ruby_notifier_steps.rb

@@ -12,4 +12,30 @@
   steps %Q{
     When I set environment variable "#{env_var}" to "#{credentials}@#{current_ip}:#{MOCK_API_PORT}"
   }
+end
+Then(/^the "(.+)" of the top project stackframe equals "(.+)"(?: for request (\d+))?$/) do |element, value, request_index|
+  stacktrace = read_key_path(find_request(request_index)[:body], 'events.0.exceptions.0.stacktrace')
+  frame_index = 0
+  stacktrace.each do |frame, index|
+    unless /.*lib\/bugsnag.*\.rb/.match(frame["file"])
+      frame_index = index
+      break
+    end
+  end
+  steps %Q{
+    the "#{element}" of stack frame #{frame_index} equals "#{value}"
+  }
+end
+Then(/^the "(.+)" of the top project stackframe equals (\d+)(?: for request (\d+))?$/) do |element, value, request_index|
+  stacktrace = read_key_path(find_request(request_index)[:body], 'events.0.exceptions.0.stacktrace')
+  frame_index = 0
+  stacktrace.each do |frame, index|
+    unless /.*lib\/bugsnag.*\.rb/.match(frame["file"])
+      frame_index = index
+      break
+    end
+  end
+  steps %Q{
+    the "#{element}" of stack frame #{frame_index} equals #{value}
+  }
 end

lib/bugsnag/stacktrace.rb

@@ -26,8 +26,7 @@ def initialize(backtrace, configuration)
 
         # Parse the stacktrace line
 
-        # Skip stacktrace lines inside lib/bugsnag
-        next(nil) if file.nil? || file =~ %r{lib/bugsnag(/|\.rb)}
+        next(nil) if file.nil?
 
         # Expand relative paths
         p = Pathname.new(file)

spec/report_spec.rb

@@ -503,7 +503,12 @@ def gloops
 
   it "does not mark the top-most stacktrace line as inProject if out of project" do
     Bugsnag.configuration.project_root = "/Random/location/here"
-    Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+    begin
+      "Test".prepnd "T"
+    rescue Exception => e
+      Bugsnag.notify(e)
+    end
 
     expect(Bugsnag).to have_sent_notification{ |payload, headers|
       exception = get_exception_from_payload(payload)
@@ -514,12 +519,17 @@ def gloops
 
   it "marks the top-most stacktrace line as inProject if necessary" do
     Bugsnag.configuration.project_root = File.expand_path File.dirname(__FILE__)
-    Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+    begin
+      "Test".prepnd "T"
+    rescue Exception => e
+      Bugsnag.notify(e)
+    end
 
     expect(Bugsnag).to have_sent_notification{ |payload, headers|
       exception = get_exception_from_payload(payload)
       expect(exception["stacktrace"].size).to be >= 1
-      expect(exception["stacktrace"].first["inProject"]).to eq(true)
+      expect(exception["stacktrace"][0]["inProject"]).to eq(true)
     }
   end
 
@@ -1050,12 +1060,21 @@ def gloops
       exception = event["exceptions"][0]
       expect(exception["errorClass"]).to eq("RuntimeError")
       expect(exception["message"]).to eq("'nil' was notified as an exception")
+    }
+  end
 
-      stacktrace = exception["stacktrace"][0]
-      expect(stacktrace["lineNumber"]).to eq(1047)
-      expect(stacktrace["file"]).to end_with("spec/report_spec.rb")
-      expect(stacktrace["code"]["1046"]).to eq("  it 'uses an appropriate message if nil is notified' do")
-      expect(stacktrace["code"]["1047"]).to eq("    Bugsnag.notify(nil)")
+  it "includes bugsnag lines marked out of project" do
+    notify_test_exception
+    expect(Bugsnag).to have_sent_notification{ |payload, headers|
+      exception = get_exception_from_payload(payload)
+      bugsnag_count = 0
+      exception["stacktrace"].each do |frame|
+        if /.*lib\/bugsnag.*\.rb/.match(frame["file"])
+          bugsnag_count += 1
+          expect(frame["inProject"]).to be_nil
+        end
+      end
+      expect(bugsnag_count).to be > 0
     }
   end
 

spec/spec_helper.rb

@@ -83,4 +83,4 @@ def have_sent_notification(&matcher)
       raise "no matcher provided to have_sent_notification (did you use { })"
     end
   end
-end
+end

spec/stacktrace_spec.rb

@@ -2,25 +2,29 @@
 
 describe Bugsnag::Stacktrace do
   it "includes code in the stack trace" do
-    _a = 1
-    _b = 2
-    _c = 3
-    notify_test_exception
-    _d = 4
-    _e = 5
-    _f = 6
+    begin
+      _a = 1
+      _b = 2
+      _c = 3
+      "Test".prepnd "T"
+      _d = 4
+      _e = 5
+      _f = 6
+    rescue Exception => e
+      Bugsnag.notify(e)
+    end
 
     expect(Bugsnag).to have_sent_notification{ |payload, headers|
       exception = get_exception_from_payload(payload)
-      starting_line = __LINE__ - 10
-      expect(exception["stacktrace"][1]["code"]).to eq({
-        (starting_line + 0).to_s => "    _a = 1",
-        (starting_line + 1).to_s => "    _b = 2",
-        (starting_line + 2).to_s => "    _c = 3",
-        (starting_line + 3).to_s => "    notify_test_exception",
-        (starting_line + 4).to_s => "    _d = 4",
-        (starting_line + 5).to_s => "    _e = 5",
-        (starting_line + 6).to_s => "    _f = 6"
+      starting_line = __LINE__ - 13
+      expect(exception["stacktrace"][0]["code"]).to eq({
+        (starting_line + 0).to_s => "      _a = 1",
+        (starting_line + 1).to_s => "      _b = 2",
+        (starting_line + 2).to_s => "      _c = 3",
+        (starting_line + 3).to_s => "      \"Test\".prepnd \"T\"",
+        (starting_line + 4).to_s => "      _d = 4",
+        (starting_line + 5).to_s => "      _e = 5",
+        (starting_line + 6).to_s => "      _f = 6"
         })
     }
   end