Skip to content

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.

Generalize frontend version warning to all comfy* requirements.txt entries (#13875)

Christian Byrneb112f68681e5
diff --git a/app/frontend_management.py b/app/frontend_management.py
index 7108bd35a..d0596b276 100644
--- a/app/frontend_management.py
+++ b/app/frontend_management.py
@@ -38,40 +38,54 @@ def is_valid_version(version: str) -> bool:
pattern = r"^(\d+)\.(\d+)\.(\d+)$"
return bool(re.match(pattern, version))
-def get_installed_frontend_version():
- """Get the currently installed frontend package version."""
- frontend_version_str = version("comfyui-frontend-package")
- return frontend_version_str
-
-
def get_required_frontend_version():
return get_required_packages_versions().get("comfyui-frontend-package", None)
-def check_frontend_version():
- """Check if the frontend version is up to date."""
-
- try:
- frontend_version_str = get_installed_frontend_version()
- frontend_version = parse_version(frontend_version_str)
- required_frontend_str = get_required_frontend_version()
- required_frontend = parse_version(required_frontend_str)
- if frontend_version < required_frontend:
+COMFY_PACKAGE_VERSIONS = []
+def get_comfy_package_versions():
+ """List installed/required versions for every comfy* package in requirements.txt."""
+ if COMFY_PACKAGE_VERSIONS:
+ return COMFY_PACKAGE_VERSIONS.copy()
+ out = COMFY_PACKAGE_VERSIONS
+ for name, required in (get_required_packages_versions() or {}).items():
+ if not name.startswith("comfy"):
+ continue
+ try:
+ installed = version(name)
+ except Exception:
+ installed = None
+ out.append({"name": name, "installed": installed, "required": required})
+ return out.copy()
+
+
+def check_comfy_packages_versions():
+ """Warn for every comfy* package whose installed version is below requirements.txt."""
+ from packaging.version import InvalidVersion, parse as parse_pep440
+ for pkg in get_comfy_package_versions():
+ installed_str = pkg["installed"]
+ required_str = pkg["required"]
+ if not installed_str or not required_str:
+ continue
+ try:
+ outdated = parse_pep440(installed_str) < parse_pep440(required_str)
+ except InvalidVersion as e:
+ logging.error(f"Failed to check {pkg['name']} version: {e}")
+ continue
+ if outdated:
app.logger.log_startup_warning(
f"""
________________________________________________________________________
WARNING WARNING WARNING WARNING WARNING
-Installed frontend version {".".join(map(str, frontend_version))} is lower than the recommended version {".".join(map(str, required_frontend))}.
+Installed {pkg["name"]} version {installed_str} is lower than the recommended version {required_str}.
-{frontend_install_warning_message()}
+{get_missing_requirements_message()}
________________________________________________________________________
""".strip()
)
else:
- logging.info("ComfyUI frontend version: {}".format(frontend_version_str))
- except Exception as e:
- logging.error(f"Failed to check frontend version: {e}")
+ logging.info("{} version: {}".format(pkg["name"], installed_str))
REQUEST_TIMEOUT = 10 # seconds
@@ -201,6 +215,11 @@ class FrontendManager:
def get_required_templates_version(cls) -> str:
return get_required_packages_versions().get("comfyui-workflow-templates", None)
+ @classmethod
+ def get_comfy_package_versions(cls):
+ """List installed/required versions for every comfy* package in requirements.txt."""
+ return get_comfy_package_versions()
+
@classmethod
def default_frontend_path(cls) -> str:
try:
@@ -341,7 +360,7 @@ comfyui-workflow-templates is not installed.
main error source might be request timeout or invalid URL.
"""
if version_string == DEFAULT_VERSION_STRING:
- check_frontend_version()
+ check_comfy_packages_versions()
return cls.default_frontend_path()
repo_owner, repo_name, version = cls.parse_version_string(version_string)
@@ -403,7 +422,7 @@ comfyui-workflow-templates is not installed.
except Exception as e:
logging.error("Failed to initialize frontend: %s", e)
logging.info("Falling back to the default frontend.")
- check_frontend_version()
+ check_comfy_packages_versions()
return cls.default_frontend_path()
@classmethod
def template_asset_handler(cls):
diff --git a/openapi.yaml b/openapi.yaml
index 96be4c1d5..214962c5c 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -6030,6 +6030,24 @@ components:
type: string
nullable: true
description: Minimum required workflow templates version for this ComfyUI build
+ comfy_package_versions:
+ type: array
+ description: Installed and required versions for every comfy* package pinned in requirements.txt
+ items:
+ type: object
+ required:
+ - name
+ - installed
+ - required
+ properties:
+ name:
+ type: string
+ installed:
+ type: string
+ nullable: true
+ required:
+ type: string
+ nullable: true
devices:
type: array
items:
diff --git a/server.py b/server.py
index 2f3b438bb..44470b904 100644
--- a/server.py
+++ b/server.py
@@ -656,6 +656,7 @@ class PromptServer():
required_frontend_version = FrontendManager.get_required_frontend_version()
installed_templates_version = FrontendManager.get_installed_templates_version()
required_templates_version = FrontendManager.get_required_templates_version()
+ comfy_package_versions = FrontendManager.get_comfy_package_versions()
system_stats = {
"system": {
@@ -666,6 +667,7 @@ class PromptServer():
"required_frontend_version": required_frontend_version,
"installed_templates_version": installed_templates_version,
"required_templates_version": required_templates_version,
+ "comfy_package_versions": comfy_package_versions,
"python_version": sys.version,
"pytorch_version": comfy.model_management.torch_version,
"embedded_python": os.path.split(os.path.split(sys.executable)[0])[1] == "python_embeded",
diff --git a/tests-unit/app_test/frontend_manager_test.py b/tests-unit/app_test/frontend_manager_test.py
index 1d5a84b47..8c8a2eb48 100644
--- a/tests-unit/app_test/frontend_manager_test.py
+++ b/tests-unit/app_test/frontend_manager_test.py
@@ -52,7 +52,10 @@ def mock_provider(mock_releases):
@pytest.fixture(autouse=True)
def clear_cache():
import utils.install_util
+ import app.frontend_management
+
utils.install_util.PACKAGE_VERSIONS = {}
+ app.frontend_management.COMFY_PACKAGE_VERSIONS = []
def test_get_release(mock_provider, mock_releases):
@@ -147,7 +150,7 @@ def test_init_frontend_default_with_mocks():
# Act
with (
- patch("app.frontend_management.check_frontend_version") as mock_check,
+ patch("app.frontend_management.check_comfy_packages_versions") as mock_check,
patch.object(
FrontendManager, "default_frontend_path", return_value="/mocked/path"
),
@@ -168,7 +171,7 @@ def test_init_frontend_fallback_on_error():
patch.object(
FrontendManager, "init_frontend_unsafe", side_effect=Exception("Test error")
),
- patch("app.frontend_management.check_frontend_version") as mock_check,
+ patch("app.frontend_management.check_comfy_packages_versions") as mock_check,
patch.object(
FrontendManager, "default_frontend_path", return_value="/default/path"
),
@@ -277,7 +280,9 @@ def test_get_installed_templates_version():
def test_get_installed_templates_version_not_installed():
# Act
- with patch("app.frontend_management.version", side_effect=Exception("Package not found")):
+ with patch(
+ "app.frontend_management.version", side_effect=Exception("Package not found")
+ ):
version = FrontendManager.get_installed_templates_version()
# Assert