Support code reloading when configuring static preferences sources #4449
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
aldesantis
approved these changes
Jul 13, 2022
kennyadsl
approved these changes
Jul 13, 2022
Good point! I updated the Changelog accordingly. |
This is how we usually recommend configuring sources for static
preferences [1]:
```ruby
Spree.config do |config|
config.static_model_preferences.add(
AmazingStore::AmazingPaymentMethod,
'amazing_payment_method_credentials',
credentials: ENV['AMAZING_PAYMENT_METHOD_CREDENTIALS'],
server: Rails.env.production? ? 'production' : 'test',
test_mode: !Rails.env.production?
)
end
```
However, it's no longer possible to directly reference an autoloadable
class from an initializer [2].
In this case, we can't change the `#add` method to take the class name
instead. The reason is that it ends up invoking a sanitization check on
the given preferences against the defined preferences, and that, of
course, needs access to the actual class [3].
Therefore, it's better to start recommending nesting the configuration
within a `.to_prepare` block, as they run every time the code is
reloaded [4]:
```ruby
Rails.application.config.to_prepare do
Spree::Config.static_model_preferences.add(
AmazingStore::AmazingPaymentMethod,
'amazing_payment_method_credentials',
credentials: ENV['AMAZING_PAYMENT_METHOD_CREDENTIALS'],
server: Rails.env.production? ? 'production' : 'test',
test_mode: !Rails.env.production?
)
end
```
However, that means running the `#add` method multiple times, so we need
to change it to replace the definition instead of raising an error.
[1] - https://github.com/solidusio/solidus_stripe/blob/3fab36511a9d02ebd64d03571704ac5a9031b63b/README.md#usage
[2] - https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-on-boot-and-on-each-reload
[3] - https://github.com/solidusio/solidus/blob/df51df62fa9b829216958b21b20514b7a3d87b30/core/lib/spree/preferences/static_model_preferences.rb#L13
[4] - https://guides.rubyonrails.org/configuring.html#initialization-events
Closes solidusio#4070 & solidusio#4040
We rearrange the CHANGELOG to accommodate the increased amount of information.
waiting-for-dev
force-pushed
the
waiting-for-dev/accept_static_class_name_as_string
branch
from
27beeac to
c9562c6
Compare
waiting-for-dev
deleted the
waiting-for-dev/accept_static_class_name_as_string
branch
DanielePalombo
pushed a commit
to solidusio/solidus_bolt
that referenced
this pull request
Aug 30, 2022
This is needed in Rails 7 [1] and latest Solidus was adapted to support it. See solidusio/solidus#4449 [1] - https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-on-boot-and-on-each-reload
piyushswain
added a commit
to piyushswain/solidus_razorpay
that referenced
this pull request
Mar 9, 2023
This is needed in Rails 7 [1] and latest Solidus was adapted to support it. See solidusio/solidus#4449 [1] - https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-on-boot-and-on-each-reload
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.
This is how we usually recommend configuring sources for static
preferences:
However, it's no longer possible to directly reference an autoloadable
class from an initializer.
In this case, we can't change the
#addmethod to take the class nameinstead. The reason is that it ends up invoking a sanitization check on
the given preferences against the defined preferences, and that, of
course, needs access to the actual class.
Therefore, it's better to start recommending nesting the configuration
within a
.to_prepareblock, as they run every time the code isreloaded:
However, that means running the
#addmethod multiple times, so we needto change it to replace the definition instead of raising an error.
Closes #4070 & #4040