Show text progress messages on executing nodes

[christian-byrne]

Adds a new websocket message type for text progress reports from a node. When receiving such messages, render a Vue DOM widget to display the text on the iniating node.

The websocket message follows format:

[4 bytes: event type = 3 (int)][4 bytes: length of node id][n bytes: node id (utf-8 string)][... text (utf-8 string)]

The messages can be sent from a node like:

from server import PromptServer

class Node:
    @classmethod
    def INPUT_TYPES(cls):
        return {
            "hidden" : {
                "unique_id": "UNIQUE_ID",
            }
        }

    RETURN_TYPES = (,)
    FUNCTION = "send_message"

    def send_message(self, unique_id=None):
        PromptServer.instance.send_progress_text("Loading...", unique_id)
        time.sleep(2)
        PromptServer.instance.send_progress_text("result: foo bar", unique_id)
        return (,)

Resolves #3793

---

Related:

• Upstream generalized text preview method: Add method to stream text to node UI ComfyUI#8018
• Add text preview UI component on frontend: Show text progress messages on executing nodes #3824
• Implement with Pika nodes as example: https://github.com/Comfy-Org/ComfyUI-private/pull/168

┆Issue is synchronized with this Notion page by Unito

[christian-byrne]

How it appears in UI:

text-progress.mp4