Rails引入ActiveJob::TestHelper后RSpec延迟广播测试失败求助

环境 #

• Rails 7.1.2
• rspec-rails 6.1.0

核心问题 #

全局引入ActiveJob::TestHelper后，使用broadcast_update_later_to的延迟广播系统测试会失败；移除该全局配置后测试正常通过。

相关代码 #

模型代码（app/models/my_class.rb） #

class MyClass < ApplicationRecord
  after_update_commit :broadcast_update_user

  private

  def broadcast_update_user
    broadcast_update_later_to('ts_channel_id', ...)
  end
end

测试代码（system/my_class_spec.rb） #

RSpec.describe 'MyClass system tests', :type => :system do
  it 'should broadcast', :js => true do
    @my_instance = FactoryBot.create(:regular_instance)

    visit my_path

    # 模拟记录更新
    @my_instance.update!(:value => 'YO!!!')
  
    expect(page).to have_css('span.value-target', :text => 'YO!!!', :exact_text => true, :count => 1)
  end
end

测试配置对比 #

失败配置（rails_helper.rb） #

RSpec.configure do |config|
  config.include ActiveJob::TestHelper

  config.before(:suite) do
    ActiveJob::Base.queue_adapter = :async
  end
end

现象：测试失败，日志显示作业被加入Test队列但未执行。

成功配置（rails_helper.rb） #

RSpec.configure do |config|
  # config.include ActiveJob::TestHelper

  config.before(:suite) do
    ActiveJob::Base.queue_adapter = :async
  end
end

现象：测试通过，日志显示作业被加入Async队列并正常执行完成广播。

补充说明 #

• 开发与生产环境中延迟广播功能正常；
• 使用同步广播方法broadcast_update_to时测试可通过，但业务需求必须使用延迟广播；
• 问题疑似与Rails官方Issue #36697相关，但未确认。

解决方案 #

方案1：限制ActiveJob::TestHelper的引入范围 #

不要全局包含该helper，仅在job类型测试中引入，避免影响系统测试：

RSpec.configure do |config|
  config.include ActiveJob::TestHelper, type: :job

  config.before(:suite) do
    ActiveJob::Base.queue_adapter = :async
  end
end

方案2：在系统测试中强制重置队列适配器 #

在系统测试的前置钩子中显式设置队列适配器为:async，覆盖ActiveJob::TestHelper的默认行为：

RSpec.describe 'MyClass system tests', :type => :system do
  before do
    ActiveJob::Base.queue_adapter = :async
  end

  it 'should broadcast', :js => true do
    # 测试代码保持不变
    @my_instance = FactoryBot.create(:regular_instance)
    visit my_path
    @my_instance.update!(:value => 'YO!!!')
    expect(page).to have_css('span.value-target', :text => 'YO!!!', :exact_text => true, :count => 1)
  end
end

方案3：手动触发作业执行（需权衡场景） #

如果必须全局引入ActiveJob::TestHelper，可以在测试中用perform_enqueued_jobs同步执行延迟作业：

it 'should broadcast', :js => true do
  @my_instance = FactoryBot.create(:regular_instance)
  visit my_path

  perform_enqueued_jobs do
    @my_instance.update!(:value => 'YO!!!')
  end
  
  expect(page).to have_css('span.value-target', :text => 'YO!!!', :exact_text => true, :count => 1)
end

注意：该方式会同步执行作业，无法完全模拟真实延迟场景，仅适合不需要验证异步时序的测试。

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