refactor: [ACI-820] simplify course grade status event payload (#10)

openedx · Mar 29, 2024 · c72e3a9 · c72e3a9
1 parent c10437e
commit c72e3a9
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 23 deletions.
diff --git a/...vent_bus/avro/tests/schemas/org+openedx+learning+ccx+course+passing+status+v1_schema.avsc b/...vent_bus/avro/tests/schemas/org+openedx+learning+ccx+course+passing+status+v1_schema.avsc
@@ -51,14 +51,6 @@
               ]
             }
           },
-          {
-            "name": "update_timestamp",
-            "type": "string"
-          },
-          {
-            "name": "grading_policy_hash",
-            "type": "string"
-          },
           {
             "name": "course",
             "type": {

diff --git a/...ts/event_bus/avro/tests/schemas/org+openedx+learning+course+passing+status+v1_schema.avsc b/...ts/event_bus/avro/tests/schemas/org+openedx+learning+course+passing+status+v1_schema.avsc
@@ -83,14 +83,6 @@
                 }
               ]
             }
-          },
-          {
-            "name": "update_timestamp",
-            "type": "string"
-          },
-          {
-            "name": "grading_policy_hash",
-            "type": "string"
           }
         ]
       }

diff --git a/openedx_events/learning/data.py b/openedx_events/learning/data.py
@@ -475,13 +475,12 @@ class CourseNotificationData:
 @attr.s(frozen=True)
 class CoursePassingStatusData:
     """
-    Represents the event data when a user's grade crosses a grading policy threshold in a course.
+    Represents the event data when a user's grade is updated, indicates if current grade is enough for course passing.
 
     Attributes:
-        user (UserData): An instance of UserData containing information about the user whose grade crossed the threshold.
-        course (CourseData): An instance of CourseData containing details about the course in which the grade threshold was crossed.
-        update_timestamp (datetime): The timestamp when the grade crossing event was recorded.
-        grading_policy_hash (str): A hash of the course's grading policy at the time of the event, used for verifying the grading policy has not changed.
+        status (str): A string containing information about user's current course grade value in comparison to the grading policy threshold.
+        user (UserData): An instance of UserData containing information about the user whose grade was updated.
+        course (CourseData): An instance of CourseData containing details about the course in which the grade was updated.
     """
     PASSING = 'passing'
     FAILING = 'failing'
@@ -490,8 +489,6 @@ class CoursePassingStatusData:
     status = attr.ib(type=str, validator=in_(STATUSES))
     course = attr.ib(type=CourseData)
     user = attr.ib(type=UserData)
-    update_timestamp = attr.ib(type=datetime)
-    grading_policy_hash = attr.ib(type=str)
 
 
 @attr.s(frozen=True)