The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.
feat: add cancelled filter to /jobs (#11680)
ric-yu04c49a29b493
diff --git a/comfy_execution/jobs.py b/comfy_execution/jobs.pyindex 59fb49357..97fd803b8 100644--- a/comfy_execution/jobs.py+++ b/comfy_execution/jobs.py@@ -14,8 +14,9 @@ class JobStatus:IN_PROGRESS = 'in_progress'COMPLETED = 'completed'FAILED = 'failed'+ CANCELLED = 'cancelled'- ALL = [PENDING, IN_PROGRESS, COMPLETED, FAILED]+ ALL = [PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED]# Media types that can be previewed in the frontend@@ -94,12 +95,6 @@ def normalize_history_item(prompt_id: str, history_item: dict, include_outputs:status_info = history_item.get('status', {})status_str = status_info.get('status_str') if status_info else None- if status_str == 'success':- status = JobStatus.COMPLETED- elif status_str == 'error':- status = JobStatus.FAILED- else:- status = JobStatus.COMPLETEDoutputs = history_item.get('outputs', {})outputs_count, preview_output = get_outputs_summary(outputs)@@ -107,6 +102,7 @@ def normalize_history_item(prompt_id: str, history_item: dict, include_outputs:execution_error = Noneexecution_start_time = Noneexecution_end_time = None+ was_interrupted = Falseif status_info:messages = status_info.get('messages', [])for entry in messages:@@ -119,6 +115,15 @@ def normalize_history_item(prompt_id: str, history_item: dict, include_outputs:execution_end_time = event_data.get('timestamp')if event_name == 'execution_error':execution_error = event_data+ elif event_name == 'execution_interrupted':+ was_interrupted = True++ if status_str == 'success':+ status = JobStatus.COMPLETED+ elif status_str == 'error':+ status = JobStatus.CANCELLED if was_interrupted else JobStatus.FAILED+ else:+ status = JobStatus.COMPLETEDjob = prune_dict({'id': prompt_id,@@ -268,13 +273,13 @@ def get_all_jobs(for item in queued:jobs.append(normalize_queue_item(item, JobStatus.PENDING))- include_completed = JobStatus.COMPLETED in status_filter- include_failed = JobStatus.FAILED in status_filter- if include_completed or include_failed:+ history_statuses = {JobStatus.COMPLETED, JobStatus.FAILED, JobStatus.CANCELLED}+ requested_history_statuses = history_statuses & set(status_filter)+ if requested_history_statuses:for prompt_id, history_item in history.items():- is_failed = history_item.get('status', {}).get('status_str') == 'error'- if (is_failed and include_failed) or (not is_failed and include_completed):- jobs.append(normalize_history_item(prompt_id, history_item))+ job = normalize_history_item(prompt_id, history_item)+ if job.get('status') in requested_history_statuses:+ jobs.append(job)if workflow_id:jobs = [j for j in jobs if j.get('workflow_id') == workflow_id]diff --git a/tests/execution/test_jobs.py b/tests/execution/test_jobs.pyindex 918c8080a..4d2f9ed36 100644--- a/tests/execution/test_jobs.py+++ b/tests/execution/test_jobs.py@@ -19,6 +19,7 @@ class TestJobStatus:assert JobStatus.IN_PROGRESS == 'in_progress'assert JobStatus.COMPLETED == 'completed'assert JobStatus.FAILED == 'failed'+ assert JobStatus.CANCELLED == 'cancelled'def test_all_contains_all_statuses(self):"""ALL should contain all status values."""@@ -26,7 +27,8 @@ class TestJobStatus:assert JobStatus.IN_PROGRESS in JobStatus.ALLassert JobStatus.COMPLETED in JobStatus.ALLassert JobStatus.FAILED in JobStatus.ALL- assert len(JobStatus.ALL) == 4+ assert JobStatus.CANCELLED in JobStatus.ALL+ assert len(JobStatus.ALL) == 5class TestIsPreviewable:@@ -336,6 +338,40 @@ class TestNormalizeHistoryItem:assert job['execution_error']['node_type'] == 'KSampler'assert job['execution_error']['exception_message'] == 'CUDA out of memory'+ def test_cancelled_job(self):+ """Cancelled/interrupted history item should have cancelled status."""+ history_item = {+ 'prompt': (+ 5,+ 'prompt-cancelled',+ {'nodes': {}},+ {'create_time': 1234567890000},+ ['node1'],+ ),+ 'status': {+ 'status_str': 'error',+ 'completed': False,+ 'messages': [+ ('execution_start', {'prompt_id': 'prompt-cancelled', 'timestamp': 1234567890500}),+ ('execution_interrupted', {+ 'prompt_id': 'prompt-cancelled',+ 'node_id': '5',+ 'node_type': 'KSampler',+ 'executed': ['1', '2', '3'],+ 'timestamp': 1234567891000,+ })+ ]+ },+ 'outputs': {},+ }++ job = normalize_history_item('prompt-cancelled', history_item)+ assert job['status'] == 'cancelled'+ assert job['execution_start_time'] == 1234567890500+ assert job['execution_end_time'] == 1234567891000+ # Cancelled jobs should not have execution_error set+ assert 'execution_error' not in job+def test_include_outputs(self):"""When include_outputs=True, should include full output data."""history_item = {