Move importing assignments into a celery task (#118)

Closes #110

Author: ElijahFeldman7

tin/apps/courses/forms.py

@@ -74,6 +74,16 @@ def __init__(self, course, *args, **kwargs):
             required=False,
         )
 
+    def serialize_for_task(self):
+        return {
+            "folder_ids": [f.id for f in self.cleaned_data["folders"]],
+            "assignment_ids": [a.id for a in self.cleaned_data["assignments"]],
+            "hide": self.cleaned_data["hide"],
+            "shift_due_dates": self.cleaned_data["shift_due_dates"],
+            "copy_graders": self.cleaned_data["copy_graders"],
+            "copy_files": self.cleaned_data["copy_files"],
+        }
+
 
 class StudentForm(forms.ModelForm):
     students = UserMultipleChoiceField(

tin/apps/courses/tasks.py

@@ -0,0 +1,69 @@
+from pathlib import Path
+
+from celery import shared_task
+from django.utils import timezone
+
+from tin.apps.assignments.models import Assignment, Folder
+
+from .models import Course
+
+
+@shared_task(bind=True)
+def import_course_data_tasks(self, target_id, source_id, data):
+    target_course = Course.objects.get(pk=target_id)
+
+    folder_ids = data.get("folder_ids", [])
+    individual_assignment_ids = data.get("assignment_ids", [])
+
+    assignments_to_process = []
+
+    folders = Folder.objects.filter(id__in=folder_ids)
+    for folder in folders:
+        folder_assignments = list(folder.assignments.all())
+        folder.pk = None
+        folder._state.adding = True
+        folder.course = target_course
+        folder.save()
+
+        for a in folder_assignments:
+            assignments_to_process.append((a, folder.id))
+
+    individual_assignments = Assignment.objects.filter(id__in=individual_assignment_ids)
+    for a in individual_assignments:
+        assignments_to_process.append((a, None))
+
+    total = len(assignments_to_process)
+
+    for index, (old_assignment, new_folder_id) in enumerate(assignments_to_process):
+        assignment = old_assignment
+        assignment.pk = None
+        assignment._state.adding = True
+        assignment.course = target_course
+        assignment.folder_id = new_folder_id
+        assignment.assigned = timezone.now()
+        assignment.grader_file = None
+
+        if data.get("hide"):
+            assignment.hidden = True
+        assignment.save()
+        assignment.make_assignment_dir()
+
+        if data.get("copy_graders") and old_assignment.grader_file:
+            with open(old_assignment.grader_file.path, "rb") as f:
+                assignment.save_grader_file(f.read())
+
+        if data.get("copy_files"):
+            for _, filename, path, _, _ in old_assignment.list_files():
+                content = Path(path).read_bytes()
+                assignment.save_file(content, filename)
+
+        self.update_state(
+            state="PROGRESS",
+            meta={
+                "current": index + 1,
+                "total": total,
+                "percent": int(((index + 1) / total) * 100) if total > 0 else 100,
+            },
+        )
+
+    return {"status": "Completed", "total": total}

tin/apps/courses/urls.py

@@ -20,4 +20,9 @@
     path("<int:course_id>/students/manage", views.manage_students_view, name="manage_students"),
     path("<int:course_id>/add_period", views.add_period_view, name="add_period"),
     path("<int:course_id>/edit_period/<int:period_id>", views.edit_period_view, name="edit_period"),
+    path(
+        "<int:course_id>/import/status/<str:task_id>",
+        views.import_status_view,
+        name="import_status",
+    ),
 ]

tin/apps/courses/views.py

@@ -1,6 +1,7 @@
-from datetime import date, timedelta
-from pathlib import Path
+from datetime import timedelta
 
+from celery.result import AsyncResult
+from django.http import JsonResponse
 from django.shortcuts import get_object_or_404, redirect, render
 from django.utils import timezone
 
@@ -14,6 +15,7 @@
     StudentForm,
 )
 from .models import Course, Period, StudentImport
+from .tasks import import_course_data_tasks
 
 
 # Create your views here.
@@ -178,66 +180,10 @@ def import_from_selected_course(request, course_id, other_course_id):
     if request.method == "POST":
         form = ImportFromSelectedCourseForm(data=request.POST, course=other_course)
         if form.is_valid():
-            assignments_to_process = []
-
-            # Import folders
-            if form.cleaned_data["folders"]:
-                for folder in form.cleaned_data["folders"]:
-                    assignments = list(folder.assignments.all())
-                    folder.pk = None
-                    folder._state.adding = True
-                    folder.course = course
-                    folder.save()
-                    for assignment in assignments:
-                        assignments_to_process.append((assignment, course, folder))
-
-            # Import assignments
-            if form.cleaned_data["assignments"]:
-                for assignment in form.cleaned_data["assignments"]:
-                    assignments_to_process.append((assignment, course, None))
-
-            for assignment, course, folder in assignments_to_process:
-                old_id = assignment.id
-
-                # Save as new
-                assignment.pk = None
-                assignment._state.adding = True
-
-                # Update course, folder, assigned date, and grader file
-                assignment.course = course
-                if folder:
-                    assignment.folder = folder
-                assignment.assigned = timezone.now()
-                assignment.grader_file = None
-
-                # Some user options need to be applied before saving
-                if form.cleaned_data["hide"]:
-                    assignment.hidden = True
-                if form.cleaned_data["shift_due_dates"]:
-                    due = assignment.due
-                    try:
-                        assignment.due = due.replace(year=assignment.due.year + 1)
-                    except ValueError:  # February 29 -> February 28
-                        assignment.due = due + date(due.year + 1, 3, 1) - date(due.year, 3, 1)
-
-                assignment.save()
-
-                # Make directory with new ID
-                assignment.make_assignment_dir()
-
-                # Access the old assignment
-                old_assignment = Assignment.objects.get(id=old_id)
-
-                if form.cleaned_data["copy_graders"] and old_assignment.grader_file:
-                    with open(old_assignment.grader_file.path) as f:
-                        assignment.save_grader_file(f.read())  # Save to new directory
-
-                if form.cleaned_data["copy_files"]:
-                    for _, filename, path, _, _ in old_assignment.list_files():
-                        content = Path(path).read_bytes()
-                        assignment.save_file(content, filename)
+            task_data = form.serialize_for_task()
 
-            return redirect("courses:show", course.id)
+            task = import_course_data_tasks.delay(course.id, other_course.id, task_data)
+            return redirect("courses:import_status", course_id=course.id, task_id=task.id)
     else:
         form = ImportFromSelectedCourseForm(course=other_course)
 
@@ -424,3 +370,26 @@ def edit_period_view(request, course_id, period_id):
         "courses/edit_create.html",
         {"form": form, "course": course, "nav_item": "Edit Period"},
     )
+
+
+@teacher_or_superuser_required
+def import_status_view(request, course_id, task_id):
+    course = get_object_or_404(Course.objects.filter_editable(request.user), id=course_id)
+    task = AsyncResult(task_id)
+
+    if request.headers.get("X-Requested-With") == "XMLHttpRequest":
+        response_data = {
+            "state": task.state,
+            "ready": task.ready(),
+        }
+        if task.state == "PROGRESS":
+            response_data.update(task.info)
+        elif task.ready():
+            response_data["result"] = task.result
+        return JsonResponse(response_data)
+
+    return render(
+        request,
+        "courses/import_status.html",
+        {"course": course, "task_id": task_id, "nav_item": "Import Status"},
+    )

tin/templates/courses/import_status.html

@@ -0,0 +1,63 @@
+{% extends "base.html" %}
+{% load static %}
+
+{% block title %}
+  Turn-In: {{ course.name }}: Import Status
+{% endblock %}
+
+{% block main %}
+
+  <h2>{{ course.name }}: Import Status</h2>
+
+  <div id="status-container">
+    <p id="status-message">Checking import status...</p>
+    <div id="progress-container" style="display: none;">
+      <progress id="progress-bar" value="0" max="100" style="width: 100%;"></progress>
+      <p id="progress-text"></p>
+    </div>
+  </div>
+
+  <p id="complete-message" style="display: none;">
+    <a href="{% url 'courses:show' course.id %}">Return to course</a>
+  </p>
+
+  <script>
+    $(function() {
+      function checkStatus() {
+        $.ajax({
+          url: window.location.href,
+          headers: {
+            "X-Requested-With": "XMLHttpRequest"
+          },
+          success: function(data) {
+            if (data.state === "PROGRESS") {
+              $("#status-message").text("Importing...");
+              $("#progress-container").show();
+              $("#progress-bar").val(data.percent || 0);
+              $("#progress-text").text("Processing " + (data.current || 0) + " of " + (data.total || 0) + " assignments");
+              setTimeout(checkStatus, 1000);
+            } else if (data.state === "PENDING") {
+              $("#status-message").text("Task pending...");
+              setTimeout(checkStatus, 1000);
+            } else if (data.ready) {
+              $("#status-message").text("Import complete!");
+              $("#progress-container").hide();
+              $("#complete-message").show();
+            } else if (data.state === "FAILURE") {
+              $("#status-message").text("Import failed. Please try again.");
+            } else {
+              setTimeout(checkStatus, 1000);
+            }
+          },
+          error: function(error) {
+            $("#status-message").text("Error checking status.");
+            console.error("Error:", error);
+          }
+        });
+      }
+
+      checkStatus();
+    });
+  </script>
+
+{% endblock %}