Add ability to cancel tasks, automatically fail running tasks on app opening (#36)

* Add ability to cancel tasks, automatically fail running tasks on app opening

* add cancel button on the task progress page

Author: qsodia

deid/home/apps.py

@@ -0,0 +1,19 @@
+from django.apps import AppConfig
+
+
+class HomeConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'home'
+
+    def ready(self):
+        from django.db import OperationalError, ProgrammingError
+        try:
+            from .models import Project
+            stale_count = Project.objects.filter(
+                status__in=[Project.TaskStatus.PENDING, Project.TaskStatus.RUNNING]
+            ).update(status=Project.TaskStatus.FAILED, process_pid=None)
+            if stale_count > 0:
+                print(f"Marked {stale_count} stale task(s) as FAILED on startup")
+        except (OperationalError, ProgrammingError):
+            pass
+

deid/home/management/commands/worker.py

@@ -35,6 +35,9 @@ def run_subprocess_and_capture_log_path(cmd, env, task):
         bufsize=1
     )
 
+    task.process_pid = process.pid
+    task.save()
+    
     log_path_captured = False
     stdout_lines = []
     stderr_lines = []
@@ -673,6 +676,7 @@ def run_worker():
                     print(f"Error processing task {task.id}: {str(e)}")
                     task.status = Project.TaskStatus.FAILED
                 finally:
+                    task.process_pid = None
                     task.save()
                     print(f"Task {task.id} finished with status: {task.status}")
 

deid/home/migrations/0002_add_cancelled_status_and_process_pid.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.7 on 2025-12-03 20:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('home', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='process_pid',
+            field=models.IntegerField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='project',
+            name='status',
+            field=models.CharField(choices=[('PENDING', 'Pending'), ('RUNNING', 'Running'), ('COMPLETED', 'Completed'), ('FAILED', 'Failed'), ('CANCELLED', 'Cancelled')], default='PENDING', max_length=20),
+        ),
+        migrations.AlterField(
+            model_name='project',
+            name='task_type',
+            field=models.CharField(choices=[('IMAGE_DEID', 'Image Deidentification'), ('IMAGE_QUERY', 'Image Query'), ('HEADER_QUERY', 'Header Query'), ('HEADER_EXTRACT', 'Header Extract'), ('TEXT_DEID', 'Text Deidentification'), ('IMAGE_EXPORT', 'Image Export'), ('IMAGE_DEID_EXPORT', 'Image Deidentification and Export'), ('GENERAL_MODULE', 'General Module')], max_length=25),
+        ),
+    ]

deid/home/models.py

@@ -26,12 +26,14 @@ class TaskStatus(models.TextChoices):
         RUNNING = 'RUNNING', 'Running'
         COMPLETED = 'COMPLETED', 'Completed'
         FAILED = 'FAILED', 'Failed'
+        CANCELLED = 'CANCELLED', 'Cancelled'
 
     status = models.CharField(
         max_length=20,
         choices=TaskStatus.choices,
         default=TaskStatus.PENDING
     )
+    process_pid = models.IntegerField(null=True, blank=True)
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
     scheduled_time = models.DateTimeField(null=True, blank=True)

deid/home/urls.py

@@ -40,6 +40,7 @@
     path('verify_admin_password/', views.verify_admin_password, name='verify_admin_password'),
     path('task_list/', views.TaskListView.as_view(), name='task_list'),
     path('delete_task/<int:task_id>/', views.delete_task, name='delete_task'),
+    path('cancel_task/<int:task_id>/', views.cancel_task, name='cancel_task'),
     path('upload_module/', views.upload_module, name='upload_module'),
     path('get_modules/', views.get_modules, name='get_modules'),
     path('reset_deid_settings/', views.reset_deid_settings, name='reset_deid_settings'),

deid/home/views.py

@@ -12,6 +12,7 @@
 
 import bcrypt
 import pandas as pd
+import psutil
 import pytz
 from django.db import OperationalError
 from django.http import (
@@ -1112,6 +1113,51 @@ def delete_task(request, task_id):
     except Exception as e:
         return JsonResponse({'status': 'error', 'message': str(e)}, status=400)
 
+
+def kill_process_tree(pid):
+    try:
+        parent = psutil.Process(pid)
+        children = parent.children(recursive=True)
+        for child in children:
+            try:
+                child.terminate()
+            except psutil.NoSuchProcess:
+                pass
+        parent.terminate()
+        gone, alive = psutil.wait_procs(children + [parent], timeout=5)
+        for p in alive:
+            try:
+                p.kill()
+            except psutil.NoSuchProcess:
+                pass
+    except psutil.NoSuchProcess:
+        pass
+
+
+@require_http_methods(["POST"])
+@csrf_exempt
+def cancel_task(request, task_id):
+    try:
+        task = get_object_or_404(Project, id=task_id)
+        
+        if task.status not in [Project.TaskStatus.PENDING, Project.TaskStatus.RUNNING]:
+            return JsonResponse({
+                'status': 'error',
+                'message': 'Only pending or running tasks can be cancelled'
+            }, status=400)
+        
+        if task.status == Project.TaskStatus.RUNNING and task.process_pid:
+            kill_process_tree(task.process_pid)
+        
+        task.status = Project.TaskStatus.CANCELLED
+        task.process_pid = None
+        task.save()
+        
+        return JsonResponse({'status': 'success'})
+    except Exception as e:
+        return JsonResponse({'status': 'error', 'message': str(e)}, status=400)
+
+
 # Add this middleware function to process timezone from session
 def timezone_middleware(get_response):
     def middleware(request):

deid/templates/task_list.html

@@ -29,6 +29,7 @@ <h1 class="text-xl flex-1">Projects</h1>
                             {% if task.status == 'PENDING' %}bg-yellow-100 text-yellow-800
                             {% elif task.status == 'RUNNING' %}bg-blue-100 text-blue-800
                             {% elif task.status == 'COMPLETED' %}bg-green-100 text-green-800
+                            {% elif task.status == 'CANCELLED' %}bg-gray-100 text-gray-800
                             {% else %}bg-red-100 text-red-800{% endif %}">
                             {{ task.get_status_display }}
                         </span>
@@ -47,7 +48,10 @@ <h1 class="text-xl flex-1">Projects</h1>
                         <div class="flex space-x-4 justify-end">
                             <a href="{% url 'task_progress' %}?project_id={{ task.id }}" 
                                class="text-indigo-600 hover:text-indigo-900">Open</a>
-                            {% if task.status != 'RUNNING' %}
+                            {% if task.status == 'PENDING' or task.status == 'RUNNING' %}
+                                <button onclick="cancelTask('{{ task.id }}')" 
+                                        class="text-orange-600 hover:text-orange-900">Cancel</button>
+                            {% else %}
                                 <button onclick="deleteTask('{{ task.id }}')" 
                                         class="text-red-600 hover:text-red-900">Delete</button>
                             {% endif %}
@@ -71,6 +75,31 @@ <h1 class="text-xl flex-1">Projects</h1>
     return document.querySelector('meta[name="csrf_token"]').getAttribute('content');
 }
 
+async function cancelTask(taskId) {
+    if (!confirm('Are you sure you want to cancel this task?')) {
+        return;
+    }
+    
+    try {
+        const response = await fetch(`/cancel_task/${taskId}/`, {
+            method: 'POST',
+            headers: {
+                'X-CSRFToken': getCsrfToken(),
+            },
+        });
+        
+        if (response.ok) {
+            window.location.reload();
+        } else {
+            const result = await response.json();
+            alert('Failed to cancel task: ' + (result.message || 'Unknown error'));
+        }
+    } catch (error) {
+        console.error('Error:', error);
+        alert('Failed to cancel task: ' + error.message);
+    }
+}
+
 async function deleteTask(taskId) {
     if (!confirm('Are you sure you want to delete this project?')) {
         return;

deid/templates/task_progress.html

@@ -9,7 +9,8 @@ <h1 class="text-xl flex-1">{{ module_name }} ({{ project_name }})</h1>
         <button id="openOutputFolder" class="px-2 py-1 bg-white shadow text-xs hover:bg-gray-100">Open output folder</button>
         <div>
             <button id="openAppdataFolder" class="px-2 py-1 bg-white shadow text-xs hover:bg-gray-100 mr-2">Open appdata folder</button>
-            <button id="openLogsFolder" class="px-2 py-1 bg-white shadow text-xs hover:bg-gray-100">Open logs folder</button>
+            <button id="openLogsFolder" class="px-2 py-1 bg-white shadow text-xs hover:bg-gray-100 mr-2">Open logs folder</button>
+            <button id="cancelTask" class="px-2 py-1 bg-white shadow text-xs hover:bg-gray-100 text-orange-600 hover:text-orange-900 hidden">Cancel task</button>
         </div>
     </div>
     <div id="errorPopup" class="hidden fixed inset-0 bg-gray-600 bg-opacity-50 overflow-y-auto h-full w-full">
@@ -27,6 +28,21 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
             </div>
         </div>
     </div>
+    <div id="cancelledPopup" class="hidden fixed inset-0 bg-gray-600 bg-opacity-50 overflow-y-auto h-full w-full">
+        <div class="relative top-20 mx-auto p-5 border w-96 shadow-lg rounded-md bg-white">
+            <div class="mt-3 text-center">
+                <h3 id="cancelledTitle" class="text-lg leading-6 font-medium text-gray-900">Task Cancelled</h3>
+                <div class="mt-2 px-7 py-3">
+                    <p id="cancelledMessage" class="text-sm text-gray-500"></p>
+                </div>
+                <div class="items-center px-4 py-3">
+                    <button id="closeCancelled" class="px-4 py-2 bg-green-500 text-white text-base font-medium rounded-md shadow-sm hover:bg-green-600 focus:outline-none focus:ring-2 focus:ring-green-300">
+                        Close
+                    </button>
+                </div>
+            </div>
+        </div>
+    </div>
     <pre class="bg-black text-white p-4 font-mono text-xs h-[calc(100vh-13rem-45px)] overflow-y-auto whitespace-pre-wrap" id="logContent">
     </pre>
 </div>
@@ -42,6 +58,7 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
     let sameContentCount = 0;
     let pollInterval;
     let hasError = false;
+    let taskStatus = null;
 
     // List of error messages from validate_config
     const errorMessages = [
@@ -68,6 +85,8 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
             const response = await fetch(`/api/task_status/${projectId}`);
             const data = await response.json();
 
+            taskStatus = data.status;
+            
             if (data.log_path && data.log_path !== '' && data.log_path !== logPath) {
                 logPath = data.log_path;
                 console.log('Log path updated to:', logPath);
@@ -84,6 +103,7 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
             }
 
             updateFolderLinks();
+            updateCancelButton();
 
             if (data.status === 'FAILED') {
                 hasError = true;
@@ -96,6 +116,18 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
                 }, 3000);
                 return;
             }
+            
+            if (data.status === 'CANCELLED') {
+                hasError = true;
+                document.getElementById('cancelledMessage').textContent = "Task has been cancelled.";
+                document.getElementById('cancelledPopup').classList.remove('hidden');
+                clearInterval(pollInterval);
+                clearInterval(statusInterval);
+                setTimeout(() => {
+                    window.location.href = '/task_list';
+                }, 3000);
+                return;
+            }
         } catch (error) {
             console.error('Error checking task status:', error);
         }
@@ -151,6 +183,53 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
         }
     }
 
+    function updateCancelButton() {
+        const cancelBtn = document.getElementById('cancelTask');
+        
+        if (taskStatus === 'PENDING' || taskStatus === 'RUNNING') {
+            cancelBtn.classList.remove('hidden');
+        } else {
+            cancelBtn.classList.add('hidden');
+        }
+    }
+    
+    function getCsrfToken() {
+        return document.querySelector('meta[name="csrf_token"]').getAttribute('content');
+    }
+    
+    async function cancelTask() {
+        if (!confirm('Are you sure you want to cancel this task?')) {
+            return;
+        }
+        
+        try {
+            const response = await fetch(`/cancel_task/${projectId}/`, {
+                method: 'POST',
+                headers: {
+                    'X-CSRFToken': getCsrfToken(),
+                },
+            });
+            
+            if (response.ok) {
+                hasError = true;
+                document.getElementById('cancelledTitle').textContent = "Cancelling Task";
+                document.getElementById('cancelledMessage').textContent = "Task is being cancelled...";
+                document.getElementById('cancelledPopup').classList.remove('hidden');
+                clearInterval(pollInterval);
+                clearInterval(statusInterval);
+                setTimeout(() => {
+                    window.location.href = '/task_list';
+                }, 2000);
+            } else {
+                const result = await response.json();
+                alert('Failed to cancel task: ' + (result.message || 'Unknown error'));
+            }
+        } catch (error) {
+            console.error('Error:', error);
+            alert('Failed to cancel task: ' + error.message);
+        }
+    }
+    
     async function fetchLogContent() {
         if (hasError) return;
 
@@ -187,6 +266,9 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">Error</h3>
         document.getElementById('errorPopup').classList.add('hidden');
         window.history.back(); // Return to previous page
     });
+    
+    // Handle cancel button click
+    document.getElementById('cancelTask').addEventListener('click', cancelTask);
 
     // Initial fetch
     fetchLogContent();