bugsnag 6.14.0 → 6.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ddadee8c92423e803ed8d9be43b564c79110ea9ddf8dd4180a9a3b1080e575
-  data.tar.gz: 887d7017da4d23fe00515109c8c791c2e4d205e5968faaa3178d522ab5a7c51c
+  metadata.gz: 1a4f6c896c7046dba3d9db2adfa32e232232e3a7923cb9984321ee3a8b09b6e3
+  data.tar.gz: f6b27c0b50846c1a3e012bb80bccbe5ad6663257c8de4e300742e7af4b065b3f
 SHA512:
-  metadata.gz: 0a4808f2f7f73728ebab03d434f3ddccc38ceb743d986adf56225725ebdeee84c9ec63c4a2334078fbef44aa084b362468ab6cc98f2bcf8bc6ada991db44099a
-  data.tar.gz: ad4ba7af2a2aae7360cf111507dbaec30e0a6e668b606c111e231fc75683556ff14e0376673c50f45231dbcec5f59ff0649cf2e89c85e8cedf7e14b9b4fc196d
+  metadata.gz: d51d64bbf0b2cc094742a8a207702e963c33eac9e18f58f2348f3d9e6475a1bd0c43dc44baf139bb976823bfabd8b3ff5bab261ae3dababd46f083b7539602f4
+  data.tar.gz: 3621690efd266608313b000f7acff6df354380457e9b78e448290573e97dd0b17beb68afa5efff96fdcc7b21b39d2d292fddc38082eae7bece24dd1f2d457f0d

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 Changelog
 =========
 
+## 6.15.0 (27 July 2020)
+
+### Enhancements
+
+* Add `on_error` callbacks to replace `before_notify_callbacks`
+  | [#608](https://github.com/bugsnag/bugsnag-ruby/pull/608)
+
+* Improve performance when extracting code from files in stacktraces
+  | [#604](https://github.com/bugsnag/bugsnag-ruby/pull/604)
+
+* Reduce memory use when session tracking is disabled
+  | [#606](https://github.com/bugsnag/bugsnag-ruby/pull/606)
+
+### Deprecated
+
+* `before_notify_callbacks` have been deprecated in favour of `on_error` and will be removed in the next major release
+
 ## 6.14.0 (20 July 2020)
 
 ### Enhancements

data/VERSION

@@ -1 +1 @@
-6.14.0
+6.15.0

data/features/fixtures/docker-compose.yml

@@ -120,6 +120,7 @@ services:
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
+      - ADD_ON_ERROR
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     restart: "no"
 
@@ -155,6 +156,7 @@ services:
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
+      - ADD_ON_ERROR
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     restart: "no"
 
@@ -190,6 +192,7 @@ services:
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
+      - ADD_ON_ERROR
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     restart: "no"
 
@@ -225,6 +228,7 @@ services:
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
+      - ADD_ON_ERROR
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     restart: "no"
     networks:
@@ -296,4 +300,4 @@ services:
 
 networks:
   default:
-    name: ${NETWORK_NAME}
+    name: ${NETWORK_NAME}

data/features/fixtures/plain/app/report_modification/initiators/handled_on_error.rb

@@ -0,0 +1,10 @@
+require 'bugsnag'
+require './app'
+
+configure_basics
+
+def run(callback)
+  Bugsnag.add_on_error(callback)
+
+  Bugsnag.notify(RuntimeError.new("Oh no"))
+end

data/features/fixtures/plain/app/report_modification/initiators/unhandled_on_error.rb

@@ -0,0 +1,11 @@
+require 'bugsnag'
+require './app'
+
+configure_basics
+add_at_exit
+
+def run(callback)
+  Bugsnag.add_on_error(callback)
+
+  raise RuntimeError.new "Oh no"
+end

data/features/fixtures/plain/app/stack_frame_modification/initiators/handled_on_error.rb

@@ -0,0 +1,29 @@
+require 'bugsnag'
+require './app'
+
+configure_basics
+
+def run(callback)
+  Bugsnag.add_on_error(callback)
+  step_one
+end
+
+def step_one
+  step_two
+end
+
+def step_two
+  step_three
+end
+
+def step_three
+  crash
+end
+
+def crash
+  begin
+    "Test".insrt(-1, "!")
+  rescue Exception => e
+    Bugsnag.notify(e)
+  end
+end

data/features/fixtures/plain/app/stack_frame_modification/initiators/unhandled_on_error.rb

@@ -0,0 +1,26 @@
+require 'bugsnag'
+require './app'
+
+configure_basics
+add_at_exit
+
+def run(callback)
+  Bugsnag.add_on_error(callback)
+  step_one
+end
+
+def step_one
+  step_two
+end
+
+def step_two
+  step_three
+end
+
+def step_three
+  crash
+end
+
+def crash
+  raise RuntimeError.new "Oh no"
+end

data/features/fixtures/rails3/app/config/initializers/bugsnag.rb

@@ -18,4 +18,12 @@ Bugsnag.configure do |config|
       breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
     end
   end
+
+  if ENV["ADD_ON_ERROR"] == "true"
+    config.add_on_error(proc do |report|
+      report.add_tab(:on_error, {
+        source: report.unhandled ? 'on_error unhandled' : 'on_error handled'
+      })
+    end)
+  end
 end

data/features/fixtures/rails4/app/config/initializers/bugsnag.rb

@@ -18,4 +18,12 @@ Bugsnag.configure do |config|
       breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
     end
   end
+
+  if ENV["ADD_ON_ERROR"] == "true"
+    config.add_on_error(proc do |report|
+      report.add_tab(:on_error, {
+        source: report.unhandled ? 'on_error unhandled' : 'on_error handled'
+      })
+    end)
+  end
 end

data/features/fixtures/rails5/app/config/initializers/bugsnag.rb

@@ -18,4 +18,12 @@ Bugsnag.configure do |config|
       breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
     end
   end
+
+  if ENV["ADD_ON_ERROR"] == "true"
+    config.add_on_error(proc do |report|
+      report.add_tab(:on_error, {
+        source: report.unhandled ? 'on_error unhandled' : 'on_error handled'
+      })
+    end)
+  end
 end

data/features/fixtures/rails6/app/config/initializers/bugsnag.rb

@@ -18,4 +18,12 @@ Bugsnag.configure do |config|
       breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
     end
   end
+
+  if ENV["ADD_ON_ERROR"] == "true"
+    config.add_on_error(proc do |report|
+      report.add_tab(:on_error, {
+        source: report.unhandled ? 'on_error unhandled' : 'on_error handled'
+      })
+    end)
+  end
 end

data/features/plain_features/add_tab.feature

@@ -15,6 +15,8 @@ Scenario Outline: Metadata can be added to a report using add_tab
   | handled_before_notify   |
   | handled_block           |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |
 
 Scenario Outline: Metadata can be added to an existing tab using add_tab
   Given I set environment variable "CALLBACK_INITIATOR" to "<initiator>"
@@ -33,6 +35,8 @@ Scenario Outline: Metadata can be added to an existing tab using add_tab
   | handled_before_notify   |
   | handled_block           |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |
 
 Scenario Outline: Metadata can be overwritten using add_tab
   Given I set environment variable "CALLBACK_INITIATOR" to "<initiator>"
@@ -46,4 +50,6 @@ Scenario Outline: Metadata can be overwritten using add_tab
   | initiator               |
   | handled_before_notify   |
   | handled_block           |
-  | unhandled_before_notify |
+  | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |

data/features/plain_features/ignore_report.feature

@@ -10,3 +10,5 @@ Scenario Outline: A reports severity can be modified
   | initiator               |
   | handled_before_notify   |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |

data/features/plain_features/report_api_key.feature

@@ -11,4 +11,6 @@ Scenario Outline: A report can have its api_key modified
   | initiator               |
   | handled_before_notify   |
   | handled_block           |
-  | unhandled_before_notify |
+  | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |

data/features/plain_features/report_severity.feature

@@ -13,3 +13,5 @@ Scenario Outline: A reports severity can be modified
   | handled_before_notify   |
   | handled_block           |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |

data/features/plain_features/report_stack_frames.feature

@@ -12,6 +12,8 @@ Scenario Outline: Stack frames can be removed
   | initiator               | lineNumber |
   | handled_before_notify   | 20         |
   | unhandled_before_notify | 21         |
+  | handled_on_error        | 20         |
+  | unhandled_on_error      | 21         |
 
 Scenario: Stack frames can be removed from a notified string
   Given I set environment variable "CALLBACK_INITIATOR" to "handled_block"
@@ -36,6 +38,8 @@ Scenario Outline: Stack frames can be marked as in project
   | initiator               |
   | handled_before_notify   |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |
 
 Scenario: Stack frames can be marked as in project with a handled string
   Given I set environment variable "CALLBACK_INITIATOR" to "handled_block"

data/features/plain_features/report_user.feature

@@ -14,6 +14,8 @@ Scenario Outline: A report can have a user name, email, and id set
   | handled_before_notify   |
   | handled_block           |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |
 
 Scenario Outline: A report can have custom info set
   Given I set environment variable "CALLBACK_INITIATOR" to "<initiator>"
@@ -30,6 +32,8 @@ Scenario Outline: A report can have custom info set
   | handled_before_notify   |
   | handled_block           |
   | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |
 
 Scenario Outline: A report can have its user info removed
   Given I set environment variable "CALLBACK_INITIATOR" to "<initiator>"
@@ -42,4 +46,6 @@ Scenario Outline: A report can have its user info removed
   | initiator               |
   | handled_before_notify   |
   | handled_block           |
-  | unhandled_before_notify |
+  | unhandled_before_notify |
+  | handled_on_error        |
+  | unhandled_on_error      |

data/features/rails_features/on_error.feature

@@ -0,0 +1,29 @@
+Feature: On error callbacks
+
+@rails3 @rails4 @rails5 @rails6
+Scenario: Rails on_error works on handled errors
+  Given I set environment variable "ADD_ON_ERROR" to "true"
+  And I start the rails service
+  When I navigate to the route "/handled/unthrown" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
+  And the exception "errorClass" equals "RuntimeError"
+  And the exception "message" starts with "handled unthrown error"
+  And the event "unhandled" is false
+  And the event "app.type" equals "rails"
+  And the event "metaData.request.url" ends with "/handled/unthrown"
+  And the event "metaData.on_error.source" equals "on_error handled"
+
+@rails3 @rails4 @rails5 @rails6
+Scenario: Rails on_error works on unhandled errors
+  Given I set environment variable "ADD_ON_ERROR" to "true"
+  And I start the rails service
+  When I navigate to the route "/unhandled/error" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
+  And the exception "errorClass" equals "NameError"
+  And the exception "message" starts with "undefined local variable or method `generate_unhandled_error' for #<UnhandledController"
+  And the event "unhandled" is true
+  And the event "app.type" equals "rails"
+  And the event "metaData.request.url" ends with "/unhandled/error"
+  And the event "metaData.on_error.source" equals "on_error unhandled"

data/lib/bugsnag.rb

@@ -48,6 +48,12 @@ module Bugsnag
     def configure(validate_api_key=true)
       yield(configuration) if block_given?
 
+      # Create the session tracker if sessions are enabled to avoid the overhead
+      # of creating it on the first request. We skip this if we're not validating
+      # the API key as we use this internally before the user's configure block
+      # has run, so we don't know if sessions are enabled yet.
+      session_tracker if validate_api_key && configuration.auto_capture_sessions
+
       check_key_valid if validate_api_key
       check_endpoint_setup
 
@@ -169,6 +175,8 @@ module Bugsnag
     # Allow access to "before notify" callbacks as an array.
     #
     # These callbacks will be called whenever an error notification is being made.
+    #
+    # @deprecated Use {Bugsnag#add_on_error} instead
     def before_notify_callbacks
       Bugsnag.configuration.request_data[:before_callbacks] ||= []
     end
@@ -227,6 +235,33 @@ module Bugsnag
       configuration.breadcrumbs << breadcrumb unless breadcrumb.ignore?
     end
 
+    ##
+    # Add the given callback to the list of on_error callbacks
+    #
+    # The on_error callbacks will be called when an error is captured or reported
+    # and are passed a {Bugsnag::Report} object
+    #
+    # Returning false from an on_error callback will cause the error to be ignored
+    # and will prevent any remaining callbacks from being called
+    #
+    # @param callback [Proc]
+    # @return [void]
+    def add_on_error(callback)
+      configuration.add_on_error(callback)
+    end
+
+    ##
+    # Remove the given callback from the list of on_error callbacks
+    #
+    # Note that this must be the same Proc instance that was passed to
+    # {Bugsnag#add_on_error}, otherwise it will not be removed
+    #
+    # @param callback [Proc]
+    # @return [void]
+    def remove_on_error(callback)
+      configuration.remove_on_error(callback)
+    end
+
     ##
     # Returns the client's Cleaner object, or creates one if not yet created.
     #

data/lib/bugsnag/code_extractor.rb

@@ -0,0 +1,137 @@
+module Bugsnag
+  # @api private
+  class CodeExtractor
+    MAXIMUM_LINES_TO_KEEP = 7
+
+    ##
+    # @param configuration [Configuration]
+    def initialize(configuration)
+      @files = {}
+      @configuration = configuration
+    end
+
+    ##
+    # Add a file and its corresponding trace hash to be processed.
+    #
+    # @param path [String] The full path to the file
+    # @param trace [Hash]
+    # @return [void]
+    def add_file(path, trace)
+      # If the file doesn't exist we can't extract code from it, so we can skip
+      # this file entirely
+      unless File.exist?(path)
+        trace[:code] = nil
+
+        return
+      end
+
+      @files[path] ||= []
+      @files[path].push(trace)
+
+      # Record the line numbers we want to fetch for this trace
+      # We grab extra lines so that we can compensate if the error is on the
+      # first or last line of a file
+      first_line_number = trace[:lineNumber] - MAXIMUM_LINES_TO_KEEP
+
+      trace[:first_line_number] = first_line_number < 1 ? 1 : first_line_number
+      trace[:last_line_number] = trace[:lineNumber] + MAXIMUM_LINES_TO_KEEP
+    end
+
+    ##
+    # Add the code to the hashes that were given in {#add_file} by modifying
+    # them in-place. They will have a new ':code' key containing a hash of line
+    # number => string of code for that line
+    #
+    # @return [void]
+    def extract!
+      @files.each do |path, traces|
+        begin
+          line_numbers = Set.new
+
+          traces.each do |trace|
+            trace[:first_line_number].upto(trace[:last_line_number]) do |line_number|
+              line_numbers << line_number
+            end
+          end
+
+          extract_from(path, traces, line_numbers)
+        rescue StandardError => e
+          # Clean up after ourselves
+          traces.each do |trace|
+            trace[:code] ||= nil
+            trace.delete(:first_line_number)
+            trace.delete(:last_line_number)
+          end
+
+          @configuration.warn("Error extracting code: #{e.inspect}")
+        end
+      end
+    end
+
+    private
+
+    ##
+    # @param path [String]
+    # @param traces [Array<Hash>]
+    # @param line_numbers [Set<Integer>]
+    # @return [void]
+    def extract_from(path, traces, line_numbers)
+      code = {}
+
+      File.open(path) do |file|
+        current_line_number = 0
+
+        file.each_line do |line|
+          current_line_number += 1
+
+          next unless line_numbers.include?(current_line_number)
+
+          code[current_line_number] = line[0...200].rstrip
+        end
+      end
+
+      associate_code_with_trace(code, traces)
+    end
+
+    ##
+    # @param code [Hash{Integer => String}]
+    # @param traces [Array<Hash>]
+    # @return [void]
+    def associate_code_with_trace(code, traces)
+      traces.each do |trace|
+        trace[:code] = {}
+
+        code.each do |line_number, line|
+          # If we've gone past the last line we care about, we can stop iterating
+          break if line_number > trace[:last_line_number]
+
+          # Skip lines that aren't in the range we want
+          next unless line_number >= trace[:first_line_number]
+
+          trace[:code][line_number] = line
+        end
+
+        trim_excess_lines(trace[:code], trace[:lineNumber])
+        trace.delete(:first_line_number)
+        trace.delete(:last_line_number)
+      end
+    end
+
+    ##
+    # @param code [Hash{Integer => String}]
+    # @param line_number [Integer]
+    # @return [void]
+    def trim_excess_lines(code, line_number)
+      while code.length > MAXIMUM_LINES_TO_KEEP
+        last_line = code.keys.max
+        first_line = code.keys.min
+
+        if (last_line - line_number) > (line_number - first_line)
+          code.delete(last_line)
+        else
+          code.delete(first_line)
+        end
+      end
+    end
+  end
+end