Allow rendering different ERB files per tenant #5030
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
multitenancy
branch
from
4ca56a1
to
e38b860
Compare
javierm
changed the title
javierm
force-pushed
the
tenant_variants
branch
from
37e5e69
to
0e333b8
Compare
javierm
force-pushed
the
tenant_variants
branch
3 times, most recently
from
73f6baf
to
b523501
Compare
javierm
force-pushed
the
tenant_variants
branch
2 times, most recently
from
4553282
to
abcbd29
Compare
javierm
force-pushed
the
tenant_variants
branch
from
abcbd29
to
3554512
Compare
javierm
force-pushed
the
tenant_variants
branch
from
3554512
to
893be3b
Compare
taitus
approved these changes
Nov 29, 2022
ViewComponent 2.78.0 adds support for variants with dashes and dots in their names; since we're going to add variants named after a subdomain, we need this feature.
Sometimes it might be convenient to use completely different views for different tenants. For example, a certain tenant might use a footer that has nothing to do with the default one. For these cases, instead of adding `case Tenant.current_schema` conditions to the view, it might be tidier to use a different file. For this purpose, we're using Rails variants [1], which means that a tenant named `mytenant` will use a template ending with `.html+mytenant.erb` if it's available. This works with components too, but has a limitation: when using the `custom/` folder to add ERB files for a tenant, the default tenant ERB file needs to be added to the `custom/` folder as well; if there aren't changes to this file, a symbolic link will do. For example, if we're writing a custom `admin/action_component` view for the tenant `milky-way` but don't need to change this file for the default tenant: 1. Create `app/components/custom/admin/action_component.rb` according to the components customizations documentation [2] 2. Create the custom view for the `milky-way` tenant and save it under `app/components/custom/admin/action_component.html+milky-way.erb` 3. Enter the `app/components/custom/admin/` folder and run `ln -s ../../admin/action_component.html.erb` We're also adding some controller tests. Since Rails doesn't load the middleware during controller tests, we're stubbing the `current_schema` method directly instead of changing the subdomain of the request. [1] https://guides.rubyonrails.org/v6.0/layouts_and_rendering.html#the-variants-option [2] https://docs.consulproject.org/docs/english-documentation/customization/components
We were assigning variants in a controller, in the context of a request. However, when sending emails, there is no request and no controller is involved, so we also need to set the variant in the ApplicationMailer class.
javierm
force-pushed
the
tenant_variants
branch
from
893be3b
to
d579bcc
Compare
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
Background
Sometimes it might be convenient to use completely different views for different tenants. For example, a certain tenant might use a footer that has nothing to do with the default one.
For these cases, instead of adding
case Tenant.current_schemaconditions to the view, it might be tidier to use a different file.For this purpose, we can use Rails variants, which means that a tenant named
mytenantwill use a template ending with.html+mytenant.erbif it's available.Objectives
Notes
This works with components too, but has a limitation: when using the
custom/folder to add ERB files for a tenant, the default tenant ERB file needs to be added to thecustom/folder as well; if there aren't changes to this file, a symbolic link will do.For example, if we're writing a custom
admin/action_componentview for the tenantmilky-waybut don't need to change this file for the default tenant:app/components/custom/admin/action_component.rbaccording to the components customizations documentationmilky-waytenant and save it underapp/components/custom/admin/action_component.html+milky-way.erbapp/components/custom/admin/folder and runln -s ../../admin/action_component.html.erbWe're also adding some controller tests. Since Rails doesn't load the middleware during controller tests, we're stubbing the
current_schemamethod directly instead of changing the subdomain of the request.