Add option to lazy load factory definitions #522
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
quadule requested review from sarahraqueld, smaboshe and minaslater as code owners quadule commented Jan 7, 2025
| FactoryBot.find_definitions | ||
| if app.config.factory_bot.lazy_load_definitions && !app.config.eager_load | ||
| require "factory_bot_rails/lazy_registry_find" | ||
| FactoryBot::Registry.prepend FactoryBotRails::LazyRegistryFind |
There was a problem hiding this comment.
This should probably be implemented in the factory_bot gem instead, so I'll open another PR for that if there's any interest here.
quadule force-pushed the lazy-load-definitions branch from f18edf4 to b909731 Compare 
quadule force-pushed the lazy-load-definitions branch from b909731 to 3c76e51 Compare 
neilvcarvalho requested review from vburzynski and removed request for smaboshe, sarahraqueld and minaslater Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Loading factory definitions can sometimes have a noticeable impact on Rails boot time: For example, in a large app I work on
FactoryBot.find_definitionstakes an average of 0.3s to load 274 factories. An option to lazy load them would avoid this overhead when factories are not needed.The new
lazy_load_definitionsoption is disabled by default for compatibility reasons, but all tests pass for bothfactory_botandfactory_bot_railswhen enabled. The railtie will also continue to load all factory definitions at boot ifconfig.eager_loadis enabled in the application.