Issue with the upcoming Factory Bot Rails due to lacking of lazy load hooks #89

tagliala · 2023-11-01T17:44:13Z

Hello,

I'm using database_cleaner-active_record together with factory-bot-rails in an application.

The issue is documented here: thoughtbot/factory_bot_rails#426

Here it is a reproducible test case:

# frozen_string_literal: true

require 'bundler/inline'

begin
  gemfile(true) do
    source 'https://rubygems.org'

    gem 'pg'
    gem 'rails'
    # Comment out `git` and `branch` params to use the latest stable version of factory bot and make the test pass
    gem 'factory_bot_rails', git: 'https://github.com/thoughtbot/factory_bot_rails.git', branch: 'main'
    gem 'database_cleaner-active_record'
  end

  require 'active_record'
  require 'factory_bot_rails'
  require 'database_cleaner-active_record'
rescue Gem::LoadError => e
  puts "\nMissing Dependency:\n#{e.backtrace.first} #{e.message}"
rescue LoadError => e
  puts "\nError:\n#{e.backtrace.first} #{e.message}"
  exit 1
end

puts 'Ok'

Error:

~/.rvm/gems/ruby-3.2.2/gems/railties-7.1.1/lib/rails.rb:51:in `configuration': undefined method `config' for nil:NilClass (NoMethodError)

      application.config
                 ^^^^^^^
	from ~/.rvm/gems/ruby-3.2.2/bundler/gems/factory_bot_rails-fd1ca67b43f4/lib/factory_bot_rails/railtie.rb:25:in `block in <class:Railtie>'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:97:in `class_eval'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:97:in `block in execute_hook'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:87:in `with_execution_control'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:92:in `execute_hook'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:78:in `block in run_load_hooks'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:77:in `each'
	from ~/.rvm/gems/ruby-3.2.2/gems/activesupport-7.1.1/lib/active_support/lazy_load_hooks.rb:77:in `run_load_hooks'
	from ~/.rvm/gems/ruby-3.2.2/gems/activerecord-7.1.1/lib/active_record/base.rb:338:in `<module:ActiveRecord>'
	from ~/.rvm/gems/ruby-3.2.2/gems/activerecord-7.1.1/lib/active_record/base.rb:15:in `<top (required)>'
	from <internal:~/.rvm/rubies/ruby-3.2.2/lib/ruby/site_ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
	from <internal:~/.rvm/rubies/ruby-3.2.2/lib/ruby/site_ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
	from ~/.rvm/gems/ruby-3.2.2/gems/database_cleaner-active_record-2.1.0/lib/database_cleaner/active_record/truncation.rb:2:in `<top (required)>'
	from <internal:~/.rvm/rubies/ruby-3.2.2/lib/ruby/site_ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
	from <internal:~/.rvm/rubies/ruby-3.2.2/lib/ruby/site_ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
	from ~/.rvm/gems/ruby-3.2.2/gems/database_cleaner-active_record-2.1.0/lib/database_cleaner/active_record.rb:4:in `<top (required)>'
	from <internal:~/.rvm/rubies/ruby-3.2.2/lib/ruby/site_ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
	from <internal:~/.rvm/rubies/ruby-3.2.2/lib/ruby/site_ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
	from ~/.rvm/gems/ruby-3.2.2/gems/database_cleaner-active_record-2.1.0/lib/database_cleaner-active_record.rb:1:in `<top (required)>'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/runtime.rb:60:in `require'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/runtime.rb:60:in `block (2 levels) in require'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/runtime.rb:55:in `each'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/runtime.rb:55:in `block in require'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/runtime.rb:44:in `each'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/runtime.rb:44:in `require'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/inline.rb:66:in `block (2 levels) in gemfile'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/settings.rb:140:in `temporary'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/inline.rb:51:in `block in gemfile'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler.rb:411:in `block in with_unbundled_env'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler.rb:657:in `with_env'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler.rb:411:in `with_unbundled_env'
	from ~/.rvm/gems/ruby-3.2.2/gems/bundler-2.4.20/lib/bundler/inline.rb:42:in `gemfile'

It is due to the fact that Database Cleaner does not use lazy hooks before using ActiveRecord. You can see a fix to the same issue with another gem here: amoeba-rb/amoeba#115

However, the fix does not appear to be so trivial with Database Cleaner, so this is why I'm opening an issue rather than submitting a PR

The text was updated successfully, but these errors were encountered:

tagliala · 2023-11-20T12:40:13Z

Hopefully this will be addressed by Factory Bot Rails itself in thoughtbot/factory_bot_rails#432

jamesw · 2023-11-21T18:39:56Z

@tagliala Having the same issue here, this issue happens for me regardless of factory bot rails version used and appears totally unrelated to factory bot rails

tagliala · 2023-11-22T08:44:44Z

Please try with the branch used in thoughtbot/factory_bot_rails#432

benoittgt · 2023-11-23T09:58:11Z

I think this gem should follow lazy loading like other project:

This is well known issue. We should prefer to code that reference active record only when it's already lazy loaded. It can break other gems initializing process Related: - rails/rails#46567 - paper-trail-gem/paper_trail@fc6c5f6 (inspiration) - thoughtbot/factory_bot_rails#432 Fix: DatabaseCleaner#89

Doing this cause a slew of problems with Rails loading process, causing some configurations not to be applied, etc. Fix: DatabaseCleaner#89 Fix: DatabaseCleaner#90

Doing this cause a slew of problems with Rails loading process, causing some configurations not to be applied, etc. Fix: #89 Fix: #90

tagliala changed the title ~~Issue with the upcoming Factory Bot Rails due to~~ Issue with the upcoming Factory Bot Rails due to lacking of lazy load hooks Nov 1, 2023

tagliala mentioned this issue Nov 1, 2023

The railtie included in #419 breaks compatibility with some gems "undefined method `config' for nil:NilClass" Factory Bot > 6.2.0 thoughtbot/factory_bot_rails#426

Closed

3 tasks

jamesw mentioned this issue Nov 22, 2023

Engine broken after upgrading from Rails 7.1.1 to Rails 7.1.2 rails/rails#50126

Closed

benoittgt mentioned this issue Nov 23, 2023

Defer code loading when active record is properly loaded #90

Closed

casperisfine mentioned this issue Nov 23, 2023

Avoid loading ActiveRecord::Base early #91

Merged

etagwerker closed this as completed in #91 Nov 23, 2023

etagwerker pushed a commit that referenced this issue Nov 23, 2023

Avoid loading ActiveRecord::Base early (#91)

4afa131

Doing this cause a slew of problems with Rails loading process, causing some configurations not to be applied, etc. Fix: #89 Fix: #90

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue with the upcoming Factory Bot Rails due to lacking of lazy load hooks #89

Issue with the upcoming Factory Bot Rails due to lacking of lazy load hooks #89

tagliala commented Nov 1, 2023

tagliala commented Nov 20, 2023

jamesw commented Nov 21, 2023 •

edited

Loading

tagliala commented Nov 22, 2023

benoittgt commented Nov 23, 2023

Issue with the upcoming Factory Bot Rails due to lacking of lazy load hooks #89

Issue with the upcoming Factory Bot Rails due to lacking of lazy load hooks #89

Comments

tagliala commented Nov 1, 2023

tagliala commented Nov 20, 2023

jamesw commented Nov 21, 2023 • edited Loading

tagliala commented Nov 22, 2023

benoittgt commented Nov 23, 2023

jamesw commented Nov 21, 2023 •

edited

Loading