bugsnag 6.10.0 → 6.11.0

data/lib/bugsnag/breadcrumbs/breadcrumb.rb

@@ -0,0 +1,76 @@
+module Bugsnag::Breadcrumbs
+  class Breadcrumb
+    # @return [String] the breadcrumb name
+    attr_accessor :name
+
+    # @return [String] the breadcrumb type
+    attr_accessor :type
+
+    # @return [Hash, nil] metadata hash containing strings, numbers, or booleans, or nil
+    attr_accessor :meta_data
+
+    # @return [Boolean] set to `true` if the breadcrumb was automatically generated
+    attr_reader :auto
+
+    # @return [Time] a Time object referring to breadcrumb creation time
+    attr_reader :timestamp
+
+    ##
+    # Creates a breadcrumb
+    #
+    # This will not have been validated, which must occur before this is attached to a report
+    #
+    # @api private
+    #
+    # @param name [String] the breadcrumb name
+    # @param type [String] the breadcrumb type from Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES
+    # @param meta_data [Hash, nil] a hash containing strings, numbers, or booleans, or nil
+    # @param auto [Symbol] set to `:auto` if the breadcrumb is automatically generated
+    def initialize(name, type, meta_data, auto)
+      @should_ignore = false
+      self.name = name
+      self.type = type
+      self.meta_data = meta_data
+
+      # Use the symbol comparison to improve readability of breadcrumb creation
+      @auto = auto == :auto
+
+      # Store it as a timestamp for now
+      @timestamp = Time.now.utc
+    end
+
+    ##
+    # Flags the breadcrumb to be ignored
+    #
+    # Ignored breadcrumbs will not be attached to a report
+    def ignore!
+      @should_ignore = true
+    end
+
+    ##
+    # Checks if the `ignore!` method has been called
+    #
+    # Ignored breadcrumbs will not be attached to a report
+    #
+    # @return [True] if `ignore!` has been called
+    # @return [nil] if `ignore` has not been called
+    def ignore?
+      @should_ignore
+    end
+
+    ##
+    # Outputs the breadcrumb data in a formatted hash
+    #
+    # These adhere to the breadcrumb format as defined in the Bugsnag error reporting API
+    #
+    # @return [Hash] Hash representation of the breadcrumb
+    def to_h
+      {
+        :name => @name,
+        :type => @type,
+        :metaData => @meta_data,
+        :timestamp => @timestamp.iso8601
+      }
+    end
+  end
+end

data/lib/bugsnag/breadcrumbs/breadcrumbs.rb

@@ -0,0 +1,14 @@
+module Bugsnag::Breadcrumbs
+  MAX_NAME_LENGTH = 30
+
+  VALID_BREADCRUMB_TYPES = [
+    ERROR_BREADCRUMB_TYPE = "error",
+    MANUAL_BREADCRUMB_TYPE = "manual",
+    NAVIGATION_BREADCRUMB_TYPE = "navigation",
+    REQUEST_BREADCRUMB_TYPE = "request",
+    PROCESS_BREADCRUMB_TYPE = "process",
+    LOG_BREADCRUMB_TYPE = "log",
+    USER_BREADCRUMB_TYPE = "user",
+    STATE_BREADCRUMB_TYPE = "state"
+  ].freeze
+end

data/lib/bugsnag/breadcrumbs/validator.rb

@@ -0,0 +1,59 @@
+require 'bugsnag/breadcrumbs/breadcrumbs'
+
+module Bugsnag::Breadcrumbs
+  ##
+  # Validates a given breadcrumb before it is stored
+  class Validator
+    ##
+    # @param configuration [Bugsnag::Configuration] The current configuration
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    ##
+    # Validates a given breadcrumb.
+    #
+    # @param breadcrumb [Bugsnag::Breadcrumbs::Breadcrumb] the breadcrumb to be validated
+    def validate(breadcrumb)
+      # Check name length
+      if breadcrumb.name.size > Bugsnag::Breadcrumbs::MAX_NAME_LENGTH
+        @configuration.warn("Breadcrumb name trimmed to length #{Bugsnag::Breadcrumbs::MAX_NAME_LENGTH}.  Original name: #{breadcrumb.name}")
+        breadcrumb.name = breadcrumb.name.slice(0...Bugsnag::Breadcrumbs::MAX_NAME_LENGTH)
+      end
+
+      # Check meta_data hash doesn't contain complex values
+      breadcrumb.meta_data = breadcrumb.meta_data.select do |k, v|
+        if valid_meta_data_type?(v)
+          true
+        else
+          @configuration.warn("Breadcrumb #{breadcrumb.name} meta_data #{k}:#{v} has been dropped for having an invalid data type")
+          false
+        end
+      end
+
+      # Check type is valid, set to manual otherwise
+      unless Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES.include?(breadcrumb.type)
+        @configuration.warn("Invalid type: #{breadcrumb.type} for breadcrumb: #{breadcrumb.name}, defaulting to #{Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE}")
+        breadcrumb.type = Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE
+      end
+
+      # If auto is true, check type is in enabled_automatic_breadcrumb_types
+      return unless breadcrumb.auto && !@configuration.enabled_automatic_breadcrumb_types.include?(breadcrumb.type)
+
+      @configuration.warn("Automatic breadcrumb of type #{breadcrumb.type} ignored: #{breadcrumb.name}")
+      breadcrumb.ignore!
+    end
+
+    private
+
+    ##
+    # Tests whether the meta_data types are non-complex objects.
+    #
+    # Acceptable types are String, Numeric, TrueClass, FalseClass, and nil.
+    #
+    # @param value [Object] the object to be type checked
+    def valid_meta_data_type?(value)
+      value.nil? || value.is_a?(String) || value.is_a?(Numeric) || value.is_a?(FalseClass) || value.is_a?(TrueClass)
+    end
+  end
+end

data/lib/bugsnag/configuration.rb

@@ -8,6 +8,9 @@ require "bugsnag/middleware/ignore_error_class"
 require "bugsnag/middleware/suggestion_data"
 require "bugsnag/middleware/classify_error"
 require "bugsnag/middleware/session_data"
+require "bugsnag/middleware/breadcrumbs"
+require "bugsnag/utility/circular_buffer"
+require "bugsnag/breadcrumbs/breadcrumbs"
 
 module Bugsnag
   class Configuration
@@ -22,7 +25,6 @@ module Bugsnag
     attr_accessor :app_version
     attr_accessor :app_type
     attr_accessor :meta_data_filters
-    attr_accessor :endpoint
     attr_accessor :logger
     attr_accessor :middleware
     attr_accessor :internal_middleware
@@ -35,12 +37,38 @@ module Bugsnag
     attr_accessor :ignore_classes
     attr_accessor :auto_capture_sessions
     attr_accessor :track_sessions
-    attr_accessor :session_endpoint
+
+    ##
+    # @return [String] URL error notifications will be delivered to
+    attr_reader :notify_endpoint
+    alias :endpoint :notify_endpoint
+
+    ##
+    # @return [String] URL session notifications will be delivered to
+    attr_reader :session_endpoint
+
+    ##
+    # @return [Boolean] whether any sessions types will be delivered
+    attr_reader :enable_sessions
+
+    ##
+    # @return [Array<String>] strings indicating allowable automatic breadcrumb types
+    attr_accessor :enabled_automatic_breadcrumb_types
+
+    ##
+    # @return [Array<#call>] callables to be run before a breadcrumb is logged
+    attr_accessor :before_breadcrumb_callbacks
+
+    ##
+    # @return [Integer] the maximum allowable amount of breadcrumbs per thread
+    attr_reader :max_breadcrumbs
 
     API_KEY_REGEX = /[0-9a-f]{32}/i
     THREAD_LOCAL_NAME = "bugsnag_req_data"
-    DEFAULT_ENDPOINT = "https://notify.bugsnag.com"
+
+    DEFAULT_NOTIFY_ENDPOINT = "https://notify.bugsnag.com"
     DEFAULT_SESSION_ENDPOINT = "https://sessions.bugsnag.com"
+    DEFAULT_ENDPOINT = DEFAULT_NOTIFY_ENDPOINT
 
     DEFAULT_META_DATA_FILTERS = [
       /authorization/i,
@@ -51,6 +79,8 @@ module Bugsnag
       "rack.request.form_vars"
     ].freeze
 
+    DEFAULT_MAX_BREADCRUMBS = 25
+
     alias :track_sessions :auto_capture_sessions
     alias :track_sessions= :auto_capture_sessions=
 
@@ -62,12 +92,23 @@ module Bugsnag
       self.send_environment = false
       self.send_code = true
       self.meta_data_filters = Set.new(DEFAULT_META_DATA_FILTERS)
-      self.endpoint = DEFAULT_ENDPOINT
       self.hostname = default_hostname
       self.timeout = 15
       self.notify_release_stages = nil
-      self.auto_capture_sessions = false
-      self.session_endpoint = DEFAULT_SESSION_ENDPOINT
+      self.auto_capture_sessions = true
+
+      # All valid breadcrumb types should be allowable initially
+      self.enabled_automatic_breadcrumb_types = Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES.dup
+      self.before_breadcrumb_callbacks = []
+
+      # Store max_breadcrumbs here instead of outputting breadcrumbs.max_items
+      # to avoid infinite recursion when creating breadcrumb buffer
+      @max_breadcrumbs = DEFAULT_MAX_BREADCRUMBS
+
+      # These are set exclusively using the "set_endpoints" method
+      @notify_endpoint = DEFAULT_NOTIFY_ENDPOINT
+      @session_endpoint = DEFAULT_SESSION_ENDPOINT
+      @enable_sessions = true
 
       # SystemExit and SignalException are common Exception types seen with
       # successful exits and are not automatically reported to Bugsnag
@@ -95,6 +136,7 @@ module Bugsnag
       self.internal_middleware.use Bugsnag::Middleware::SuggestionData
       self.internal_middleware.use Bugsnag::Middleware::ClassifyError
       self.internal_middleware.use Bugsnag::Middleware::SessionData
+      self.internal_middleware.use Bugsnag::Middleware::Breadcrumbs
 
       self.middleware = Bugsnag::MiddlewareStack.new
       self.middleware.use Bugsnag::Middleware::Callbacks
@@ -190,6 +232,61 @@ module Bugsnag
       self.proxy_password = proxy.password
     end
 
+    ##
+    # Sets the maximum allowable amount of breadcrumbs
+    #
+    # @param [Integer] the new maximum breadcrumb limit
+    def max_breadcrumbs=(new_max_breadcrumbs)
+      @max_breadcrumbs = new_max_breadcrumbs
+      breadcrumbs.max_items = new_max_breadcrumbs
+    end
+
+    ##
+    # Returns the breadcrumb circular buffer
+    #
+    # @return [Bugsnag::Utility::CircularBuffer] a thread based circular buffer containing breadcrumbs
+    def breadcrumbs
+      request_data[:breadcrumbs] ||= Bugsnag::Utility::CircularBuffer.new(@max_breadcrumbs)
+    end
+
+    # Sets the notification endpoint
+    #
+    # @param new_notify_endpoint [String] The URL to deliver error notifications to
+    #
+    # @deprecated Use {#set_endpoints} instead
+    def endpoint=(new_notify_endpoint)
+      warn("The 'endpoint' configuration option is deprecated. The 'set_endpoints' method should be used instead")
+      set_endpoints(new_notify_endpoint, session_endpoint) # Pass the existing session_endpoint through so it doesn't get overwritten
+    end
+
+    ##
+    # Sets the sessions endpoint
+    #
+    # @param new_session_endpoint [String] The URL to deliver session notifications to
+    #
+    # @deprecated Use {#set_endpoints} instead
+    def session_endpoint=(new_session_endpoint)
+      warn("The 'session_endpoint' configuration option is deprecated. The 'set_endpoints' method should be used instead")
+      set_endpoints(notify_endpoint, new_session_endpoint) # Pass the existing notify_endpoint through so it doesn't get overwritten
+    end
+
+    ##
+    # Sets the notification and session endpoints
+    #
+    # @param new_notify_endpoint [String] The URL to deliver error notifications to
+    # @param new_session_endpoint [String] The URL to deliver session notifications to
+    def set_endpoints(new_notify_endpoint, new_session_endpoint)
+      @notify_endpoint = new_notify_endpoint
+      @session_endpoint = new_session_endpoint
+    end
+
+    ##
+    # Disables session tracking and delivery.  Cannot be undone
+    def disable_sessions
+      self.auto_capture_sessions = false
+      @enable_sessions = false
+    end
+
     private
 
     PROG_NAME = "[Bugsnag]"

data/lib/bugsnag/integrations/mongo.rb

@@ -0,0 +1,132 @@
+require 'mongo'
+require 'bugsnag/breadcrumbs/breadcrumbs'
+
+module Bugsnag
+  ##
+  # Subscribes to, and creates breadcrumbs from, mongo_ruby_driver events
+  #
+  # @api private
+  class MongoBreadcrumbSubscriber
+    MONGO_MESSAGE_PREFIX = "Mongo query "
+    MONGO_EVENT_PREFIX = "mongo."
+    MONGO_COMMAND_KEY = :bugsnag_mongo_commands
+    MAX_FILTER_DEPTH = 5
+
+    ##
+    # Listens to the 'started' event, storing the command for later usage
+    #
+    # @param event [Mongo::Event::Base] the mongo_ruby_driver generated event
+    def started(event)
+      leave_command(event)
+    end
+
+    ##
+    # Listens to the 'succeeded' event, leaving a breadcrumb
+    #
+    # @param event [Mongo::Event::Base] the mongo_ruby_driver generated event
+    def succeeded(event)
+      leave_mongo_breadcrumb("succeeded", event)
+    end
+
+    ##
+    # Listens to the 'failed' event, leaving a breadcrumb
+    #
+    # @param event [Mongo::Event::Base] the mongo_ruby_driver generated event
+    def failed(event)
+      leave_mongo_breadcrumb("failed", event)
+    end
+
+    private
+
+    ##
+    # Generates breadcrumb data from an event
+    #
+    # @param event_name [String] the type of event
+    # @param event [Mongo::Event::Base] the mongo_ruby_driver generated event
+    def leave_mongo_breadcrumb(event_name, event)
+      message = MONGO_MESSAGE_PREFIX + event_name
+      meta_data = {
+        :event_name => MONGO_EVENT_PREFIX + event_name,
+        :command_name => event.command_name,
+        :database_name => event.database_name,
+        :operation_id => event.operation_id,
+        :request_id => event.request_id,
+        :duration => event.duration
+      }
+      if (command = pop_command(event.request_id))
+        collection_key = event.command_name == "getMore" ? "collection" : event.command_name
+        meta_data[:collection] = command[collection_key]
+        unless command["filter"].nil?
+          filter = sanitize_filter_hash(command["filter"])
+          meta_data[:filter] = JSON.dump(filter)
+        end
+      end
+      meta_data[:message] = event.message if defined?(event.message)
+
+      Bugsnag.leave_breadcrumb(message, meta_data, Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE, :auto)
+    end
+
+    ##
+    # Removes values from filter hashes, replacing them with '?'
+    #
+    # @param filter_hash [Hash] the filter hash for the mongo transaction
+    # @param depth [Integer] the current filter depth
+    #
+    # @return [Hash] the filtered hash
+    def sanitize_filter_hash(filter_hash, depth = 0)
+      filter_hash.each_with_object({}) do |(key, value), output|
+        output[key] = sanitize_filter_value(value, depth)
+      end
+    end
+
+    ##
+    # Transforms a value element into a useful, redacted, version
+    #
+    # @param value [Object] the filter value
+    # @param depth [Integer] the current filter depth
+    #
+    # @return [Array, Hash, String] the sanitized value
+    def sanitize_filter_value(value, depth)
+      depth += 1
+      if depth >= MAX_FILTER_DEPTH
+        '[MAX_FILTER_DEPTH_REACHED]'
+      elsif value.is_a?(Array)
+        value.map { |array_value| sanitize_filter_value(array_value, depth) }
+      elsif value.is_a?(Hash)
+        sanitize_filter_hash(value, depth)
+      else
+        '?'
+      end
+    end
+
+    ##
+    # Stores the mongo command in the request data by the request_id
+    #
+    # @param event [Mongo::Event::Base] the mongo_ruby_driver generated event
+    def leave_command(event)
+      event_commands[event.request_id] = event.command
+    end
+
+    ##
+    # Removes and retrieves a stored command from the request data
+    #
+    # @param request_id [String] the id of the mongo_ruby_driver event
+    #
+    # @return [Hash, nil] the requested command, or nil if not found
+    def pop_command(request_id)
+      event_commands.delete(request_id)
+    end
+
+    ##
+    # Provides access to a thread-based mongo event command hash
+    #
+    # @return [Hash] the hash of mongo event commands
+    def event_commands
+      Bugsnag.configuration.request_data[MONGO_COMMAND_KEY] ||= {}
+    end
+  end
+end
+
+##
+# Add the subscriber to the global Mongo monitoring object
+Mongo::Monitoring::Global.subscribe(Mongo::Monitoring::COMMAND, Bugsnag::MongoBreadcrumbSubscriber.new)

data/lib/bugsnag/integrations/rails/rails_breadcrumbs.rb

@@ -0,0 +1,118 @@
+require "bugsnag/breadcrumbs/breadcrumbs"
+
+module Bugsnag::Rails
+  DEFAULT_RAILS_BREADCRUMBS = [
+    {
+      :id => "perform_action.action_cable",
+      :message => "Perform ActionCable",
+      :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :channel_class,
+        :action
+      ]
+    },
+    {
+      :id => "perform_start.active_job",
+      :message => "Start perform ActiveJob",
+      :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
+      :allowed_data => []
+    },
+    {
+      :id => "cache_read.active_support",
+      :message => "Read cache",
+      :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :key,
+        :hit,
+        :super_operation
+      ]
+    },
+    {
+      :id => "cache_fetch_hit.active_support",
+      :message => "Fetch cache hit",
+      :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :key
+      ]
+    },
+    {
+      :id => "sql.active_record",
+      :message => "ActiveRecord SQL query",
+      :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :name,
+        :connection_id,
+        :cached
+      ]
+    },
+    {
+      :id => "start_processing.action_controller",
+      :message => "Controller started processing",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :controller,
+        :action,
+        :method,
+        :path
+      ]
+    },
+    {
+      :id => "process_action.action_controller",
+      :message => "Controller action processed",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :controller,
+        :action,
+        :method,
+        :status,
+        :db_runtime
+      ]
+    },
+    {
+      :id => "redirect_to.action_controller",
+      :message => "Controller redirect",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :status,
+        :location
+      ]
+    },
+    {
+      :id => "halted_callback.action_controller",
+      :message => "Controller halted via callback",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :filter
+      ]
+    },
+    {
+      :id => "render_template.action_view",
+      :message => "ActionView template rendered",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :identifier,
+        :layout
+      ]
+    },
+    {
+      :id => "render_partial.action_view",
+      :message => "ActionView partial rendered",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :identifier
+      ]
+    },
+    {
+      :id => "deliver.action_mailer",
+      :message => "ActionMail delivered",
+      :type => Bugsnag::Breadcrumbs::REQUEST_BREADCRUMB_TYPE,
+      :allowed_data => [
+        :mailer,
+        :message_id,
+        :from,
+        :date,
+        :perform_deliveries
+      ]
+    }
+  ]
+end