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

feat: Add AdvancedEditors with an iframe [FC-0076] #1568

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Dec 12, 2024

Description

Creates the AdvancedEditor to support editors like Drag and Drop, openresponse, poll, survey, and other advanced editors.

Follow this discovery for next steps.

  • AdvancedEditor created to call studio_view of the block
  • Update LibraryBlock to support any view (and use studio_view in AdvancedEditor)
  • Intercept cancel-clicked message to close the Advanced editor.

Useful information to include:

  • Which edX user roles will this change impact? "Course Author", "Developer".

Supporting information

Testing instructions

  • Use this branch of edx-platform: feat: Changes in xblock_v2 to support studio_view [FC-0076] edx-platform#36029
  • Update LIBRARY_SUPPORTED_BLOCKS="problem,video,html,poll,drag-and-drop-v2,lti_consumer,google-document,survey" in .env.development
  • Go to a library.
  • Create a drag-and-drop component.
  • Open the editor and verify that is rendered. Test the cancel and save buttons
  • Got a a course > Settings > Advanced Settings and in Advanced module list add:
[
    "poll",
    "lti_consumer",
    "survey",
    "google-document"
]
  • Go to a unit an create a poll.
  • Copy the poll and paste it in the library.
  • Open the editor and verify that is rendered. Test the cancel and save buttons
  • Do the same with LTI provider, survey and google document.

Other information

N/A

@ChrisChV ChrisChV requested a review from a team as a code owner December 12, 2024 02:17
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 12, 2024

Thanks for the pull request, @ChrisChV!

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:

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 Dec 12, 2024
@ChrisChV ChrisChV changed the title feat: Add AdvancedEditors with an iframe feat: Add AdvancedEditors with an iframe [FC-0076] Dec 12, 2024
@ChrisChV ChrisChV marked this pull request as draft December 12, 2024 02:17
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 12, 2024
Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.97%. Comparing base (73490a5) to head (091957d).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1568      +/-   ##
==========================================
+ Coverage   92.94%   92.97%   +0.02%     
==========================================
  Files        1073     1076       +3     
  Lines       21098    21206     +108     
  Branches     4479     4483       +4     
==========================================
+ Hits        19610    19716     +106     
- Misses       1422     1424       +2     
  Partials       66       66              

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

@ChrisChV ChrisChV force-pushed the chris/advanced-editors-iframe branch from c547d84 to c0f84ab Compare December 13, 2024 21:14
Copy link
Contributor

@DanielVZ96 DanielVZ96 left a comment

Choose a reason for hiding this comment

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

👍

  • I tested this: Ran the testing instructions
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

4 participants