fix: ensure iframe visibility tracking is triggered on load

[Agrendalath]

The previous implementation (#1491) had a race condition that sometimes prevented XBlocks from being marked as viewed. Users had to scroll or resize the window to trigger visibility tracking instead of having it happen once the content loads.

Description

Testing instructions:

1. (Optional) Set COMPLETION_BY_VIEWING_DELAY_MS = 1000 in lms/envs/private.py for easier testing. The default value is 5000.
2. (Optional) Change publish_completion to publish_completions in lms/static/completion/js/CompletionOnViewService.js for easier testing. Otherwise, you will need to create a new XBlock for the next check or manually remove the BlockCompletion object from the DB to get the API call re-triggered the next time you view it.
3. Use Chrome for the next steps (do not check out this branch yet).
4. Create an HTML block with a single line. Check that the publish_completion request is not called in the Learning MFE.
5. Check out this branch and repeat the previous step. Ensure that the request has been published.

Deadline

"None"

Other information

Private-ref: BB-9602

[openedx-webhooks]

Thanks for the pull request, @Agrendalath!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.83%. Comparing base (af50d5a) to head (136da2b).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1777   +/-   ##
=======================================
  Coverage   90.83%   90.83%           
=======================================
  Files         344      344           
  Lines        5792     5794    +2     
  Branches     1331     1374   +43     
=======================================
+ Hits         5261     5263    +2     
+ Misses        514      512    -2     
- Partials       17       19    +2     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[itsjeyd]

@Agrendalath Are you waiting for an OpenCraft-internal review here or are the changes ready for upstream review?

[Agrendalath]

@itsjeyd, this one is ready for upstream review.

[wgu-jesse-stewart]

@Agrendalath I may be missing something important - I tried reproducing this error and I was unable to get an instance where the Raw HTML block did not call publish_completion. Are there any further setup tests needed to reproduce this bug? Currently on main/master of all branches. Running tutor dev start

[Agrendalath]

@wgu-jesse-stewart , did you use Chrome and checked this with the Network tab already opened (to avoid resizing the viewport) and without scrolling? This happens when no "resize" or "scroll" actions are triggered.

[wgu-jesse-stewart]

Using Chrome. Devtools already open to the network tab. I did another test to be sure I'm not accidentally scrolling and I avoided using the mouse entirely.

I will pull you code and test it as well.

[wgu-jesse-stewart]

I could not reproduce the error, but I have tested that this code works as expected. Nicely done

[itsjeyd]

@Agrendalath

this one is ready for upstream review.

OK, pinging maintainers now.

@openedx/committers-frontend-app-learning This is ready for you.

[farhaanbukhsh]

👍

• ✅ I tested this on devstack
• ✅ I read through the code
• ❌ I checked for accessibility issues
• ❌ Includes documentation

[farhaanbukhsh]

@Agrendalath can you rebase the PR and trigger the tests?

[Agrendalath]

@farhaanbukhsh, sure thing - done.