-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #341 from openedx/cag/add-grading-events
feat: add xapi transformer for grading events
- Loading branch information
Showing
15 changed files
with
482 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,4 @@ | |
| Various backends for receiving edX LMS events.. | ||
| """ | ||
|
|
||
| __version__ = '5.5.6' | ||
| __version__ = '5.6.0' | ||
37 changes: 37 additions & 0 deletions
37
...ds/processors/tests/fixtures/current/edx.grades.course.grade_calculated_letter_grade.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "name": "edx.grades.course.grade_calculated", | ||
| "context": { | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_user_tags": {}, | ||
| "user_id": 3, | ||
| "path": "/courses/course-v1:edX+DemoX+Demo_Course/xblock/block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2/handler/xmodule_handler/problem_check", | ||
| "org_id": "edX", | ||
| "enterprise_uuid": "", | ||
| "module": { | ||
| "display_name": "Checkboxes", | ||
| "usage_key": "block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2" | ||
| } | ||
| }, | ||
| "username": "edX", | ||
| "session": "056aca2a1c6b76742b283e73d3424453", | ||
| "ip": "172.19.0.1", | ||
| "agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", | ||
| "host": "localhost:18000", | ||
| "referer": "http://localhost:18000/xblock/block-v1:edX+DemoX+Demo_Course+type@vertical+block@ea9e33c0ad15445195f96d3c42ebc9f0?show_title=0&show_bookmark_button=0&recheck_access=1&view=student_view&format=Homework", | ||
| "accept_language": "en-US,en;q=0.9,es;q=0.8", | ||
| "data": { | ||
| "user_id": "3", | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_version": "64e64c6835fe1d2093ba4d69", | ||
| "percent_grade": 1.0, | ||
| "letter_grade": "Pass", | ||
| "course_edited_timestamp": "2023-08-23 18:14:00.070241+00:00", | ||
| "event_transaction_id": "a47772a0-3c7f-4a0e-9c11-7e903a03e503", | ||
| "event_transaction_type": "edx.grades.problem.submitted", | ||
| "grading_policy_hash": "ChVp0lHGQGCevD0t4njna/C44zQ=" | ||
| }, | ||
| "time": "2023-08-23T20:37:45.526615+00:00", | ||
| "event_type": "edx.grades.course.grade_calculated", | ||
| "event_source": "server", | ||
| "page": null | ||
| } |
37 changes: 37 additions & 0 deletions
37
...processors/tests/fixtures/current/edx.grades.course.grade_calculated_no_letter_grade.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "name": "edx.grades.course.grade_calculated", | ||
| "context": { | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_user_tags": {}, | ||
| "user_id": 3, | ||
| "path": "/courses/course-v1:edX+DemoX+Demo_Course/xblock/block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2/handler/xmodule_handler/problem_check", | ||
| "org_id": "edX", | ||
| "enterprise_uuid": "", | ||
| "module": { | ||
| "display_name": "Checkboxes", | ||
| "usage_key": "block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2" | ||
| } | ||
| }, | ||
| "username": "edX", | ||
| "session": "056aca2a1c6b76742b283e73d3424453", | ||
| "ip": "172.19.0.1", | ||
| "agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", | ||
| "host": "localhost:18000", | ||
| "referer": "http://localhost:18000/xblock/block-v1:edX+DemoX+Demo_Course+type@vertical+block@ea9e33c0ad15445195f96d3c42ebc9f0?show_title=0&show_bookmark_button=0&recheck_access=1&view=student_view&format=Homework", | ||
| "accept_language": "en-US,en;q=0.9,es;q=0.8", | ||
| "data": { | ||
| "user_id": "3", | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_version": "64e64c6835fe1d2093ba4d69", | ||
| "percent_grade": 0.02, | ||
| "letter_grade": "", | ||
| "course_edited_timestamp": "2023-08-23 18:14:00.070241+00:00", | ||
| "event_transaction_id": "a47772a0-3c7f-4a0e-9c11-7e903a03e503", | ||
| "event_transaction_type": "edx.grades.problem.submitted", | ||
| "grading_policy_hash": "ChVp0lHGQGCevD0t4njna/C44zQ=" | ||
| }, | ||
| "time": "2023-08-23T20:37:45.526615+00:00", | ||
| "event_type": "edx.grades.course.grade_calculated", | ||
| "event_source": "server", | ||
| "page": null | ||
| } |
41 changes: 41 additions & 0 deletions
41
...ng_backends/processors/tests/fixtures/current/edx.grades.subsection.grade_calculated.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| { | ||
| "name": "edx.grades.subsection.grade_calculated", | ||
| "context": { | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_user_tags": {}, | ||
| "user_id": 3, | ||
| "path": "/courses/course-v1:edX+DemoX+Demo_Course/xblock/block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2/handler/xmodule_handler/problem_check", | ||
| "org_id": "edX", | ||
| "enterprise_uuid": "", | ||
| "module": { | ||
| "display_name": "Checkboxes", | ||
| "usage_key": "block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2" | ||
| } | ||
| }, | ||
| "username": "edX", | ||
| "session": "056aca2a1c6b76742b283e73d3424453", | ||
| "ip": "172.19.0.1", | ||
| "agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", | ||
| "host": "localhost:18000", | ||
| "referer": "http://localhost:18000/xblock/block-v1:edX+DemoX+Demo_Course+type@vertical+block@ea9e33c0ad15445195f96d3c42ebc9f0?show_title=0&show_bookmark_button=0&recheck_access=1&view=student_view&format=Homework", | ||
| "accept_language": "en-US,en;q=0.9,es;q=0.8", | ||
| "data": { | ||
| "user_id": "4", | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "block_id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@a2184f8ebf9d478ba57edcc4f288854a", | ||
| "course_version": "64e64c6835fe1d2093ba4d69", | ||
| "weighted_total_earned": 3.0, | ||
| "weighted_total_possible": 3.0, | ||
| "weighted_graded_earned": 3.0, | ||
| "weighted_graded_possible": 3.0, | ||
| "first_attempted": "2023-08-22 17:58:21.710578+00:00", | ||
| "subtree_edited_timestamp": "2023-08-23 18:14:00.070241+00:00", | ||
| "event_transaction_id": "a47772a0-3c7f-4a0e-9c11-7e903a03e503", | ||
| "event_transaction_type": "edx.grades.problem.submitted", | ||
| "visible_blocks_hash": "7bcnLlOwpFfmByYbwqBmWHskIEY=" | ||
| }, | ||
| "time": "2023-08-23T20:37:44.920732+00:00", | ||
| "event_type": "edx.grades.subsection.grade_calculated", | ||
| "event_source": "server", | ||
| "page": null | ||
| } |
41 changes: 41 additions & 0 deletions
41
...rs/tests/fixtures/current/edx.grades.subsection.grade_calculated.weighted_possible_0.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| { | ||
| "name": "edx.grades.subsection.grade_calculated", | ||
| "context": { | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_user_tags": {}, | ||
| "user_id": 3, | ||
| "path": "/courses/course-v1:edX+DemoX+Demo_Course/xblock/block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2/handler/xmodule_handler/problem_check", | ||
| "org_id": "edX", | ||
| "enterprise_uuid": "", | ||
| "module": { | ||
| "display_name": "Checkboxes", | ||
| "usage_key": "block-v1:edX+DemoX+Demo_Course+type@problem+block@185ffd73e23843168ca02e8d070ffcf2" | ||
| } | ||
| }, | ||
| "username": "edX", | ||
| "session": "056aca2a1c6b76742b283e73d3424453", | ||
| "ip": "172.19.0.1", | ||
| "agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36", | ||
| "host": "localhost:18000", | ||
| "referer": "http://localhost:18000/xblock/block-v1:edX+DemoX+Demo_Course+type@vertical+block@ea9e33c0ad15445195f96d3c42ebc9f0?show_title=0&show_bookmark_button=0&recheck_access=1&view=student_view&format=Homework", | ||
| "accept_language": "en-US,en;q=0.9,es;q=0.8", | ||
| "data": { | ||
| "user_id": "4", | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "block_id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@a2184f8ebf9d478ba57edcc4f288854a", | ||
| "course_version": "64e64c6835fe1d2093ba4d69", | ||
| "weighted_total_earned": 0.0, | ||
| "weighted_total_possible": 0.0, | ||
| "weighted_graded_earned": 0.0, | ||
| "weighted_graded_possible": 0.0, | ||
| "first_attempted": "2023-08-22 17:58:21.710578+00:00", | ||
| "subtree_edited_timestamp": "2023-08-23 18:14:00.070241+00:00", | ||
| "event_transaction_id": "a47772a0-3c7f-4a0e-9c11-7e903a03e503", | ||
| "event_transaction_type": "edx.grades.problem.submitted", | ||
| "visible_blocks_hash": "7bcnLlOwpFfmByYbwqBmWHskIEY=" | ||
| }, | ||
| "time": "2023-08-23T20:37:44.920732+00:00", | ||
| "event_type": "edx.grades.subsection.grade_calculated", | ||
| "event_source": "server", | ||
| "page": null | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
event_routing_backends/processors/xapi/event_transformers/grading_events.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| """ | ||
| Transformers for grading related events. | ||
| """ | ||
| from tincan import Activity, ActivityDefinition, Extensions, LanguageMap, Result, Verb | ||
|
|
||
| from event_routing_backends.helpers import get_course_from_id | ||
| from event_routing_backends.processors.xapi import constants | ||
| from event_routing_backends.processors.xapi.registry import XApiTransformersRegistry | ||
| from event_routing_backends.processors.xapi.transformer import XApiTransformer | ||
|
|
||
|
|
||
| @XApiTransformersRegistry.register("edx.grades.subsection.grade_calculated") | ||
| class SubsectionGradedTransformer(XApiTransformer): | ||
| """ | ||
| Transformer for event generated when an subsection is graded. | ||
| """ | ||
|
|
||
| verb = Verb( | ||
| id=constants.XAPI_VERB_EARNED, | ||
| display=LanguageMap({constants.EN: constants.EARNED}), | ||
| ) | ||
|
|
||
| additional_fields = ("result",) | ||
|
|
||
| def get_object(self): | ||
| """ | ||
| Get object for xAPI transformed event related to subsection grading. | ||
| Returns: | ||
| `Activity` | ||
| """ | ||
|
|
||
| return Activity( | ||
| id=self.get_object_iri("xblock", self.get_data("data.block_id", True)), | ||
| definition=ActivityDefinition( | ||
| type=constants.XAPI_ACTIVITY_RESOURCE, | ||
| ), | ||
| ) | ||
|
|
||
| def get_result(self): | ||
| """ | ||
| Get result for xAPI transformed event. | ||
| Returns: | ||
| `Result` | ||
| """ | ||
| event_data = self.get_data("data") | ||
| weighted_possible = event_data["weighted_total_possible"] or 0 | ||
| weighted_earned = event_data["weighted_total_earned"] or 0 | ||
|
|
||
| if weighted_possible > 0: | ||
| scaled = weighted_earned / weighted_possible | ||
| else: | ||
| scaled = 0 | ||
| return Result( | ||
| success=weighted_earned >= weighted_possible, | ||
| score={ | ||
| "min": 0, | ||
| "max": weighted_possible, | ||
| "raw": weighted_earned, | ||
| "scaled": scaled, | ||
| }, | ||
| ) | ||
|
|
||
|
|
||
| @XApiTransformersRegistry.register("edx.grades.course.grade_calculated") | ||
| class CourseGradedTransformer(XApiTransformer): | ||
| """ | ||
| Transformer for event generated when an course is graded. | ||
| """ | ||
|
|
||
| verb = Verb( | ||
| id=constants.XAPI_VERB_EARNED, | ||
| display=LanguageMap({constants.EN: constants.EARNED}), | ||
| ) | ||
|
|
||
| additional_fields = ("result",) | ||
|
|
||
| def get_object(self): | ||
| """ | ||
| Get object for xAPI transformed event related to course grading. | ||
| Returns: | ||
| `Activity` | ||
| """ | ||
| course_id = self.get_data("context.course_id", True) | ||
| object_id = self.get_object_iri("course", course_id) | ||
| course = get_course_from_id(course_id) | ||
| display_name = course["display_name"] | ||
|
|
||
| return Activity( | ||
| id=object_id, | ||
| definition=ActivityDefinition( | ||
| type=constants.XAPI_ACTIVITY_COURSE, | ||
| name=LanguageMap( | ||
| **({constants.EN: display_name} if display_name is not None else {}) | ||
| ), | ||
| ), | ||
| ) | ||
|
|
||
| def get_result(self): | ||
| """ | ||
| Get result for xAPI transformed event. | ||
| Returns: | ||
| `Result` | ||
| """ | ||
| event_data = self.get_data("data") | ||
| weighted_possible = 1.0 | ||
| weighted_earned = event_data["percent_grade"] or 0 | ||
|
|
||
| letter_grade = self.get_data("data.letter_grade") or "Fail" | ||
|
|
||
| return Result( | ||
| score={ | ||
| "min": 0, | ||
| "max": weighted_possible, | ||
| "raw": weighted_earned, | ||
| "scaled": weighted_earned, | ||
| }, | ||
| extensions=Extensions( | ||
| { | ||
| constants.XAPI_ACTIVITY_GRADE_CLASSIFICATION: letter_grade | ||
| } | ||
| ), | ||
| ) |
Oops, something went wrong.