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

Update CORS allowed headers for compatibility w/ axios-cache-interceptor #35402

Conversation

bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Aug 29, 2024

Summary

Fixes a CORS error seen by developers who run MFEs in dev mode on their host, alongside Tutor.

Description

In openedx/frontend-app-authoring#1209 , the version of axios-cache-interceptor used in the Course Authoring MFE was bumped from v0.28 to v1.6. The new setting cache.cacheTakeover which defaults to true is adding three new headers to the "runtime config" request that happens when the MFE starts up, and this is causing an error for those of us who run the MFE outside of a container.

This exact issue and the suggested fix are described in the linked documentation for cache.cacheTakeover:

cache.cacheTakeover (default true): you need to make sure Cache-Control, Pragma and Expires headers are included into your server’s Access-Control-Allow-Headers CORS configuration.

Supporting information

Discussed on Slack

Alternatives

I could make the changes for both cms and lms; currently I only modified LMS.

I could make the changes in Tutor or only in dev mode; I put them in lms/common

Testing instructions

  1. Make sure course-authoring is bind-mounted so tutor doesn't run it:
    tutor mounts add /path/to/frontend-app-course-authoring
    
  2. Start Tutor but not the MFE: tutor dev start lms cms mfe (we don't start course-authoring)
  3. On your host, run git pull and npm install in the frontend-app-course-authoring folder.
  4. On your host, start the MFE:
    APP_ID=course-authoring PUBLIC_PATH=/course-authoring/ MFE_CONFIG_API_URL='http://localhost:8000/api/mfe_config/v1' npm run start -- --host apps.local.overhang.io
    
    (or apps.local.edly.io if your Tutor instance is not as old as mine is)
  5. Without this fix, you should see a CORE error when trying to access any part of course-authoring. With this fix, it should work.

Deadline

None

See https://axios-cache-interceptor.js.org/config/request-specifics#cache-cachetakeover

cache.cacheTakeover (default true): you need to make sure Cache-Control,
Pragma and Expires headers are included into your server’s
Access-Control-Allow-Headers CORS configuration.
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

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 @openedx/wg-maintenance-edx-platform. 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 29, 2024
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

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

Only question is whether you'd want a unit test to ensure that the change doesn't get unintentionally lost.

@bradenmacdonald
Copy link
Contributor Author

Thanks! I think it's fine for now without a test. If we later realize these headers are really important, we can add them to CMS too and add some tests. For now it only affects a few developers.

@bradenmacdonald bradenmacdonald merged commit bfee53b into openedx:master Aug 30, 2024
49 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/axios-cache-interceptor-compat branch August 30, 2024 18:53
@openedx-webhooks
Copy link

@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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