feat: allowing studio asides for course-authoring MFE

[Anas12091101]

Supporting Information

Issue: Frontend App Course Authoring - Issue #545
EdX Platform PR: EdX Platform - Pull Request #34026

Note: This pull request should be reviewed concurrently with the EdX Platform PR.

Description

The current problem editor page lacks options for configuring aside values of the problem xblock. This pull request addresses this by enabling the asides' studio views in the problem editor.

More information in the EdX Platform PR

Note: Styles are not finalized, and suggestions for improvement are welcome.

Screenshot

How to test locally

• In your local edx-platform, checkout to https://github.com/Anas12091101/edx-platform/tree/MFE-studio-view
• Login to edx-platform.
• In Studio, go to the edX Demo Course. Create a new unit which is a multiple choice problem.
• Configure the rapid response aside for this problem.
• Add the waffle flags to use the course authoring MFE in the studio admin if not already.
• Click the edit tab on the problem xblock which will redirect you to the course authoring MFE if properly configured.
• You can see the rapid response aside being rendered in an iframe as shown in image above.

(Note: The styling of the iframe has not been completed yet. The PR only offers a basic approach to resolve openedx/frontend-app-authoring#545. It should be merged after the edx-platform PR is merged.)

[openedx-webhooks]

Thanks for the pull request, @Anas12091101!

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/2u-tnl. 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.

[mphilbrick211]

Hi @Anas12091101! Thanks so much for this contribution! Please let me know if you have any questions on submitting a CLA form. Thanks!

[pdpinch]

@mphilbrick211 Anas should be covered by the MIT Entity agreement. I don't know if you have access, but I've added him to the list at https://docs.google.com/spreadsheets/d/1HEaYDtoBtN-vvloA5UC-4oAHTVGzWbJWYVzYrEwFT4Y/edit#gid=755274227&range=28:28

[e0d]

I've added him.

[codecov]

Codecov Report

Attention: Patch coverage is 83.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 90.60%. Comparing base (ed051c3) to head (4aa771c).
Report is 86 commits behind head on main.

Files with missing lines	Patch %	Lines
...omponents/EditProblemView/SettingsWidget/index.jsx	50.00%	1 Missing ⚠️
src/editors/data/redux/problem/selectors.js	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #452      +/-   ##
==========================================
+ Coverage   90.51%   90.60%   +0.09%     
==========================================
  Files         227      228       +1     
  Lines        4110     4160      +50     
  Branches      825      842      +17     
==========================================
+ Hits         3720     3769      +49     
- Misses        369      371       +2     
+ Partials       21       20       -1     

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

[pdpinch]

@Anas12091101 please add a section to the PR description with instructions on how to test this. It requires installing an xBlock that uses the asides functionality, right?

[Anas12091101]

@Anas12091101 please add a section to the PR description with instructions on how to test this.

@pdpinch I was testing the functionality to create a screen cast and found some bugs in the functionality due to which the asides are not loading and throwing an error. I will write the testing instructions once I find the solution for this

[pdpinch]

Ok. I'm going to change this to "waiting on author" then.

[Anas12091101]

Ok. I'm going to change this to "waiting on author" then.

I've fixed the problem in the edx-platform PR and have added the test steps in this PR's description

[bradenmacdonald]

@Anas12091101 @pdpinch is this PR still ready to go? We've now moved this code into https://github.com/openedx/frontend-app-course-authoring/ so we'll need you to please re-open this PR against https://github.com/openedx/frontend-app-course-authoring/ if you'd like to continue it. Feel free to reach out to me if you aren't sure how to do that using git and I can help (basically: add your local content-components repo as a remote in course-authoring, then pull the branch and rebase it).

[openedx-webhooks]

@Anas12091101 Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.