feat: MFE runtime configuration API

[PKulkoRaccoonGang]

Description

This pull request provides a sandbox for testing MFE runtime configurations.

Example config:

{
    "MFE_CONFIG_OVERRIDES": {
        "discussions": {
            "PARAGON_THEME_URLS": {
                "core": {
                    "urls": {
                        "default": "https://cdn.jsdelivr.net/npm/@openedx/paragon@$paragonVersion/dist/core.min.css"
                    }
                },
                "defaults": {
                    "light": "light",
                },
                "variants": {
                    "light": {
                        "urls": {
                            "default": "https://cdn.jsdelivr.net/npm/@openedx/paragon@$paragonVersion/dist/light.min.css"
                        }
                    }
                }
            }
        }
    }
}

Info

• Theming support with Paragon
• Migrating MFEs to Paragon design tokens and CSS variables

Related PRs

• [BD-46] feat: added support Paragon design tokens frontend-component-footer#303
• [BD-46] feat: added support Paragon design tokens frontend-component-header#351
• feat: Using locally installed Paragon CSS #723
• feat: adds support for loading external theme CSS for MFEs  frontend-platform#689
• feat: add ParagonWebpackPlugin to support design tokens frontend-build#546
• testing: Using Paragon CSS External Hosting (JavaScript-based configuration) #707
• feat: Using locally installed Paragon CSS #723

[openedx-webhooks]

Thanks for the pull request, @PKulkoRaccoonGang!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/edx-infinity. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.88%. Comparing base (422fbf6) to head (56f49c0).
Report is 8 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #724   +/-   ##
=======================================
  Coverage   92.88%   92.88%           
=======================================
  Files         160      160           
  Lines        3329     3329           
  Branches      888      897    +9     
=======================================
  Hits         3092     3092           
+ Misses        219      218    -1     
- Partials       18       19    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[brian-smith-tcril]

I'm not sure where the best place to report this issue is, but when visiting https://app.pr-724-6b242e.sandboxes.opencraft.hosting/discussions/course-v1:openedx+123+2023/posts/66879d5d57bfb4002db05e09 with a small window I noticed a visual bug

Screencast.from.2024-07-05.11-07-00.webm

[dcoa]

I remove the dark mode configuration to load only the Paragon light theme and avoid the reported issue.

C.C @PKulkoRaccoonGang @brian-smith-tcril

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[open-craft-grove]

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

[mphilbrick211]

Hi @PKulkoRaccoonGang - can this be closed, or is it still in progress?

[brian-smith-tcril]

@mphilbrick211 this PR should stay open. The plan is to land it in a new long living branch for design tokens once it is updated to use a published version of Paragon that supports design tokens (which is getting really close!)

[open-craft-grove]

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements