bugsnag 6.10.0 → 6.11.0

data/lib/bugsnag/integrations/railtie.rb

@@ -1,12 +1,14 @@
 # Rails 3.x hooks
 
+require "json"
 require "rails"
 require "bugsnag"
 require "bugsnag/middleware/rails3_request"
 require "bugsnag/middleware/rack_request"
+require "bugsnag/integrations/rails/rails_breadcrumbs"
 
 module Bugsnag
-  class Railtie < Rails::Railtie
+  class Railtie < ::Rails::Railtie
 
     FRAMEWORK_ATTRIBUTES = {
       :framework => "Rails"
@@ -38,6 +40,8 @@ module Bugsnag
         include Bugsnag::Rails::ActiveRecordRescue
       end
 
+      Bugsnag::Rails::DEFAULT_RAILS_BREADCRUMBS.each { |event| event_subscription(event) }
+
       Bugsnag.configuration.app_type = "rails"
     end
 
@@ -63,5 +67,28 @@ module Bugsnag
         app.config.middleware.use Bugsnag::Rack
       end
     end
+
+    ##
+    # Subscribes to an ActiveSupport event, leaving a breadcrumb when it triggers
+    #
+    # @api private
+    # @param event [Hash] details of the event to subscribe to
+    def event_subscription(event)
+      ActiveSupport::Notifications.subscribe(event[:id]) do |*, event_id, data|
+        filtered_data = data.slice(*event[:allowed_data])
+        filtered_data[:event_name] = event[:id]
+        filtered_data[:event_id] = event_id
+        if event[:id] == "sql.active_record"
+          binds = data[:binds].each_with_object({}) { |bind, output| output[bind.name] = '?' if defined?(bind.name) }
+          filtered_data[:binds] = JSON.dump(binds) unless binds.empty?
+        end
+        Bugsnag.leave_breadcrumb(
+          event[:message],
+          filtered_data,
+          event[:type],
+          :auto
+        )
+      end
+    end
   end
 end

data/lib/bugsnag/middleware/breadcrumbs.rb

@@ -0,0 +1,21 @@
+module Bugsnag::Middleware
+  ##
+  # Adds breadcrumbs to the report
+  class Breadcrumbs
+    ##
+    # @param next_callable [#call] the next callable middleware
+    def initialize(next_callable)
+      @next = next_callable
+    end
+
+    ##
+    # Execute this middleware
+    #
+    # @param report [Bugsnag::Report] the report being iterated over
+    def call(report)
+      breadcrumbs = report.configuration.breadcrumbs.to_a
+      report.breadcrumbs = breadcrumbs unless breadcrumbs.empty?
+      @next.call(report)
+    end
+  end
+end

data/lib/bugsnag/report.rb

@@ -23,6 +23,7 @@ module Bugsnag
     attr_accessor :api_key
     attr_accessor :app_type
     attr_accessor :app_version
+    attr_accessor :breadcrumbs
     attr_accessor :configuration
     attr_accessor :context
     attr_accessor :delivery_method
@@ -51,6 +52,7 @@ module Bugsnag
       self.api_key = configuration.api_key
       self.app_type = configuration.app_type
       self.app_version = configuration.app_version
+      self.breadcrumbs = []
       self.delivery_method = configuration.delivery_method
       self.hostname = configuration.hostname
       self.meta_data = {}
@@ -110,7 +112,14 @@ module Bugsnag
       payload_event = Bugsnag::Cleaner.clean_object_encoding(payload_event)
 
       # filter out sensitive values in (and cleanup encodings) metaData
-      payload_event[:metaData] = Bugsnag::Cleaner.new(configuration.meta_data_filters).clean_object(meta_data)
+      filter_cleaner = Bugsnag::Cleaner.new(configuration.meta_data_filters)
+      payload_event[:metaData] = filter_cleaner.clean_object(meta_data)
+      payload_event[:breadcrumbs] = breadcrumbs.map do |breadcrumb|
+        breadcrumb_hash = breadcrumb.to_h
+        breadcrumb_hash[:metaData] = filter_cleaner.clean_object(breadcrumb_hash[:metaData])
+        breadcrumb_hash
+      end
+
       payload_event.reject! {|k,v| v.nil? }
 
       # return the payload hash
@@ -153,6 +162,26 @@ module Bugsnag
       @should_ignore = true
     end
 
+    ##
+    # Generates a summary to be attached as a breadcrumb
+    #
+    # @return [Hash] a Hash containing the report's error class, error message, and severity
+    def summary
+      # Guard against the exceptions array being removed/changed or emptied here
+      if exceptions.respond_to?(:first) && exceptions.first
+        {
+          :error_class => exceptions.first[:errorClass],
+          :message => exceptions.first[:message],
+          :severity => severity
+        }
+      else
+        {
+          :error_class => "Unknown",
+          :severity => severity
+        }
+      end
+    end
+
     private
 
     def generate_exception_list

data/lib/bugsnag/session_tracker.rb

@@ -35,6 +35,7 @@ module Bugsnag
     #
     # This allows Bugsnag to track error rates for a release.
     def start_session
+      return unless Bugsnag.configuration.enable_sessions
       start_delivery_thread
       start_time = Time.now().utc().strftime('%Y-%m-%dT%H:%M:00')
       new_session = {

data/lib/bugsnag/utility/circular_buffer.rb

@@ -0,0 +1,62 @@
+module Bugsnag::Utility
+  ##
+  # A container class with a maximum size, that removes oldest items as required.
+  #
+  # @api private
+  class CircularBuffer
+    include Enumerable
+
+    # @return [Integer] the current maximum allowable number of items
+    attr_reader :max_items
+
+    ##
+    # @param max_items [Integer] the initial maximum number of items
+    def initialize(max_items = 25)
+      @max_items = max_items
+      @buffer = []
+    end
+
+    ##
+    # Adds an item to the circular buffer
+    #
+    # If this causes the buffer to exceed its maximum items, the oldest item will be removed
+    #
+    # @param item [Object] the item to add to the buffer
+    # @return [self] returns itself to allow method chaining
+    def <<(item)
+      @buffer << item
+      trim_buffer
+      self
+    end
+
+    ##
+    # Iterates over the buffer
+    #
+    # @yield [Object] sequentially gives stored items to the block
+    def each(&block)
+      @buffer.each(&block)
+    end
+
+    ##
+    # Sets the maximum allowable number of items
+    #
+    # If the current number of items exceeds the new maximum, oldest items will be removed
+    # until this is no longer the case
+    #
+    # @param new_max_items [Integer] the new allowed item maximum
+    def max_items=(new_max_items)
+      @max_items = new_max_items
+      trim_buffer
+    end
+
+    private
+
+    ##
+    # Trims the buffer down to the current maximum allowable item number
+    def trim_buffer
+      trim_size = @buffer.size - @max_items
+      trim_size = 0 if trim_size < 0
+      @buffer.shift(trim_size)
+    end
+  end
+end

data/spec/breadcrumbs/breadcrumb_spec.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'bugsnag/breadcrumbs/breadcrumb'
+
+RSpec.describe Bugsnag::Breadcrumbs::Breadcrumb do
+  describe "#name" do
+    it "is assigned in #initialize" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", nil, nil, nil)
+
+      expect(breadcrumb.name).to eq("my message")
+    end
+  end
+
+  describe "#type" do
+    it "is assigned in #initialize" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, "test type", nil, nil)
+
+      expect(breadcrumb.type).to eq("test type")
+    end
+  end
+
+  describe "#meta_data" do
+    it "is assigned in #initialize" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, {:a => 1, :b => 2}, nil)
+
+      expect(breadcrumb.meta_data).to eq({:a => 1, :b => 2})
+    end
+  end
+
+  describe "#auto" do
+    it "defaults to false" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, nil)
+
+      expect(breadcrumb.auto).to eq(false)
+    end
+
+    it "is true if auto argument == :auto" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, :auto)
+
+      expect(breadcrumb.auto).to eq(true)
+    end
+
+    it "is false if auto argument is anything else" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, :manual)
+
+      expect(breadcrumb.auto).to eq(false)
+    end
+  end
+
+  describe "#timestamp" do
+    it "is stored as a timestamp" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, nil)
+
+      expect(breadcrumb.timestamp).to be_within(0.5).of Time.now.utc
+    end
+  end
+
+  describe "#ignore?" do
+    it "is not true by default" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", "test type", {:a => 1, :b => 2}, :manual)
+
+      expect(breadcrumb.ignore?).to eq(false)
+    end
+
+    it "is able to be set" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", "test type", {:a => 1, :b => 2}, :manual)
+      breadcrumb.ignore!
+
+      expect(breadcrumb.ignore?).to eq(true)
+    end
+  end
+
+  describe "#to_h" do
+    it "outputs as a hash" do
+      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", "test type", {:a => 1, :b => 2}, :manual)
+      output = breadcrumb.to_h
+
+      timestamp_regex = /^\d{4}\-\d{2}\-\d{2}T\d{2}:\d{2}:[\d\.]+Z$/
+
+      expect(output).to match(
+        :name => "my message",
+        :type => "test type",
+        :metaData => {
+          :a => 1,
+          :b => 2
+        },
+        :timestamp => eq(breadcrumb.timestamp.iso8601)
+      )
+    end
+  end
+end

data/spec/breadcrumbs/validator_spec.rb

@@ -0,0 +1,200 @@
+# encoding: utf-8
+require 'spec_helper'
+
+require 'bugsnag/breadcrumbs/breadcrumb'
+require 'bugsnag/breadcrumbs/validator'
+
+RSpec.describe Bugsnag::Breadcrumbs::Validator do
+  let(:enabled_automatic_breadcrumb_types) { Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES }
+  let(:auto) { false }
+  let(:name) { "Valid message" }
+  let(:type) { Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE }
+  let(:meta_data) { {} }
+
+  describe "#validate" do
+    it "does not 'ignore!' a valid breadcrumb" do
+      config = instance_double(Bugsnag::Configuration)
+      allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(enabled_automatic_breadcrumb_types)
+      validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+      breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+        :auto => auto,
+        :name => name,
+        :type => type,
+        :meta_data => meta_data,
+        :meta_data= => nil
+      })
+
+      expect(breadcrumb).to_not receive(:ignore!)
+      expect(config).to_not receive(:warn)
+
+      validator.validate(breadcrumb)
+    end
+
+    it "trims long messages to length and warns" do
+      config = instance_double(Bugsnag::Configuration)
+      allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(enabled_automatic_breadcrumb_types)
+      validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+      name = "1234567890123456789012345678901234567890"
+
+      breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+        :auto => auto,
+        :name => name,
+        :type => type,
+        :meta_data => meta_data,
+        :meta_data= => nil
+      })
+
+      expect(breadcrumb).to_not receive(:ignore!)
+      expect(breadcrumb).to receive(:name=).with("123456789012345678901234567890")
+      expected_string = "Breadcrumb name trimmed to length 30.  Original name: #{name}"
+      expect(config).to receive(:warn).with(expected_string)
+
+      validator.validate(breadcrumb)
+      # Check the original message has not been modified
+      expect(name).to eq("1234567890123456789012345678901234567890")
+    end
+
+    describe "tests meta_data types" do
+      it "accepts Strings, Numerics, Booleans, & nil" do
+        config = instance_double(Bugsnag::Configuration)
+        allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(enabled_automatic_breadcrumb_types)
+        validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+        meta_data = {
+          :string => "This is a string",
+          :integer => 12345,
+          :float => 12345.6789,
+          :false => false,
+          :true => true,
+          :nil => nil
+        }
+
+        breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+          :auto => auto,
+          :name => name,
+          :type => type,
+          :meta_data => meta_data,
+          :meta_data= => nil
+        })
+
+        expect(breadcrumb).to_not receive(:ignore!)
+        expect(config).to_not receive(:warn)
+
+        validator.validate(breadcrumb)
+      end
+
+      it "rejects Arrays, Hashes, and non-primitive objects" do
+        config = instance_double(Bugsnag::Configuration)
+        allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(enabled_automatic_breadcrumb_types)
+        validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+        class TestClass
+        end
+
+        meta_data = {
+          :fine => 1,
+          :array => [1, 2, 3],
+          :hash => {
+            :a => 1
+          },
+          :object => TestClass.new
+        }
+
+        breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+          :auto => auto,
+          :name => name,
+          :type => type,
+          :meta_data => meta_data
+        })
+
+        expect(breadcrumb).to_not receive(:ignore!)
+        expected_string_1 = "Breadcrumb #{breadcrumb.name} meta_data array:#{meta_data[:array]} has been dropped for having an invalid data type"
+        expected_string_2 = "Breadcrumb #{breadcrumb.name} meta_data hash:#{meta_data[:hash]} has been dropped for having an invalid data type"
+        expected_string_3 = "Breadcrumb #{breadcrumb.name} meta_data object:#{ meta_data[:object]} has been dropped for having an invalid data type"
+        expect(config).to receive(:warn).with(expected_string_1)
+        expect(config).to receive(:warn).with(expected_string_2)
+        expect(config).to receive(:warn).with(expected_string_3)
+
+        # Confirms that the meta_data is being filtered
+        expect(breadcrumb).to receive(:meta_data=).with({
+          :fine => 1
+        })
+
+        validator.validate(breadcrumb)
+      end
+    end
+
+    it "tests type, defaulting to 'manual' if invalid" do
+      config = instance_double(Bugsnag::Configuration)
+      allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(enabled_automatic_breadcrumb_types)
+      validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+      type = "Not a valid type"
+
+      breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+        :auto => auto,
+        :name => name,
+        :type => type,
+        :meta_data => meta_data,
+        :meta_data= => nil
+      })
+
+      expect(breadcrumb).to receive(:type=).with(Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE)
+      expect(breadcrumb).to_not receive(:ignore!)
+      expected_string = "Invalid type: #{type} for breadcrumb: #{breadcrumb.name}, defaulting to #{Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE}"
+      expect(config).to receive(:warn).with(expected_string)
+
+      validator.validate(breadcrumb)
+    end
+
+    describe "with enabled_automatic_breadcrumb_types set" do
+      it "rejects automatic breadcrumbs with rejected types" do
+        config = instance_double(Bugsnag::Configuration)
+        allowed_breadcrumb_types = []
+        allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(allowed_breadcrumb_types)
+        validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+        auto = true
+        type = Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
+
+        breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+          :auto => auto,
+          :name => name,
+          :type => type,
+          :meta_data => meta_data,
+          :meta_data= => nil
+        })
+
+        expect(breadcrumb).to receive(:ignore!)
+        expected_string = "Automatic breadcrumb of type #{Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE} ignored: #{breadcrumb.name}"
+        expect(config).to receive(:warn).with(expected_string)
+
+        validator.validate(breadcrumb)
+      end
+
+      it "does not reject manual breadcrumbs with rejected types" do
+        config = instance_double(Bugsnag::Configuration)
+        allowed_breadcrumb_types = []
+        allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(allowed_breadcrumb_types)
+        validator = Bugsnag::Breadcrumbs::Validator.new(config)
+
+        type = Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
+
+        breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
+          :auto => auto,
+          :name => name,
+          :type => type,
+          :meta_data => meta_data,
+          :meta_data= => nil
+        })
+
+        expect(breadcrumb).to_not receive(:ignore!)
+        expect(config).to_not receive(:warn)
+
+        validator.validate(breadcrumb)
+      end
+    end
+  end
+end