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

feat: add and switch to downstream-only fields [FC-0076] #36158

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Jan 23, 2025

Description

Adds the concept of "downstream-only" fields to the XBlock upstream sync logic.

Downstream-only fields are customizable fields which are set only on the downstream XBlock -- we don't keep track of the upstream field value anywhere on the downstream XBlock. Changes made to these fields in the upstream block are ignored, and if the link to the upstream block is severed, the downstream changes are preserved (not reset back to defaults, like the upstream-tracked customizable fields are).

The list of fields chosen as "downstream-only" are fields related to scoring and grading.

The max_attempts field was previously a customizable field where the upstream value was tracked, but because it is a scoring-related field, it's been converted to a "downstream-only" field.

This change impacts Course Authors using Library content in their courses.

Supporting information

Part of: openedx/frontend-app-authoring#1317
Relates to: openedx/frontend-app-authoring#1601
Private-ref: FAL-3996

Testing instructions

Backend changes are covered by unit tests.

For manual testing instructions, see openedx/frontend-app-authoring#1601

Deadline

None

Downstream-only fields are customizable on the downstream XBlock only --
we don't keep track of the upstream value anywhere on the downstream
XBlock.

So changes to these fields in the upstream block are ignored, and
if the link to the upstream block is severed, they are preserved (not
reset).
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@robrap
Copy link
Contributor

robrap commented Jan 23, 2025

Passing comment:
Updating the title to something like the following would highlight more of the PR description:

feat: add and switch to downstream-only fields

@pomegranited pomegranited changed the title feat: adds downstream-only fields feat: add and switch to downstream-only fields [FC-0076] Jan 24, 2025
@pomegranited pomegranited added the FC Relates to an Axim Funded Contribution project label Jan 24, 2025
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pomegranited Looks good. 👍

  • I tested this: (Verified syncing upstream does not affect downstream only fields)
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@ChrisChV
Copy link
Contributor

Looks good! I will merge this on monday

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for integrating this in so seamlessly with the existing upstream sync concept!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

6 participants