feat: [ACI-69, ACI-87] describe new public events for course grade pa…

…ssing/failing feat: [ACI-75] new public events
raccoongang · Jan 15, 2024 · 2fadf62 · 2fadf62
2 parents 1a5f9ca + 2b4563f
commit 2fadf62
Show file tree

Hide file tree

Showing 4 changed files with 213 additions and 0 deletions.
diff --git a/.../event_bus/avro/tests/schemas/org+openedx+learning+course+grade+now+failed+v1_schema.avsc b/.../event_bus/avro/tests/schemas/org+openedx+learning+course+grade+now+failed+v1_schema.avsc
@@ -0,0 +1,88 @@
+{
+  "name": "CloudEvent",
+  "type": "record",
+  "doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
+  "fields": [
+    {
+      "name": "user_course_data",
+      "type": {
+        "name": "UserCourseData",
+        "type": "record",
+        "fields": [
+          {
+            "name": "user",
+            "type": {
+              "name": "UserData",
+              "type": "record",
+              "fields": [
+                {
+                  "name": "id",
+                  "type": "long"
+                },
+                {
+                  "name": "is_active",
+                  "type": "boolean"
+                },
+                {
+                  "name": "pii",
+                  "type": {
+                    "name": "UserPersonalData",
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "username",
+                        "type": "string"
+                      },
+                      {
+                        "name": "email",
+                        "type": "string"
+                      },
+                      {
+                        "name": "name",
+                        "type": "string"
+                      }
+                    ]
+                  }
+                }
+              ]
+            }
+          },
+          {
+            "name": "course",
+            "type": {
+              "name": "CourseData",
+              "type": "record",
+              "fields": [
+                {
+                  "name": "course_key",
+                  "type": "string"
+                },
+                {
+                  "name": "display_name",
+                  "type": "string"
+                },
+                {
+                  "name": "start",
+                  "type": [
+                    "null",
+                    "string"
+                  ],
+                  "default": null
+                },
+                {
+                  "name": "end",
+                  "type": [
+                    "null",
+                    "string"
+                  ],
+                  "default": null
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "namespace": "org.openedx.learning.course.grade.now.failed.v1"
+}
diff --git a/.../event_bus/avro/tests/schemas/org+openedx+learning+course+grade+now+passed+v1_schema.avsc b/.../event_bus/avro/tests/schemas/org+openedx+learning+course+grade+now+passed+v1_schema.avsc
@@ -0,0 +1,88 @@
+{
+  "name": "CloudEvent",
+  "type": "record",
+  "doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
+  "fields": [
+    {
+      "name": "user_course_data",
+      "type": {
+        "name": "UserCourseData",
+        "type": "record",
+        "fields": [
+          {
+            "name": "user",
+            "type": {
+              "name": "UserData",
+              "type": "record",
+              "fields": [
+                {
+                  "name": "id",
+                  "type": "long"
+                },
+                {
+                  "name": "is_active",
+                  "type": "boolean"
+                },
+                {
+                  "name": "pii",
+                  "type": {
+                    "name": "UserPersonalData",
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "username",
+                        "type": "string"
+                      },
+                      {
+                        "name": "email",
+                        "type": "string"
+                      },
+                      {
+                        "name": "name",
+                        "type": "string"
+                      }
+                    ]
+                  }
+                }
+              ]
+            }
+          },
+          {
+            "name": "course",
+            "type": {
+              "name": "CourseData",
+              "type": "record",
+              "fields": [
+                {
+                  "name": "course_key",
+                  "type": "string"
+                },
+                {
+                  "name": "display_name",
+                  "type": "string"
+                },
+                {
+                  "name": "start",
+                  "type": [
+                    "null",
+                    "string"
+                  ],
+                  "default": null
+                },
+                {
+                  "name": "end",
+                  "type": [
+                    "null",
+                    "string"
+                  ],
+                  "default": null
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "namespace": "org.openedx.learning.course.grade.now.passed.v1"
+}
diff --git a/openedx_events/learning/data.py b/openedx_events/learning/data.py
@@ -469,3 +469,17 @@ class CourseNotificationData:
     content_url = attr.ib(type=str)
     content_context = attr.ib(type=dict, factory=dict)
     audience_filters = attr.ib(type=dict, factory=dict)
+
+
+@attr.s(frozen=True)
+class UserCourseData:
+    """
+    Attributes defined for Open edX user course data object.
+
+    Arguments:
+        user (UserData): user associated with the Course Enrollment.
+        course (CourseData): course where the user is enrolled in.
+    """
+
+    user = attr.ib(type=UserData)
+    course = attr.ib(type=CourseData)
diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py
@@ -19,6 +19,7 @@
     ManageStudentsPermissionData,
     PersistentCourseGradeData,
     ProgramCertificateData,
+    UserCourseData,
     UserData,
     UserNotificationData,
     XBlockSkillVerificationData,
@@ -327,3 +328,25 @@
         "course_notification_data": CourseNotificationData,
     }
 )
+
+# .. event_type: org.openedx.learning.course.grade.now.passed.v1
+# .. event_name: COURSE_GRADE_NOW_PASSED
+# .. event_description: Emmited when course grade is passed.
+# .. event_data: UserCourseData
+COURSE_GRADE_NOW_PASSED = OpenEdxPublicSignal(
+    event_type="org.openedx.learning.course.grade.now.passed.v1",
+    data={
+        "user_course_data": UserCourseData,
+    }
+)
+
+# .. event_type: org.openedx.learning.course.grade.now.failed.v1
+# .. event_name: COURSE_GRADE_NOW_FAILED
+# .. event_description: Emmited when course grade is failed.
+# .. event_data: UserCourseData
+COURSE_GRADE_NOW_FAILED = OpenEdxPublicSignal(
+    event_type="org.openedx.learning.course.grade.now.failed.v1",
+    data={
+        "user_course_data": UserCourseData,
+    }
+)