The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.
Also attach the metadata to a prompt's preview image frames. (#16809)
Christian Byrne84164fc04bc5
diff --git a/server.py b/server.pyindex eaf49f64a..ca0399df2 100644--- a/server.py+++ b/server.py@@ -1463,8 +1463,21 @@ class PromptServer():await send_socket_catch_exception(self.sockets[sid].send_json, message)def send_sync(self, event, data, sid=None):- if self.workflow_metadata and isinstance(data, dict) and "prompt_id" in data:- data = {**self.workflow_metadata, **data}+ if self.workflow_metadata:+ if isinstance(data, dict) and "prompt_id" in data:+ data = {**self.workflow_metadata, **data}+ elif (+ event == BinaryEventTypes.PREVIEW_IMAGE_WITH_METADATA+ and isinstance(data, tuple)+ and len(data) == 2+ and isinstance(data[1], dict)+ and "prompt_id" in data[1]+ ):+ # Merged here rather than at publication: messages wait in the+ # queue, so by the time publish_loop sends a preview the next+ # prompt may already have replaced workflow_metadata, and the+ # frame would carry the wrong workflow.+ data = (data[0], {**self.workflow_metadata, **data[1]})self.loop.call_soon_threadsafe(self.messages.put_nowait, (event, data, sid))diff --git a/tests-unit/server_test/test_ws_workflow_metadata.py b/tests-unit/server_test/test_ws_workflow_metadata.pyindex 0e3294b99..1a037106c 100644--- a/tests-unit/server_test/test_ws_workflow_metadata.py+++ b/tests-unit/server_test/test_ws_workflow_metadata.py@@ -4,6 +4,7 @@ import jsonimport pytest+import protocolimport serverfrom comfy_api.feature_flags import SERVER_FEATURE_FLAGS # noqa: F401@@ -162,3 +163,64 @@ class TestWorkflowMetadataFromPrompt:if metadata is None:metadata = server.workflow_metadata_from_prompt(extra_data)assert metadata == {"workflow_id": "explicit"}++class TestBinaryPreviewMetadata:+ """The json messages of a prompt carry the client's metadata; the binary+ preview frames of the same prompt should too, so a client can tell which of+ its open workflows a mid-execution preview belongs to.++ Merged in send_sync rather than at publication: messages sit in a queue, so+ by the time publish_loop sends a preview the next prompt may already have+ replaced workflow_metadata, and the frame would carry the wrong workflow."""++ PREVIEW = protocol.BinaryEventTypes.PREVIEW_IMAGE_WITH_METADATA++ @staticmethod+ def preview_metadata(prompt_server):+ """The metadata dict of the last queued preview frame."""+ event, data, _ = prompt_server.messages.sent[-1]+ assert event == protocol.BinaryEventTypes.PREVIEW_IMAGE_WITH_METADATA+ return data[1]++ def test_preview_of_a_prompt_carries_the_metadata(self, prompt_server):+ prompt_server.workflow_metadata = {"workflow_id": "abc"}+ prompt_server.send_sync(self.PREVIEW, ("image", {"prompt_id": "p1", "node_id": "3"}))+ sent = self.preview_metadata(prompt_server)+ assert sent["workflow_id"] == "abc"+ assert sent["prompt_id"] == "p1"+ assert sent["node_id"] == "3"++ def test_metadata_cannot_overwrite_the_frame_own_fields(self, prompt_server):+ prompt_server.workflow_metadata = {"prompt_id": "spoofed", "node_id": "spoofed"}+ prompt_server.send_sync(self.PREVIEW, ("image", {"prompt_id": "p1", "node_id": "3"}))+ sent = self.preview_metadata(prompt_server)+ assert sent["prompt_id"] == "p1"+ assert sent["node_id"] == "3"++ def test_absent_when_no_metadata_was_supplied(self, prompt_server):+ prompt_server.workflow_metadata = {}+ prompt_server.send_sync(self.PREVIEW, ("image", {"prompt_id": "p1"}))+ assert "workflow_id" not in self.preview_metadata(prompt_server)++ def test_left_alone_when_the_frame_names_no_prompt(self, prompt_server):+ prompt_server.workflow_metadata = {"workflow_id": "abc"}+ prompt_server.send_sync(self.PREVIEW, ("image", {"node_id": "3"}))+ assert "workflow_id" not in self.preview_metadata(prompt_server)++ def test_the_image_half_of_the_tuple_is_untouched(self, prompt_server):+ prompt_server.workflow_metadata = {"workflow_id": "abc"}+ prompt_server.send_sync(self.PREVIEW, ("the-image", {"prompt_id": "p1"}))+ _, data, _ = prompt_server.messages.sent[-1]+ assert data[0] == "the-image"++ def test_a_preview_queued_before_the_next_prompt_keeps_its_own_metadata(+ self, prompt_server+ ):+ # The reason the merge is at enqueue time: this frame belongs to p1, and+ # p2 starting before the queue drains must not relabel it.+ prompt_server.workflow_metadata = {"workflow_id": "first"}+ prompt_server.send_sync(self.PREVIEW, ("image", {"prompt_id": "p1"}))+ prompt_server.workflow_metadata = {"workflow_id": "second"}++ event, data, _ = prompt_server.messages.sent[-1]+ assert data[1]["workflow_id"] == "first"