feat!: Make MFE scroll content instead of iFrame when scrollToXblock is called

[saraburns1]

Description

Fixes openedx/openedx-aspects#316 by scrolling window to the xblock location instead of scrolling within the iFrame

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Test with openedx/frontend-app-authoring#2363
Need to enable Aspects in-context metrics (https://github.com/openedx/frontend-plugin-aspects)

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

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.

[brian-smith-tcril]

I think before we land this we should:

• Confirm frontend-app-authoring is the only place this is used. This is moving the responsibility of actually scrolling the content into view over to the MFE, so we should make sure any MFEs that are currently relying on this functionality are updated to handle the new message being sent.
• Land the frontend-app-authoring PR - if this PR lands before that does then we'll lose the scrolling functionality until that one lands.

[saraburns1]

@brian-smith-tcril - the only other place scrollToXblock is used is in frontend-plugin-aspects which is installed within frontend-app-authoring for the in-context metrics in studio so I think we're good

[brian-smith-tcril]

@brian-smith-tcril - the only other place scrollToXblock is used is in frontend-plugin-aspects which is installed within frontend-app-authoring for the in-context metrics in studio so I think we're good

Sounds good! This is technically a breaking change so we should probably make sure the commit message communicates that.

[brian-smith-tcril]

@saraburns1 I created the fast-track DEPR ticket, please feel free to edit it if there's anything you'd like to add/update!

[farhaanbukhsh]

@brian-smith-tcril @saraburns1 scrollToXBlocks was introduced during the landing of in-context metrics, so I assume it's not being used in many places. However, it is always better to be safe than sorry. Thanks a lot for the DEPR ticket.

Also please let me know if I can merge this since I tested this and it is working 😄

[farhaanbukhsh]

👍

• ✅ I tested this with incontext-metrics and it's working fine 👍🏾
• ✅ I read through the code
• ❌ I checked for accessibility issues
• ❌ Includes documentation

[brian-smith-tcril]

@farhaanbukhsh the DEPR ticket is a "fast-track" DEPR, and is marked as "Transition Already Unblocked."

Feel free to merge this!

[farhaanbukhsh]

Thanks @brian-smith-tcril and @saraburns1 for the work. 🚀

[edx-pipeline-bot]

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

[edx-pipeline-bot]

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