The "paper_trail" initializer is not guaranteed to execute before the "load_config_initializers" initializer

[glasses618]

Summary

The name of load_config_initializers which is used for registering "paper_trail" initializer's before-initializer should be :load_config_initializers instead of 'load_config_initializers'. Please refer to https://github.com/rails/rails/blob/3668b4b5978822f1e6311c7fd7a32f58daee136a/railties/lib/rails/engine.rb#L618.

paper_trail/lib/paper_trail/frameworks/rails/railtie.rb

Line 13 in d627260

initializer "paper_trail", before: "load_config_initializers" do

Reproduce script

• All tsort_each_child of initializers of load_config_initializers should contain 'paper_trail' initializer.

P.S. The original template cannot be utilized to reproduce this issue, so I've prepared an alternative script.

Script

1. Prepare a Rails app
2. Add gem 'paper_trail', '15.0.0' into Gemfile and run bundle install
3. In rails console, run the following script:

initializers_of_load_config_initializers = Rails.application.initializers.select{ |s| s.name == :load_config_initializers }

initializers = Rails.application.initializers
initializers_of_load_config_initializers.map do |initializer| 
  initializers.tsort_each_child(initializer).any?{|s| s.name == 'paper_trail' }
end

expected result

=> [true, true, true, true, true, true, true, true, true]

Actual result

=> [false, false, false, false, false, false, false, false, false]

Fix

• Replace step 2's gem 'paper_trail', '15.0.0' with gem 'paper_trail', github: 'glasses618/paper_trail', branch: 'master' can fix the problem.
  • commit to fix: 7ea0926

Environment

Rails version

7.0.7.2

Ruby version

3.2.2

paper_trail version

15.0.0

Related rails source codes

• The logic for configuring an initializer's name is located here: https://github.com/rails/rails/blob/3668b4b5978822f1e6311c7fd7a32f58daee136a/railties/lib/rails/initializable.rb#L91
• The logic for finding child nodes in Rails::Initializable::Collection#tsort_each_child can be found here: https://github.com/rails/rails/blob/3668b4b5978822f1e6311c7fd7a32f58daee136a/railties/lib/rails/initializable.rb#L50

[github-actions]

This issue has been automatically marked as stale due to inactivity.
The resources of our volunteers are limited.
Bug reports must provide a script that reproduces the bug, using our template. Feature suggestions must include a promise to build the feature yourself.
Thank you for all your contributions.