bugsnag 6.9.0 → 6.10.0

data/features/rails_features/send_environment.feature

@@ -1,19 +1,19 @@
 Feature: Send environment
 
 Background:
-  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And I set environment variable "APP_PATH" to "/usr/src"
   And I configure the bugsnag endpoint
 
 Scenario Outline: Send_environment should send environment in handled errors when true
   Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
-  And I set environment variable "MAZE_SEND_ENVIRONMENT" to "true"
+  And I set environment variable "BUGSNAG_SEND_ENVIRONMENT" to "true"
   And I start the service "rails<rails_version>"
   And I wait for the app to respond on port "6128<rails_version>"
   When I navigate to the route "/send_environment/initializer" on port "6128<rails_version>"
   Then I should receive a request
   And the request is a valid for the error reporting API
-  And the request used the Ruby notifier
+  And the request used the "Ruby Bugsnag Notifier" notifier
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And the payload field "events" is an array with 1 element
   And the exception "errorClass" equals "RuntimeError"

data/features/rails_features/unhandled.feature

@@ -1,7 +1,7 @@
 Feature: Unhandled exceptions support
 
 Background:
-  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And I set environment variable "APP_PATH" to "/usr/src"
   And I configure the bugsnag endpoint
 
@@ -12,7 +12,7 @@ Scenario Outline: Unhandled RuntimeError
   When I navigate to the route "/unhandled/error" on port "6128<rails_version>"
   Then I should receive a request
   And the request is a valid for the error reporting API
-  And the request used the Ruby notifier
+  And the request used the "Ruby Bugsnag Notifier" notifier
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And the payload field "events" is an array with 1 element
   And the event "unhandled" is true
@@ -21,8 +21,8 @@ Scenario Outline: Unhandled RuntimeError
   And the event "app.type" equals "rails"
   And the event "metaData.request.url" ends with "/unhandled/error"
   And the event "severity" equals "error"
-  And the event "severityReason.type" is "unhandledExceptionMiddleware"
-  And the event "severityReason.attributes.framework" is "Rack"
+  And the event "severityReason.type" equals "unhandledExceptionMiddleware"
+  And the event "severityReason.attributes.framework" equals "Rack"
 
   Examples:
     | ruby_version | rails_version |

data/features/rails_features/user_info.feature

@@ -1,7 +1,7 @@
 Feature: Capture user information
 
 Background:
-  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And I set environment variable "APP_PATH" to "/usr/src"
   And I configure the bugsnag endpoint
 
@@ -13,7 +13,7 @@ Scenario Outline: Warden user information is sent
   And I navigate to the route "/warden/<route>?email=testtest@test.test" on port "6128<rails_version>"
   Then I should receive a request
   And the request is a valid for the error reporting API
-  And the request used the Ruby notifier
+  And the request used the "Ruby Bugsnag Notifier" notifier
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And the payload field "events" is an array with 1 element
   And the event "user.email" equals "testtest@test.test"
@@ -45,7 +45,7 @@ Scenario Outline: Devise user information is sent
   And I navigate to the route "/devise/<route>" on port "6128<rails_version>"
   Then I should receive a request
   And the request is a valid for the error reporting API
-  And the request used the Ruby notifier
+  And the request used the "Ruby Bugsnag Notifier" notifier
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And the payload field "events" is an array with 1 element
   And the event "user.email" equals "test+test@test.test"
@@ -68,7 +68,7 @@ Scenario Outline: Clearance user information is sent
   And I navigate to the route "/clearance/<route>" on port "6128<rails_version>"
   Then I should receive a request
   And the request is a valid for the error reporting API
-  And the request used the Ruby notifier
+  And the request used the "Ruby Bugsnag Notifier" notifier
   And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And the payload field "events" is an array with 1 element
   And the event "user.email" equals "testtest@test.test"

data/features/sidekiq.feature

@@ -2,7 +2,6 @@ Feature: Bugsnag raises errors in Sidekiq workers
 
 Background:
   Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
   And I set environment variable "APP_PATH" to "/usr/src"
   And I configure the bugsnag endpoint
 
@@ -13,14 +12,14 @@ Scenario Outline: An unhandled RuntimeError sends a report
   And I run the command "bundle exec ruby initializers/UnhandledError.rb" on the service "sidekiq"
   And I wait for 1 seconds
   Then I should receive a request
-  And the request used the Ruby notifier
+  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 event "unhandled" is true
-  And the event "severity" is "error"
-  And the event "context" is "UnhandledError@default"
-  And the event "severityReason.type" is "unhandledExceptionMiddleware"
-  And the event "severityReason.attributes.framework" is "Sidekiq"
+  And the event "severity" equals "error"
+  And the event "context" equals "UnhandledError@default"
+  And the event "severityReason.type" equals "unhandledExceptionMiddleware"
+  And the event "severityReason.attributes.framework" equals "Sidekiq"
   And the exception "errorClass" equals "RuntimeError"
   And the "file" of stack frame 0 equals "/usr/src/app.rb"
   And the "lineNumber" of stack frame 0 equals 33
@@ -59,13 +58,13 @@ Scenario Outline: A handled RuntimeError can be notified
   And I run the command "bundle exec ruby initializers/HandledError.rb" on the service "sidekiq"
   And I wait for 1 seconds
   Then I should receive a request
-  And the request used the Ruby notifier
+  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 event "unhandled" is false
-  And the event "context" is "HandledError@default"
-  And the event "severity" is "warning"
-  And the event "severityReason.type" is "handledException"
+  And the event "context" equals "HandledError@default"
+  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.rb"
   And the "lineNumber" of stack frame 0 equals 24

data/features/steps/ruby_notifier_steps.rb

@@ -1,44 +1,25 @@
-require 'net/http'
-require 'open3'
-
-When("I configure the bugsnag endpoint") do
-  steps %Q{
-    When I set environment variable "MAZE_ENDPOINT" to "http://#{current_ip}:#{MOCK_API_PORT}"
-  }
-end
-
-When("I navigate to the route {string} on port {string}") do |route, port|
-  steps %Q{
-    When I open the URL "http://localhost:#{port}#{route}"
-    And I wait for 1 second
-  }
-end
-
 When("I set environment variable {string} to the current IP") do |env_var|
   steps %Q{
     When I set environment variable "#{env_var}" to "#{current_ip}"
   }
 end
+
 When("I set environment variable {string} to the mock API port") do |env_var|
   steps %Q{
     When I set environment variable "#{env_var}" to "#{MOCK_API_PORT}"
   }
 end
+
 When("I set environment variable {string} to the proxy settings with credentials {string}") do |env_var, credentials|
   steps %Q{
     When I set environment variable "#{env_var}" to "#{credentials}@#{current_ip}:#{MOCK_API_PORT}"
   }
 end
-Then("the request used the Ruby notifier") do
-  bugsnag_regex = /^http(s?):\/\/www.bugsnag.com/
-  steps %Q{
-    Then the payload field "notifier.name" equals "Ruby Bugsnag Notifier"
-    And the payload field "notifier.url" matches the regex "#{bugsnag_regex}"
-  }
-end
 
-Then("the event {string} is {string}") do |key, value|
+Then(/^the "(.+)" of the top non-bugsnag 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 = stacktrace.find_index { |frame| ! /.*lib\/bugsnag.*\.rb/.match(frame["file"]) }
   steps %Q{
-    Then the event "#{key}" equals "#{value}"
+    the "#{element}" of stack frame #{frame_index} equals #{value}
   }
 end

data/features/support/env.rb

@@ -1,5 +1,4 @@
-require 'open3'
-require 'os'
+require 'fileutils'
 
 Before do
   find_default_docker_compose
@@ -34,14 +33,24 @@ def install_fixture_gems
   end
 end
 
-def current_ip
-  if OS.mac?
-    'host.docker.internal'
-  else
-    ip_addr = `ifconfig | grep -Eo 'inet (addr:)?([0-9]*\\\.){3}[0-9]*' | grep -v '127.0.0.1'`
-    ip_list = /((?:[0-9]*\.){3}[0-9]*)/.match(ip_addr)
-    ip_list.captures.first
+# Added to ensure that multiple versions of Gems do not exist within the fixture folders,
+# which can be difficult to track down and clear up
+def remove_installed_gems
+  removal_targets = ['temp-bugsnag-lib', 'bugsnag-*.gem']
+  Dir.entries('features/fixtures').reject { |entry| ['.', '..'].include?(entry) }.each do |entry|
+    target_dir = "features/fixtures/#{entry}"
+    target_entries = []
+    removal_targets.each do |r_target|
+      target_entries += Dir.glob("#{target_dir}/#{r_target}")
+    end
+    target_entries.each do |d_target|
+      FileUtils.rm_rf(d_target)
+    end
   end
 end
 
+at_exit do
+  remove_installed_gems
+end
+
 install_fixture_gems

data/lib/bugsnag/configuration.rb

@@ -69,9 +69,9 @@ module Bugsnag
       self.auto_capture_sessions = false
       self.session_endpoint = DEFAULT_SESSION_ENDPOINT
 
-      # SystemExit and Interrupt are common Exception types seen with successful
-      # exits and are not automatically reported to Bugsnag
-      self.ignore_classes = Set.new([SystemExit, Interrupt])
+      # SystemExit and SignalException are common Exception types seen with
+      # successful exits and are not automatically reported to Bugsnag
+      self.ignore_classes = Set.new([SystemExit, SignalException])
 
       # Read the API key from the environment
       self.api_key = ENV["BUGSNAG_API_KEY"]

data/lib/bugsnag/integrations/mailman.rb

@@ -21,7 +21,6 @@ module Bugsnag
         Bugsnag.configuration.set_request_data :mailman_msg, mail.to_s
         yield
       rescue Exception => ex
-        raise ex if [Interrupt, SystemExit, SignalException].include? ex.class
         Bugsnag.notify(ex, true) do |report|
           report.severity = "error"
           report.severity_reason = {

data/lib/bugsnag/integrations/shoryuken.rb

@@ -27,14 +27,12 @@ module Bugsnag
 
         yield
       rescue Exception => ex
-        unless [Interrupt, SystemExit, SignalException].include?(ex.class)
-          Bugsnag.notify(ex, true) do |report|
-            report.severity = "error"
-            report.severity_reason = {
-              :type => Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
-              :attributes => Bugsnag::Shoryuken::FRAMEWORK_ATTRIBUTES
-            }
-          end
+        Bugsnag.notify(ex, true) do |report|
+          report.severity = "error"
+          report.severity_reason = {
+            :type => Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
+            :attributes => Bugsnag::Shoryuken::FRAMEWORK_ATTRIBUTES
+          }
         end
         raise
       ensure

data/lib/bugsnag/integrations/sidekiq.rb

@@ -18,20 +18,22 @@ module Bugsnag
     end
 
     def call(worker, msg, queue)
-      begin
-        # store msg/queue in thread local state to be read by Bugsnag::Middleware::Sidekiq
-        Bugsnag.configuration.set_request_data :sidekiq, { :msg => msg, :queue => queue }
-        yield
-      rescue Exception => ex
-        self.class.notify(ex) unless self.class.sidekiq_supports_error_handlers
-        raise
-      ensure
-        Bugsnag.configuration.clear_request_data
-      end
+      # store msg/queue in thread local state to be read by Bugsnag::Middleware::Sidekiq
+      Bugsnag.configuration.set_request_data(:sidekiq, { :msg => msg, :queue => queue })
+      error_raised = false
+      yield
+    rescue Exception => ex
+      error_raised = true
+      self.class.notify(ex) unless self.class.sidekiq_supports_error_handlers
+      raise
+    ensure
+      # if an error was raised and error handlers are installed, the data will be cleared after
+      # the notification is sent. Otherwise, the data must be cleared.
+      keep_data = error_raised && self.class.sidekiq_supports_error_handlers
+      Bugsnag.configuration.clear_request_data unless keep_data
     end
 
     def self.notify(exception)
-      return if [Interrupt, SystemExit, SignalException].include? exception.class
       Bugsnag.notify(exception, true) do |report|
         report.severity = "error"
         report.severity_reason = {
@@ -49,6 +51,7 @@ module Bugsnag
       if Bugsnag::Sidekiq.sidekiq_supports_error_handlers
         server.error_handlers << proc do |ex, _context|
           Bugsnag::Sidekiq.notify(ex)
+          Bugsnag.configuration.clear_request_data
         end
       end
 

data/lib/bugsnag/stacktrace.rb

@@ -26,8 +26,7 @@ module Bugsnag
 
         # 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)

data/spec/configuration_spec.rb

@@ -219,7 +219,7 @@ describe Bugsnag::Configuration do
   end
 
   it "should have exit exception classes ignored by default" do
-    expect(subject.ignore_classes).to eq(Set.new([SystemExit, Interrupt]))
+    expect(subject.ignore_classes).to eq(Set.new([SystemExit, SignalException]))
   end
 
 end

data/spec/integrations/sidekiq_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'sidekiq/testing'
 
-class FailingWorker
+class Worker
   include Sidekiq::Worker
   def perform(value)
     puts "Work: #{100/value}"
@@ -21,15 +21,11 @@ describe Bugsnag::Sidekiq do
     end
 
     it "works" do
-      begin
-        FailingWorker.perform_async(-0)
-        fail("shouldn't be here")
-      rescue
-      end
+      expect{ Worker.perform_async(-0) }.to raise_error(ZeroDivisionError)
 
       expect(Bugsnag).to have_sent_notification {|payload, headers|
         event = get_event_from_payload(payload)
-        expect(event["metaData"]["sidekiq"]["msg"]["class"]).to eq("FailingWorker")
+        expect(event["metaData"]["sidekiq"]["msg"]["class"]).to eq("Worker")
         expect(event["metaData"]["sidekiq"]["msg"]["args"]).to eq([-0])
         expect(event["metaData"]["sidekiq"]["msg"]["queue"]).to eq("default")
         expect(event["severity"]).to eq("error")
@@ -66,4 +62,74 @@ describe Bugsnag::Sidekiq do
       expect(error_handlers.size).to eq(1)
     end
   end
+
+  context "ensuring data reset" do
+    context "v2" do
+      before do
+        Sidekiq::Testing.inline!
+        stub_const('Sidekiq::VERSION', '2.0.0')
+        Sidekiq::Testing.server_middleware do |chain|
+          chain.add ::Bugsnag::Sidekiq
+        end
+      end
+
+      it "resets with an exception" do
+        expect(Bugsnag.configuration).to receive(:set_request_data).with(:sidekiq, hash_including(:queue => "default"))
+        expect(Bugsnag.configuration).to receive(:clear_request_data).at_least(:once)
+        expect{ Worker.perform_async(-0) }.to raise_error(ZeroDivisionError)
+      end
+
+      it "resets without an exception" do
+        expect(Bugsnag.configuration).to receive(:set_request_data).with(:sidekiq, hash_including(:queue => "default"))
+        expect(Bugsnag.configuration).to receive(:clear_request_data).at_least(:once)
+        expect{ Worker.perform_async(1) }.to_not raise_error
+      end
+    end
+
+    context "v3" do
+      before do
+        Sidekiq::Testing.inline!
+        stub_const('Sidekiq::VERSION', '3.0.0')
+        Sidekiq::Testing.server_middleware do |chain|
+          chain.add ::Bugsnag::Sidekiq
+        end
+      end
+
+      it "doesn't reset with an exception" do
+        # This test ensures that when an exception occurs the request data isn't immediately reset
+        expect(Bugsnag.configuration).to receive(:set_request_data).with(:sidekiq, hash_including(:queue => "default"))
+        # Always received once due to the spec_helper setup
+        expect(Bugsnag.configuration).to receive(:clear_request_data).once
+        expect{ Worker.perform_async(-0) }.to raise_error(ZeroDivisionError)
+      end
+
+      it "resets without an exception" do
+        expect(Bugsnag.configuration).to receive(:set_request_data).with(:sidekiq, hash_including(:queue => "default"))
+        expect(Bugsnag.configuration).to receive(:clear_request_data).twice
+        expect{ Worker.perform_async(1) }.to_not raise_error
+      end
+
+      it "always resets in the error handler" do
+        config = double
+        allow(::Sidekiq).to receive(:configure_server).and_yield(config)
+
+        error_handlers = []
+        allow(config).to receive(:error_handlers).and_return(error_handlers)
+
+        chain = double
+        allow(config).to receive(:server_middleware).and_yield(chain)
+        allow(chain).to receive(:add).with(::Bugsnag::Sidekiq)
+
+        Bugsnag::Sidekiq.configure_server(config)
+
+        expect(error_handlers.size).to equal(1)
+
+        ex = double
+        expect(Bugsnag::Sidekiq).to receive(:notify).with(ex)
+        expect(Bugsnag.configuration).to receive(:clear_request_data).twice
+
+        error_handlers[0].call(ex)
+      end
+    end
+  end
 end

data/spec/report_spec.rb

@@ -146,18 +146,27 @@ describe Bugsnag::Report do
   end
 
   it "sets correct severity and reason for specific error classes" do
-    Bugsnag.notify(SignalException.new("TERM"))
-    expect(Bugsnag).to have_sent_notification{ |payload, headers|
-      event = get_event_from_payload(payload)
-      expect(event["unhandled"]).to be false
-      expect(event["severity"]).to eq("info")
-      expect(event["severityReason"]).to eq({
-        "type" => "errorClass",
-        "attributes" => {
-          "errorClass" => "SignalException"
-        }
-      })
-    }
+    original_ignore_classes = Bugsnag.configuration.ignore_classes
+
+    begin
+      # The default ignore_classes includes SignalException, so we need to
+      # temporarily set it to something else.
+      Bugsnag.configuration.ignore_classes = Set[SystemExit]
+      Bugsnag.notify(SignalException.new("TERM"))
+      expect(Bugsnag).to have_sent_notification{ |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["unhandled"]).to be false
+        expect(event["severity"]).to eq("info")
+        expect(event["severityReason"]).to eq({
+          "type" => "errorClass",
+          "attributes" => {
+            "errorClass" => "SignalException"
+          }
+        })
+      }
+    ensure
+      Bugsnag.configuration.ignore_classes = original_ignore_classes
+    end
   end
 
   # TODO: nested context
@@ -503,7 +512,12 @@ describe Bugsnag::Report do
 
   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 +528,17 @@ describe Bugsnag::Report do
 
   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 +1069,35 @@ describe Bugsnag::Report do
       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
+      # 7 is used here as the called bugsnag frames for a `notify` call should be:
+      # - Bugsnag.notify
+      # - Report.new
+      # - Report.initialize
+      # - Report.generate_exceptions_list
+      # - Report.generate_exceptions_list | raw_exceptions.map
+      # - Report.generate_exceptions_list | raw_exceptions.map | block
+      # - Report.generate_exceptions_list | raw_exceptions.map | block | Stacktrace.new
+      # However, JRUBY does not include the two `new` frames, resulting in 5 bugsnag frames
+      if defined?(JRUBY_VERSION)
+        frame_count = 5
+      else
+        frame_count = 7
+      end
+      expect(bugsnag_count).to equal frame_count
     }
   end