feat: add new learning events for course grades and badges

[kyrylo-kh]

Description:

This is a prerequisite work for the new Badges with Credly integration feature.

Changes

• Adds a new dependency:

  • edx-ccx-keys

• Implements new custom serializer:

  • CcxCourseLocatorAvroSerializer

• Implements new data classes:

  • CcxCourseData (CCX specific course data)
  • CoursePassingStatusData (current course grade passing status for user)
  • CcxCoursePassingStatusData (current CCX course grade passing status for user)
  • BadgeTemplateData (badge template credential type)
  • BadgeData (badge user credential)

• Adds new public signals:

  • COURSE_PASSING_STATUS_UPDATED (course grade update with passing status)
  • CCX_COURSE_PASSING_STATUS_UPDATED (CCX course grade update with passing status)
  • BADGE_AWARDED (new badge awarding for user)
  • BADGE_REVOKED (existing badge revocation for user)

ISSUE: openedx/platform-roadmap#280

Dependencies: this PR itself is a blocker for 2 PRs (LMS, Credentials) which are work in progress.

Merge deadline: ASAP when possible.

Installation instructions: nothing special.

Testing instructions: noting special.

Reviewers:

• @mariajgrimaldi
• @justinhynes

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)

Author concerns:

This PR is a blocker for further LMS/Credentials contribution, since both services depend on the future openedx-events version that includes these signals/data.

[openedx-webhooks]

Thanks for the pull request, @kyrylo-kh! 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.

[mphilbrick211]

Hi @kyrylo-kh! Thanks for this contribution. It looks like you're contributing on behalf of Raccoon Gang. In order to get you added to Raccoon Gang's entity CLA agreement, please have your manager reach out to oscm@axim.org. Thank you!

[wowkalucky]

Context: Credentials Badges (+Credly integration).

This is a WIP PR to make possible early feedback. We have started from the bare minimum, but the details are still a matter of shaping.

[justinhynes]

Instead of this just being a combination of UserData and CourseData, should we instead possibly make this a GradeData data class?

Since this is being used in the new COURSE_GRADE_NOW_PASSED and COURSE_GRADE_NOW_FAILED events, it could be useful to the folks who may be consuming this event in the future to have the actual grade data available as part of the event.

Hopefully we could include some items like percent_grade, letter_grade and other model fields from the PersistentCourseGrade model of the LMS?

Seems like we're missing an opportunity here to include that data for future event bus consumers.

[wowkalucky]

@kyrylo-kh pls update the description as well.

[mariajgrimaldi]

Do you folks have a draft PR in the service from where these events will be sent?

[wowkalucky]

@mariajgrimaldi here related Platform draft PR.

[wowkalucky]

I like the suggestion of refactoring the status property with constants to is_passing = <bool> as a more explicit option.

[mariajgrimaldi]

Could you add docstrings here? Thanks!

[mariajgrimaldi]

Picking up the conversation about whether using status='passing' | 'failing' or `is_passing=True':

Option 1 status='passing' | 'failing':

Pros

• Explicit status attribute for CoursePassingStatus...

Cons

• Hard-coded constant
• No validation support yet. Status could be anything.
• The integration PR would need to know the status format:

        CCX_COURSE_PASSING_STATUS_UPDATED.send_event(
            course_passing_status=CcxCoursePassingStatusData(
                status='passing',
                user=UserData(
                    pii=UserPersonalData(
                        username=user.username,
                        email=user.email,
                        name=user.get_full_name(),
                    ),
                    id=user.id,
                    is_active=user.is_active,
                ),
                course=CcxCourseData(
                    ccx_course_key=course_id,
                    master_course_key=course_id.to_course_locator(),
                ),
            )
        )

status='passing' was previously CcxCoursePassingStatusData.PASSING, which was standardized but then dropped altogether with the validator, but for maintainability reasons, we shouldn't use status='passing'.

Option 2 is_passing=True:

Pros

• It's similar to what's currently used by the PersistentCourseGrade model to send the events: https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/grades/course_grade_factory.py#L180 passed=grade.passed
• Doesn't need validation, it could be either True or False

Cons

• Is it explicit enough?

Which of the options should we choose? I'm leaning towards option 2, but you folks have more context on the problem you're solving. Please, let me know.

[wowkalucky]

Hi @mariajgrimaldi.
We discussed it internally and decided to go with the second option: we'll update status in favor of the is_passing=True|False.

[wowkalucky]

@mariajgrimaldi we've refactored as discussed. Please, review.
@GlugovGrGlib fyi.

[GlugovGrGlib]

@mariajgrimaldi This is ready for the final review, it'll be good if we could bump version and merge related edx-platform PR after requirements update before Redwood cut

[mariajgrimaldi]

Just a few minor comments left to address. Thank you!

[wowkalucky]

@mariajgrimaldi fixed.

[mariajgrimaldi]

@wowkalucky: could you please address this last comment? Thank you. I'll merge @ 11am est or once that's done.

[mariajgrimaldi]

I'll merge this now as is. Thank you again!

[openedx-webhooks]

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

[mariajgrimaldi]

v9.10.0 released! Thank you all.