Skip to content

fix: ensure iframe visibility tracking is triggered on load #1777

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Agrendalath
Copy link
Member

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

The previous implementation 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 content loads.
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 6, 2025
@openedx-webhooks
Copy link

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:

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 Aug 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.83%. Comparing base (e6f7588) to head (448bd20).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1777   +/-   ##
=======================================
  Coverage   90.83%   90.83%           
=======================================
  Files         344      344           
  Lines        5792     5794    +2     
  Branches     1372     1371    -1     
=======================================
+ Hits         5261     5263    +2     
  Misses        512      512           
  Partials       19       19           

☔ 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
Copy link

itsjeyd commented Aug 8, 2025

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

@itsjeyd itsjeyd moved this from Needs Triage to Waiting on Author in Contributions Aug 8, 2025
@Agrendalath
Copy link
Member Author

@itsjeyd, this one is ready for upstream review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). 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.

3 participants