class ActiveRecord::LogSubscriber

Constants

IGNORE_PAYLOAD_NAMES

Public Class Methods

reset_runtime() click to toggle source
# File lib/active_record/log_subscriber.rb, line 17
def self.reset_runtime
  rt, self.runtime = runtime, 0
  rt
end
runtime() click to toggle source
# File lib/active_record/log_subscriber.rb, line 13
def self.runtime
  ActiveRecord::RuntimeRegistry.sql_runtime ||= 0
end
runtime=(value) click to toggle source
# File lib/active_record/log_subscriber.rb, line 9
def self.runtime=(value)
  ActiveRecord::RuntimeRegistry.sql_runtime = value
end

Public Instance Methods

sql(event) click to toggle source
# File lib/active_record/log_subscriber.rb, line 32
def sql(event)
  self.class.runtime += event.duration
  return unless logger.debug?

  payload = event.payload

  return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])

  name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
  name  = "CACHE #{name}" if payload[:cached]
  sql   = payload[:sql]
  binds = nil

  if payload[:binds]&.any?
    casted_params = type_casted_binds(payload[:type_casted_binds])

    binds = []
    payload[:binds].each_with_index do |attr, i|
      binds << render_bind(attr, casted_params[i])
    end
    binds = binds.inspect
    binds.prepend("  ")
  end

  name = colorize_payload_name(name, payload[:name])
  sql  = color(sql, sql_color(sql), true) if colorize_logging

  debug "  #{name}  #{sql}#{binds}"
end
strict_loading_violation(event) click to toggle source
# File lib/active_record/log_subscriber.rb, line 22
def strict_loading_violation(event)
  debug do
    owner = event.payload[:owner]
    association = event.payload[:reflection].klass
    name = event.payload[:reflection].name

    color("Strict loading violation: #{owner} is marked for strict loading. The #{association} association named :#{name} cannot be lazily loaded.", RED)
  end
end

Private Instance Methods

colorize_payload_name(name, payload_name) click to toggle source
# File lib/active_record/log_subscriber.rb, line 82
def colorize_payload_name(name, payload_name)
  if payload_name.blank? || payload_name == "SQL" # SQL vs Model Load/Exists
    color(name, MAGENTA, true)
  else
    color(name, CYAN, true)
  end
end
debug(progname = nil, &block) click to toggle source
Calls superclass method
# File lib/active_record/log_subscriber.rb, line 115
def debug(progname = nil, &block)
  return unless super

  if ActiveRecord::Base.verbose_query_logs
    log_query_source
  end
end
extract_query_source_location(locations) click to toggle source
# File lib/active_record/log_subscriber.rb, line 131
def extract_query_source_location(locations)
  backtrace_cleaner.clean(locations.lazy).first
end
log_query_source() click to toggle source
# File lib/active_record/log_subscriber.rb, line 123
def log_query_source
  source = extract_query_source_location(caller)

  if source
    logger.debug("  ↳ #{source}")
  end
end
logger() click to toggle source
# File lib/active_record/log_subscriber.rb, line 111
def logger
  ActiveRecord::Base.logger
end
render_bind(attr, value) click to toggle source
# File lib/active_record/log_subscriber.rb, line 67
def render_bind(attr, value)
  case attr
  when ActiveModel::Attribute
    if attr.type.binary? && attr.value
      value = "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>"
    end
  when Array
    attr = attr.first
  else
    attr = nil
  end

  [attr&.name, value]
end
sql_color(sql) click to toggle source
# File lib/active_record/log_subscriber.rb, line 90
def sql_color(sql)
  case sql
  when /\A\s*rollback/mi
    RED
  when /select .*for update/mi, /\A\s*lock/mi
    WHITE
  when /\A\s*select/i
    BLUE
  when /\A\s*insert/i
    GREEN
  when /\A\s*update/i
    YELLOW
  when /\A\s*delete/i
    RED
  when /transaction\s*\Z/i
    CYAN
  else
    MAGENTA
  end
end
type_casted_binds(casted_binds) click to toggle source
# File lib/active_record/log_subscriber.rb, line 63
def type_casted_binds(casted_binds)
  casted_binds.respond_to?(:call) ? casted_binds.call : casted_binds
end