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

chore: iframe rendering optimization #1544

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

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Dec 4, 2024

🚨 Dependencies:

Description

This PR provides iframe reload optimizations for various xblock related actions. Added some improvements related to scrolling to the current xblock. Fixed behavior of the xblock action dropdown list.

Testing instructions

  1. Open New Course Unit page.
  2. When duplicating a block, a scroll to a new copy of the block occurs.
  3. Delete, duplicate, drag xblock - a full iframe reboot should not occur.
  4. Open a new xblock editor, save the changes - after returning to the course unit page, the page should scroll to the xblock for which the changes were made.
Screen.Recording.2025-01-20.at.9.21.47.AM.mov

Other information

Improvements to the editing modals and tagging will be added in future PRs.

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/raccoongang/edx-platform.git
EDX_PLATFORM_VERSION: Peter_Kulko/rendering-optimization

TUTOR_GROVE_NEW_MFES:
  authoring:
    port: 18000
    repository: https://github.com/raccoongang/frontend-app-course-authoring.git
    version: Peter_Kulko/rendering-optimization

TUTOR_GROVE_WAFFLE_FLAGS:
  - name: contentstore.new_studio_mfe.use_new_unit_page
    everyone: true

TUTOR_GROVE_MFE_LMS_COMMON_SETTINGS:
  MFE_CONFIG:
    ENABLE_UNIT_PAGE: true

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

openedx-webhooks commented Dec 4, 2024

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/2u-tnl.

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.

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

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

Project coverage is 93.30%. Comparing base (13b2ed5) to head (675242b).

Files with missing lines Patch % Lines
src/course-unit/sidebar/PublishControls.jsx 50.00% 1 Missing ⚠️
src/course-unit/xblock-container-iframe/index.tsx 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1544      +/-   ##
==========================================
+ Coverage   93.25%   93.30%   +0.05%     
==========================================
  Files        1100     1100              
  Lines       21794    21791       -3     
  Branches     4702     4718      +16     
==========================================
+ Hits        20323    20333      +10     
+ Misses       1399     1387      -12     
+ Partials       72       71       -1     

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

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/rendering-optimization branch 3 times, most recently from 9c320e4 to f290f99 Compare January 16, 2025 11:55
refactor: corrected scroll to target xblock

refactor: fixed scroll behavior to xblock element

refactor: after rebase

refactor: fixed tests

refactor: updated tests
@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/rendering-optimization branch from f290f99 to 4168e54 Compare January 16, 2025 12:33
@PKulkoRaccoonGang PKulkoRaccoonGang added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Jan 16, 2025
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as ready for review January 20, 2025 07:13
@PKulkoRaccoonGang PKulkoRaccoonGang requested a review from a team as a code owner January 20, 2025 07:13
@@ -1,6 +1,7 @@
.DS_Store
.eslintcache
.idea
.run
Copy link
Contributor

Choose a reason for hiding this comment

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

[question] Do we need to extend the .gitignore with this directory?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems to me that if we already have a .idea folder that is created by the development environment, why not add .run too?

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/rendering-optimization branch from b0c2570 to b0faf3f Compare January 22, 2025 09:50
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR 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