Move custom ActiveStorage service to $LOAD_PATH #5492
Merged
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
javierm
force-pushed
the
move_tenant_service_to_load_path
branch
2 times, most recently
from
a81b61c
to
5badeb0
Compare
This way we simplify the code a little bit and we create a method unique to the `TenantDiskService` class, which can be used to check whether we're using this class without using `is_a?` or similar.
javierm
force-pushed
the
move_tenant_service_to_load_path
branch
3 times, most recently
from
cdd417c
to
0ca5565
Compare
We moved this file to `app/lib/` in commit cb47714 so it would be in the autoload_paths. However, this class is loaded by ActiveStorage, with the following method: ``` def resolve(class_name) require "active_storage/service/#{class_name.to_s.underscore}_service" ActiveStorage::Service.const_get(:"#{class_name.camelize}Service") rescue LoadError raise "Missing service adapter for #{class_name.inspect}" end `` So this file needs to be in the $LOAD_PATH, or else ActiveStorage won't be able to load it when we disable the `add_autoload_paths_to_load_path` option, which is the default in Rails 7.1 [1]. Moving it to the `lib` folder solves the issue; as mentioned in the guide to upgrade to Rails 7.1 [2]: > The lib directory is not affected by this flag, it is added to > $LOAD_PATH always. However, we were also referencing this class in the `Tenant` model, meaning we needed to autoload it as well somehow. So, instead of directly referencing this class, we're using `respond_to?` in the Tenant model. We're changing the test so it fails when the code calls `is_a?(ActiveStorage::Service::TenantDiskService)`. We need to change the active storage configurations in the test because, otherwise, the moment `ActiveStorage::Blob` is loaded, the `TenantDiskService` class is also loaded, meaning the test will pass when using `is_a?`. Note that, since this class isn't in the autoload paths anymore, we need to add a `require` in the tests. We could add an initializer to require it; we're not doing it in order to be consistent with what ActiveStorage does: it only loads the service that's going to be used in the current Rails environment. If somebody changed their production environment in order to use (for example), S3, and we added an initializer to require the TenantDiskService, we would still load the TenantDiskService even if it isn't going to be used. [1] https://guides.rubyonrails.org/v7.1/configuring.html#config-add-autoload-paths-to-load-path [2] https://guides.rubyonrails.org/v7.1/upgrading_ruby_on_rails.html#autoloaded-paths-are-no-longer-in-$load-path
javierm
force-pushed
the
move_tenant_service_to_load_path
branch
from
0ca5565
to
118c2bf
Compare
taitus
approved these changes
Apr 17, 2024
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.
References
Objectives