Class: Bugsnag::Breadcrumbs::Validator

Inherits:
Object
  • Object
show all
Defined in:
lib/bugsnag/breadcrumbs/validator.rb

Overview

Validates a given breadcrumb before it is stored

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Validator

Returns a new instance of Validator.

Parameters:



9
10
11
 
# File 'lib/bugsnag/breadcrumbs/validator.rb', line 9

def initialize(configuration)
  @configuration = configuration
end

Instance Method Details

#validate(breadcrumb) ⇒ Object

Validates a given breadcrumb.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/bugsnag/breadcrumbs/validator.rb', line 17

def validate(breadcrumb)
  # 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.debug("Breadcrumb #{breadcrumb.name} meta_data #{k}:#{v.class} 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.debug("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.debug("Automatic breadcrumb of type #{breadcrumb.type} ignored: #{breadcrumb.name}")
  breadcrumb.ignore!
end