mirror of
https://github.com/comfyanonymous/ComfyUI.git
synced 2026-06-12 01:07:30 +08:00
ce200c0850
Some checks are pending
Detect Unreviewed Merge / detect (push) Waiting to run
Python Linting / Run Ruff (push) Waiting to run
Python Linting / Run Pylint (push) Waiting to run
Full Comfy CI Workflow Runs / test-stable (12.1, , linux, 3.10, [self-hosted Linux], stable) (push) Waiting to run
Full Comfy CI Workflow Runs / test-stable (12.1, , linux, 3.11, [self-hosted Linux], stable) (push) Waiting to run
Full Comfy CI Workflow Runs / test-stable (12.1, , linux, 3.12, [self-hosted Linux], stable) (push) Waiting to run
Full Comfy CI Workflow Runs / test-unix-nightly (12.1, , linux, 3.11, [self-hosted Linux], nightly) (push) Waiting to run
Execution Tests / test (macos-latest) (push) Waiting to run
Execution Tests / test (ubuntu-latest) (push) Waiting to run
Execution Tests / test (windows-latest) (push) Waiting to run
Test server launches without errors / test (push) Waiting to run
Unit Tests / test (windows-2022) (push) Waiting to run
Unit Tests / test (macos-latest) (push) Waiting to run
Unit Tests / test (ubuntu-latest) (push) Waiting to run
* feat(assets): enrich executed WS message with asset metadata
When --enable-assets is set, each file-type output entry in the
`executed` WebSocket message now includes id, name, asset_hash, size,
and mime_type — matching the shape already returned by /upload/image.
The enrichment lives in comfy_execution/asset_enrichment.py (no torch
dependency) and is called from both send sites in execution.py: freshly
executed nodes register the file inline via register_file_in_place;
cached node re-sends look up the existing AssetReference by file path
to avoid re-hashing. Errors are caught per-entry so a failure never
blocks the WS message from sending.
* fix(assets): inject only id in executed WS message per Asset Identity RFC
Per the Asset Identity RFC, the executed WebSocket payload should carry
id alone — hash is already encoded in the filename, and name/preview_url/
size belong behind GET /api/assets/{id} rather than being pushed eagerly.
Simplifies the DB lookup path: we only need ref.id, so the asset.hash
null-check is no longer required as a fallback trigger.
* fix(assets): reject path traversal when resolving output abs_path
Subfolder/filename were joined and absolutized without containment check,
so '..' segments or an absolute filename could escape the type's base
directory and register an unrelated on-disk file as an asset.
Add commonpath-based containment check; skip enrichment (warn, leave
entry unchanged) when the resolved path escapes base. Catches ValueError
from cross-drive paths on Windows.
* docs(assets): drop Asset Identity RFC reference from docstring
* docs(assets): trim docstring to what enrichment does, not what it doesn't
* test(assets): use real platform paths so containment check works on Windows
The previous test setup patched os.path.abspath to identity and used a
POSIX-style '/output' base, which collided with Windows path separators
in os.path.commonpath. Drop the abspath/join patches and use a real
tempdir-rooted base so the containment check runs against actual
platform paths.
* refactor(assets): enrich at output-processing time, not in the WS send path
Per review: enrichment lived inside the client_id-guarded send sites, so a
headless run (no websocket client) never registered assets at all, and
ui_outputs/history stored the un-enriched entries.
Now output_ui is enriched once, right after the node produces it and before
it is stored in ui_outputs — so registration happens regardless of connected
clients, and the asset id flows into history and the execution cache for
free. _send_cached_ui re-sends the stored (already-enriched) dict verbatim,
which lets the DB-lookup-by-path fallback be deleted: every enrichment is
now a fresh output, and register_file_in_place re-hashes on upsert so an
overwritten path can never carry a stale id.
67 lines
2.8 KiB
Python
67 lines
2.8 KiB
Python
"""Enrich executed-node output entries with asset id."""
|
|
import logging
|
|
import os
|
|
|
|
|
|
def enrich_output_with_assets(output_ui: dict) -> dict:
|
|
"""Register file-type output entries as assets and inject their ``id``.
|
|
|
|
Runs at output-processing time, once per produced output, when
|
|
--enable-assets is set. Returns a new dict; entries without a resolvable
|
|
on-disk file path are left unchanged. Errors are caught per-entry so a
|
|
failure never blocks execution or the other entries.
|
|
"""
|
|
from comfy.cli_args import args
|
|
if not args.enable_assets:
|
|
return output_ui
|
|
|
|
import folder_paths
|
|
from app.assets.services.ingest import register_file_in_place, DependencyMissingError
|
|
|
|
enriched = {}
|
|
for key, entries in output_ui.items():
|
|
if not isinstance(entries, list):
|
|
enriched[key] = entries
|
|
continue
|
|
new_entries = []
|
|
for entry in entries:
|
|
if not isinstance(entry, dict) or "filename" not in entry or "type" not in entry:
|
|
new_entries.append(entry)
|
|
continue
|
|
try:
|
|
base = folder_paths.get_directory_by_type(entry["type"])
|
|
if base is None:
|
|
new_entries.append(entry)
|
|
continue
|
|
base_abs = os.path.abspath(base)
|
|
abs_path = os.path.abspath(os.path.join(base_abs, entry.get("subfolder") or "", entry["filename"]))
|
|
try:
|
|
if os.path.commonpath([base_abs, abs_path]) != base_abs:
|
|
raise ValueError("escapes base")
|
|
except ValueError:
|
|
logging.warning("Asset enrichment skipped (path escapes base): %s", entry.get("filename"))
|
|
new_entries.append(entry)
|
|
continue
|
|
if not os.path.isfile(abs_path):
|
|
new_entries.append(entry)
|
|
continue
|
|
|
|
# Register unconditionally: the file was just produced, and
|
|
# register_file_in_place re-hashes so an overwritten path can
|
|
# never carry a stale id.
|
|
result = register_file_in_place(
|
|
abs_path=abs_path,
|
|
name=entry["filename"],
|
|
tags=[entry["type"]],
|
|
)
|
|
|
|
entry = dict(entry)
|
|
entry["id"] = result.ref.id
|
|
except DependencyMissingError:
|
|
logging.warning("Asset enrichment skipped (blake3 not available): %s", entry.get("filename"))
|
|
except Exception:
|
|
logging.warning("Failed to enrich output entry with asset id: %s", entry.get("filename"), exc_info=True)
|
|
new_entries.append(entry)
|
|
enriched[key] = new_entries
|
|
return enriched
|