feat: [FC-0070] listen to xblock interaction events #1431

PKulkoRaccoonGang · 2024-10-23T16:46:38Z

🚨 Dependencies:

Xblock interaction events

🔗 Edx-platform PR

Description

This PR includes changes to the CourseUnit component and the functionality of interaction between xblocks in the iframe and the react page.

The following events have been processed:

delete event
Manage Access event (opening and closing a modal window)
edit event for new xblock React editors
clipboard events
duplicate event

Testing instructions

Screen.Recording.2024-11-15.at.15.52.27.mov

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/raccoongang/edx-platform.git
EDX_PLATFORM_VERSION: Peter_Kulko/listen-to-xblock-interaction-events

TUTOR_GROVE_NEW_MFES:
  authoring:
    port: 18000
    repository: https://github.com/raccoongang/frontend-app-course-authoring.git
    version: Peter_Kulko/xblock-interaction-events

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 · 2024-10-23T16:46:43Z

Thanks for the pull request, @PKulkoRaccoonGang!

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.

codecov · 2024-10-25T09:53:22Z

Codecov Report

Attention: Patch coverage is 94.91525% with 6 lines in your changes missing coverage. Please review.

Project coverage is 93.09%. Comparing base (55fe87a) to head (c8382eb).
Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
src/course-unit/xblock-container-iframe/index.tsx	90.16%	5 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1431      +/-   ##
==========================================
+ Coverage   92.91%   93.09%   +0.17%     
==========================================
  Files        1065     1079      +14     
  Lines       20979    21175     +196     
  Branches     4537     4554      +17     
==========================================
+ Hits        19493    19712     +219     
+ Misses       1419     1391      -28     
- Partials       67       72       +5

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

open-craft-grove · 2024-10-29T03:32:17Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2024-10-29T04:53:14Z

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

open-craft-grove · 2024-10-29T06:43:25Z

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

open-craft-grove · 2024-11-10T13:48:37Z

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

open-craft-grove · 2024-11-15T12:09:41Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

PKulkoRaccoonGang · 2024-11-15T14:14:11Z

ℹ️ [inform]: In the next PRs we will move away from receiving updated data via iframe reloading.

open-craft-grove · 2024-11-18T08:34:29Z

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

open-craft-grove · 2024-11-22T11:51:24Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2024-11-22T12:08:04Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2024-11-22T12:51:11Z

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

PKulkoRaccoonGang · 2024-11-25T09:28:06Z

[inform]: The following PRs will add:

tagging functionality
modal editing windows (legacy)
optimization of iframe reloading during changes on the page, some improvements related to scrolling to the current xblock, behavior of the xblock action dropdown list
chore: iframe rendering optimization #1544
chore: iframe rendering optimization edx-platform#35959

PKulkoRaccoonGang · 2024-11-25T09:30:24Z

src/course-unit/data/thunk.js

@@ -249,12 +246,7 @@ export function duplicateUnitItemQuery(itemId, xblockId) {
    dispatch(showProcessingNotification(NOTIFICATION_MESSAGES.duplicating));

    try {
-      const { locator } = await duplicateUnitItem(itemId, xblockId);
-      const newCourseVerticalChildren = await getCourseVerticalChildren(itemId);
-      dispatch(duplicateXBlock({


[inform]: since we use legacy functionality to store xblock data, in the current implementation it makes sense to use thunks exclusively for working with the backend API, without storing data from the Redux store

PKulkoRaccoonGang · 2024-11-25T09:31:28Z

src/course-unit/header-title/HeaderTitle.jsx

+    // to ensure the iframe content is properly refreshed.
+    setTimeout(() => {
+      sendMessageToIframe(messageTypes.refreshXBlock, null);
+    }, 1000);


[inform]: such delays will be removed after optimization of updating content inside the iframe, via the backbone.js

PKulkoRaccoonGang · 2024-11-25T09:33:20Z

src/course-unit/xblock-container-iframe/index.tsx

+    setTimeout(() => {
+      sendMessageToIframe(messageTypes.refreshXBlock, null);
+    }, 1000);
+  }, [sendMessageToIframe]);


[inform]: we plan to abandon such reboots after implementing the tree comparison algorithm on the backbone.js side

What would that look like? I generally think we need to try to dramatically reduce the amount of code we have on the backbone side, not add major new functionality to it.

We assumed there might be a comparison algorithm that compares the response containing xblocks information with the current backbone xblocks model. However, this idea turned out to be incorrect since we do not have separate models for xblocks on the backbone side. At the moment, a draft of a working solution is presented in these draft PRs.

edx-platform

frontend-app-authoring

open-craft-grove · 2024-11-25T10:03:10Z

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

open-craft-grove · 2024-11-25T11:52:21Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2024-11-25T12:57:38Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

bradenmacdonald · 2024-11-26T23:33:29Z

src/constants.js

@@ -76,3 +76,7 @@ export const REGEX_RULES = {
  specialCharsRule: /^[a-zA-Z0-9_\-.'*~\s]+$/,
  noSpaceRule: /^\S*$/,
 };
+
+export const IFRAME_FEATURE_POLICY = (
+  'microphone *; camera *; midi *; geolocation *; encrypted-media *, clipboard-write *'


I mentioned this on another PR, but this contains a typo: openedx/frontend-app-learning#1500

[inform] Implemented in follow-up commit: ea4da9f#diff-8e3b187293d8e7902d08eff3c650466860fe527b0c7da8ec32c1ee4a450f97c5R81

bradenmacdonald · 2024-11-26T23:35:04Z

src/course-unit/xblock-container-iframe/index.tsx

+    setTimeout(() => {
+      sendMessageToIframe(messageTypes.refreshXBlock, null);
+    }, 1000);
+  }, [sendMessageToIframe]);


What would that look like? I generally think we need to try to dramatically reduce the amount of code we have on the backbone side, not add major new functionality to it.

bradenmacdonald · 2024-11-26T23:36:01Z

src/course-unit/xblock-container-iframe/index.tsx

+  const [isConfigureModalOpen, openConfigureModal, closeConfigureModal] = useToggle(false);
+  const { setIframeRef, sendMessageToIframe } = useIframe();
+  const [currentXBlockId, setCurrentXBlockId] = useState<string | null>(null);
+  const [currentXBlockData, setCurrentXBlockData] = useState<any>({});


Please specify an actual type, not any.

What is the "current XBlock" ?

[inform] Implemented in follow-up commit: ea4da9f#diff-b3b994409f1cdaa22d4d3c9cdba42318405a2bcaf82c1f91056eca6443f7448aR39

bradenmacdonald · 2024-11-26T23:48:14Z

src/course-unit/xblock-container-iframe/index.tsx

+    return () => {
+      window.removeEventListener('message', handleMessage);
+    };
+  }, [dispatch, blockId, courseVerticalChildren, currentXBlockId, currentXBlockData]);


Complex objects like courseVerticalChildren and currentXBlockData sometimes cause additional runs of the effect, because they're compared by reference and not by value. That may be OK in this case but it's not ideal.

This is also missing dependencies like handleDuplicateXBlock, handleRefetchXBlocks, etc. which are also changing.

Since currentXBlockData is React state, I would personally just fetch it inside handleDuplicateXBlock (const handleDuplicateXBlock = useCallback(() => { /* do something with currentXBlockData */ }, [currentXBlockData]);) and then you can simplify this so it's just [messageTypes.duplicateXBlock]: () => handleDuplicateXBlock and only depends on handleDuplicateXBlock, not directly depending on currentXBlockData

But as I mentioned on the other PR, I think it would be much cleaner to pass in the usage key as part of the event payload, and then you don't need currentXBlock[Id|Data] at all, and you can simplify a lot of these, as well as removing most of the dependencies for the useEffect and useCallback hooks, which will improve performance and reduce re-rendering a lot.

Yes, thanks. I like the idea of getting the xblock id via payload. I added this feature + did some refactoring, please take a look.
ea4da9f

open-craft-grove · 2024-11-27T06:39:38Z

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

open-craft-grove · 2024-11-28T03:46:36Z

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

bradenmacdonald

Thanks for that change, @PKulkoRaccoonGang. I think that's much cleaner.
I haven't tested this again but I'm happy with how the code is looking. Thanks for all the new Typescript typing 💯

src/course-unit/constants.js

open-craft-grove · 2024-12-04T10:48:32Z

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

PKulkoRaccoonGang requested a review from a team as a code owner October 23, 2024 16:46

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 23, 2024

PKulkoRaccoonGang marked this pull request as draft October 23, 2024 16:46

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 23, 2024

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch from 42da735 to cc25c40 Compare October 24, 2024 16:56

PKulkoRaccoonGang added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Oct 24, 2024

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch 4 times, most recently from 89ba553 to d9da128 Compare October 25, 2024 09:42

PKulkoRaccoonGang added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Oct 25, 2024

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch 2 times, most recently from 0c8c37e to 54c22f2 Compare November 15, 2024 11:25

PKulkoRaccoonGang self-assigned this Nov 15, 2024

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch 2 times, most recently from b34f1f5 to 9c498fd Compare November 22, 2024 11:50

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch from 9c498fd to a18a2e9 Compare November 22, 2024 12:00

PKulkoRaccoonGang added 2 commits November 25, 2024 11:20

refactor: updated tests

2e4cef3

refactor: some refactoring

1d9ac29

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch from 9a07af9 to 1d9ac29 Compare November 25, 2024 09:24

PKulkoRaccoonGang commented Nov 25, 2024

View reviewed changes

PKulkoRaccoonGang marked this pull request as ready for review November 25, 2024 09:37

PKulkoRaccoonGang requested a review from arbrandes November 25, 2024 09:37

PKulkoRaccoonGang mentioned this pull request Nov 25, 2024

feat: Listen to xBlock interaction events openedx/edx-platform#35694

Open

refactor: added some tests

310421d

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch from 9f2796e to 310421d Compare November 25, 2024 12:31

PKulkoRaccoonGang requested review from bradenmacdonald and ihor-romaniuk November 26, 2024 08:27

bradenmacdonald reviewed Nov 26, 2024

View reviewed changes

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch from 2261a51 to 4c2d5bf Compare November 27, 2024 19:00

refactor: after review

ea4da9f

PKulkoRaccoonGang force-pushed the Peter_Kulko/xblock-interaction-events branch from 4c2d5bf to ea4da9f Compare November 27, 2024 19:04

PKulkoRaccoonGang requested a review from bradenmacdonald November 28, 2024 09:05

bradenmacdonald approved these changes Nov 28, 2024

View reviewed changes

src/course-unit/constants.js Outdated Show resolved Hide resolved

src/course-unit/constants.js Outdated Show resolved Hide resolved

refactor: removed unused constants

c8382eb

This was referenced Dec 9, 2024

chore: iframe rendering optimization #1544

Draft

chore: iframe rendering optimization openedx/edx-platform#35959

Draft

Problem Bank "Add Components" modal is way too long in unit page iframe. #1502

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [FC-0070] listen to xblock interaction events #1431

feat: [FC-0070] listen to xblock interaction events #1431

PKulkoRaccoonGang commented Oct 23, 2024 •

edited

Loading

openedx-webhooks commented Oct 23, 2024 •

edited

Loading

codecov bot commented Oct 25, 2024 •

edited

Loading

open-craft-grove commented Oct 29, 2024

open-craft-grove commented Oct 29, 2024

open-craft-grove commented Oct 29, 2024

open-craft-grove commented Nov 10, 2024

open-craft-grove commented Nov 15, 2024

PKulkoRaccoonGang commented Nov 15, 2024

open-craft-grove commented Nov 18, 2024

open-craft-grove commented Nov 22, 2024

open-craft-grove commented Nov 22, 2024

open-craft-grove commented Nov 22, 2024

PKulkoRaccoonGang commented Nov 25, 2024 •

edited

Loading

PKulkoRaccoonGang Nov 25, 2024

PKulkoRaccoonGang Nov 25, 2024

PKulkoRaccoonGang Nov 25, 2024

bradenmacdonald Nov 26, 2024

PKulkoRaccoonGang Dec 4, 2024

open-craft-grove commented Nov 25, 2024

open-craft-grove commented Nov 25, 2024

open-craft-grove commented Nov 25, 2024

bradenmacdonald Nov 26, 2024

PKulkoRaccoonGang Nov 28, 2024

bradenmacdonald Nov 26, 2024

bradenmacdonald Nov 26, 2024

PKulkoRaccoonGang Nov 28, 2024

bradenmacdonald Nov 26, 2024

PKulkoRaccoonGang Nov 28, 2024

open-craft-grove commented Nov 27, 2024

open-craft-grove commented Nov 28, 2024

bradenmacdonald left a comment

open-craft-grove commented Dec 4, 2024

feat: [FC-0070] listen to xblock interaction events #1431

Are you sure you want to change the base?

feat: [FC-0070] listen to xblock interaction events #1431

Conversation

PKulkoRaccoonGang commented Oct 23, 2024 • edited Loading

Description

Testing instructions

openedx-webhooks commented Oct 23, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

codecov bot commented Oct 25, 2024 • edited Loading

Codecov Report

open-craft-grove commented Oct 29, 2024

open-craft-grove commented Oct 29, 2024

open-craft-grove commented Oct 29, 2024

open-craft-grove commented Nov 10, 2024

open-craft-grove commented Nov 15, 2024

PKulkoRaccoonGang commented Nov 15, 2024

open-craft-grove commented Nov 18, 2024

open-craft-grove commented Nov 22, 2024

open-craft-grove commented Nov 22, 2024

open-craft-grove commented Nov 22, 2024

PKulkoRaccoonGang commented Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

open-craft-grove commented Nov 25, 2024

open-craft-grove commented Nov 25, 2024

open-craft-grove commented Nov 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

open-craft-grove commented Nov 27, 2024

open-craft-grove commented Nov 28, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

open-craft-grove commented Dec 4, 2024

PKulkoRaccoonGang commented Oct 23, 2024 •

edited

Loading

openedx-webhooks commented Oct 23, 2024 •

edited

Loading

codecov bot commented Oct 25, 2024 •

edited

Loading

PKulkoRaccoonGang commented Nov 25, 2024 •

edited

Loading