# frozen_string_literal: true module ActiveRecord class LogSubscriber < ActiveSupport::LogSubscriber IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN"] class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new def self.runtime=(value) ActiveRecord.deprecator.warn(<<-MSG.squish) ActiveRecord::LogSubscriber.runtime= is deprecated and will be removed in Rails 7.2. MSG ActiveRecord::RuntimeRegistry.sql_runtime = value end def self.runtime ActiveRecord.deprecator.warn(<<-MSG.squish) ActiveRecord::LogSubscriber.runtime is deprecated and will be removed in Rails 7.2. MSG ActiveRecord::RuntimeRegistry.sql_runtime end def self.reset_runtime ActiveRecord.deprecator.warn(<<-MSG.squish) ActiveRecord::LogSubscriber.reset_runtime is deprecated and will be removed in Rails 7.2. MSG ActiveRecord::RuntimeRegistry.reset end def strict_loading_violation(event) debug do owner = event.payload[:owner] reflection = event.payload[:reflection] color(reflection.strict_loading_violation_message(owner), RED) end end subscribe_log_level :strict_loading_violation, :debug def sql(event) payload = event.payload return if IGNORE_PAYLOAD_NAMES.include?(payload[:name]) name = if payload[:async] "ASYNC #{payload[:name]} (#{payload[:lock_wait].round(1)}ms) (db time #{event.duration.round(1)}ms)" else "#{payload[:name]} (#{event.duration.round(1)}ms)" end 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| attribute_name = if attr.respond_to?(:name) attr.name elsif attr.respond_to?(:[]) && attr[i].respond_to?(:name) attr[i].name else nil end filtered_params = filter(attribute_name, casted_params[i]) binds << render_bind(attr, filtered_params) end binds = binds.inspect binds.prepend(" ") end name = colorize_payload_name(name, payload[:name]) sql = color(sql, sql_color(sql), bold: true) if colorize_logging debug " #{name} #{sql}#{binds}" end subscribe_log_level :sql, :debug private def type_casted_binds(casted_binds) casted_binds.respond_to?(:call) ? casted_binds.call : casted_binds end 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 def colorize_payload_name(name, payload_name) if payload_name.blank? || payload_name == "SQL" # SQL vs Model Load/Exists color(name, MAGENTA, bold: true) else color(name, CYAN, bold: true) end end 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 def logger ActiveRecord::Base.logger end def debug(progname = nil, &block) return unless super if ActiveRecord.verbose_query_logs log_query_source end end def log_query_source source = query_source_location if source logger.debug(" ↳ #{source}") end end if Thread.respond_to?(:each_caller_location) def query_source_location Thread.each_caller_location do |location| frame = backtrace_cleaner.clean_frame(location) return frame if frame end nil end else def query_source_location backtrace_cleaner.clean(caller(1).lazy).first end end def filter(name, value) ActiveRecord::Base.inspection_filter.filter_param(name, value) end end end ActiveRecord::LogSubscriber.attach_to :active_record