Skip to content
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

fix: apply getPath to PUBLIC_PATH to allow use with CDN #346

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dcoa
Copy link
Contributor

@dcoa dcoa commented Aug 15, 2024

Description

When ORA is configured to be used with CDN the locationId is unresolved because PUBLIC_PATH is not fully matched.

image

The API returns 404 because the location has /ora-grading/.

How to replicate

  1. Set the public path to a URL, e.g. ENV PUBLIC_PATH='http://apps.local.edly.io/ora-grading/'
  2. Load the ORA-Grading MFE
  3. Check the request.

[OPTIONAL] Proposal

I was thinking that it might be better to resolve this on the frontend platform, I mean, use getPath to parse the PUBLIC_PATH in the config class, in this way all the MFEs that use that variable don't need to use parse it.

What do you think @arbrandes (as reviewer on the fronted platform implementation)?

@openedx-webhooks
Copy link

openedx-webhooks commented Aug 15, 2024

Thanks for the pull request, @dcoa!

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.

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

Who will review my changes?

This repository is currently maintained by @codewithemad. 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:

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 15, 2024
Copy link

codecov bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4581cf8) to head (7cf788f).

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #346   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          109       109           
  Lines         1085      1086    +1     
  Branches       166       166           
=========================================
+ Hits          1085      1086    +1     

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

@dcoa
Copy link
Contributor Author

dcoa commented Sep 17, 2024

Hi @arbrandes, have you had time to check this small fix?

C.C. @mphilbrick211

Copy link

@MaferMazu MaferMazu left a comment

Choose a reason for hiding this comment

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

Thanks for this PR @dcoa. This change looks good to me ✨

Screenshots

I tried this PR and here is the before and after using your instructions to test:

Before
Screenshot from 2024-10-15 14-28-34-edited
After

Screenshot from 2024-10-15 14-29-57-edited

@MaferMazu
Copy link

@arbrandes, could you help us with a review?

@dcoa
Copy link
Contributor Author

dcoa commented Nov 18, 2024

@CodeWithEmad, could you please have a look in this PR?

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
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

3 participants