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.

Added parameter required_frontend_version in the /system_stats API response (#8875)

SHIVANSH GUPTAd03ae077b433
diff --git a/app/frontend_management.py b/app/frontend_management.py
index 001ebbecb..0bee73685 100644
--- a/app/frontend_management.py
+++ b/app/frontend_management.py
@@ -29,18 +29,48 @@ def frontend_install_warning_message():
This error is happening because the ComfyUI frontend is no longer shipped as part of the main repo but as a pip package instead.
""".strip()
+def parse_version(version: str) -> tuple[int, int, int]:
+ return tuple(map(int, version.split(".")))
+
+def is_valid_version(version: str) -> bool:
+ """Validate if a string is a valid semantic version (X.Y.Z format)."""
+ 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():
+ """Get the required frontend version from requirements.txt."""
+ try:
+ with open(requirements_path, "r", encoding="utf-8") as f:
+ for line in f:
+ line = line.strip()
+ if line.startswith("comfyui-frontend-package=="):
+ version_str = line.split("==")[-1]
+ if not is_valid_version(version_str):
+ logging.error(f"Invalid version format in requirements.txt: {version_str}")
+ return None
+ return version_str
+ logging.error("comfyui-frontend-package not found in requirements.txt")
+ return None
+ except FileNotFoundError:
+ logging.error("requirements.txt not found. Cannot determine required frontend version.")
+ return None
+ except Exception as e:
+ logging.error(f"Error reading requirements.txt: {e}")
+ return None
def check_frontend_version():
"""Check if the frontend version is up to date."""
- def parse_version(version: str) -> tuple[int, int, int]:
- return tuple(map(int, version.split(".")))
-
try:
- frontend_version_str = version("comfyui-frontend-package")
+ frontend_version_str = get_installed_frontend_version()
frontend_version = parse_version(frontend_version_str)
- with open(requirements_path, "r", encoding="utf-8") as f:
- required_frontend = parse_version(f.readline().split("=")[-1])
+ required_frontend_str = get_required_frontend_version()
+ required_frontend = parse_version(required_frontend_str)
if frontend_version < required_frontend:
app.logger.log_startup_warning(
f"""
@@ -168,6 +198,11 @@ def download_release_asset_zip(release: Release, destination_path: str) -> None:
class FrontendManager:
CUSTOM_FRONTENDS_ROOT = str(Path(__file__).parents[1] / "web_custom_versions")
+ @classmethod
+ def get_required_frontend_version(cls) -> str:
+ """Get the required frontend package version."""
+ return get_required_frontend_version()
+
@classmethod
def default_frontend_path(cls) -> str:
try:
diff --git a/server.py b/server.py
index 71a58f0fa..f4de0079b 100644
--- a/server.py
+++ b/server.py
@@ -553,6 +553,7 @@ class PromptServer():
ram_free = comfy.model_management.get_free_memory(cpu_device)
vram_total, torch_vram_total = comfy.model_management.get_total_memory(device, torch_total_too=True)
vram_free, torch_vram_free = comfy.model_management.get_free_memory(device, torch_free_too=True)
+ required_frontend_version = FrontendManager.get_required_frontend_version()
system_stats = {
"system": {
@@ -560,6 +561,7 @@ class PromptServer():
"ram_total": ram_total,
"ram_free": ram_free,
"comfyui_version": __version__,
+ "required_frontend_version": required_frontend_version,
"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 ce67df6c6..ce43ac564 100644
--- a/tests-unit/app_test/frontend_manager_test.py
+++ b/tests-unit/app_test/frontend_manager_test.py
@@ -1,7 +1,7 @@
import argparse
import pytest
from requests.exceptions import HTTPError
-from unittest.mock import patch
+from unittest.mock import patch, mock_open
from app.frontend_management import (
FrontendManager,
@@ -172,3 +172,36 @@ def test_init_frontend_fallback_on_error():
# Assert
assert frontend_path == "/default/path"
mock_check.assert_called_once()
+
+
+def test_get_frontend_version():
+ # Arrange
+ expected_version = "1.25.0"
+ mock_requirements_content = """torch
+torchsde
+comfyui-frontend-package==1.25.0
+other-package==1.0.0
+numpy"""
+
+ # Act
+ with patch("builtins.open", mock_open(read_data=mock_requirements_content)):
+ version = FrontendManager.get_required_frontend_version()
+
+ # Assert
+ assert version == expected_version
+
+
+def test_get_frontend_version_invalid_semver():
+ # Arrange
+ mock_requirements_content = """torch
+torchsde
+comfyui-frontend-package==1.29.3.75
+other-package==1.0.0
+numpy"""
+
+ # Act
+ with patch("builtins.open", mock_open(read_data=mock_requirements_content)):
+ version = FrontendManager.get_required_frontend_version()
+
+ # Assert
+ assert version is None