fix: added object handling to PersistentCourseGradeData serialization #544
+309
−7
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses a production issue with circular reference errors during JSON serialization of event data involving MongoDB BSON objects. It introduces converters to handle BSON FixedOffset timezones and ObjectId fields in the
PersistentCourseGradeDataandCourseDataclasses, ensuring compatibility and preventing serialization errors. Comprehensive tests have been added to verify the new converters.Serialization Fixes for BSON Objects:
_normalize_datetime_timezoneconverter to replace BSONFixedOffsettimezones with standard UTC in thestart,end,course_edited_timestamp, andpassed_timestampfields ofCourseDataandPersistentCourseGradeDatato prevent circular reference errors during JSON serialization. [1] [2] [3]_convert_objectid_to_strconverter to ensure that MongoDBObjectIdvalues in thecourse_versionfield ofPersistentCourseGradeDataare converted to strings for serialization. [1] [2]Testing:
tests/test_bson_converters.pywith extensive tests for BSONFixedOffsetandObjectIdconversions, including production scenario replication to ensure serialization succeeds without circular reference errors.Documentation and Versioning:
10.5.1. [1] [2]Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.