From 4086c95ff0a24999696a41abb0b5ac3602a7377e Mon Sep 17 00:00:00 2001 From: Brian Mesick Date: Tue, 20 Feb 2024 15:35:35 -0500 Subject: [PATCH] feat: Add event_key_field annotations where possible Not all events are compatible with the bus, and some that are have never been configured for it that I could find. This is everything I could locate in the org. --- docs/reference/events.rst | 2 +- openedx_events/analytics/signals.py | 1 + openedx_events/content_authoring/signals.py | 1 + openedx_events/learning/signals.py | 9 +++++++++ 4 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/reference/events.rst b/docs/reference/events.rst index 2ae99cad..20b19005 100644 --- a/docs/reference/events.rst +++ b/docs/reference/events.rst @@ -4,6 +4,6 @@ Events This is the list of Open edX events found in this repository. .. note:: - Events can be create in other projects and plugins as well, but these default events are guaranteed to exist. + Events can be created in other projects and plugins as well, but these default events are guaranteed to exist. .. openedxevents:: diff --git a/openedx_events/analytics/signals.py b/openedx_events/analytics/signals.py index 6bbb2fd4..8817b994 100644 --- a/openedx_events/analytics/signals.py +++ b/openedx_events/analytics/signals.py @@ -13,6 +13,7 @@ # .. event_type: org.openedx.analytics.tracking.event.emitted.v1 # .. event_name: TRACKING_EVENT_EMITTED +# .. event_key_field: tracking_log.name # .. event_description: emitted when a tracking log is created. # .. event_data: TrackingLogData TRACKING_EVENT_EMITTED = OpenEdxPublicSignal( diff --git a/openedx_events/content_authoring/signals.py b/openedx_events/content_authoring/signals.py index d664ee75..a10770b1 100644 --- a/openedx_events/content_authoring/signals.py +++ b/openedx_events/content_authoring/signals.py @@ -20,6 +20,7 @@ # .. event_type: org.openedx.content_authoring.course.catalog_info.changed.v1 # .. event_name: COURSE_CATALOG_INFO_CHANGED +# .. event_key_field: catalog_info.course_key # .. event_description: Fired when a course changes in Studio in a way that is relevant for catalog consumers. # .. event_data: CourseCatalogData COURSE_CATALOG_INFO_CHANGED = OpenEdxPublicSignal( diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py index 1a9c6f07..48898581 100644 --- a/openedx_events/learning/signals.py +++ b/openedx_events/learning/signals.py @@ -39,6 +39,7 @@ # .. event_type: org.openedx.learning.auth.session.login.completed.v1 # .. event_name: SESSION_LOGIN_COMPLETED +# .. event_key_field: user.pii.username # .. event_description: emitted when the user's login process in the LMS is completed. # .. event_data: UserData SESSION_LOGIN_COMPLETED = OpenEdxPublicSignal( @@ -75,6 +76,7 @@ # .. event_type: org.openedx.learning.course.unenrollment.completed.v1 # .. event_name: COURSE_UNENROLLMENT_COMPLETED +# .. event_key_field: enrollment.course.course_key # .. event_description: emitted when the user's unenrollment process is completed. # .. event_data: CourseEnrollmentData COURSE_UNENROLLMENT_COMPLETED = OpenEdxPublicSignal( @@ -87,6 +89,7 @@ # .. event_type: org.openedx.learning.certificate.created.v1 # .. event_name: CERTIFICATE_CREATED +# .. event_key_field: certificate.course.course_key # .. event_description: emitted when the user's certificate creation process is completed. # .. event_data: CertificateData CERTIFICATE_CREATED = OpenEdxPublicSignal( @@ -98,6 +101,7 @@ # .. event_type: org.openedx.learning.program.certificate.awarded.v1 # .. event_name: PROGRAM_CERTIFICATE_AWARDED +# .. event_key_field: program_certificate.program.uuid # .. event_description: Emit when a program certificate is awarded to a learner # .. event_data: ProgramCertificateData PROGRAM_CERTIFICATE_AWARDED = OpenEdxPublicSignal( @@ -121,6 +125,7 @@ # .. event_type: org.openedx.learning.certificate.revoked.v1 # .. event_name: CERTIFICATE_REVOKED +# .. event_key_field: certificate.course.course_key # .. event_description: emitted when the user's certificate annulation process is completed. # .. event_data: CertificateData CERTIFICATE_REVOKED = OpenEdxPublicSignal( @@ -132,6 +137,7 @@ # .. event_type: org.openedx.learning.program.certificate.revoked.v1 # .. event_name: PROGRAM_CERTIFICATE_REVOKED +# .. event_key_field: program_certificate.program.uuid # .. event_description: Emit when a program certificate is revoked from a learner # .. event_data: ProgramCertificateData PROGRAM_CERTIFICATE_REVOKED = OpenEdxPublicSignal( @@ -179,6 +185,7 @@ # .. event_type: org.openedx.learning.xblock.skill.verified.v1 # .. event_name: XBLOCK_SKILL_VERIFIED +# .. event_key_field: xblock_info.usage_key # .. event_description: Fired when an XBlock skill is verified. # .. event_data: XBlockSkillVerificationData XBLOCK_SKILL_VERIFIED = OpenEdxPublicSignal( @@ -258,6 +265,7 @@ # .. event_type: org.openedx.learning.user.course_access_role.added.v1 # .. event_name: COURSE_ACCESS_ROLE_ADDED +# .. event_key_field: course_access_role_data.course_key # .. event_description: Emitted when a user is given a course access role. # .. event_data: CourseAccessRoleData COURSE_ACCESS_ROLE_ADDED = OpenEdxPublicSignal( @@ -269,6 +277,7 @@ # .. event_type: org.openedx.learning.user.course_access_role.removed.v1 # .. event_name: COURSE_ACCESS_ROLE_REMOVED +# .. event_key_field: course_access_role_data.course_key # .. event_description: Emitted when a course access role is removed from a user. # .. event_data: CourseAccessRoleData COURSE_ACCESS_ROLE_REMOVED = OpenEdxPublicSignal(