Skip to content
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

fix: sidebar completion for completable XBlocks with children #36043

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

Conversation

Agrendalath
Copy link
Member

Description

It is possible to create a completable XBlock with children. An example is the Library Content Block with the MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW feature toggle. The sidebar should use the same mechanism as the BlockCompletionTransformer and the edx-completion library. It means that we should treat:

  1. An aggregator XBlock as completed only when all its children are completed.
  2. A completable XBlock as completed when it is directly marked as completed (without checking the completion of its children).

Testing instructions

  1. Do not check out the branch from this PR.
  2. Set settings.FEATURES['MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW'] = True.
  3. Create a new library with a Problem XBlock.
  4. Create a new subsection with two units - the first with this new library and the second with any other XBlock. Publish these blocks.
  5. Visit the Library Content Block in the LMS. Do not submit the problem - only wait a few seconds for the publish_completion request to be sent (you can check it, e.g., with the Network tab).
  6. Click the button to navigate to the second unit (without refreshing the page). This will trigger the get_completion request, which retrieves the completion data from the completion service (from the edx-completion).
  7. Refresh the page. See that the completion checkmark for the first unit is now gone.
  8. Check out the branch from this PR.
  9. Refresh the page. See that the completion checkmark for the first unit is now displayed correctly.

Deadline

"None"

Private-ref: BB-8469 (temporary)

@Agrendalath Agrendalath self-assigned this Dec 17, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @Agrendalath!

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.

It is possible to create a completable XBlock with children.
An example is the Library Content Block with the
`MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW` feature toggle.
The sidebar should use the same mechanism as the `BlockCompletionTransformer`
and the `edx-completion` library. It means that we should treat:
1. An aggregator XBlock as completed only when all its children are completed.
2. A completable XBlock as completed when it is directly marked as completed
   (without checking the completion of its children).
@Agrendalath Agrendalath force-pushed the agrendalath/sidebar-completion-of-completable-blocks-with-children branch from 2095e35 to ad97ec8 Compare December 17, 2024 23:10
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

3 participants