Skip to content

feat: [FC-0070] Listen to xBlock interaction events - #35694

Merged
arbrandes merged 4 commits into
openedx:masterfrom
raccoongang:Peter_Kulko/listen-to-xblock-interaction-events
Jan 14, 2025
Merged

feat: [FC-0070] Listen to xBlock interaction events#35694
arbrandes merged 4 commits into
openedx:masterfrom
raccoongang:Peter_Kulko/listen-to-xblock-interaction-events

Conversation

@peterkulko

@peterkulko peterkulko commented Oct 22, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

🚨 Dependencies:

Description

This PR introduces several changes to improve the handling of XBlock events and the user interface in the CMS. The most important changes include adding event listeners for message handling, refining the postMessage logic, and updating the CSS for better visual consistency.

Testing instructions

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

@openedx-webhooks

openedx-webhooks commented Oct 22, 2024 •
edited
Loading

Copy link
Copy Markdown

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/wg-maintenance-edx-platform. 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 Oct 22, 2024
@peterkulko
peterkulko marked this pull request as draft October 22, 2024 11:14
@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch 2 times, most recently from e921480 to 7be761c Compare October 24, 2024 16:49
@peterkulko peterkulko self-assigned this Oct 24, 2024
@arbrandes arbrandes mentioned this pull request Nov 1, 2024
Merged
@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch from c1c62b9 to 29add8c Compare November 10, 2024 13:44
peterkulko
peterkulko commented Nov 15, 2024
View reviewed changes
Comment thread cms/static/js/views/pages/container_subviews.js Outdated

tagContentElement.appendChild(tagValueElement);
parentElement.appendChild(tagContentElement);
parentElement?.appendChild(tagContentElement);

@peterkulko peterkulko Nov 15, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

[inform]: This change is temporary and will be removed after this PR #35828 is merged.

@arbrandes arbrandes Nov 22, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

#35828 has merged. Will the conditional be removed?

@peterkulko peterkulko Nov 25, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes 💯

@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch from 6b6fb77 to cae1f67 Compare November 15, 2024 11:52
@peterkulko peterkulko mentioned this pull request Nov 15, 2024
Merged
@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch 2 times, most recently from bd2fc9a to e4925e6 Compare November 18, 2024 07:46
@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch from e4925e6 to 362ab43 Compare November 25, 2024 08:45
@peterkulko
peterkulko marked this pull request as ready for review November 25, 2024 09:37
bradenmacdonald
bradenmacdonald reviewed Nov 26, 2024
View reviewed changes
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js
Comment thread cms/static/js/views/pages/container.js Outdated
Comment thread cms/static/js/views/pages/container.js
bradenmacdonald
bradenmacdonald reviewed Nov 28, 2024
View reviewed changes

@bradenmacdonald bradenmacdonald left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code looks good to me now 👍🏻. Is there someone else who is testing this or do you need me to?

@peterkulko

peterkulko commented Dec 4, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Code looks good to me now 👍🏻. Is there someone else who is testing this or do you need me to?

@bradenmacdonald thanks for taking the time to look at this PR! I think it would be great if @arbrandes took another look.

This was referenced Dec 9, 2024
Merged
Merged
@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch from 8d5b7e3 to a0834a2 Compare December 9, 2024 07:55
@peterkulko
peterkulko force-pushed the Peter_Kulko/listen-to-xblock-interaction-events branch from 42a622d to 023b0d0 Compare December 12, 2024 08:42
@peterkulko peterkulko changed the title feat: Listen to xBlock interaction events feat: [FC-0070] Listen to xBlock interaction events Dec 12, 2024
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 17, 2024
ormsbee
ormsbee approved these changes Jan 12, 2025
View reviewed changes

@ormsbee ormsbee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The code looks good to me, though I also haven't tested. @arbrandes: Do you want to review this before it merges?

arbrandes
arbrandes approved these changes Jan 14, 2025
View reviewed changes

@arbrandes arbrandes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍🏼

@arbrandes
arbrandes merged commit 755bf98 into openedx:master Jan 14, 2025
@edx-pipeline-bot

edx-pipeline-bot commented Jan 14, 2025

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

edx-pipeline-bot commented Jan 14, 2025

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

edx-pipeline-bot commented Jan 14, 2025

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald left review comments
@ormsbee ormsbee ormsbee approved these changes
@arbrandes arbrandes arbrandes approved these changes
@ihor-romaniuk ihor-romaniuk Awaiting requested review from ihor-romaniuk

Assignees

@peterkulko peterkulko

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@peterkulko @openedx-webhooks @edx-pipeline-bot @ormsbee @arbrandes @bradenmacdonald @mphilbrick211