Skip to content

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 text preview support to jobs API (#12169)

Christian Byrne850e8b42ff67
diff --git a/comfy_execution/jobs.py b/comfy_execution/jobs.py
index 370014fb6..fcd7ef735 100644
--- a/comfy_execution/jobs.py
+++ b/comfy_execution/jobs.py
@@ -20,7 +20,7 @@ class JobStatus:
# Media types that can be previewed in the frontend
-PREVIEWABLE_MEDIA_TYPES = frozenset({'images', 'video', 'audio', '3d'})
+PREVIEWABLE_MEDIA_TYPES = frozenset({'images', 'video', 'audio', '3d', 'text'})
# 3D file extensions for preview fallback (no dedicated media_type exists)
THREE_D_EXTENSIONS = frozenset({'.obj', '.fbx', '.gltf', '.glb', '.usdz'})
@@ -75,6 +75,23 @@ def normalize_outputs(outputs: dict) -> dict:
normalized[node_id] = normalized_node
return normalized
+# Text preview truncation limit (1024 characters) to prevent preview_output bloat
+TEXT_PREVIEW_MAX_LENGTH = 1024
+
+
+def _create_text_preview(value: str) -> dict:
+ """Create a text preview dict with optional truncation.
+
+ Returns:
+ dict with 'content' and optionally 'truncated' flag
+ """
+ if len(value) <= TEXT_PREVIEW_MAX_LENGTH:
+ return {'content': value}
+ return {
+ 'content': value[:TEXT_PREVIEW_MAX_LENGTH],
+ 'truncated': True
+ }
+
def _extract_job_metadata(extra_data: dict) -> tuple[Optional[int], Optional[str]]:
"""Extract create_time and workflow_id from extra_data.
@@ -221,23 +238,43 @@ def get_outputs_summary(outputs: dict) -> tuple[int, Optional[dict]]:
continue
for item in items:
- normalized = normalize_output_item(item)
- if normalized is None:
- continue
+ if not isinstance(item, dict):
+ # Handle text outputs (non-dict items like strings or tuples)
+ normalized = normalize_output_item(item)
+ if normalized is None:
+ # Not a 3D file string — check for text preview
+ if media_type == 'text':
+ count += 1
+ if preview_output is None:
+ if isinstance(item, tuple):
+ text_value = item[0] if item else ''
+ else:
+ text_value = str(item)
+ text_preview = _create_text_preview(text_value)
+ enriched = {
+ **text_preview,
+ 'nodeId': node_id,
+ 'mediaType': media_type
+ }
+ if fallback_preview is None:
+ fallback_preview = enriched
+ continue
+ # normalize_output_item returned a dict (e.g. 3D file)
+ item = normalized
count += 1
if preview_output is not None:
continue
- if isinstance(normalized, dict) and is_previewable(media_type, normalized):
+ if is_previewable(media_type, item):
enriched = {
- **normalized,
+ **item,
'nodeId': node_id,
}
- if 'mediaType' not in normalized:
+ if 'mediaType' not in item:
enriched['mediaType'] = media_type
- if normalized.get('type') == 'output':
+ if item.get('type') == 'output':
preview_output = enriched
elif fallback_preview is None:
fallback_preview = enriched
diff --git a/tests/execution/test_jobs.py b/tests/execution/test_jobs.py
index 83c36fe48..814af5c13 100644
--- a/tests/execution/test_jobs.py
+++ b/tests/execution/test_jobs.py
@@ -38,13 +38,13 @@ class TestIsPreviewable:
"""Unit tests for is_previewable()"""
def test_previewable_media_types(self):
- """Images, video, audio, 3d media types should be previewable."""
- for media_type in ['images', 'video', 'audio', '3d']:
+ """Images, video, audio, 3d, text media types should be previewable."""
+ for media_type in ['images', 'video', 'audio', '3d', 'text']:
assert is_previewable(media_type, {}) is True
def test_non_previewable_media_types(self):
"""Other media types should not be previewable."""
- for media_type in ['latents', 'text', 'metadata', 'files']:
+ for media_type in ['latents', 'metadata', 'files']:
assert is_previewable(media_type, {}) is False
def test_3d_extensions_previewable(self):