Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

feat: add graded boolean to xblock json (FC-0033) #27

Merged

Conversation

SoryRawyer
Copy link
Contributor

@SoryRawyer SoryRawyer commented Aug 17, 2023

Description: This PR adds an items graded attribute to the xblock_data_json field and defaults to false if that attribute doesn't exist. This attribute indicates whether the xblock is part of a graded subsection and is a relevant piece of metadata for course problems.

This was discussed in tutor-contrib-aspects issue #292

Testing instructions:

  1. Install this branch as part of tutor-contrib-aspects
  2. Rebuild images via tutor images build openedx --no-cache
  3. Run tutor local do dump-courses-to-clickhouse (possibly with --options "--force" if no courses are pushed)
  4. There should now be a graded attribute for some blocks in the xblock_json_data field in event_sink.course_blocks
  5. If necessary, generate event data by running the LMS locally and clicking through a course page.

Reviewers:

  • tag reviewer
  • tag reviewer

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

Indicates whether the xblock is part of a graded subsection
@openedx-webhooks
Copy link

Thanks for the pull request, @SoryRawyer! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 17, 2023
@SoryRawyer SoryRawyer changed the title feat: add graded boolean to xblock json feat: add graded boolean to xblock json (FC-0033) Aug 17, 2023
@bmtcril
Copy link
Contributor

bmtcril commented Aug 17, 2023

Looks good, can you add a test for it and bump the version?

This ensures the `graded` attribute is added to the serialized xblock
json data.
@SoryRawyer
Copy link
Contributor Author

I think this test follows the appropriate conventions and make validate passes, but please let me know if anything looks off to you.

@bmtcril bmtcril requested a review from Ian2012 August 17, 2023 20:25
Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@Ian2012 Ian2012 merged commit abba0a7 into openedx-unsupported:main Aug 18, 2023
8 checks passed
@openedx-webhooks
Copy link

@SoryRawyer 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants