Made Delayed::Backend::ActiveRecord::Job class load lazily
#245
Conversation
This file contains 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
In Rails, classes like `ActiveRecord::Base` are designed to be loaded lazily. If a gem eagerly loads classes when required, as this gem did, it can cause issues where configurations written in `config/initializers/*.rb` for ActiveRecord are not applied properly. To avoid this, the `ActiveSupport.on_load(:active_record) do ... end` block is used to delay loading the `ActiveRecord::Base` class and `Delayed::Backend::ActiveRecord::Job` class until after Rails has fully initialized. In this commit, I wrapped the existing `Delayed::Backend::ActiveRecord::Job` class definition in a block to minimize changes. However, it might be better to separate `Delayed::Backend::ActiveRecord::Configuration` into a dedicated file for easier management.
Rubocop issued warnings, so I resolved it by splitting each class into its own file.
```
lib/delayed/backend/active_record.rb:33:7: C: Metrics/BlockLength: Block has too many lines. [122/25]
ActiveSupport.on_load(:active_record) do ...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/delayed/backend/active_record.rb:36:9: W: Lint/ConstantDefinitionInBlock: Do not define constants this way within a block.
class Job < ::ActiveRecord::Base ...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```
Fix the following offenses using RuboCop’s autocorrect feature.
```
Offenses:
lib/delayed/backend/active_record/job.rb:55:15: C: [Correctable] Layout/MultilineMethodCallIndentation: Align .min_priority with ready_to_run(worker.name, max_run_time) on line 54.
.min_priority
^^^^^^^^^^^^^
lib/delayed/backend/active_record/job.rb:56:15: C: [Correctable] Layout/MultilineMethodCallIndentation: Align .max_priority with ready_to_run(worker.name, max_run_time) on line 54.
.max_priority
^^^^^^^^^^^^^
lib/delayed/backend/active_record/job.rb:57:15: C: [Correctable] Layout/MultilineMethodCallIndentation: Align .for_queues with ready_to_run(worker.name, max_run_time) on line 54.
.for_queues
^^^^^^^^^^^
lib/delayed/backend/active_record/job.rb:58:15: C: [Correctable] Layout/MultilineMethodCallIndentation: Align .by_priority with ready_to_run(worker.name, max_run_time) on line 54.
.by_priority
^^^^^^^^^^^^
```
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
In Rails, classes like
ActiveRecord::Baseare designed to be loaded lazily. If a gem eagerly loads classes when required, as this gem did, it can cause issues where configurations written inconfig/initializers/*.rbfor ActiveRecord are not applied properly. To avoid this, theActiveSupport.on_load(:active_record) do ... endblock is used to delay loading theActiveRecord::Baseclass andDelayed::Backend::ActiveRecord::Jobclass until after Rails has fully initialized.In this commit, I wrapped the existing
Delayed::Backend::ActiveRecord::Jobclass definition in a block to minimize changes. However, it might be better to separateDelayed::Backend::ActiveRecord::Configurationinto a dedicated file for easier management.