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: [FC-0044] Course unit - Edit iframe modal window #35777

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Nov 5, 2024

🚨 Dependencies:

Description

This PR adds logic to support the functionality of editing xblocks via the legacy modal editing window.

Useful information to include:

  • Communication between the Backbone.js and the React app is done via post messages.
  • xBlock resources (CSS, JS files) are passed to the legacy modal edit window template.
  • Added some styles for xblock legacy modal content.

Supporting information

The next PR will be adding post messages for the tagging functionality.

Testing instructions

Please provide detailed step-by-step instructions for testing this change.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • If your database migration can't be rolled back easily.

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

openedx-webhooks commented Nov 5, 2024

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.


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.

@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as draft November 5, 2024 15:34
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/advanced_blocks_edit_and_move_modals branch 2 times, most recently from b64202e to 0e6e817 Compare November 5, 2024 18:27
@PKulkoRaccoonGang PKulkoRaccoonGang self-assigned this Nov 5, 2024
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/advanced_blocks_edit_and_move_modals branch from 8a6b032 to 74ac804 Compare November 6, 2024 17:40
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/advanced_blocks_edit_and_move_modals branch from 00886d4 to efccc8a Compare February 13, 2025 06:34
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/advanced_blocks_edit_and_move_modals branch from efccc8a to 362e883 Compare February 13, 2025 06:46
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 14, 2025
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

I don't love the fact we need so many CSS fixes in cms/static/sass/course-unit-mfe-iframe-bundle.scss, but I figure this is just part doing business with this code. (I suspect the existing XBlock editors are making bad assumptions about the surrounding styles to begin with.)

I also have no way to test the Hotjar stuff, so we'll just deal with it if issues arise down the line.

And finally, as before I'm not going to block this from merging, but I was able to get more details in the y-scrolling issue identified earlier. When you create a block for the first time and save it, the y position is not changed to find it after loading. This is not observed when you edit a block after it already exists, in which case the scroll happens correctly. If this is confirmed to be a regression, we should fix it in future PRs.

@arbrandes arbrandes merged commit 0319d62 into openedx:master Feb 20, 2025
49 checks passed
@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.

@PKulkoRaccoonGang
Copy link
Contributor Author

PKulkoRaccoonGang commented Feb 21, 2025

I don't love the fact we need so many CSS fixes in cms/static/sass/course-unit-mfe-iframe-bundle.scss, but I figure this is just part doing business with this code. (I suspect the existing XBlock editors are making bad assumptions about the surrounding styles to begin with.)

Yes, you are right. Since the styling of different xblocks can be implemented differently (most styles do not rely on Paragon), the course-unit-mfe-iframe-bundle.scss file was created to improve the UI/UX when working with modal editing windows.

And finally, as before I'm not going to block this from merging, but I was able to get more details in the y-scrolling issue identified openedx/frontend-app-authoring#1544 (review). When you create a block for the first time and save it, the y position is not changed to find it after loading. This is not observed when you edit a block after it already exists, in which case the scroll happens correctly. If this is confirmed to be a regression, we should fix it in future PRs.

Thanks, I remember about it, I will fix it in the next PR

gabrielC1409 added a commit to aulasneo/edx-platform that referenced this pull request Feb 21, 2025
…to send to edx-submission

test: Adjust styles

feat: course unit - edit iframe modal window (openedx#35777)

Adds logic to support the functionality of editing xblocks via the legacy modal editing window.

docs: fixing make docs command. (openedx#36280)

* docs: fixing make docs command.

fix: import authoring filter from content_authoring instead (openedx#36109)

Correctly name authoring subdomain according to DDD docs: https://openedx.atlassian.net/wiki/spaces/AC/pages/663224968/edX+DDD+Bounded+Contexts

fix: ADR document update for change from Xqueue to edx-submission
gabrielC1409 added a commit to aulasneo/edx-platform that referenced this pull request Feb 21, 2025
…to send to edx-submission

test: Adjust styles

feat: course unit - edit iframe modal window (openedx#35777)

Adds logic to support the functionality of editing xblocks via the legacy modal editing window.

docs: fixing make docs command. (openedx#36280)

* docs: fixing make docs command.

fix: import authoring filter from content_authoring instead (openedx#36109)

Correctly name authoring subdomain according to DDD docs: https://openedx.atlassian.net/wiki/spaces/AC/pages/663224968/edX+DDD+Bounded+Contexts

fix: ADR document update for change from Xqueue to edx-submission
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: Done
Development

Successfully merging this pull request may close these issues.

7 participants