The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.
Add deploy environment header (Comfy-Env) to partner node API calls (#13425)
Jedrzej Kosinskie758594e3b93
diff --git a/.gitignore b/.gitignoreindex 0ab4ba75e..fc426eda4 100644--- a/.gitignore+++ b/.gitignore@@ -23,3 +23,4 @@ web_custom_versions/.DS_Storefiltered-openapi.yamluv.lock+.comfy_environmentdiff --git a/comfy/deploy_environment.py b/comfy/deploy_environment.pynew file mode 100644index 000000000..8c99a3584--- /dev/null+++ b/comfy/deploy_environment.py@@ -0,0 +1,34 @@+import functools+import logging+import os++logger = logging.getLogger(__name__)++_DEFAULT_DEPLOY_ENV = "local-git"+_ENV_FILENAME = ".comfy_environment"++# Resolve the ComfyUI install directory (the parent of this `comfy/` package).+# We deliberately avoid `folder_paths.base_path` here because that is overridden+# by the `--base-directory` CLI arg to a user-supplied path, whereas the+# `.comfy_environment` marker is written by launchers/installers next to the+# ComfyUI install itself.+_COMFY_INSTALL_DIR = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))+++def get_deploy_environment() -> str:+ env_file = os.path.join(_COMFY_INSTALL_DIR, _ENV_FILENAME)+ try:+ with open(env_file, encoding="utf-8") as f:+ # Cap the read so a malformed or maliciously crafted file (e.g.+ # a single huge line with no newline) can't blow up memory.+ first_line = f.readline(128).strip()+ value = "".join(c for c in first_line if 32 <= ord(c) < 127)+ if value:+ return value+ except FileNotFoundError:+ pass+ except Exception as e:+ logger.error("Failed to read %s: %s", env_file, e)++ return _DEFAULT_DEPLOY_ENVdiff --git a/comfy_api_nodes/util/client.py b/comfy_api_nodes/util/client.pyindex a0b8d35e1..8e1ba91ba 100644--- a/comfy_api_nodes/util/client.py+++ b/comfy_api_nodes/util/client.py@@ -19,6 +19,8 @@ from comfy import utilsfrom comfy_api.latest import IOfrom server import PromptServer+from comfy.deploy_environment import get_deploy_environment+from . import request_loggerfrom ._helpers import (default_base_url,@@ -624,6 +626,7 @@ async def _request_base(cfg: _RequestConfig, expect_binary: bool):payload_headers = {"Accept": "*/*"} if expect_binary else {"Accept": "application/json"}if not parsed_url.scheme and not parsed_url.netloc: # is URL relative?payload_headers.update(get_auth_header(cfg.node_cls))+ payload_headers["Comfy-Env"] = get_deploy_environment()if cfg.endpoint.headers:payload_headers.update(cfg.endpoint.headers)diff --git a/tests-unit/deploy_environment_test.py b/tests-unit/deploy_environment_test.pynew file mode 100644index 000000000..c3497fbb0--- /dev/null+++ b/tests-unit/deploy_environment_test.py@@ -0,0 +1,109 @@+"""Tests for comfy.deploy_environment."""++import os++import pytest++from comfy import deploy_environment+from comfy.deploy_environment import get_deploy_environment++[email protected](autouse=True)+def _reset_cache_and_install_dir(tmp_path, monkeypatch):+ """Reset the functools cache and point the ComfyUI install dir at a tmp dir for each test."""+ get_deploy_environment.cache_clear()+ monkeypatch.setattr(deploy_environment, "_COMFY_INSTALL_DIR", str(tmp_path))+ yield+ get_deploy_environment.cache_clear()+++def _write_env_file(tmp_path, content: str) -> str:+ """Write the env file with exact content (no newline translation).++ `newline=""` disables Python's text-mode newline translation so the bytes+ on disk match the literal string passed in, regardless of host OS.+ Newline-style tests (CRLF, lone CR) rely on this.+ """+ path = os.path.join(str(tmp_path), ".comfy_environment")+ with open(path, "w", encoding="utf-8", newline="") as f:+ f.write(content)+ return path+++class TestGetDeployEnvironment:+ def test_returns_local_git_when_file_missing(self):+ assert get_deploy_environment() == "local-git"++ def test_reads_value_from_file(self, tmp_path):+ _write_env_file(tmp_path, "local-desktop2-standalone\n")+ assert get_deploy_environment() == "local-desktop2-standalone"++ def test_strips_trailing_whitespace_and_newline(self, tmp_path):+ _write_env_file(tmp_path, " local-desktop2-standalone \n")+ assert get_deploy_environment() == "local-desktop2-standalone"++ def test_only_first_line_is_used(self, tmp_path):+ _write_env_file(tmp_path, "first-line\nsecond-line\n")+ assert get_deploy_environment() == "first-line"++ def test_crlf_line_ending(self, tmp_path):+ # Windows editors often save text files with CRLF line endings.+ # The CR must not end up in the returned value.+ _write_env_file(tmp_path, "local-desktop2-standalone\r\n")+ assert get_deploy_environment() == "local-desktop2-standalone"++ def test_crlf_multiline_only_first_line_used(self, tmp_path):+ _write_env_file(tmp_path, "first-line\r\nsecond-line\r\n")+ assert get_deploy_environment() == "first-line"++ def test_crlf_with_surrounding_whitespace(self, tmp_path):+ _write_env_file(tmp_path, " local-desktop2-standalone \r\n")+ assert get_deploy_environment() == "local-desktop2-standalone"++ def test_lone_cr_line_ending(self, tmp_path):+ # Classic-Mac / some legacy editors use a bare CR.+ # Universal-newlines decoding treats it as a line terminator too.+ _write_env_file(tmp_path, "local-desktop2-standalone\r")+ assert get_deploy_environment() == "local-desktop2-standalone"++ def test_empty_file_falls_back_to_default(self, tmp_path):+ _write_env_file(tmp_path, "")+ assert get_deploy_environment() == "local-git"++ def test_empty_after_whitespace_strip_falls_back_to_default(self, tmp_path):+ _write_env_file(tmp_path, " \n")+ assert get_deploy_environment() == "local-git"++ def test_strips_control_chars_within_first_line(self, tmp_path):+ # Embedded NUL/control chars in the value should be stripped+ # (header-injection / smuggling protection).+ _write_env_file(tmp_path, "abc\x00\x07xyz\n")+ assert get_deploy_environment() == "abcxyz"++ def test_strips_non_ascii_characters(self, tmp_path):+ _write_env_file(tmp_path, "café-é\n")+ assert get_deploy_environment() == "caf-"++ def test_caps_read_at_128_bytes(self, tmp_path):+ # A single huge line with no newline must not be fully read into memory.+ huge = "x" * 10_000+ _write_env_file(tmp_path, huge)+ result = get_deploy_environment()+ assert result == "x" * 128++ def test_result_is_cached_across_calls(self, tmp_path):+ path = _write_env_file(tmp_path, "first_value\n")+ assert get_deploy_environment() == "first_value"+ # Overwrite the file — cached value should still be returned.+ with open(path, "w", encoding="utf-8") as f:+ f.write("second_value\n")+ assert get_deploy_environment() == "first_value"++ def test_unreadable_file_falls_back_to_default(self, tmp_path, monkeypatch):+ _write_env_file(tmp_path, "should_not_be_used\n")++ def _boom(*args, **kwargs):+ raise OSError("simulated read failure")++ monkeypatch.setattr("builtins.open", _boom)+ assert get_deploy_environment() == "local-git"