Rails7.1.4.1+Rspec测试日志格式化弃用警告的非升级解决办法

问题描述 #

DEPRECATION WARNING: Bolding log text with a positional boolean is deprecated and will be removed in Rails 7.2. Use an option hash instead (eg. color("my text", :red, bold: true)). (called from tap at internal:kernel:90)

在使用Rails 7.1.4.1搭配Rspec运行测试时，多次出现上述弃用警告，但应用代码中未使用任何color、bold等日志格式化相关代码，警告也未指向具体文件或行号，无法定位触发源，需要在不升级Rails gem的前提下解决该问题。

解决方案 #

1. 定位警告触发源 #

虽然警告本身未提供具体文件路径，但可以通过临时打印调用栈找到根源：

• 在项目的config/initializers目录下创建debug_log_deprecation.rb文件，添加以下代码：

module ActiveSupport
  module Logger
    module SimpleFormatter
      def color(message, color, bold = false)
        caller_locations.each do |loc|
          puts "Color method called from: #{loc.path}:#{loc.lineno}"
        end
        super(message, color, bold)
      end
    end
  end
end

运行测试后，控制台会输出color方法的完整调用栈，从而定位到触发警告的代码（可能是第三方gem或Rails内部的特定逻辑）。

2. 临时屏蔽特定弃用警告 #

如果暂时无法定位或修复触发源，可以只屏蔽该条警告，保留其他弃用提示：

• 在config/environments/test.rb中添加以下配置：

ActiveSupport::Deprecation.filter_warnings do |warning|
  !warning.include?("Bolding log text with a positional boolean is deprecated")
end

3. 修复第三方gem触发的警告 #

如果通过调用栈定位到是某个第三方gem的问题：

• 查看该gem的最新版本是否已修复该问题，若有则单独升级该gem（无需升级Rails）
• 若gem未修复，可通过猴子补丁修改其日志调用逻辑：
  比如原代码使用color(text, :green, true)，可在config/initializers中添加补丁：

# 示例：针对某gem的日志方法补丁
module TargetGem
  class CustomLogger
    def print_notice(text)
      # 替换原positional参数调用为选项哈希
      color(text, :green, bold: true)
    end
  end
end

内容的提问来源于stack exchange，提问作者Samuel Da Costa