Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
22e0742d47 | ||
|
|
90ecd3218c | ||
|
|
1f136526cf | ||
|
|
e5db513585 | ||
|
|
c962fa5adf | ||
|
|
d054d978cd | ||
|
|
37b77f837a | ||
|
|
1113a80229 |
@@ -91,6 +91,18 @@ CLIENT_CAPABILITIES = [
|
||||
# legacy client without the decoder surfaces NEGOTIATION_FAILED
|
||||
# at descriptor-load time rather than crashing at execute.
|
||||
Capability.MODEL_3D_GLB_INLINE,
|
||||
# 3D MODEL BUNDLE envelope (multi-file: primary mesh plus N
|
||||
# companion files — textures / .mtl / .bin / etc. — as a single
|
||||
# coherent unit). The decoder in
|
||||
# ``serialization.decode_model3d_envelope`` dispatches on
|
||||
# ``encoding="bundle_inline"`` and returns a ``BundledFile3D``
|
||||
# (a ``File3D`` subclass) whose ``get_source()`` / ``save_to()``
|
||||
# materialise the whole bundle on disk so cross-file refs (.obj
|
||||
# -> .mtl -> textures; .gltf -> .bin + textures) resolve via
|
||||
# the filesystem. Servers gate bundle-emitting descriptors on
|
||||
# this token; legacy clients surface NEGOTIATION_FAILED at
|
||||
# descriptor-load time rather than crashing at execute.
|
||||
Capability.MODEL_3D_BUNDLE_INLINE,
|
||||
]
|
||||
|
||||
# Reported in the X-RNP-Client-Version header.
|
||||
|
||||
@@ -0,0 +1,526 @@
|
||||
"""Smoke test for the DYNAMIC_COMBO + AUTOGROW parser extension.
|
||||
|
||||
Verifies the proxy_node parser now constructs real V3
|
||||
``IO.DynamicCombo.Input`` and ``IO.Autogrow.Input`` objects from the
|
||||
flattened RNP wire shapes that the server already emits, instead of
|
||||
falling through to the opaque ``IO.Custom`` bucket.
|
||||
|
||||
Checks:
|
||||
|
||||
1. Bria-shaped 2-branch DYNAMIC_COMBO (the "false" branch has empty
|
||||
``inputs``; the "true" branch has 3 BOOLEAN sub-widgets) parses
|
||||
into an ``IO.DynamicCombo.Input`` whose two ``Option``s carry the
|
||||
right keys + sub-input objects. Proves empty branches are kept and
|
||||
that the outer id is whatever the descriptor key was (here
|
||||
``"moderation"``, *not* ``"model"``).
|
||||
2. Grok-V2-shaped DYNAMIC_COMBO with three branches, each containing
|
||||
a nested AUTOGROW(IMAGE) plus a COMBO + INT (and an aspect_ratio
|
||||
COMBO on 2 of the 3 branches). Asserts the AUTOGROW becomes a real
|
||||
``IO.Autogrow.Input`` with a ``TemplatePrefix`` whose underlying
|
||||
input is ``IO.Image.Input``, and that prefix / min / max survive.
|
||||
3. ElevenLabs-shaped DYNAMIC_COMBO whose branches mix
|
||||
``IO.Custom(<opaque_io_type>).Input`` (voiceN custom-IO) with
|
||||
primitive STRING sub-widgets — proves the recursive opaque
|
||||
fallback path inside a branch still works for partner helper
|
||||
types.
|
||||
4. Synthetic nested DYNAMIC_COMBO-inside-DYNAMIC_COMBO — no provider
|
||||
uses this today, but defensive coverage so the recursive entry
|
||||
point keeps working.
|
||||
5. Malformed DYNAMIC_COMBO / AUTOGROW shapes return ``None`` (so the
|
||||
caller skips the descriptor entirely) instead of silently
|
||||
falling through to the opaque IO.Custom bucket.
|
||||
6. Regression: ``_collect_local_validate`` output is byte-identical
|
||||
before and after the parser change (the rules-extraction path is
|
||||
independent of input construction and must not regress).
|
||||
7. AUTOGROW template that is itself a dynamic input is rejected
|
||||
(upstream Autogrow asserts this).
|
||||
8. Source-level check: the proxy_node docstring + dispatch covers
|
||||
DYNAMIC_COMBO and AUTOGROW (not just the existing primitive set).
|
||||
|
||||
Run with the ComfyUI venv (needs torch / comfy_api on PYTHONPATH):
|
||||
|
||||
python notes/run_dynamic_combo_parser.py
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import importlib.util
|
||||
import os
|
||||
import sys
|
||||
import types
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Locate the worktree under test.
|
||||
# ---------------------------------------------------------------------------
|
||||
_HERE = os.path.dirname(os.path.abspath(__file__))
|
||||
_CLIENT_DIR = os.path.dirname(_HERE)
|
||||
_COMFYUI_DIR = os.path.dirname(os.path.dirname(_CLIENT_DIR))
|
||||
|
||||
|
||||
def _load_module(name: str, path: str) -> types.ModuleType:
|
||||
spec = importlib.util.spec_from_file_location(name, path)
|
||||
mod = importlib.util.module_from_spec(spec)
|
||||
sys.modules[name] = mod
|
||||
spec.loader.exec_module(mod)
|
||||
return mod
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Stub all the heavy deps proxy_node + comfy_api/latest/_io.py pull in.
|
||||
#
|
||||
# We only need three things from the world:
|
||||
#
|
||||
# * the real V3 IO classes (DynamicCombo / Autogrow / Image / Combo / String /
|
||||
# Int / Boolean / Custom) — load ``_io.py`` standalone so we don't pay the
|
||||
# full ``comfy_api.latest`` package init (PIL, numpy, comfy.cli_args,
|
||||
# comfy_execution, the sync-class generator etc.).
|
||||
# * the real proxy_node parser helpers — load ``proxy_node.py`` after the
|
||||
# ``comfy_api.latest`` shim is in place.
|
||||
# * the real protocol module (lightweight; for the ErrorCode / Header / etc.
|
||||
# imports proxy_node does up top).
|
||||
#
|
||||
# Everything else (server.PromptServer, aiohttp, comfy_api_nodes.*) is
|
||||
# stubbed because proxy_node only references those at request-time, not at
|
||||
# import-time-after-trivial-stub.
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# 1) Stub ``torch`` — _io.py uses ``torch.Tensor`` only in type annotations
|
||||
# (``Type = torch.Tensor`` class-level field), so a bare-class stub works.
|
||||
_torch_stub = types.ModuleType("torch")
|
||||
class _Tensor: # noqa: D401
|
||||
pass
|
||||
_torch_stub.Tensor = _Tensor
|
||||
sys.modules.setdefault("torch", _torch_stub)
|
||||
|
||||
# 2) Stub ``comfy_execution.graph_utils.ExecutionBlocker`` — only used as a
|
||||
# class reference inside Output construction; never instantiated here.
|
||||
_comfy_execution = types.ModuleType("comfy_execution")
|
||||
_graph_utils = types.ModuleType("comfy_execution.graph_utils")
|
||||
class _ExecutionBlocker: # noqa: D401
|
||||
pass
|
||||
_graph_utils.ExecutionBlocker = _ExecutionBlocker
|
||||
sys.modules.setdefault("comfy_execution", _comfy_execution)
|
||||
sys.modules.setdefault("comfy_execution.graph_utils", _graph_utils)
|
||||
|
||||
# 3) Stub ``comfy_api.internal`` — _io.py imports a handful of helper names.
|
||||
# The parser code paths exercised here don't actually invoke any of these;
|
||||
# bare-function / bare-class stubs are sufficient to satisfy the import.
|
||||
_comfy_api = types.ModuleType("comfy_api")
|
||||
_comfy_api.__path__ = []
|
||||
_comfy_api_internal = types.ModuleType("comfy_api.internal")
|
||||
class _ComfyNodeInternal: # noqa: D401
|
||||
pass
|
||||
class _NodeOutputInternal: # noqa: D401
|
||||
pass
|
||||
class _classproperty: # noqa: D401
|
||||
def __init__(self, f):
|
||||
self.f = f
|
||||
def __get__(self, instance, owner):
|
||||
return self.f(owner)
|
||||
def _identity(x, *_args, **_kw):
|
||||
return x
|
||||
def _first_real_override(*_a, **_kw):
|
||||
return None
|
||||
def _is_class(x):
|
||||
return isinstance(x, type)
|
||||
def _prune_dict(d):
|
||||
return {k: v for k, v in (d or {}).items() if v is not None}
|
||||
_comfy_api_internal._ComfyNodeInternal = _ComfyNodeInternal
|
||||
_comfy_api_internal._NodeOutputInternal = _NodeOutputInternal
|
||||
_comfy_api_internal.classproperty = _classproperty
|
||||
_comfy_api_internal.copy_class = _identity
|
||||
_comfy_api_internal.first_real_override = _first_real_override
|
||||
_comfy_api_internal.is_class = _is_class
|
||||
_comfy_api_internal.prune_dict = _prune_dict
|
||||
_comfy_api_internal.shallow_clone_class = _identity
|
||||
sys.modules.setdefault("comfy_api", _comfy_api)
|
||||
sys.modules.setdefault("comfy_api.internal", _comfy_api_internal)
|
||||
|
||||
# 3b) Stub ``comfy_api.input`` for the lazy imports inside _io.py's
|
||||
# Curve / RangeInput class bodies — the parser code never touches
|
||||
# those types, but the *class body* runs at module load.
|
||||
_comfy_api_input = types.ModuleType("comfy_api.input")
|
||||
class _CurvePoint: pass # noqa: E701,D401
|
||||
class _RangeInput: pass # noqa: E701,D401
|
||||
_comfy_api_input.CurvePoint = _CurvePoint
|
||||
_comfy_api_input.RangeInput = _RangeInput
|
||||
sys.modules.setdefault("comfy_api.input", _comfy_api_input)
|
||||
|
||||
# 4) Stub ``comfy_api.latest._util`` — _io.py imports MESH / VOXEL / SVG /
|
||||
# File3D as type-token classes. We don't construct any here.
|
||||
_comfy_api_latest = types.ModuleType("comfy_api.latest")
|
||||
_comfy_api_latest.__path__ = []
|
||||
_comfy_api_latest_util = types.ModuleType("comfy_api.latest._util")
|
||||
class _MESH: pass # noqa: E701,D401
|
||||
class _VOXEL: pass # noqa: E701,D401
|
||||
class _SVG: pass # noqa: E701,D401
|
||||
class _File3D: pass # noqa: E701,D401
|
||||
_comfy_api_latest_util.MESH = _MESH
|
||||
_comfy_api_latest_util.VOXEL = _VOXEL
|
||||
_comfy_api_latest_util.SVG = _SVG
|
||||
_comfy_api_latest_util.File3D = _File3D
|
||||
sys.modules.setdefault("comfy_api.latest", _comfy_api_latest)
|
||||
sys.modules.setdefault("comfy_api.latest._util", _comfy_api_latest_util)
|
||||
|
||||
# 5) Load the real ``_io.py`` as ``comfy_api.latest._io`` — its
|
||||
# relative ``from ._util import ...`` requires the parent-package
|
||||
# setup we just did.
|
||||
_io_path = os.path.join(_COMFYUI_DIR, "comfy_api", "latest", "_io.py")
|
||||
_io_mod = _load_module("comfy_api.latest._io", _io_path)
|
||||
# Expose ``IO`` exactly like the real package does
|
||||
# (``from . import _io_public as io; IO = io`` where _io_public is just
|
||||
# ``from ._io import *``).
|
||||
_comfy_api_latest.IO = _io_mod
|
||||
_comfy_api_latest.io = _io_mod
|
||||
IO = _io_mod # local alias for the assertions below
|
||||
|
||||
# 6) Stub proxy_node's other heavyweight imports.
|
||||
for missing in (
|
||||
"server",
|
||||
"aiohttp",
|
||||
"comfy_api_nodes",
|
||||
"comfy_api_nodes.util",
|
||||
"comfy_api_nodes.util.client",
|
||||
"comfy_api_nodes.util.common_exceptions",
|
||||
):
|
||||
if missing not in sys.modules:
|
||||
m = types.ModuleType(missing)
|
||||
sys.modules[missing] = m
|
||||
m.__path__ = [] # type: ignore[attr-defined]
|
||||
sys.modules["server"].PromptServer = type("_StubPS", (), {})
|
||||
sys.modules["comfy_api_nodes.util.client"].ApiEndpoint = type("_StubAE", (), {})
|
||||
sys.modules["comfy_api_nodes.util.client"].poll_op_raw = lambda *a, **k: None
|
||||
sys.modules["comfy_api_nodes.util.common_exceptions"].ProcessingInterrupted = type(
|
||||
"_StubPI", (Exception,), {},
|
||||
)
|
||||
|
||||
# 7) Emulate the package layout for the client so its relative imports
|
||||
# work (``from .protocol import ...`` etc.).
|
||||
pkg = types.ModuleType("comfy_remote_nodes_test")
|
||||
pkg.__path__ = [_CLIENT_DIR]
|
||||
sys.modules["comfy_remote_nodes_test"] = pkg
|
||||
sys.modules["comfy_remote_nodes_test.client"] = types.ModuleType(
|
||||
"comfy_remote_nodes_test.client",
|
||||
)
|
||||
sys.modules["comfy_remote_nodes_test.serialization"] = types.ModuleType(
|
||||
"comfy_remote_nodes_test.serialization",
|
||||
)
|
||||
_load_module(
|
||||
"comfy_remote_nodes_test.protocol",
|
||||
os.path.join(_CLIENT_DIR, "protocol.py"),
|
||||
)
|
||||
|
||||
proxy_node = _load_module(
|
||||
"comfy_remote_nodes_test.proxy_node",
|
||||
os.path.join(_CLIENT_DIR, "proxy_node.py"),
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 1. Bria-shaped 2-branch DYNAMIC_COMBO.
|
||||
# ---------------------------------------------------------------------------
|
||||
bria_spec = [
|
||||
"DYNAMIC_COMBO",
|
||||
{
|
||||
"options": [
|
||||
{"key": "false", "inputs": []},
|
||||
{
|
||||
"key": "true",
|
||||
"inputs": [
|
||||
["prompt_content_moderation", "BOOLEAN", {"default": False}],
|
||||
["visual_input_moderation", "BOOLEAN", {"default": False}],
|
||||
["visual_output_moderation", "BOOLEAN", {"default": True}],
|
||||
],
|
||||
},
|
||||
],
|
||||
"tooltip": "Moderation settings",
|
||||
},
|
||||
]
|
||||
inp = proxy_node._parse_input_spec("moderation", bria_spec, optional=False)
|
||||
assert inp is not None, "Bria DYNAMIC_COMBO returned None"
|
||||
assert isinstance(inp, IO.DynamicCombo.Input), (
|
||||
f"Expected IO.DynamicCombo.Input, got {type(inp).__name__}"
|
||||
)
|
||||
assert inp.id == "moderation", f"outer id should track descriptor key, got {inp.id!r}"
|
||||
assert len(inp.options) == 2, f"expected 2 branches, got {len(inp.options)}"
|
||||
assert [o.key for o in inp.options] == ["false", "true"], (
|
||||
f"branch keys wrong: {[o.key for o in inp.options]}"
|
||||
)
|
||||
# Empty branch preserved (UX needs the dropdown entry).
|
||||
assert inp.options[0].inputs == [], "empty 'false' branch dropped"
|
||||
assert len(inp.options[1].inputs) == 3, (
|
||||
f"'true' branch should have 3 sub-inputs, got {len(inp.options[1].inputs)}"
|
||||
)
|
||||
for sub in inp.options[1].inputs:
|
||||
assert isinstance(sub, IO.Boolean.Input), (
|
||||
f"branch sub-input should be IO.Boolean.Input, got {type(sub).__name__}"
|
||||
)
|
||||
assert [s.id for s in inp.options[1].inputs] == [
|
||||
"prompt_content_moderation",
|
||||
"visual_input_moderation",
|
||||
"visual_output_moderation",
|
||||
], "branch sub-input names lost"
|
||||
print("PASS: Bria DYNAMIC_COMBO parses with empty + populated branches.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 2. Grok-V2-shaped DYNAMIC_COMBO with nested AUTOGROW(IMAGE) per branch.
|
||||
# ---------------------------------------------------------------------------
|
||||
def _grok_v2_subinputs(*, max_ref_images: int, with_aspect_ratio: bool) -> list:
|
||||
inputs: list = [
|
||||
[
|
||||
"images",
|
||||
"AUTOGROW",
|
||||
{
|
||||
"template": [
|
||||
"IMAGE",
|
||||
{"local_validate": {"image_max_batch": max_ref_images}},
|
||||
],
|
||||
"prefix": "image",
|
||||
"min": 1,
|
||||
"max": max_ref_images,
|
||||
"tooltip": (
|
||||
"Reference image to edit."
|
||||
if max_ref_images == 1
|
||||
else f"Reference image(s) to edit. Up to {max_ref_images} images."
|
||||
),
|
||||
},
|
||||
],
|
||||
["resolution", "COMBO", {"options": ["768p", "1k"]}],
|
||||
["number_of_images", "INT", {
|
||||
"default": 1, "min": 1, "max": 10, "step": 1,
|
||||
}],
|
||||
]
|
||||
if with_aspect_ratio:
|
||||
inputs.append(["aspect_ratio", "COMBO", {
|
||||
"options": ["auto", "1:1", "16:9"], "default": "auto",
|
||||
}])
|
||||
return inputs
|
||||
|
||||
grok_spec = [
|
||||
"DYNAMIC_COMBO",
|
||||
{
|
||||
"options": [
|
||||
{
|
||||
"key": "grok-imagine-image-quality",
|
||||
"inputs": _grok_v2_subinputs(max_ref_images=3, with_aspect_ratio=True),
|
||||
},
|
||||
{
|
||||
"key": "grok-imagine-image-pro",
|
||||
"inputs": _grok_v2_subinputs(max_ref_images=1, with_aspect_ratio=False),
|
||||
},
|
||||
{
|
||||
"key": "grok-imagine-image",
|
||||
"inputs": _grok_v2_subinputs(max_ref_images=3, with_aspect_ratio=True),
|
||||
},
|
||||
],
|
||||
"tooltip": "The model to use for editing.",
|
||||
},
|
||||
]
|
||||
grok_inp = proxy_node._parse_input_spec("model", grok_spec, optional=False)
|
||||
assert grok_inp is not None, "Grok V2 DYNAMIC_COMBO returned None"
|
||||
assert isinstance(grok_inp, IO.DynamicCombo.Input), (
|
||||
f"Expected IO.DynamicCombo.Input, got {type(grok_inp).__name__}"
|
||||
)
|
||||
assert len(grok_inp.options) == 3
|
||||
# Pro branch (max_ref_images=1, no aspect_ratio).
|
||||
pro_branch = next(o for o in grok_inp.options if o.key == "grok-imagine-image-pro")
|
||||
assert len(pro_branch.inputs) == 3, f"pro branch should have 3 sub-inputs, got {len(pro_branch.inputs)}"
|
||||
images_inp = pro_branch.inputs[0]
|
||||
assert isinstance(images_inp, IO.Autogrow.Input), (
|
||||
f"Expected nested AUTOGROW to parse as IO.Autogrow.Input, got "
|
||||
f"{type(images_inp).__name__}"
|
||||
)
|
||||
assert images_inp.id == "images"
|
||||
assert isinstance(images_inp.template, IO.Autogrow.TemplatePrefix), (
|
||||
f"Expected TemplatePrefix template, got {type(images_inp.template).__name__}"
|
||||
)
|
||||
assert images_inp.template.prefix == "image"
|
||||
assert images_inp.template.min == 1
|
||||
assert images_inp.template.max == 1, f"pro branch max should be 1, got {images_inp.template.max}"
|
||||
assert isinstance(images_inp.template.input, IO.Image.Input), (
|
||||
f"AUTOGROW template input should be IO.Image.Input, got "
|
||||
f"{type(images_inp.template.input).__name__}"
|
||||
)
|
||||
# Quality branch (max_ref_images=3 + aspect_ratio).
|
||||
qual_branch = next(o for o in grok_inp.options if o.key == "grok-imagine-image-quality")
|
||||
assert len(qual_branch.inputs) == 4, f"quality branch should have 4 sub-inputs, got {len(qual_branch.inputs)}"
|
||||
qual_images = qual_branch.inputs[0]
|
||||
assert isinstance(qual_images, IO.Autogrow.Input)
|
||||
assert qual_images.template.max == 3, f"quality branch max should be 3, got {qual_images.template.max}"
|
||||
# Primitive widgets after the autogrow.
|
||||
assert isinstance(qual_branch.inputs[1], IO.Combo.Input)
|
||||
assert isinstance(qual_branch.inputs[2], IO.Int.Input)
|
||||
assert isinstance(qual_branch.inputs[3], IO.Combo.Input)
|
||||
print("PASS: Grok V2 DYNAMIC_COMBO + nested AUTOGROW parses correctly.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 3. ElevenLabs-shaped branch with custom-IO sub-inputs (voiceN).
|
||||
# ---------------------------------------------------------------------------
|
||||
el_spec = [
|
||||
"DYNAMIC_COMBO",
|
||||
{
|
||||
"options": [
|
||||
{
|
||||
"key": "2",
|
||||
"inputs": [
|
||||
["voice0", "ELEVENLABS_VOICE", {}],
|
||||
["text0", "STRING", {"multiline": True, "default": ""}],
|
||||
["voice1", "ELEVENLABS_VOICE", {}],
|
||||
["text1", "STRING", {"multiline": True, "default": ""}],
|
||||
],
|
||||
},
|
||||
],
|
||||
"tooltip": "Number of dialogue turns.",
|
||||
},
|
||||
]
|
||||
el_inp = proxy_node._parse_input_spec("inputs", el_spec, optional=False)
|
||||
assert el_inp is not None, "ElevenLabs DYNAMIC_COMBO returned None"
|
||||
assert isinstance(el_inp, IO.DynamicCombo.Input)
|
||||
assert el_inp.id == "inputs", (
|
||||
f"outer id should be 'inputs' (not always 'model'), got {el_inp.id!r}"
|
||||
)
|
||||
branch = el_inp.options[0]
|
||||
# IO.Custom("FOO") returns a synthesized ComfyTypeIO subclass — each call
|
||||
# creates a *new* class, so isinstance-against-a-fresh-Custom doesn't
|
||||
# work. The @comfytype decorator stamps ``io_type`` onto the Input class
|
||||
# instead; check that the synthesized custom Input carries the right
|
||||
# string (this is how the frontend's connection-validity check chains
|
||||
# sockets).
|
||||
voice0 = branch.inputs[0]
|
||||
assert voice0.get_io_type() == "ELEVENLABS_VOICE", (
|
||||
f"voice0 should be opaque ELEVENLABS_VOICE Input, got "
|
||||
f"{voice0.get_io_type()!r} on {type(voice0).__name__}"
|
||||
)
|
||||
assert isinstance(branch.inputs[1], IO.String.Input)
|
||||
assert isinstance(branch.inputs[3], IO.String.Input)
|
||||
print("PASS: ElevenLabs DYNAMIC_COMBO branch mixes custom-IO + primitive.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 4. Synthetic nested DYNAMIC_COMBO inside DYNAMIC_COMBO.
|
||||
# ---------------------------------------------------------------------------
|
||||
nested = [
|
||||
"DYNAMIC_COMBO",
|
||||
{
|
||||
"options": [
|
||||
{
|
||||
"key": "outer_a",
|
||||
"inputs": [
|
||||
[
|
||||
"submodel",
|
||||
"DYNAMIC_COMBO",
|
||||
{
|
||||
"options": [
|
||||
{"key": "inner_x", "inputs": [
|
||||
["x", "INT", {"default": 1, "min": 0, "max": 10}],
|
||||
]},
|
||||
{"key": "inner_y", "inputs": []},
|
||||
],
|
||||
"tooltip": "Inner branch.",
|
||||
},
|
||||
],
|
||||
],
|
||||
},
|
||||
],
|
||||
"tooltip": "Outer branch.",
|
||||
},
|
||||
]
|
||||
nest_inp = proxy_node._parse_input_spec("model", nested, optional=False)
|
||||
assert isinstance(nest_inp, IO.DynamicCombo.Input)
|
||||
inner = nest_inp.options[0].inputs[0]
|
||||
assert isinstance(inner, IO.DynamicCombo.Input), (
|
||||
f"nested DynamicCombo should be IO.DynamicCombo.Input, got {type(inner).__name__}"
|
||||
)
|
||||
assert [o.key for o in inner.options] == ["inner_x", "inner_y"]
|
||||
assert isinstance(inner.options[0].inputs[0], IO.Int.Input)
|
||||
print("PASS: nested DYNAMIC_COMBO-in-DYNAMIC_COMBO parses recursively.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 5. Malformed dynamic specs return None (no opaque fallthrough).
|
||||
# ---------------------------------------------------------------------------
|
||||
# Missing options list on DYNAMIC_COMBO.
|
||||
assert proxy_node._parse_input_spec("x", ["DYNAMIC_COMBO", {}], optional=False) is None
|
||||
# Option missing key.
|
||||
bad = ["DYNAMIC_COMBO", {"options": [{"inputs": []}]}]
|
||||
assert proxy_node._parse_input_spec("x", bad, optional=False) is None
|
||||
# Option's inputs entry not a 3-tuple.
|
||||
bad2 = ["DYNAMIC_COMBO", {"options": [{"key": "a", "inputs": [["x"]]}]}]
|
||||
assert proxy_node._parse_input_spec("x", bad2, optional=False) is None
|
||||
# AUTOGROW without template.
|
||||
assert proxy_node._parse_input_spec("x", ["AUTOGROW", {"prefix": "p"}], optional=False) is None
|
||||
# AUTOGROW without prefix/names.
|
||||
assert (
|
||||
proxy_node._parse_input_spec("x", ["AUTOGROW", {"template": ["IMAGE", {}]}], optional=False)
|
||||
is None
|
||||
)
|
||||
print("PASS: malformed DYNAMIC_COMBO / AUTOGROW specs return None.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 6. Regression: _collect_local_validate output unchanged for these inputs.
|
||||
# ---------------------------------------------------------------------------
|
||||
desc_grok = {
|
||||
"input": {
|
||||
"required": {"model": grok_spec},
|
||||
"optional": {},
|
||||
},
|
||||
}
|
||||
rules = proxy_node._collect_local_validate(desc_grok)
|
||||
# rules['model'] should carry __branches__ with per-branch maps that each
|
||||
# carry an __template__ entry under "images" with image_max_batch.
|
||||
assert "model" in rules, f"_collect_local_validate dropped 'model': {rules!r}"
|
||||
br = rules["model"].get("__branches__")
|
||||
assert isinstance(br, dict) and set(br) == {
|
||||
"grok-imagine-image-quality",
|
||||
"grok-imagine-image-pro",
|
||||
"grok-imagine-image",
|
||||
}, f"branches mismatch: {br!r}"
|
||||
pro = br["grok-imagine-image-pro"]
|
||||
assert "images" in pro, f"pro branch should carry 'images' rule: {pro!r}"
|
||||
tmpl_rules = pro["images"].get("__template__")
|
||||
assert tmpl_rules == {"image_max_batch": 1}, (
|
||||
f"pro branch template rules wrong: {tmpl_rules!r}"
|
||||
)
|
||||
qual = br["grok-imagine-image-quality"]
|
||||
assert qual["images"].get("__template__") == {"image_max_batch": 3}
|
||||
print("PASS: _collect_local_validate output unchanged (branches + template intact).")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 7. AUTOGROW with a dynamic template input is rejected.
|
||||
# ---------------------------------------------------------------------------
|
||||
ag_with_dyn_template = [
|
||||
"AUTOGROW",
|
||||
{
|
||||
"template": [
|
||||
"DYNAMIC_COMBO",
|
||||
{"options": [{"key": "k", "inputs": []}]},
|
||||
],
|
||||
"prefix": "img",
|
||||
"min": 1,
|
||||
"max": 3,
|
||||
},
|
||||
]
|
||||
assert (
|
||||
proxy_node._parse_input_spec("bad", ag_with_dyn_template, optional=False) is None
|
||||
), "AUTOGROW with DYNAMIC_COMBO template should be rejected"
|
||||
print("PASS: AUTOGROW rejects dynamic template input (matches upstream assert).")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 8. Source-level: docstring + dispatch mention DYNAMIC_COMBO + AUTOGROW.
|
||||
# ---------------------------------------------------------------------------
|
||||
proxy_src = open(
|
||||
os.path.join(_CLIENT_DIR, "proxy_node.py"), "r", encoding="utf-8",
|
||||
).read()
|
||||
assert "DYNAMIC_COMBO" in proxy_src, "proxy_node source missing DYNAMIC_COMBO branch"
|
||||
assert "AUTOGROW" in proxy_src, "proxy_node source missing AUTOGROW branch"
|
||||
assert "_parse_named_input_spec" in proxy_src, (
|
||||
"proxy_node source missing _parse_named_input_spec helper"
|
||||
)
|
||||
assert "_build_input" in proxy_src, "proxy_node source missing _build_input helper"
|
||||
print("PASS: proxy_node source contains the new dispatch + helpers.")
|
||||
|
||||
print("ALL CHECKS PASSED.")
|
||||
@@ -0,0 +1,461 @@
|
||||
"""Smoke test for the client-side multi-file MODEL_3D bundle decoder.
|
||||
|
||||
Verifies:
|
||||
|
||||
1. ``Capability.MODEL_3D_BUNDLE_INLINE`` is intact at the vendored
|
||||
protocol layer and exposed as the well-formed
|
||||
``model_3d:bundle_inline`` token.
|
||||
2. ``is_envelope`` recognises a ``bundle_inline`` envelope (still
|
||||
``type=model_3d`` — HEAVY_TYPES unchanged).
|
||||
3. ``decode_model3d_envelope`` dispatches ``encoding=bundle_inline``
|
||||
to the new ``BundledFile3D`` class, returns a real ``File3D``
|
||||
subclass, and round-trips the primary mesh bytes via
|
||||
``get_data()`` / ``get_bytes()`` without materialising anything
|
||||
on disk.
|
||||
4. ``get_source()`` materialises the whole bundle into a temp
|
||||
directory using the producer-supplied relative paths, so a .obj
|
||||
that references its .mtl by filename (and a texture in
|
||||
``textures/``) finds them on disk via the filesystem.
|
||||
5. ``save_to(dest)`` copies the whole bundle into the destination
|
||||
directory — the primary file under the caller-specified name,
|
||||
sidecars under their ORIGINAL relative paths — so cross-file refs
|
||||
inside the .obj (which point at ``model.mtl``) still resolve when
|
||||
the user saves the model somewhere stable.
|
||||
6. Bundle-specific accessors (``primary_path``, ``file_paths``,
|
||||
``file_bytes``, ``file_role``, ``paths_with_role``) return the
|
||||
expected values; unknown roles round-trip without error.
|
||||
7. Malformed bundle envelopes (missing primary_path, missing
|
||||
files, missing data, primary_path not in files) raise
|
||||
``RnpProtocolError`` with ``code=INTERNAL`` — no opaque
|
||||
fallthrough.
|
||||
8. End-to-end against the server's ``make_model3d_bundle_envelope``
|
||||
helper (imported from the comfy-rnp-server worktree) — the bytes
|
||||
the server packs into each file are exactly the bytes the
|
||||
client unpacks, and the path sanitization happens server-side so
|
||||
the client never sees a malicious path.
|
||||
9. ``CLIENT_CAPABILITIES`` advertises ``model_3d:bundle_inline``
|
||||
so server-side capability-gated descriptors negotiate cleanly.
|
||||
|
||||
Run with the ComfyUI venv (needs torch / comfy_api on PYTHONPATH):
|
||||
|
||||
python notes/run_model3d_bundle_decoder.py
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import base64
|
||||
import importlib.util
|
||||
import os
|
||||
import shutil
|
||||
import sys
|
||||
import tempfile
|
||||
import types
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Locate the worktree under test.
|
||||
# ---------------------------------------------------------------------------
|
||||
_HERE = os.path.dirname(os.path.abspath(__file__))
|
||||
_CLIENT_DIR = os.path.dirname(_HERE)
|
||||
_COMFYUI_DIR = os.path.dirname(os.path.dirname(_CLIENT_DIR))
|
||||
_SERVER_DIR = os.path.normpath(
|
||||
os.path.join(_COMFYUI_DIR, "..", "comfy-rnp-server")
|
||||
)
|
||||
|
||||
|
||||
def _load_module(name: str, path: str) -> types.ModuleType:
|
||||
spec = importlib.util.spec_from_file_location(name, path)
|
||||
mod = importlib.util.module_from_spec(spec)
|
||||
sys.modules[name] = mod
|
||||
spec.loader.exec_module(mod)
|
||||
return mod
|
||||
|
||||
|
||||
# Make ComfyUI importable so ``comfy_api.latest._util.geometry_types.File3D``
|
||||
# resolves at first BundledFile3D construction.
|
||||
if _COMFYUI_DIR not in sys.path:
|
||||
sys.path.insert(0, _COMFYUI_DIR)
|
||||
if _SERVER_DIR not in sys.path:
|
||||
sys.path.insert(0, _SERVER_DIR)
|
||||
|
||||
# ComfyUI's full ``comfy_api`` tree pulls torch / PIL / comfy_execution at
|
||||
# import time. Stub just what BundledFile3D needs — the leaf
|
||||
# ``comfy_api.latest._util.geometry_types.File3D`` class with a faithful
|
||||
# subclass-friendly implementation.
|
||||
class _StubFile3D:
|
||||
"""Faithful subset of upstream ``comfy_api.latest._util.geometry_types.File3D``.
|
||||
|
||||
Implements the same parent-class shape (``_source`` / ``_format``
|
||||
attrs + ``get_source`` / ``get_data`` / ``get_bytes`` / ``save_to``
|
||||
methods) so subclassing it produces an object indistinguishable
|
||||
from the real thing for the decoder's purposes. The smoke test
|
||||
deliberately stubs torch + the heavy ``comfy_api.latest._util``
|
||||
package init to keep the test runnable in the rnp venv.
|
||||
"""
|
||||
def __init__(self, source, file_format: str = "") -> None:
|
||||
self._source = source
|
||||
self._format = (file_format or "").lstrip(".").lower()
|
||||
|
||||
@property
|
||||
def format(self) -> str:
|
||||
return self._format
|
||||
|
||||
@format.setter
|
||||
def format(self, value: str) -> None:
|
||||
self._format = (value or "").lstrip(".").lower()
|
||||
|
||||
|
||||
# Stub ``comfy_api.latest._util`` and the nested ``geometry_types`` module
|
||||
# so ``from comfy_api.latest._util.geometry_types import File3D`` works
|
||||
# without pulling torch / PIL / etc.
|
||||
_comfy_api = types.ModuleType("comfy_api")
|
||||
_comfy_api.__path__ = [] # type: ignore[attr-defined]
|
||||
_comfy_api_latest = types.ModuleType("comfy_api.latest")
|
||||
_comfy_api_latest.__path__ = [] # type: ignore[attr-defined]
|
||||
_comfy_api_latest_util = types.ModuleType("comfy_api.latest._util")
|
||||
_comfy_api_latest_util.__path__ = [] # type: ignore[attr-defined]
|
||||
_comfy_api_latest_util.File3D = _StubFile3D
|
||||
_comfy_api_latest_util_geom = types.ModuleType("comfy_api.latest._util.geometry_types")
|
||||
_comfy_api_latest_util_geom.File3D = _StubFile3D
|
||||
sys.modules.setdefault("comfy_api", _comfy_api)
|
||||
sys.modules.setdefault("comfy_api.latest", _comfy_api_latest)
|
||||
sys.modules.setdefault("comfy_api.latest._util", _comfy_api_latest_util)
|
||||
sys.modules.setdefault("comfy_api.latest._util.geometry_types", _comfy_api_latest_util_geom)
|
||||
|
||||
# Emulate the client package layout for the relative imports.
|
||||
pkg = types.ModuleType("comfy_remote_nodes_test")
|
||||
pkg.__path__ = [_CLIENT_DIR]
|
||||
sys.modules["comfy_remote_nodes_test"] = pkg
|
||||
|
||||
protocol = _load_module(
|
||||
"comfy_remote_nodes_test.protocol",
|
||||
os.path.join(_CLIENT_DIR, "protocol.py"),
|
||||
)
|
||||
# serialization imports ``client`` for ``rnp_client``; the bundle decoder
|
||||
# doesn't use it, so a tiny stub suffices.
|
||||
sys.modules["comfy_remote_nodes_test.client"] = types.ModuleType(
|
||||
"comfy_remote_nodes_test.client",
|
||||
)
|
||||
serialization = _load_module(
|
||||
"comfy_remote_nodes_test.serialization",
|
||||
os.path.join(_CLIENT_DIR, "serialization.py"),
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Build a minimal Wavefront-OBJ + MTL + PNG-stub bundle for the round-trip.
|
||||
# These bytes don't need to be loadable by an actual OBJ parser — the
|
||||
# decoder is bytes-in / bytes-out — but using realistic content makes
|
||||
# debugging easier if a future regression breaks the cross-file refs.
|
||||
# ---------------------------------------------------------------------------
|
||||
def _make_minimal_obj() -> bytes:
|
||||
return (
|
||||
b"# Minimal OBJ for RNP bundle smoke test.\n"
|
||||
b"mtllib model.mtl\n"
|
||||
b"v 0.0 0.0 0.0\nv 1.0 0.0 0.0\nv 0.0 1.0 0.0\n"
|
||||
b"usemtl test_material\n"
|
||||
b"f 1 2 3\n"
|
||||
)
|
||||
|
||||
|
||||
def _make_minimal_mtl() -> bytes:
|
||||
return (
|
||||
b"# Minimal MTL for RNP bundle smoke test.\n"
|
||||
b"newmtl test_material\n"
|
||||
b"Ka 1.0 1.0 1.0\n"
|
||||
b"Kd 1.0 1.0 1.0\n"
|
||||
b"map_Kd textures/albedo.png\n"
|
||||
b"map_bump textures/normal.png\n"
|
||||
)
|
||||
|
||||
|
||||
def _make_stub_png(tag: bytes) -> bytes:
|
||||
# Not a real PNG — the decoder doesn't parse it. Tag distinguishes
|
||||
# each "texture" so the round-trip assertions can pin which bytes
|
||||
# went where.
|
||||
return b"\x89PNG\r\n\x1a\n" + tag
|
||||
|
||||
|
||||
obj_bytes = _make_minimal_obj()
|
||||
mtl_bytes = _make_minimal_mtl()
|
||||
albedo_bytes = _make_stub_png(b"ALBEDO_STUB")
|
||||
normal_bytes = _make_stub_png(b"NORMAL_STUB")
|
||||
roughness_bytes = _make_stub_png(b"ROUGHNESS_STUB")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 1. Capability constant intact at the vendored protocol layer.
|
||||
# ---------------------------------------------------------------------------
|
||||
assert protocol.Capability.MODEL_3D_BUNDLE_INLINE == "model_3d:bundle_inline", (
|
||||
f"Capability.MODEL_3D_BUNDLE_INLINE wrong value: "
|
||||
f"{protocol.Capability.MODEL_3D_BUNDLE_INLINE!r}"
|
||||
)
|
||||
print("PASS: Capability.MODEL_3D_BUNDLE_INLINE = 'model_3d:bundle_inline'.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Build a hand-crafted bundle envelope for the next several checks.
|
||||
# ---------------------------------------------------------------------------
|
||||
hand_envelope = {
|
||||
"type": "model_3d",
|
||||
"encoding": "bundle_inline",
|
||||
"format": "obj",
|
||||
"primary_path": "model.obj",
|
||||
"files": [
|
||||
{"path": "model.obj", "format": "obj", "role": "mesh",
|
||||
"data": base64.b64encode(obj_bytes).decode("ascii"),
|
||||
"byte_size": len(obj_bytes)},
|
||||
{"path": "model.mtl", "format": "mtl", "role": "material",
|
||||
"data": base64.b64encode(mtl_bytes).decode("ascii")},
|
||||
{"path": "textures/albedo.png", "format": "png", "role": "texture_diffuse",
|
||||
"data": base64.b64encode(albedo_bytes).decode("ascii")},
|
||||
{"path": "textures/normal.png", "format": "png", "role": "texture_normal",
|
||||
"data": base64.b64encode(normal_bytes).decode("ascii")},
|
||||
{"path": "textures/roughness.png","format": "png","role": "texture_roughness",
|
||||
"data": base64.b64encode(roughness_bytes).decode("ascii")},
|
||||
# Unknown role — must round-trip without error.
|
||||
{"path": "extras/notes.txt", "role": "producer_notes",
|
||||
"data": base64.b64encode(b"hello").decode("ascii")},
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 2. is_envelope recognises a bundle envelope.
|
||||
# ---------------------------------------------------------------------------
|
||||
assert protocol.is_envelope(hand_envelope), (
|
||||
"is_envelope returned False for a well-formed bundle_inline envelope; "
|
||||
"HEAVY_TYPES update somehow regressed."
|
||||
)
|
||||
print("PASS: is_envelope recognises bundle_inline envelopes.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 3. decode_model3d_envelope dispatches + round-trips primary bytes.
|
||||
# ---------------------------------------------------------------------------
|
||||
bundle = serialization.decode_model3d_envelope(hand_envelope)
|
||||
bundle_cls = serialization._bundled_file3d_class()
|
||||
assert isinstance(bundle, bundle_cls), (
|
||||
f"decode_model3d_envelope should return BundledFile3D, got "
|
||||
f"{type(bundle).__name__}"
|
||||
)
|
||||
# It must ALSO be a File3D (parent class) — that's the whole point of
|
||||
# the subclass approach.
|
||||
assert isinstance(bundle, _StubFile3D), (
|
||||
f"BundledFile3D must subclass File3D — got {type(bundle).__mro__}"
|
||||
)
|
||||
# Primary file bytes round-trip via get_data / get_bytes (no disk I/O).
|
||||
assert bundle.get_bytes() == obj_bytes, (
|
||||
f"primary OBJ bytes lost: {len(bundle.get_bytes())} vs {len(obj_bytes)}"
|
||||
)
|
||||
src = bundle.get_data()
|
||||
src.seek(0)
|
||||
assert src.read() == obj_bytes, "primary OBJ get_data() didn't round-trip"
|
||||
assert bundle.format == "obj", f"primary format wrong: {bundle.format!r}"
|
||||
print("PASS: decode_model3d_envelope returns BundledFile3D + primary bytes round-trip.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 4. get_source() materialises the whole bundle on disk.
|
||||
# ---------------------------------------------------------------------------
|
||||
disk_path = bundle.get_source()
|
||||
assert os.path.isfile(disk_path), f"get_source() should return existing path: {disk_path}"
|
||||
assert disk_path.endswith("model.obj"), f"primary path wrong: {disk_path}"
|
||||
with open(disk_path, "rb") as f:
|
||||
assert f.read() == obj_bytes, "disk-materialised primary OBJ bytes mismatched"
|
||||
# Sidecars must be at the SAME relative paths so the .obj's mtllib /
|
||||
# map_Kd refs resolve.
|
||||
temp_root = bundle.materialize_to_temp_dir()
|
||||
assert os.path.isfile(os.path.join(temp_root, "model.mtl")), (
|
||||
"model.mtl missing from materialised bundle"
|
||||
)
|
||||
assert os.path.isfile(os.path.join(temp_root, "textures", "albedo.png")), (
|
||||
"textures/albedo.png missing from materialised bundle"
|
||||
)
|
||||
assert os.path.isfile(os.path.join(temp_root, "textures", "normal.png"))
|
||||
assert os.path.isfile(os.path.join(temp_root, "textures", "roughness.png"))
|
||||
assert os.path.isfile(os.path.join(temp_root, "extras", "notes.txt"))
|
||||
# Sidecar bytes match.
|
||||
with open(os.path.join(temp_root, "model.mtl"), "rb") as f:
|
||||
assert f.read() == mtl_bytes
|
||||
with open(os.path.join(temp_root, "textures", "albedo.png"), "rb") as f:
|
||||
assert f.read() == albedo_bytes
|
||||
print("PASS: get_source() materialises whole bundle on disk at producer-supplied paths.")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 5. save_to(dest) copies the whole bundle into the destination directory.
|
||||
# ---------------------------------------------------------------------------
|
||||
save_dir = tempfile.mkdtemp(prefix="rnp_save_to_test_")
|
||||
try:
|
||||
out_path = bundle.save_to(os.path.join(save_dir, "renamed_scene.obj"))
|
||||
assert os.path.isfile(out_path)
|
||||
with open(out_path, "rb") as f:
|
||||
assert f.read() == obj_bytes, "primary OBJ bytes wrong after save_to"
|
||||
# Sidecars keep ORIGINAL filenames so cross-file refs inside the
|
||||
# OBJ (which point at "model.mtl") still resolve relative to the
|
||||
# renamed primary file's directory.
|
||||
assert os.path.isfile(os.path.join(save_dir, "model.mtl")), (
|
||||
"save_to should copy model.mtl alongside the renamed primary"
|
||||
)
|
||||
assert os.path.isfile(os.path.join(save_dir, "textures", "albedo.png"))
|
||||
assert os.path.isfile(os.path.join(save_dir, "textures", "normal.png"))
|
||||
with open(os.path.join(save_dir, "textures", "normal.png"), "rb") as f:
|
||||
assert f.read() == normal_bytes
|
||||
print("PASS: save_to copies whole bundle, primary renamed, sidecars preserve filenames.")
|
||||
finally:
|
||||
shutil.rmtree(save_dir, ignore_errors=True)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 6. Bundle-specific accessors.
|
||||
# ---------------------------------------------------------------------------
|
||||
assert bundle.primary_path == "model.obj"
|
||||
assert set(bundle.file_paths) == {
|
||||
"model.obj", "model.mtl",
|
||||
"textures/albedo.png", "textures/normal.png", "textures/roughness.png",
|
||||
"extras/notes.txt",
|
||||
}
|
||||
assert bundle.file_bytes("textures/albedo.png") == albedo_bytes
|
||||
# Optional roles.
|
||||
assert bundle.file_role("model.obj") == "mesh"
|
||||
assert bundle.file_role("textures/normal.png") == "texture_normal"
|
||||
# Unknown roles round-trip — no enum check.
|
||||
assert bundle.file_role("extras/notes.txt") == "producer_notes"
|
||||
# Missing role (none supplied) returns None.
|
||||
assert bundle.file_role("nonexistent.png") is None
|
||||
# Convenience lookup.
|
||||
assert bundle.paths_with_role("texture_normal") == ["textures/normal.png"]
|
||||
assert bundle.paths_with_role("nonexistent_role") == []
|
||||
print("PASS: bundle accessors (primary_path / file_paths / file_role / paths_with_role).")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 7. Malformed bundle envelopes raise RnpProtocolError with code=INTERNAL.
|
||||
# ---------------------------------------------------------------------------
|
||||
def _expect_protocol_error(bad_env: dict, needle: str) -> None:
|
||||
try:
|
||||
serialization.decode_model3d_envelope(bad_env)
|
||||
except protocol.RnpProtocolError as e:
|
||||
assert e.code == protocol.ErrorCode.INTERNAL, f"wrong error code: {e.code}"
|
||||
assert needle in str(e), f"error msg doesn't mention {needle!r}: {e}"
|
||||
else:
|
||||
raise AssertionError(f"expected RnpProtocolError for {needle!r}")
|
||||
|
||||
_expect_protocol_error(
|
||||
{"type": "model_3d", "encoding": "bundle_inline", "files": [
|
||||
{"path": "x.obj", "data": "AA=="},
|
||||
]},
|
||||
"primary_path",
|
||||
)
|
||||
_expect_protocol_error(
|
||||
{"type": "model_3d", "encoding": "bundle_inline", "primary_path": "x.obj"},
|
||||
"files",
|
||||
)
|
||||
_expect_protocol_error(
|
||||
{"type": "model_3d", "encoding": "bundle_inline", "primary_path": "x.obj",
|
||||
"files": [{"path": "y.obj", "data": "AA=="}]},
|
||||
"primary_path 'x.obj' not in",
|
||||
)
|
||||
_expect_protocol_error(
|
||||
{"type": "model_3d", "encoding": "bundle_inline", "primary_path": "x.obj",
|
||||
"files": [{"path": "x.obj"}]}, # missing data
|
||||
"missing inline 'data'",
|
||||
)
|
||||
_expect_protocol_error(
|
||||
{"type": "model_3d", "encoding": "wat_inline", "data": "AA=="},
|
||||
"Unsupported model_3d encoding",
|
||||
)
|
||||
print("PASS: malformed bundle envelopes raise RnpProtocolError(INTERNAL).")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 8. End-to-end: server make_model3d_bundle_envelope -> client decode.
|
||||
# Skips when the server worktree isn't on disk.
|
||||
# ---------------------------------------------------------------------------
|
||||
server_protocol_path = os.path.join(
|
||||
_SERVER_DIR, "comfy_rnp_protocol", "envelopes.py",
|
||||
)
|
||||
if os.path.exists(server_protocol_path):
|
||||
server_pkg = types.ModuleType("comfy_rnp_protocol_e2e_bundle")
|
||||
server_pkg.__path__ = [os.path.join(_SERVER_DIR, "comfy_rnp_protocol")]
|
||||
sys.modules["comfy_rnp_protocol_e2e_bundle"] = server_pkg
|
||||
_load_module(
|
||||
"comfy_rnp_protocol_e2e_bundle.constants",
|
||||
os.path.join(_SERVER_DIR, "comfy_rnp_protocol", "constants.py"),
|
||||
)
|
||||
server_envelopes = _load_module(
|
||||
"comfy_rnp_protocol_e2e_bundle.envelopes",
|
||||
os.path.join(_SERVER_DIR, "comfy_rnp_protocol", "envelopes.py"),
|
||||
)
|
||||
assert hasattr(server_envelopes, "make_model3d_bundle_envelope"), (
|
||||
"Server envelopes module missing make_model3d_bundle_envelope — "
|
||||
"server-side PR #38 should have added it."
|
||||
)
|
||||
server_env = server_envelopes.make_model3d_bundle_envelope(
|
||||
files=[
|
||||
{"path": "model.obj", "format": "obj", "role": "mesh",
|
||||
"data": base64.b64encode(obj_bytes).decode("ascii"),
|
||||
"byte_size": len(obj_bytes)},
|
||||
{"path": "model.mtl", "format": "mtl", "role": "material",
|
||||
"data": base64.b64encode(mtl_bytes).decode("ascii")},
|
||||
{"path": "textures/albedo.png", "format": "png", "role": "texture_diffuse",
|
||||
"data": base64.b64encode(albedo_bytes).decode("ascii")},
|
||||
],
|
||||
primary_path="model.obj",
|
||||
format="obj",
|
||||
)
|
||||
assert server_env["type"] == "model_3d", server_env
|
||||
assert server_env["encoding"] == "bundle_inline", server_env
|
||||
assert server_env["primary_path"] == "model.obj"
|
||||
assert len(server_env["files"]) == 3
|
||||
# Path sanitization happens server-side. Confirm a malicious path
|
||||
# would be rejected at envelope build time (defence-in-depth — the
|
||||
# client decoder doesn't see this).
|
||||
try:
|
||||
server_envelopes.make_model3d_bundle_envelope(
|
||||
files=[{"path": "../etc/passwd", "data": "AA=="}],
|
||||
primary_path="../etc/passwd",
|
||||
)
|
||||
except ValueError as e:
|
||||
assert "parent-dir" in str(e) or "absolute" in str(e), (
|
||||
f"path sanitization mistake: {e!r}"
|
||||
)
|
||||
else:
|
||||
raise AssertionError("server should reject '..' path at envelope build time")
|
||||
# Pipe through the client decoder.
|
||||
server_bundle = serialization.decode_model3d_envelope(server_env)
|
||||
assert isinstance(server_bundle, bundle_cls), (
|
||||
f"server-built envelope decoded to wrong type: {type(server_bundle)}"
|
||||
)
|
||||
assert server_bundle.get_bytes() == obj_bytes
|
||||
assert server_bundle.file_bytes("textures/albedo.png") == albedo_bytes
|
||||
assert server_bundle.file_role("model.obj") == "mesh"
|
||||
print(
|
||||
"PASS: end-to-end server make_model3d_bundle_envelope -> client "
|
||||
"decode_model3d_envelope preserves all files + roles + bytes."
|
||||
)
|
||||
else:
|
||||
print(
|
||||
f"SKIP end-to-end: server worktree not found at {_SERVER_DIR!r}"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 9. CLIENT_CAPABILITIES advertises model_3d:bundle_inline.
|
||||
# client.py imports aiohttp / comfy_api_nodes — same source-level
|
||||
# contract check we used for the GLB cap in PR #1.
|
||||
# ---------------------------------------------------------------------------
|
||||
client_src = open(
|
||||
os.path.join(_CLIENT_DIR, "client.py"), "r", encoding="utf-8",
|
||||
).read()
|
||||
assert "CLIENT_CAPABILITIES = [" in client_src, (
|
||||
"client.py missing CLIENT_CAPABILITIES list"
|
||||
)
|
||||
cc_start = client_src.index("CLIENT_CAPABILITIES = [")
|
||||
cc_end = client_src.index("]", cc_start)
|
||||
cc_block = client_src[cc_start:cc_end]
|
||||
assert "Capability.MODEL_3D_BUNDLE_INLINE" in cc_block, (
|
||||
"Capability.MODEL_3D_BUNDLE_INLINE not advertised in CLIENT_CAPABILITIES"
|
||||
)
|
||||
print("PASS: CLIENT_CAPABILITIES advertises Capability.MODEL_3D_BUNDLE_INLINE.")
|
||||
|
||||
print("ALL CHECKS PASSED.")
|
||||
+61
@@ -164,6 +164,67 @@ class Capability:
|
||||
# parse — the magic-byte check at offset 0 is the only validity
|
||||
# guard the server applies).
|
||||
MODEL_3D_GLB_INLINE = "model_3d:glb_inline"
|
||||
# 3D MODEL BUNDLE envelope: a primary mesh file plus N companion
|
||||
# files (textures / .mtl / .bin / other PBR maps) carried inline as
|
||||
# a single coherent unit. Wire shape:
|
||||
#
|
||||
# {
|
||||
# "type": "model_3d",
|
||||
# "encoding": "bundle_inline",
|
||||
# "format": "obj",
|
||||
# "primary_path": "model.obj",
|
||||
# "files": [
|
||||
# {"path": "model.obj", "format": "obj", "role": "mesh",
|
||||
# "data": "<b64>", "byte_size": 12345},
|
||||
# {"path": "model.mtl", "format": "mtl", "role": "material",
|
||||
# "data": "<b64>"},
|
||||
# {"path": "textures/albedo.png", "format": "png", "role": "texture_diffuse",
|
||||
# "data": "<b64>"}
|
||||
# ]
|
||||
# }
|
||||
#
|
||||
# ``path`` is the authoritative cross-file reference key — a POSIX-
|
||||
# relative path (no ``..``, no absolute prefix, no Windows drive
|
||||
# letter, no backslashes, no case-insensitive collisions). The
|
||||
# client decoder materialises files into a temp directory using
|
||||
# exactly these paths so a ``.obj`` that references its ``.mtl``
|
||||
# via filename (or a ``.gltf`` that references its ``.bin`` /
|
||||
# textures via relative URI) resolves on disk.
|
||||
#
|
||||
# ``role`` is an OPTIONAL producer hint (NOT a closed enum) —
|
||||
# well-known values include ``mesh``, ``material``, ``buffer``,
|
||||
# ``texture_diffuse``, ``texture_metallic``, ``texture_normal``,
|
||||
# ``texture_roughness``, ``texture_ao``, ``texture_emissive``,
|
||||
# ``texture_height``. Unknown roles round-trip without error;
|
||||
# consumers may use ``role`` for convenience but ``path`` is the
|
||||
# primary identifier.
|
||||
#
|
||||
# ``primary_path`` MUST appear in ``files`` exactly once and pins
|
||||
# the entry-point file (the one passed to ComfyUI's
|
||||
# ``Types.File3D`` constructor by the client decoder). The
|
||||
# top-level ``format`` (if set) MUST match that primary file's
|
||||
# ``format``.
|
||||
#
|
||||
# The client decoder returns a ``BundledFile3D`` (a thin
|
||||
# ``File3D``-compatible wrapper) — existing downstream loaders
|
||||
# that call ``get_source()`` / ``get_data()`` / ``save_to()`` get
|
||||
# the bundle's primary file with all sidecars materialised on
|
||||
# disk first so cross-file refs resolve correctly. Override of
|
||||
# ``save_to()`` copies the *whole bundle* into the destination
|
||||
# directory, not just the primary file.
|
||||
#
|
||||
# Negotiation: the server emits this encoding ONLY when the
|
||||
# inbound request advertised this token; legacy clients without
|
||||
# the bundle decoder will surface NEGOTIATION_FAILED at
|
||||
# descriptor-load time. Whole-descriptor gating — if a node has
|
||||
# both bundle and non-bundle outputs and the cap is absent, the
|
||||
# whole descriptor is skipped rather than synthesising a
|
||||
# partial-socket variant.
|
||||
#
|
||||
# A future sibling ``Capability.MODEL_3D_BUNDLE_URI`` would carry
|
||||
# ``uri`` per file for URL-fetch-out-of-band semantics; not in
|
||||
# this PR.
|
||||
MODEL_3D_BUNDLE_INLINE = "model_3d:bundle_inline"
|
||||
|
||||
|
||||
HEAVY_TYPES = frozenset({"image", "video", "audio", "mask", "model_3d"})
|
||||
|
||||
+179
-19
@@ -3,13 +3,17 @@
|
||||
The descriptor wire format is V3 ``Schema.get_v1_info()`` verbatim, so
|
||||
per-input dicts are handed straight to V3's IO classes without
|
||||
reinterpretation. ``_parse_input_spec`` knows STRING / INT / FLOAT /
|
||||
BOOLEAN / COMBO / IMAGE / VIDEO / AUDIO / MASK; any other io_type
|
||||
string falls through to ``IO.Custom(io_type)`` (the §B opaque
|
||||
pass-through bucket — partner helper-config types like RECRAFT_*,
|
||||
OPENAI_INPUT_FILES, OPENAI_CHAT_CONFIG, GEMINI_INPUT_FILES round-trip
|
||||
as raw JSON blobs with the original io_type preserved on the V3
|
||||
socket, so node-to-node connections only chain when the strings
|
||||
match). Only a non-string / empty io_type causes a skip.
|
||||
BOOLEAN / COMBO / IMAGE / VIDEO / AUDIO / MASK plus the two V3
|
||||
dynamic input types DYNAMIC_COMBO (branch-selector dropdown with
|
||||
per-branch sub-widgets) and AUTOGROW (variable-arity slot template);
|
||||
any other io_type string falls through to ``IO.Custom(io_type)`` (the
|
||||
§B opaque pass-through bucket — partner helper-config types like
|
||||
RECRAFT_*, OPENAI_INPUT_FILES, OPENAI_CHAT_CONFIG, GEMINI_INPUT_FILES
|
||||
round-trip as raw JSON blobs with the original io_type preserved on
|
||||
the V3 socket, so node-to-node connections only chain when the strings
|
||||
match). Only a non-string / empty io_type causes a skip. Malformed
|
||||
DYNAMIC_COMBO / AUTOGROW specs skip the descriptor (return ``None``)
|
||||
rather than degrading to a single opaque socket.
|
||||
|
||||
Hidden inputs (``auth_token_comfy_org`` / ``api_key_comfy_org`` /
|
||||
``unique_id`` / ``prompt`` / ``extra_pnginfo`` / ``dynprompt``) are
|
||||
@@ -576,34 +580,90 @@ def _parse_inputs(descriptor: dict[str, Any]) -> tuple[list[Any] | None, list[st
|
||||
|
||||
|
||||
def _parse_input_spec(name: str, spec: list[Any], optional: bool) -> Any | None:
|
||||
"""Map one V3-shaped ``[io_type, options_dict]`` entry to a V3 IO Input."""
|
||||
"""Map one V3-shaped ``[io_type, options_dict]`` entry to a V3 IO Input.
|
||||
|
||||
This is the top-level entry used by ``_parse_inputs`` (where the
|
||||
name comes from the descriptor's ``input.required[name]`` /
|
||||
``input.optional[name]`` key) and recursively as the AUTOGROW
|
||||
template entry (which also lacks a leading name field — the slot
|
||||
name is provided by the surrounding AUTOGROW). Branch sub-inputs
|
||||
inside a DYNAMIC_COMBO option use the 3-tuple ``[name, io_type,
|
||||
options]`` form instead — see :func:`_parse_named_input_spec`.
|
||||
"""
|
||||
if not isinstance(spec, (list, tuple)) or len(spec) < 1:
|
||||
return None
|
||||
io_type = spec[0]
|
||||
options: dict[str, Any] = spec[1] if len(spec) > 1 and isinstance(spec[1], dict) else {}
|
||||
return _build_input(name, io_type, options, optional)
|
||||
|
||||
|
||||
def _parse_named_input_spec(spec: list[Any], optional: bool) -> Any | None:
|
||||
"""Map one V3-shaped ``[name, io_type, options_dict]`` entry to a V3 IO Input.
|
||||
|
||||
This is the shape used inside ``DYNAMIC_COMBO`` options' ``inputs``
|
||||
list (each branch sub-input carries its own name as ``spec[0]``).
|
||||
Top-level descriptor inputs use the 2-tuple form handled by
|
||||
:func:`_parse_input_spec`.
|
||||
"""
|
||||
if (
|
||||
not isinstance(spec, (list, tuple))
|
||||
or len(spec) < 2
|
||||
or not isinstance(spec[0], str)
|
||||
):
|
||||
return None
|
||||
name = spec[0]
|
||||
io_type = spec[1]
|
||||
options: dict[str, Any] = spec[2] if len(spec) > 2 and isinstance(spec[2], dict) else {}
|
||||
return _build_input(name, io_type, options, optional)
|
||||
|
||||
|
||||
def _build_input(name: str, io_type: Any, options: dict[str, Any], optional: bool) -> Any | None:
|
||||
"""Shared dispatch: construct one V3 IO Input from a parsed
|
||||
``(name, io_type, options)`` triple.
|
||||
|
||||
Recurses for the two V3 dynamic input types:
|
||||
|
||||
* ``DYNAMIC_COMBO`` — selector dropdown whose per-branch sub-inputs
|
||||
live in ``options.options[i].inputs`` (each entry is the 3-tuple
|
||||
``[name, io_type, options]`` form).
|
||||
* ``AUTOGROW`` — variable-arity slot template. The RNP wire dialect
|
||||
flattens upstream's ``Autogrow.Input.as_dict`` shape: ``template``
|
||||
is a 2-tuple ``[io_type, options]`` entry directly, with
|
||||
``prefix`` / ``min`` / ``max`` (or ``names`` / ``min``) as siblings
|
||||
of ``template`` rather than nested under ``template.template``.
|
||||
|
||||
Malformed dynamic specs return ``None`` (caller logs + skips the
|
||||
whole descriptor) rather than falling through to the opaque
|
||||
``IO.Custom`` bucket — that would mask a protocol/schema bug as
|
||||
"looks fine but renders as opaque socket".
|
||||
"""
|
||||
common = {
|
||||
"tooltip": options.get("tooltip"),
|
||||
"optional": optional,
|
||||
}
|
||||
# ``advanced`` is only accepted by WidgetInput subclasses — the
|
||||
# dynamic constructors (DynamicCombo.Input / Autogrow.Input) do
|
||||
# not take it. Build a separate kwargs bag for primitives.
|
||||
primitive_common = dict(common)
|
||||
if options.get("advanced") is not None:
|
||||
common["advanced"] = bool(options.get("advanced"))
|
||||
primitive_common["advanced"] = bool(options.get("advanced"))
|
||||
|
||||
if isinstance(io_type, list):
|
||||
# Legacy V1-style combo: io_type *is* the options list.
|
||||
return IO.Combo.Input(name, options=list(io_type),
|
||||
default=options.get("default"), **common)
|
||||
default=options.get("default"), **primitive_common)
|
||||
if io_type == "COMBO":
|
||||
opts = options.get("options")
|
||||
if not isinstance(opts, (list, tuple)):
|
||||
return None
|
||||
return IO.Combo.Input(name, options=list(opts),
|
||||
default=options.get("default"), **common)
|
||||
default=options.get("default"), **primitive_common)
|
||||
if io_type == "STRING":
|
||||
return IO.String.Input(
|
||||
name,
|
||||
default=options.get("default", ""),
|
||||
multiline=bool(options.get("multiline", False)),
|
||||
**common,
|
||||
**primitive_common,
|
||||
)
|
||||
if io_type == "INT":
|
||||
return IO.Int.Input(
|
||||
@@ -612,7 +672,7 @@ def _parse_input_spec(name: str, spec: list[Any], optional: bool) -> Any | None:
|
||||
min=options.get("min", 0),
|
||||
max=options.get("max", 2147483647),
|
||||
step=options.get("step", 1),
|
||||
**common,
|
||||
**primitive_common,
|
||||
)
|
||||
if io_type == "FLOAT":
|
||||
return IO.Float.Input(
|
||||
@@ -621,20 +681,115 @@ def _parse_input_spec(name: str, spec: list[Any], optional: bool) -> Any | None:
|
||||
min=options.get("min", 0.0),
|
||||
max=options.get("max", 1.0),
|
||||
step=options.get("step", 0.01),
|
||||
**common,
|
||||
**primitive_common,
|
||||
)
|
||||
if io_type == "BOOLEAN":
|
||||
return IO.Boolean.Input(
|
||||
name, default=bool(options.get("default", False)), **common,
|
||||
name, default=bool(options.get("default", False)), **primitive_common,
|
||||
)
|
||||
if io_type == "IMAGE":
|
||||
return IO.Image.Input(name, **common)
|
||||
return IO.Image.Input(name, **primitive_common)
|
||||
if io_type == "VIDEO":
|
||||
return IO.Video.Input(name, **common)
|
||||
return IO.Video.Input(name, **primitive_common)
|
||||
if io_type == "AUDIO":
|
||||
return IO.Audio.Input(name, **common)
|
||||
return IO.Audio.Input(name, **primitive_common)
|
||||
if io_type == "MASK":
|
||||
return IO.Mask.Input(name, **common)
|
||||
return IO.Mask.Input(name, **primitive_common)
|
||||
if io_type == "DYNAMIC_COMBO":
|
||||
# Wire shape: ``["DYNAMIC_COMBO", {"options": [{"key": str,
|
||||
# "inputs": [[name, io_type, opts], ...]}, ...], "tooltip": ...}]``.
|
||||
# Empty branch input lists are valid (e.g. Bria moderation's
|
||||
# "false" branch with ``"inputs": []``); the branch dropdown
|
||||
# still needs to render. Malformed shape -> None (no opaque
|
||||
# fallthrough — would mask a schema bug).
|
||||
opts = options.get("options")
|
||||
if not isinstance(opts, (list, tuple)):
|
||||
return None
|
||||
parsed_options: list[Any] = []
|
||||
for opt in opts:
|
||||
if not isinstance(opt, dict):
|
||||
return None
|
||||
key = opt.get("key")
|
||||
if not isinstance(key, str):
|
||||
return None
|
||||
sub_specs = opt.get("inputs") or []
|
||||
if not isinstance(sub_specs, (list, tuple)):
|
||||
return None
|
||||
sub_inputs: list[Any] = []
|
||||
for sub_spec in sub_specs:
|
||||
# Branch sub-inputs are always treated as required at
|
||||
# schema-construction time — the wire dialect doesn't
|
||||
# express per-branch optionality. Server-side runtime
|
||||
# validation enforces presence via ``__branches__``.
|
||||
sub = _parse_named_input_spec(sub_spec, optional=False)
|
||||
if sub is None:
|
||||
return None
|
||||
sub_inputs.append(sub)
|
||||
parsed_options.append(IO.DynamicCombo.Option(key=key, inputs=sub_inputs))
|
||||
return IO.DynamicCombo.Input(
|
||||
name,
|
||||
options=parsed_options,
|
||||
tooltip=options.get("tooltip"),
|
||||
optional=optional,
|
||||
)
|
||||
if io_type == "AUTOGROW":
|
||||
# Wire shape (RNP-flattened):
|
||||
# ``["AUTOGROW", {"template": [io_type, options],
|
||||
# "prefix": str, "min": int, "max": int,
|
||||
# "tooltip": ...}]``
|
||||
# or with ``names`` instead of ``prefix`` / ``max`` for the
|
||||
# TemplateNames variant.
|
||||
tmpl_spec = options.get("template")
|
||||
if not isinstance(tmpl_spec, (list, tuple)) or len(tmpl_spec) < 1:
|
||||
return None
|
||||
# Reuse top-level parser for the template — the slot name is
|
||||
# cosmetic since TemplatePrefix / TemplateNames rename each
|
||||
# cached copy per-slot.
|
||||
template_input = _parse_input_spec(name, tmpl_spec, optional=False)
|
||||
if template_input is None:
|
||||
return None
|
||||
# Upstream Autogrow asserts the template input is NOT itself a
|
||||
# DynamicInput (DynamicCombo.Input / Autogrow.Input). Mirror
|
||||
# that check at parse time so a malformed descriptor surfaces
|
||||
# as "skipped" rather than blowing up later in the IO machinery.
|
||||
if isinstance(
|
||||
template_input,
|
||||
(IO.DynamicCombo.Input, IO.Autogrow.Input),
|
||||
):
|
||||
return None
|
||||
if "names" in options:
|
||||
names = options.get("names")
|
||||
if not isinstance(names, list) or not all(isinstance(n, str) for n in names):
|
||||
return None
|
||||
try:
|
||||
template = IO.Autogrow.TemplateNames(
|
||||
template_input,
|
||||
names=names,
|
||||
min=int(options.get("min", 1)),
|
||||
)
|
||||
except AssertionError:
|
||||
return None
|
||||
elif "prefix" in options:
|
||||
prefix = options.get("prefix")
|
||||
if not isinstance(prefix, str):
|
||||
return None
|
||||
try:
|
||||
template = IO.Autogrow.TemplatePrefix(
|
||||
template_input,
|
||||
prefix=prefix,
|
||||
min=int(options.get("min", 1)),
|
||||
max=int(options.get("max", 10)),
|
||||
)
|
||||
except AssertionError:
|
||||
return None
|
||||
else:
|
||||
return None
|
||||
return IO.Autogrow.Input(
|
||||
name,
|
||||
template=template,
|
||||
tooltip=options.get("tooltip"),
|
||||
optional=optional,
|
||||
)
|
||||
# Opaque custom-IO fallthrough — any unknown io_type string becomes
|
||||
# an ``IO.Custom(io_type)`` socket so partner helper-config nodes
|
||||
# (OpenAIInputFiles → OPENAI_INPUT_FILES, OpenAIChatConfig →
|
||||
@@ -649,6 +804,11 @@ def _parse_input_spec(name: str, spec: list[Any], optional: bool) -> Any | None:
|
||||
# ``serialization`` already passes non-tensor / non-audio values
|
||||
# through ``_encode_one`` unchanged, and the deserializer treats
|
||||
# non-envelope values as already-native Python objects.
|
||||
#
|
||||
# NOTE: ``DYNAMIC_COMBO`` and ``AUTOGROW`` are handled above and
|
||||
# never reach this fallthrough — malformed dynamic specs return
|
||||
# ``None`` instead, so the caller logs + skips the descriptor
|
||||
# rather than silently degrading to a single opaque socket.
|
||||
if isinstance(io_type, str) and io_type:
|
||||
return IO.Custom(io_type).Input(name, **common)
|
||||
return None
|
||||
|
||||
+304
-15
@@ -484,27 +484,315 @@ def decode_video_envelope(envelope: dict[str, Any]) -> Any:
|
||||
# 3D model decode (encode lands when a remote node accepts MODEL_3D inputs)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Multi-file 3D bundle: a ``File3D``-compatible class that carries the
|
||||
# primary mesh plus N companion files (textures / .mtl / .bin / etc.).
|
||||
#
|
||||
# Built lazily as a ``File3D`` subclass on first use — importing
|
||||
# ``File3D`` at module load pulls torch (via ``comfy_api.latest._util.
|
||||
# geometry_types``), which is fine inside ComfyUI but breaks the
|
||||
# smoke-test pattern that exercises serialization without the heavy
|
||||
# comfy_api tree. The factory below caches the constructed class so
|
||||
# every ``BundledFile3D`` instance shares the same dynamic class and
|
||||
# ``isinstance(x, File3D)`` always succeeds.
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_BUNDLED_FILE3D_CLS: Any = None
|
||||
|
||||
|
||||
def _bundled_file3d_class() -> type:
|
||||
"""Return the cached ``BundledFile3D`` class (a ``File3D`` subclass).
|
||||
|
||||
Constructs it on first call so the ``comfy_api.latest._util``
|
||||
import (which pulls torch) is paid for only when a bundle
|
||||
envelope is actually decoded — keeps the smoke-test stubbing
|
||||
pattern intact for callers that don't exercise this path.
|
||||
"""
|
||||
global _BUNDLED_FILE3D_CLS
|
||||
if _BUNDLED_FILE3D_CLS is not None:
|
||||
return _BUNDLED_FILE3D_CLS
|
||||
from comfy_api.latest._util.geometry_types import File3D as _File3D
|
||||
|
||||
class BundledFile3D(_File3D):
|
||||
"""``File3D``-compatible wrapper for a multi-file 3D bundle.
|
||||
|
||||
Stores the primary mesh file plus N companion files (textures
|
||||
/ .mtl / .bin / etc.) in memory as a ``path -> bytes`` dict;
|
||||
lazily materialises the whole bundle into a temp directory the
|
||||
first time anything cross-file-resolution-sensitive is asked
|
||||
of it (``get_source()`` for an OBJ/GLTF that needs its
|
||||
.mtl/.bin/textures on disk; ``save_to(dest)`` which copies the
|
||||
*whole bundle* into the destination directory).
|
||||
|
||||
Cheap consumers that just want the primary file's bytes
|
||||
(``get_data()`` / ``get_bytes()``) skip the temp-dir
|
||||
materialise entirely.
|
||||
|
||||
The temp directory's lifetime is tied to this object: it is
|
||||
cleaned up on garbage-collect via ``__del__`` (best-effort).
|
||||
For workflows that need stable on-disk paths beyond this
|
||||
object's lifetime, call ``save_to(dest)`` to copy the bundle
|
||||
into a caller-controlled location.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
files: dict[str, bytes],
|
||||
primary_path: str,
|
||||
roles: dict[str, str] | None = None,
|
||||
formats: dict[str, str] | None = None,
|
||||
) -> None:
|
||||
if primary_path not in files:
|
||||
raise ValueError(
|
||||
f"primary_path {primary_path!r} not in bundle files: "
|
||||
f"{sorted(files)!r}"
|
||||
)
|
||||
self._files: dict[str, bytes] = dict(files)
|
||||
self._primary_path = primary_path
|
||||
self._roles: dict[str, str] = dict(roles or {})
|
||||
self._formats: dict[str, str] = dict(formats or {})
|
||||
self._temp_dir: str | None = None
|
||||
# Populate parent ``_source`` / ``_format`` so reads of
|
||||
# those plain attributes on downstream consumers that
|
||||
# haven't been updated still work. ``_source`` is a
|
||||
# BytesIO of the primary file; ``_format`` is the primary
|
||||
# file's extension.
|
||||
primary_fmt = (
|
||||
self._formats.get(primary_path)
|
||||
or (
|
||||
primary_path.rsplit(".", 1)[-1].lower()
|
||||
if "." in primary_path
|
||||
else ""
|
||||
)
|
||||
)
|
||||
super().__init__(BytesIO(self._files[primary_path]), primary_fmt)
|
||||
|
||||
# --------------------------------------------------------------
|
||||
# File3D-compatible accessors (overrides)
|
||||
# --------------------------------------------------------------
|
||||
|
||||
def get_source(self) -> str:
|
||||
"""Return the on-disk path to the primary file.
|
||||
|
||||
Materialises the whole bundle into a temp directory on
|
||||
first call so cross-file refs (.obj -> .mtl -> texture;
|
||||
.gltf -> .bin + textures) resolve via the filesystem.
|
||||
"""
|
||||
self._ensure_materialized()
|
||||
from os.path import join as _join
|
||||
return _join(self._temp_dir, *self._primary_path.split("/"))
|
||||
|
||||
def get_data(self) -> BytesIO:
|
||||
"""Return the primary file's bytes (no disk I/O)."""
|
||||
return BytesIO(self._files[self._primary_path])
|
||||
|
||||
def get_bytes(self) -> bytes:
|
||||
"""Return the primary file's raw bytes (no disk I/O)."""
|
||||
return self._files[self._primary_path]
|
||||
|
||||
def save_to(self, path: str) -> str:
|
||||
"""Copy the WHOLE bundle into the destination directory.
|
||||
|
||||
``path`` is the destination for the *primary file*;
|
||||
sidecars are copied alongside it preserving their relative
|
||||
paths from the original bundle layout. E.g. for
|
||||
|
||||
primary_path = "model.obj"
|
||||
files = {
|
||||
"model.obj": <bytes>,
|
||||
"model.mtl": <bytes>,
|
||||
"textures/albedo.png": <bytes>,
|
||||
}
|
||||
|
||||
``save_to("/tmp/out/scene.obj")`` writes:
|
||||
|
||||
/tmp/out/scene.obj
|
||||
/tmp/out/model.mtl
|
||||
/tmp/out/textures/albedo.png
|
||||
|
||||
Sidecars keep their ORIGINAL filenames (so cross-file
|
||||
refs inside the .obj that point at ``model.mtl`` still
|
||||
resolve); only the primary file is renamed to match
|
||||
``path``. The destination directory is created if needed.
|
||||
"""
|
||||
from pathlib import Path
|
||||
dest = Path(path)
|
||||
dest.parent.mkdir(parents=True, exist_ok=True)
|
||||
dest.write_bytes(self._files[self._primary_path])
|
||||
dest_parent_resolved = dest.parent.resolve()
|
||||
for rel_path, raw in self._files.items():
|
||||
if rel_path == self._primary_path:
|
||||
continue
|
||||
sidecar_dest = dest.parent.joinpath(*rel_path.split("/"))
|
||||
# Path safety — rel_path was sanitized at envelope
|
||||
# build time, but defence-in-depth check on the
|
||||
# resolved path keeps us safe against pathological
|
||||
# inputs that may have slipped through.
|
||||
resolved = sidecar_dest.resolve()
|
||||
if dest_parent_resolved not in resolved.parents and resolved != dest_parent_resolved:
|
||||
continue
|
||||
sidecar_dest.parent.mkdir(parents=True, exist_ok=True)
|
||||
sidecar_dest.write_bytes(raw)
|
||||
return str(dest)
|
||||
|
||||
# --------------------------------------------------------------
|
||||
# Bundle-specific accessors (additive)
|
||||
# --------------------------------------------------------------
|
||||
|
||||
@property
|
||||
def primary_path(self) -> str:
|
||||
return self._primary_path
|
||||
|
||||
@property
|
||||
def file_paths(self) -> list[str]:
|
||||
return sorted(self._files)
|
||||
|
||||
def file_bytes(self, path: str) -> bytes:
|
||||
"""Raw bytes for one file in the bundle by relative path."""
|
||||
return self._files[path]
|
||||
|
||||
def file_role(self, path: str) -> str | None:
|
||||
"""Optional producer-supplied role hint (may be ``None``)."""
|
||||
return self._roles.get(path)
|
||||
|
||||
def paths_with_role(self, role: str) -> list[str]:
|
||||
"""All file paths whose role hint equals ``role``."""
|
||||
return [p for p, r in self._roles.items() if r == role]
|
||||
|
||||
def materialize_to_temp_dir(self) -> str:
|
||||
"""Force-materialise the whole bundle into a temp directory.
|
||||
|
||||
Returns the temp-directory path. Cleanup happens on GC;
|
||||
callers that need stable lifetimes should ``save_to()`` to
|
||||
a caller-controlled location instead.
|
||||
"""
|
||||
self._ensure_materialized()
|
||||
return self._temp_dir
|
||||
|
||||
# --------------------------------------------------------------
|
||||
# Internal
|
||||
# --------------------------------------------------------------
|
||||
|
||||
def _ensure_materialized(self) -> None:
|
||||
if self._temp_dir is not None:
|
||||
return
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
self._temp_dir = tempfile.mkdtemp(prefix="rnp_model3d_bundle_")
|
||||
root = Path(self._temp_dir)
|
||||
for rel_path, raw in self._files.items():
|
||||
# rel_path was sanitized at envelope build time —
|
||||
# split-on-'/' and re-join via Path is safe.
|
||||
dest = root.joinpath(*rel_path.split("/"))
|
||||
dest.parent.mkdir(parents=True, exist_ok=True)
|
||||
dest.write_bytes(raw)
|
||||
|
||||
def __del__(self) -> None:
|
||||
td = getattr(self, "_temp_dir", None)
|
||||
if td is not None:
|
||||
try:
|
||||
import shutil
|
||||
shutil.rmtree(td, ignore_errors=True)
|
||||
except Exception: # noqa: BLE001
|
||||
pass
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return (
|
||||
f"BundledFile3D(primary={self._primary_path!r}, "
|
||||
f"files={len(self._files)}, format={self._format!r})"
|
||||
)
|
||||
|
||||
_BUNDLED_FILE3D_CLS = BundledFile3D
|
||||
return _BUNDLED_FILE3D_CLS
|
||||
|
||||
|
||||
def decode_model3d_envelope(envelope: dict[str, Any]) -> Any:
|
||||
"""Decode a 3D-model envelope into a ComfyUI ``File3D`` object.
|
||||
|
||||
Mirrors :func:`decode_video_envelope`: the only currently supported
|
||||
encoding is ``glb_inline`` (binary glTF 2.0 — magic ``b"glTF"`` at
|
||||
offset 0). The bytes are handed to ``File3D`` as a ``BytesIO`` so
|
||||
downstream nodes (preview3d / SaveGLB / Load3D) see exactly the
|
||||
same value shape they would from a local Tripo / Rodin / Meshy
|
||||
node. The envelope's optional ``format`` extra is forwarded as the
|
||||
second constructor arg so the materialiser picks the right file
|
||||
extension when persisting.
|
||||
Dispatches on the envelope's ``encoding``:
|
||||
|
||||
* ``glb_inline`` — single-file binary glTF 2.0 (magic ``b"glTF"``
|
||||
at offset 0). The bytes are handed to ``File3D`` as a
|
||||
``BytesIO`` so downstream nodes (preview3d / SaveGLB / Load3D)
|
||||
see exactly the same value shape they would from a local Tripo
|
||||
/ Rodin / Meshy node. The envelope's optional ``format`` extra
|
||||
is forwarded as the second constructor arg so the materialiser
|
||||
picks the right file extension when persisting.
|
||||
|
||||
* ``bundle_inline`` — multi-file bundle. The primary mesh file
|
||||
plus N companion files (textures / .mtl / .bin / etc.) are
|
||||
decoded into a :class:`BundledFile3D` (``File3D``-compatible)
|
||||
whose ``get_source()`` / ``save_to()`` materialise the whole
|
||||
bundle on disk so cross-file refs resolve via the filesystem.
|
||||
Path safety (no ``..`` / no absolute prefix / no Windows drive
|
||||
letter / no case-insensitive collisions) was enforced at
|
||||
envelope build time on the server; the client re-asserts the
|
||||
``primary_path``-present invariant defensively and rejects any
|
||||
file entry that lacks ``data``.
|
||||
"""
|
||||
encoding = envelope.get("encoding")
|
||||
if encoding != "glb_inline":
|
||||
raise RnpProtocolError(
|
||||
f"Unsupported model_3d encoding: {encoding!r}",
|
||||
code=ErrorCode.INTERNAL,
|
||||
if encoding == "glb_inline":
|
||||
from comfy_api.latest._util import File3D
|
||||
file_format = envelope.get("format") or "glb"
|
||||
return File3D(BytesIO(decode_envelope_data(envelope)), str(file_format))
|
||||
if encoding == "bundle_inline":
|
||||
bundle_cls = _bundled_file3d_class()
|
||||
primary_path = envelope.get("primary_path")
|
||||
if not isinstance(primary_path, str) or not primary_path:
|
||||
raise RnpProtocolError(
|
||||
"bundle_inline envelope missing 'primary_path'",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
files_spec = envelope.get("files")
|
||||
if not isinstance(files_spec, list) or not files_spec:
|
||||
raise RnpProtocolError(
|
||||
"bundle_inline envelope missing non-empty 'files' list",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
files: dict[str, bytes] = {}
|
||||
roles: dict[str, str] = {}
|
||||
formats: dict[str, str] = {}
|
||||
for entry in files_spec:
|
||||
if not isinstance(entry, dict):
|
||||
raise RnpProtocolError(
|
||||
f"bundle_inline file entry not a dict: {entry!r}",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
path = entry.get("path")
|
||||
if not isinstance(path, str) or not path:
|
||||
raise RnpProtocolError(
|
||||
f"bundle_inline file entry missing 'path': {entry!r}",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
data = entry.get("data")
|
||||
if not isinstance(data, str):
|
||||
raise RnpProtocolError(
|
||||
f"bundle_inline file {path!r} missing inline 'data'",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
files[path] = base64.b64decode(data)
|
||||
role = entry.get("role")
|
||||
if isinstance(role, str):
|
||||
roles[path] = role
|
||||
fmt = entry.get("format")
|
||||
if isinstance(fmt, str):
|
||||
formats[path] = fmt
|
||||
if primary_path not in files:
|
||||
raise RnpProtocolError(
|
||||
f"bundle_inline primary_path {primary_path!r} not in "
|
||||
f"files list (have: {sorted(files)!r})",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
return bundle_cls(
|
||||
files=files,
|
||||
primary_path=primary_path,
|
||||
roles=roles,
|
||||
formats=formats,
|
||||
)
|
||||
from comfy_api.latest._util import File3D
|
||||
file_format = envelope.get("format") or "glb"
|
||||
return File3D(BytesIO(decode_envelope_data(envelope)), str(file_format))
|
||||
raise RnpProtocolError(
|
||||
f"Unsupported model_3d encoding: {encoding!r}",
|
||||
code=ErrorCode.INTERNAL,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -567,6 +855,7 @@ __all__ = [
|
||||
"decode_audio_envelope",
|
||||
"decode_video_envelope",
|
||||
"decode_model3d_envelope",
|
||||
"_bundled_file3d_class",
|
||||
"decode_envelope",
|
||||
"is_envelope",
|
||||
"is_image_tensor",
|
||||
|
||||
Reference in New Issue
Block a user