feat: theme-agnostic view to fetch theme assets #29503
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
It is possible to set custom logos in microfrontends, for instance with the LOGO_URL setting. Ideally, we would like that MFEs share the same logos as the LMS. But this is made difficult when comprehensive theming is enabled, and the logo is overridden by a custom theme. In that scenario, the logo url becomes /static/mytheme/images/logo.png. But the MFEs do no know that the "mytheme" theme is enabled. To resolve this issue, we introduce here a view, at the "/theming/asset/<path>" url, that redirects to the corresponding asset in the theme that is currently enabled. Thus, MFEs only have to set `LOGO_URL=http://lmshost/theming/asset/images/logo.png` to point to the themed logo. Related issue: overhangio/tutor-mfe#25
openedx-webhooks
added
core committer
open-source-contribution
|
Thanks for the pull request, @regisb! I've created OSPR-6253 to keep track of it in JIRA. As a core committer in this repo, you can merge this once the pull request is approved per the core committer reviewer requirements and according to the agreement with your edX Champion. |
edx-community-bot
approved these changes
Dec 3, 2021
There was a problem hiding this comment.
👍
When you're ready to merge, add a comment that says
@edx-community-bot merge
and we'll handle the rest!
CC: @edx/community-engineering @edx/open-release-maintainers
|
Can a non-bot maybe approve this? cc @BbrSofiane |
|
@jmbowman, @kdmccormick: thought you might like to know that regisb merged this pull request. |
openedx-webhooks
added
merged
and removed
waiting on author
|
@regisb 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
|
👍 |
|
@regisb Thank you for your contribution. |
regisb
referenced
this pull request
in overhangio/tutor-mfe
Dec 8, 2021
Previously, it was not possible to make the MFEs use the themed logo from the LMS. This changed when this PR was merged: https://github.com/edx/edx-platform/pull/29503 In Maple, the /theming/asset/images/logo.png url now redirects to the themed logo. Close #25.
regisb
referenced
this pull request
in overhangio/tutor-mfe
Dec 14, 2021
- Previously, it was not possible to make the MFEs use the themed logo from the LMS. This changed when this PR was merged: https://github.com/edx/edx-platform/pull/29503 In Maple, the /theming/asset/images/logo.png url now redirects to the themed logo. Close #25. - We disable New Relic globally by upgrading frontend-build for some packages. Close openedx/wg-frontend/issues/14
regisb
referenced
this pull request
in overhangio/tutor-mfe
Dec 14, 2021
- Previously, it was not possible to make the MFEs use the themed logo from the LMS. This changed when this PR was merged: https://github.com/edx/edx-platform/pull/29503 In Maple, the /theming/asset/images/logo.png url now redirects to the themed logo. Close #25. - We disable New Relic globally by upgrading frontend-build for some packages. Close openedx/wg-frontend/issues/14
regisb
referenced
this pull request
in overhangio/tutor-mfe
Dec 21, 2021
- Previously, it was not possible to make the MFEs use the themed logo from the LMS. This changed when this PR was merged: https://github.com/edx/edx-platform/pull/29503 In Maple, the /theming/asset/images/logo.png url now redirects to the themed logo. Close #25.
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.
It is possible to set custom logos in microfrontends, for instance with the
LOGO_URL setting. Ideally, we would like that MFEs share the same logos as the
LMS. But this is made difficult when comprehensive theming is enabled, and the
logo is overridden by a custom theme. In that scenario, the logo url becomes
/static/mytheme/images/logo.png. But the MFEs do no know that the "mytheme"
theme is enabled. To resolve this issue, we introduce here a view, at the
"/theming/asset/" url, that redirects to the corresponding asset in the
theme that is currently enabled. Thus, MFEs only have to set
LOGO_URL=http://lmshost/theming/asset/images/logo.pngto point to the themedlogo.
Related issue: overhangio/tutor-mfe#25
This is a cherry-pick of the following PR: https://github.com/edx/edx-platform/pull/29461