升级至Rails 8.0.1后railties触发STATS_DIRECTORIES常量重复初始化警告

问题背景 #

将Rails 7.2.2应用升级至8.0.1，Ruby已提前升级到3.4.2且原测试无警告。升级后运行测试时，出现以下重复初始化常量的警告：

/home/<username>/.asdf/installs/ruby/3.4.2/lib/ruby/gems/3.4.0/gems/railties-8.0.1/lib/rails/tasks/statistics.rake:4: warning: already initialized constant STATS_DIRECTORIES Time: 00:00:10,  ETA: 00:03:50
/home/<username>/.asdf/installs/ruby/3.4.2/lib/ruby/gems/3.4.0/gems/railties-8.0.1/lib/rails/tasks/statistics.rake:4: warning: previous definition of STATS_DIRECTORIES was here

问题定位 #

警告来自Heroku Scheduler定时任务的测试套件，测试代码结构如下：

require "test_helper"

class TimedEmailsTaskTest < ActionDispatch::IntegrationTest
  setup do
    Rails.application.load_tasks

    @my_object = create(:object)
  end

  teardown do
    ActionMailer::Base.deliveries.clear
    Rake::Task["my_regular_emails_task"].reenable
  end

  # 4个通过Rake::Task["my_regular_emails_task"].invoke执行并断言的测试用例

end

问题核心在Rails.application.load_tasks行，修改为以下代码后，警告从每个测试用例触发一次变为仅触发一次：

Rails.application.load_tasks unless defined?(Rake::Task) && Rake::Task.tasks.any?

进一步排查发现：

• 常量STATS_DIRECTORIES最初由根目录标准Rakefile定义：

  require_relative "config/application"
  
  Rails.application.load_tasks
  

• 运行完整测试套件（如rails test或rails test:integration）时，rails test本质是通过Rake执行，会先运行根目录Rakefile加载所有任务；测试类中再次调用load_tasks就会重复定义常量触发警告。但单独运行该测试文件时，不会触发Rakefile的执行，因此无警告。
• 尝试将加载任务的代码移至test_helper.rb无效，担心测试稳定性，同时疑惑Rakefile执行时机及Rails 7无此问题的原因。

相关定时任务代码：

# ./lib/tasks/emails.rake

desc "send all notification emails"
task send_timed_email_notices: :environment do
  TimedEmailNotices.send_all
end

解决方案 #

1. 精准加载目标任务（推荐） #

不需要加载全部Rake任务，仅加载测试需要的任务文件即可，从根源避免重复加载统计类任务代码：

setup do
  load "lib/tasks/emails.rake"
  @my_object = create(:object)
end

2. 全局单次加载任务 #

在test_helper.rb中提前加载一次任务，测试类的setup中不再重复加载：

# test_helper.rb
unless defined?(Rake::Task) && Rake::Task.tasks.any?
  Rails.application.load_tasks
end

这样整个测试套件仅执行一次任务加载，避免重复定义常量。

3. 临时屏蔽警告（不推荐） #

若上述方案无法实施，可临时屏蔽该警告，但属于治标不治本的方式：

# test_helper.rb
original_verbose = $VERBOSE
$VERBOSE = nil
Rails.application.load_tasks
$VERBOSE = original_verbose

为什么Rails 7无此问题？ #

Rails 8对Rake任务加载逻辑做了调整，STATS_DIRECTORIES常量被移至statistics.rake文件中定义；而Rails 7中该常量的定义方式或任务加载逻辑不会导致重复初始化的情况。

内容的提问来源于stack exchange，提问作者NGobin