Use the json_iso_utc serializer in all dashboard endpoints

This will return dates with timezone information
hypothesis · Oct 4, 2024 · 1773877 · 1773877
1 parent 464b8fa
commit 1773877
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 18 deletions.
diff --git a/lms/js_config_types.py b/lms/js_config_types.py
@@ -4,6 +4,7 @@
 Making this a top level module to avoid circular dependency problems.
 """
 
+from datetime import datetime
 from typing import Literal, NotRequired, TypedDict
 
 
@@ -63,7 +64,7 @@ class AutoGradingGrade(TypedDict):
     last_grade: float | None
     """Last grade that was succefully sync to the LMS."""
 
-    last_grade_date: str | None
+    last_grade_date: datetime | None
     """Time when `last_grade` was synced to the LMS."""
 
 

diff --git a/lms/models/_mixins/created_updated.py b/lms/models/_mixins/created_updated.py
@@ -1,11 +1,11 @@
+from datetime import datetime
+
 import sqlalchemy as sa
+from sqlalchemy.orm import Mapped, mapped_column
 
 
 class CreatedUpdatedMixin:
-    created = sa.Column(sa.DateTime(), server_default=sa.func.now(), nullable=False)
-    updated = sa.Column(
-        sa.DateTime(),
-        server_default=sa.func.now(),
-        onupdate=sa.func.now(),
-        nullable=False,
+    created: Mapped[datetime] = mapped_column(server_default=sa.func.now())
+    updated: Mapped[datetime] = mapped_column(
+        server_default=sa.func.now(), onupdate=sa.func.now()
     )
diff --git a/lms/views/dashboard/api/course.py b/lms/views/dashboard/api/course.py
@@ -53,7 +53,7 @@ def __init__(self, request) -> None:
     @view_config(
         route_name="api.dashboard.courses",
         request_method="GET",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.DASHBOARD_VIEW,
         schema=ListCoursesSchema,
     )
@@ -85,7 +85,7 @@ def courses(self) -> APICourses:
     @view_config(
         route_name="api.dashboard.courses.metrics",
         request_method="GET",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.DASHBOARD_VIEW,
         schema=CoursesMetricsSchema,
     )
@@ -127,7 +127,7 @@ def courses_metrics(self) -> APICourses:
                     title=course.lms_name,
                     course_metrics=CourseMetrics(
                         assignments=courses_assignments_counts.get(course.id, 0),
-                        last_launched=course.updated.isoformat(),
+                        last_launched=course.updated,
                     ),
                 )
                 for course in courses
@@ -137,7 +137,7 @@ def courses_metrics(self) -> APICourses:
     @view_config(
         route_name="api.dashboard.course",
         request_method="GET",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.DASHBOARD_VIEW,
     )
     def course(self) -> APICourse:

diff --git a/lms/views/dashboard/api/grading.py b/lms/views/dashboard/api/grading.py
@@ -39,7 +39,7 @@ def __init__(self, request) -> None:
     @view_config(
         route_name="api.dashboard.assignments.grading.sync",
         request_method="POST",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.GRADE_ASSIGNMENT,
         schema=AutoGradeSyncSchema,
     )
@@ -80,7 +80,7 @@ def create_grading_sync(self):
     @view_config(
         route_name="api.dashboard.assignments.grading.sync",
         request_method="GET",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.GRADE_ASSIGNMENT,
     )
     def get_grading_sync(self):

diff --git a/lms/views/dashboard/api/user.py b/lms/views/dashboard/api/user.py
@@ -76,7 +76,7 @@ def __init__(self, request) -> None:
     @view_config(
         route_name="api.dashboard.students",
         request_method="GET",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.DASHBOARD_VIEW,
         schema=ListUsersSchema,
     )
@@ -115,7 +115,7 @@ def students(self) -> APIStudents:
     @view_config(
         route_name="api.dashboard.students.metrics",
         request_method="GET",
-        renderer="json",
+        renderer="json_iso_utc",
         permission=Permissions.DASHBOARD_VIEW,
         schema=UsersMetricsSchema,
     )
@@ -215,7 +215,7 @@ def _add_auto_grading_data(
             }
             if last_grade := last_sync_grades.get(api_student["h_userid"]):
                 auto_grading_grade["last_grade"] = last_grade.grade
-                auto_grading_grade["last_grade_date"] = last_grade.updated.isoformat()
+                auto_grading_grade["last_grade_date"] = last_grade.updated
 
             api_student["auto_grading_grade"] = auto_grading_grade
 

diff --git a/tests/unit/lms/views/dashboard/api/course_test.py b/tests/unit/lms/views/dashboard/api/course_test.py
@@ -80,7 +80,7 @@ def test_course_metrics(
                     "title": c.lms_name,
                     "course_metrics": {
                         "assignments": assignment_service.get_courses_assignments_count.return_value.get.return_value,
-                        "last_launched": c.updated.isoformat(),
+                        "last_launched": c.updated,
                     },
                 }
                 for c in courses

diff --git a/tests/unit/lms/views/dashboard/api/user_test.py b/tests/unit/lms/views/dashboard/api/user_test.py
@@ -243,7 +243,7 @@ def test_students_metrics_with_auto_grading(  # pylint:disable=too-many-locals
                 "last_grade": last_grades.get.return_value.grade
                 if with_last_grade
                 else None,
-                "last_grade_date": last_grades.get.return_value.updated.isoformat.return_value
+                "last_grade_date": last_grades.get.return_value.updated
                 if with_last_grade
                 else None,
             }