feat: add support for optional Canvas due date syncing

Implement logic to optionally sync assignment due dates from Open edX to Canvas. Key changes include:
- Added `get_use_canvas_due_dates` utility to check course settings.
- Updated `create_assignment_payload` to conditionally include due dates based on the new setting.
- Modified `diff_assignments` and sync workflows to utilize the `use_canvas_due_dates` flag.
- Refactored assignment sync logic to support toggling due date synchronization.

Author: xitij2000

src/edx_sysadmin/tests/test_tasks.py

@@ -17,7 +17,7 @@
     update_grade_payload_kv,
 )
 from ol_openedx_canvas_integration.constants import COURSE_KEY_ID_EMPTY
-from ol_openedx_canvas_integration.utils import get_canvas_course_id
+from ol_openedx_canvas_integration.utils import get_canvas_course_id, get_use_canvas_due_dates
 
 log = logging.getLogger(__name__)
 
@@ -227,6 +227,7 @@ def push_edx_grades_to_canvas(course):
     if not canvas_course_id:
         msg = f"No canvas_course_id set for course: {course.id}"
         raise Exception(msg)  # noqa: TRY002
+    use_canvas_due_dates = get_use_canvas_due_dates(course)
 
     client = CanvasClient(canvas_course_id=canvas_course_id)
     existing_assignment_dict = client.get_canvas_assignments()
@@ -240,7 +241,7 @@ def push_edx_grades_to_canvas(course):
     )
     created_assignments = {
         subsection_block: client.create_canvas_assignment(
-            create_assignment_payload(subsection_block)
+            create_assignment_payload(subsection_block, use_canvas_due_dates)
         )
         for subsection_block in new_assignment_blocks
     }

src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/api.py

@@ -247,32 +247,39 @@ def update_assignment_grades(self, canvas_assignment_id, payload):
         )
 
 
-def create_assignment_payload(subsection_block):
+def create_assignment_payload(subsection_block, use_canvas_dates=False):
     """
     Create a Canvas assignment dict matching a subsection block on edX
 
     Args:
         subsection_block (openedx.core.djangoapps.content.block_structure.block_structure.BlockData):
             The block data for the graded assignment/exam (in the structure of a course, this unit is a subsection)
+        use_canvas_dates (bool): Whether to use the due dates from canvas instead of Open edX
 
     Returns:
         dict:
             Assignment payload to be sent to Canvas to create or update the assignment
     """  # noqa: E501
+    due_date_dict = {
+        "due_at": (
+            None
+            if not subsection_block.fields.get("due")
+            # The internal API gives us a TZ-naive datetime for the due date, but Studio indicates that  # noqa: E501
+            # the user should enter a UTC datetime for the due date. Coerce this to UTC before creating the  # noqa: E501
+            # string representation.
+            else subsection_block.fields["due"].astimezone(pytz.UTC).isoformat()
+        ),
+    }
+    # If we're using canvas dates, don't set the due dats from Open edX
+    if use_canvas_dates:
+        due_date_dict = {}
     return {
         "assignment": {
             "name": subsection_block.display_name,
             "integration_id": str(subsection_block.location),
             "grading_type": "percent",
             "points_possible": DEFAULT_ASSIGNMENT_POINTS,
-            "due_at": (
-                None
-                if not subsection_block.fields.get("due")
-                # The internal API gives us a TZ-naive datetime for the due date, but Studio indicates that  # noqa: E501
-                # the user should enter a UTC datetime for the due date. Coerce this to UTC before creating the  # noqa: E501
-                # string representation.
-                else subsection_block.fields["due"].astimezone(pytz.UTC).isoformat()
-            ),
+            **due_date_dict,
             "submission_types": ["none"],
             "published": False,
         }

src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/client.py

@@ -24,19 +24,20 @@
 
 from ol_openedx_canvas_integration.api import course_graded_items
 from ol_openedx_canvas_integration.client import CanvasClient, create_assignment_payload
-from ol_openedx_canvas_integration.utils import get_canvas_course_id
+from ol_openedx_canvas_integration.utils import get_use_canvas_due_dates, get_canvas_course_id
 
 logger = logging.getLogger(__name__)
 TASK_LOG = logging.getLogger("edx.celery.task")
 
 
-def diff_assignments(openedx_assignments, canvas_assignments_map):
+def diff_assignments(openedx_assignments, canvas_assignments_map, use_canvas_dates=False):
     """Perform a diff between the assignments in Canvas and Open edX.
 
     Args:
         openedx_assignments (list): List of Open edX subsection objects
         canvas_assignments_map (dict): Map of assignment integration IDs to Canvas
                                        assignment IDs
+        use_canvas_dates (bool): Whether to sync the due dates of the assignments with the due dates of the subsections
 
     Returns:
         dict: The diff between the assignments with the following structure:
@@ -49,7 +50,7 @@ def diff_assignments(openedx_assignments, canvas_assignments_map):
     assignment_diff = {"add": [], "update": {}, "delete": []}
     for subsection in openedx_assignments:
         integration_id = str(subsection.location)
-        payload = create_assignment_payload(subsection)
+        payload = create_assignment_payload(subsection, use_canvas_dates=use_canvas_dates)
         canvas_assignment = canvas_assignments_map.pop(integration_id, None)
         if canvas_assignment:
             # if the assignment exists in Canvas, remove from the map to indicate
@@ -156,6 +157,7 @@ def sync_course_assignments_with_canvas(course_id):
     course_key = CourseLocator.from_string(course_id)
     course = get_course_by_id(course_key)
     canvas_course_id = get_canvas_course_id(course)
+    use_canvas_due_dates = get_use_canvas_due_dates(course)
 
     if not canvas_course_id:
         logger.info(
@@ -170,7 +172,7 @@ def sync_course_assignments_with_canvas(course_id):
     canvas = CanvasClient(canvas_course_id=canvas_course_id)
     canvas_assignments = canvas.get_canvas_assignments()
 
-    operations_map = diff_assignments(openedx_assignments, canvas_assignments)
+    operations_map = diff_assignments(openedx_assignments, canvas_assignments, use_canvas_due_dates)
     logger.info(
         "Syncing assignments with Canvas. Adding: %d, Updating: %d, Deleting: %d",
         len(operations_map["add"]),
@@ -198,9 +200,7 @@ def _sync_canvas_due_dates(course_id: str):
             course_id,
         )
         return
-    use_canvas_due_dates = course.other_course_settings.get(
-        "use_canvas_due_dates", False
-    )
+    use_canvas_due_dates = get_use_canvas_due_dates(course)
     if not use_canvas_due_dates:
         TASK_LOG.info(
             "Due Date Sync: Disabled. Skipped for course %s",

src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/cms_tasks.py

@@ -6,6 +6,11 @@ def get_canvas_course_id(course=None):
     return course.other_course_settings.get("canvas_id") if course else None
 
 
+def get_use_canvas_due_dates(course=None):
+    """Get the canvas due dates setting from the course settings"""
+    return course.other_course_settings.get("use_canvas_due_dates", False) if course else None
+
+
 def get_task_output_formatted_message(task_output):
     """Take the edX task output and format a message for table display on task result"""
     # this reports on actions for a course as a whole