Skip to content

fix: create the brand fallback for {} PARAGON_THEME_URLS #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

dcoa
Copy link
Contributor

@dcoa dcoa commented Mar 31, 2025

Description:
If the brand package is installed with a compatible version of design tokens and define PARAGON_THEMES_URLS={} to use the local files, this one is not creating the corresponding urls - only the Paragon default ones. This PR aims to add the logic to permit the creation of those urls.

image

I added some improvements in the test file based on the comments of the original PR #689 (comment)

Merge checklist:

  • Consider running your code modifications in the included example app within frontend-platform. This can be done by running npm start and opening http://localhost:8080.
  • Consider testing your code modifications in another local micro-frontend using local aliases configured via the module.config.js file in frontend-build.
  • Verify your commit title/body conforms to the conventional commits format (e.g., fix, feat) and is appropriate for your code change. Consider whether your code is a breaking change, and modify your commit accordingly.

Post merge:

  • After the build finishes for the merged commit, verify the new release has been pushed to NPM.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 31, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @dcoa!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.


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:

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.

Copy link

codecov bot commented Mar 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.78%. Comparing base (e0656d1) to head (b333419).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #785      +/-   ##
==========================================
+ Coverage   86.71%   86.78%   +0.06%     
==========================================
  Files          48       48              
  Lines        1393     1400       +7     
  Branches      293      297       +4     
==========================================
+ Hits         1208     1215       +7     
  Misses        172      172              
  Partials       13       13              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dcoa dcoa changed the title fix: allow to create the brand fallback for {} PARAGON_THEME_URLS fix: create the brand fallback for {} PARAGON_THEME_URLS Mar 31, 2025
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Left a small comment with a clarifying question, but it's definitely non-blocking.

Comment on lines +105 to +107
const localParagonCoreUrl = PARAGON_THEME?.paragon?.themeUrls?.core;
const localParagonThemeVariants = PARAGON_THEME?.paragon?.themeUrls?.variants;
const localParagonDefaultThemeVariants = PARAGON_THEME?.paragon?.themeUrls?.defaults;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to make sure I'm understanding this:

  • Before this we were assuming we had PARAGON_THEME but not assuming we had PARAGON_THEME.paragon
  • With this we are not assuming we have PARAGON_THEME

This is to handle PARAGON_THEME being undefined (as it is with the test change) correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to handle PARAGON_THEME being undefined (as it is with the test change) correct?

Yes, it is

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Apr 1, 2025
@brian-smith-tcril brian-smith-tcril merged commit 455c45e into openedx:master Apr 2, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Apr 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants