fix(palm): receive XBlock visibility from the Learning MFE #662
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the LMS retrieves the viewport information with
getBoundingClientRect
. However, it doesn't work correctly when the XBlocks are rendered in an iframe because the iframe is automatically resized to its full height.This solves the described problem by sending the visibility status from the Learning MFE to the LMS.
Testing instructions:
COMPLETION_BY_VIEWING_DELAY_MS = 1000
inlms/envs/private.py
for easier testing. The default value is5000
.publish_completion
topublish_completions
inlms/static/completion/js/CompletionOnViewService.js
for easier testing. Otherwise, you will need to create a new XBlock for the next check or manually remove theBlockCompletion
object from the DB to get the API call re-triggered the next time you view it.publish_completion
request is called in both the Learning MFE and the Preview (to check for regressions).publish_completion
request is called when you scroll down to the bottom of each of these blocks (in the Learning MFE and Preview).Private-ref: BB-8826