Skip to content

Conversation

@jacobo-dominguez-wgu
Copy link
Contributor

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Oct 28, 2025

Description

It solves the following issues on example app:

  • PageRoute import not found
  • Missing env variables
  • Replaces deprecated ReactDOM render

Also upgrades the version for @edx/frontend-platform on example app.

closes #3838.

Warning

Due to some code conflicts I had to regenerate the package-lock.json file.
I am not sure if this may cause delay on this pr due to node 24 migration and related with the comment here #3687 and this ticket #3854

How to test it

A tutor plugin is required to patch CORS settings with the example app url:

  1. Create a new file (i.e. paragon-example-app.py) in your tutor plugins folder (tutor plugins printroot to get the path)
  2. Edit the file with the following code:
from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
  (
    "openedx-lms-development-settings",
    """
CORS_ORIGIN_WHITELIST.append("http://localhost:8080")
LOGIN_REDIRECT_WHITELIST.append("http://localhost:8080")
CSRF_TRUSTED_ORIGINS.append("http://localhost:8080")
    """
    )
)
  1. Enable the plugin: tutor plugins enable paragon-example-app
  2. Save configs and restart: tutor config save && tutor dev restart

Then run the example app:

  1. npm install
  2. npm run example:start
  3. Go to http://localhost:8080/

Deploy Preview

image

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

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

openedx-webhooks commented Oct 28, 2025

Thanks for the pull request, @jacobo-dominguez-wgu!

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

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.

Details
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.

@netlify
Copy link

netlify bot commented Oct 28, 2025

Deploy Preview for paragon-openedx-v23 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 1117233
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/69383c63b1967e00088dc152
😎 Deploy Preview https://deploy-preview-3956--paragon-openedx-v23.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jacobo-dominguez-wgu jacobo-dominguez-wgu marked this pull request as draft October 28, 2025 21:49
@jacobo-dominguez-wgu jacobo-dominguez-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Oct 28, 2025
@codecov
Copy link

codecov bot commented Oct 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.37%. Comparing base (cce7beb) to head (1117233).
⚠️ Report is 16 commits behind head on release-23.x.

Additional details and impacted files
@@              Coverage Diff              @@
##           release-23.x    #3956   +/-   ##
=============================================
  Coverage         94.37%   94.37%           
=============================================
  Files               242      242           
  Lines              4282     4287    +5     
  Branches           1016     1017    +1     
=============================================
+ Hits               4041     4046    +5     
+ Misses              237      233    -4     
- Partials              4        8    +4     

☔ 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.

@jacobo-dominguez-wgu jacobo-dominguez-wgu marked this pull request as ready for review October 29, 2025 17:18
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Oct 29, 2025
@jacobo-dominguez-wgu
Copy link
Contributor Author

Hi @PKulkoRaccoonGang Can I get another review here? CC @brian-smith-tcril

@jacobo-dominguez-wgu jacobo-dominguez-wgu moved this from In Eng Review to Ready for Review in Contributions Dec 2, 2025
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

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

Sorry for the delay. I tried running the example app from this PR by following the steps in the "How to test" it section, but I encountered the following errors. I also tried logging in through my locally running Tutor Open edX instance, but the errors still persist. Is there anything else I need to set up before following the "How to test" it instructions?

Access to XMLHttpRequest at 'http://local.openedx.io:8000/login_refresh' from origin 'http://localhost:8080' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

POST http://local.openedx.io:8000/login_refresh net::ERR_FAILED 401 (Unauthorized)

@jacobo-dominguez-wgu
Copy link
Contributor Author

Sorry for the delay. I tried running the example app from this PR by following the steps in the "How to test" it section, but I encountered the following errors. I also tried logging in through my locally running Tutor Open edX instance, but the errors still persist. Is there anything else I need to set up before following the "How to test" it instructions?

Access to XMLHttpRequest at 'http://local.openedx.io:8000/login_refresh' from origin 'http://localhost:8080' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

POST http://local.openedx.io:8000/login_refresh net::ERR_FAILED 401 (Unauthorized)

@PKulkoRaccoonGang It is also needed to patch CORS settings to bypass example app url. I updated the how to test it section with the instructions to create a tutor plugin to do that, try that and lets see if that fixes your errors.

Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

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

Thank you for this PR! I tested it locally, and everything works as expected. I did notice some styling issues in the example app, but since this PR is specifically aimed at resolving the routing problems, it seems reasonable to handle the styling fixes in a separate issue (#4032).

I’ve added a minor comment about updating the documentation in the "Steps to install the example app" section. I believe making this update would simplify running the example app going forward 💯


Steps to install the `example` app.

1. `npm install` to install dependencies.
Copy link
Contributor

Choose a reason for hiding this comment

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

Given the instructions outlined in the "How to test it" section of this PR, would it make sense to update the "Steps to install the example app" section too? Since devstack has been deprecated, it seems worthwhile to update the documentation on how to run the example app.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated the readme with the instructions.

@mphilbrick211 mphilbrick211 moved this from Ready for Review to In Eng Review in Contributions Dec 11, 2025
@jacobo-dominguez-wgu
Copy link
Contributor Author

@PKulkoRaccoonGang I have addressed your comments, can you do another review?

@openedx-webhooks openedx-webhooks added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Dec 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

PageRoute import not found in @edx/frontend-platform/react in example app

3 participants