feat: emit passing status updated events for badging #34749

GlugovGrGlib · 2024-05-09T06:31:25Z

Description

This PR introduces emission of the COURSE_PASSING_STATUS_UPDATED as well as CCX_COURSE_PASSING_STATUS_UPDATED events, that are groundwork for the new Credly integration and the future badging initiative.

Product GH ticket for tracking - openedx/platform-roadmap#280

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Configure Redis stream or Kafka event bus
Set settings.FEATURES['BADGES_ENABLED'] to True
Configure grading in a course
Pass the course with testing user
Observe generated COURSE_PASSING_STATUS_UPDATED events
Change grading for this course in a studio
Observe generated COURSE_PASSING_STATUS_UPDATED events

(The same should work for CCX courses)

Please refer to openedx-events PR for more information on the events itself: openedx/openedx-events#303

Deadline

Redwood

Other information

This PR is the replacement for the #34524

openedx-webhooks · 2024-05-09T06:31:29Z

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

GlugovGrGlib · 2024-05-09T08:14:33Z

@mariajgrimaldi Kindly ask you to review this edx-platform PR if possible before the Redwood cut, as it mostly just adding new events under a feature flag and updating openedx-events version.

mariajgrimaldi

@GlugovGrGlib: Thanks for the ping.

The tests are failing, could you fix them? Also, could we remove the pylint disable statements from the test files?

Thanks.

Co-authored-by: Andrii <[email protected]>

mariajgrimaldi

LGTM. Thank you! I'll try merging this once tests pass.

GlugovGrGlib · 2024-05-09T14:14:03Z

@mariajgrimaldi Thank you!

cms/envs/common.py

justinhynes

I don't know as much about the use-case, but from the event bus functionality -- this seems good to me!

openedx-webhooks · 2024-05-09T15:52:38Z

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

robrap

I'm not trying to block this merged PR, but just adding some additional thoughts and questions. Thanks.

robrap · 2024-05-09T16:27:08Z

lms/envs/common.py

 #### Event bus producing ####
+
+def _should_send_learning_badge_events(settings):
+    return settings.FEATURES['BADGES_ENABLED']


Will this toggle be used for anything other than _should_send_learning_badge_events? It seems like the toggle name could be much more descriptive, because this seems like there is a whole new feature that might be enabled/disabled.

Is there any relationship with the badges DEPR: [DEPR]: lms/djangoapps/badges #31541? If not, you can see how a toggle named FEATURES['BADGES_ENABLED'] would confuse me to thinking there would be.

@robrap: thank you for raising this.

@GlugovGrGlib: Could you help us out here? If anything needs to be changed, we can do it in a follow-up PR and backport it to Redwood.

@GlugovGrGlib: Since the redwood branch is now created off https://github.com/openedx/edx-platform/tree/2u/release, these changes didn't make it in time. So, if this needs to land in redwood, we still need to open a PR against open-release/redwood.master.

@robrap

This is the first phase of the badging initiative outlined in the Credly integration platform-roadmap#280, which is expected to include additional milestones in the future. These potential milestones may encompass issuing badges for various achievements such as passing parts of the courses, and displaying claimed badges alongside courseware. The intention is to avoid embedding specific badging logic directly within the edx-platform. Instead, the plan is to emit generic events in the LMS or CMS, which can then be consumed and processed by the credentials IDA.

From a product perspective, this feature represents a relaunch of the legacy open badges functionality, which was deprecated last year. Although it serves similar use cases, the current solution centralizes all processing logic within the credentials IDA. Additionally, future plans include support for multiple badging services beyond Credly, such as Accredible or others. Using a generic name like BADGES_ENABLED can ease the adoption of the feature across different community releases. With each release, users won't need to reconfigure LMS to use new functionality introduced in future milestones. At the same time, the primary configuration for processing remains within the credentials IDA.

@mariajgrimaldi sure will do, thanks

robrap · 2024-05-09T16:31:34Z

lms/djangoapps/grades/tests/test_events.py

+    UserPersonalData
+)
+from openedx_events.learning.signals import (
+    CCX_COURSE_PASSING_STATUS_UPDATED,


I didn't know anyone else was using CCX. I wonder when and if CCX documentation could be improved? I don't know where its docs live. It would be great if there were even a README in lms/djangoapps/ccx.

The docs I know of are here: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/set_up_course/studio_add_course_information/custom_courses.html

There are two major Open edX operators in the community that are heavily relying on CCX courses up to these days, Pearson and Campus. As per my knowledge, all the CCX functionality is still operable and compatible with learning MFE.
It would be good to have an additional initiative to document CCXs, as suggested. Maybe somebody from the community would be interested in maintaining lms/djangoapps/ccx app until there's an alternative for content reuse.

edx-pipeline-bot · 2024-05-09T18:04:48Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-05-09T18:28:56Z

2U Release Notice: This PR has been deployed to the edX production environment.

Introduce emission of the COURSE_PASSING_STATUS_UPDATED as well as CCX_COURSE_PASSING_STATUS_UPDATED events, that are groundwork for the new Credly integration and the future badging initiative. Product GH ticket for tracking - openedx/platform-roadmap#280

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 9, 2024

GlugovGrGlib requested review from deborahgu, justinhynes, mariajgrimaldi and a team May 9, 2024 08:11

mariajgrimaldi requested changes May 9, 2024

View reviewed changes

kyrylo-kh and others added 5 commits May 9, 2024 16:37

feat: emit new course passing status events

07e16b2

refactor: [ACI-972] extract event bus event to another function (#2552)

f4674b4

Co-authored-by: Andrii <[email protected]>

refactor: add protected utility to send events and update docs

e23f728

chore: upgrade openedx-events dependency

1b244af

fix: update code because of quality check

4cd9a56

GlugovGrGlib force-pushed the glugovgrglib/emit_passing_status_events_for_badging branch from 24462fe to 4cd9a56 Compare May 9, 2024 13:37

docs: add docstrings for tests

0d0d45e

mariajgrimaldi approved these changes May 9, 2024

View reviewed changes

mariajgrimaldi reviewed May 9, 2024

View reviewed changes

cms/envs/common.py Outdated Show resolved Hide resolved

fix: correct course key for ccx event

c14b5f5

justinhynes approved these changes May 9, 2024

View reviewed changes

deborahgu approved these changes May 9, 2024

View reviewed changes

mariajgrimaldi merged commit 4599e45 into openedx:master May 9, 2024
79 of 80 checks passed

robrap reviewed May 9, 2024

View reviewed changes

GlugovGrGlib mentioned this pull request May 15, 2024

feat: emit passing status updated events for badging #34806

Merged

Serafin-dev mentioned this pull request May 30, 2024

PADV-1346: Backport edx-platform changes needed for Event Bus to work on our olive instance. Pearson-Advance/edx-platform#124

Merged

kyrylo-kh mentioned this pull request Jun 4, 2024

feat: add badges feature openedx/credentials#2489

Merged

KyryloKireiev mentioned this pull request Jul 23, 2024

feat: Backport adding Badge issuance to Redwood openedx/credentials#2528

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: emit passing status updated events for badging #34749

feat: emit passing status updated events for badging #34749

GlugovGrGlib commented May 9, 2024

openedx-webhooks commented May 9, 2024

GlugovGrGlib commented May 9, 2024

mariajgrimaldi left a comment

mariajgrimaldi left a comment

GlugovGrGlib commented May 9, 2024

justinhynes left a comment

openedx-webhooks commented May 9, 2024

robrap left a comment

robrap May 9, 2024

mariajgrimaldi May 9, 2024

mariajgrimaldi May 9, 2024 •

edited

Loading

GlugovGrGlib May 9, 2024

GlugovGrGlib May 9, 2024

robrap May 9, 2024

kdmccormick May 9, 2024

GlugovGrGlib May 9, 2024 •

edited

Loading

edx-pipeline-bot commented May 9, 2024

edx-pipeline-bot commented May 9, 2024

feat: emit passing status updated events for badging #34749

feat: emit passing status updated events for badging #34749

Conversation

GlugovGrGlib commented May 9, 2024

Description

Supporting information

Testing instructions

Deadline

Other information

openedx-webhooks commented May 9, 2024

GlugovGrGlib commented May 9, 2024

mariajgrimaldi left a comment

Choose a reason for hiding this comment

mariajgrimaldi left a comment

Choose a reason for hiding this comment

GlugovGrGlib commented May 9, 2024

justinhynes left a comment

Choose a reason for hiding this comment

openedx-webhooks commented May 9, 2024

robrap left a comment

Choose a reason for hiding this comment

robrap May 9, 2024

Choose a reason for hiding this comment

mariajgrimaldi May 9, 2024

Choose a reason for hiding this comment

mariajgrimaldi May 9, 2024 • edited Loading

Choose a reason for hiding this comment

GlugovGrGlib May 9, 2024

Choose a reason for hiding this comment

GlugovGrGlib May 9, 2024

Choose a reason for hiding this comment

robrap May 9, 2024

Choose a reason for hiding this comment

kdmccormick May 9, 2024

Choose a reason for hiding this comment

GlugovGrGlib May 9, 2024 • edited Loading

Choose a reason for hiding this comment

edx-pipeline-bot commented May 9, 2024

edx-pipeline-bot commented May 9, 2024

mariajgrimaldi May 9, 2024 •

edited

Loading

GlugovGrGlib May 9, 2024 •

edited

Loading