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.

Add workflow templates version tracking to system_stats (#9089)

Christian Byrne255572188f79
diff --git a/app/frontend_management.py b/app/frontend_management.py
index 0bee73685..cce0c117d 100644
--- a/app/frontend_management.py
+++ b/app/frontend_management.py
@@ -42,6 +42,7 @@ def get_installed_frontend_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:
@@ -63,6 +64,7 @@ def get_required_frontend_version():
logging.error(f"Error reading requirements.txt: {e}")
return None
+
def check_frontend_version():
"""Check if the frontend version is up to date."""
@@ -203,6 +205,37 @@ class FrontendManager:
"""Get the required frontend package version."""
return get_required_frontend_version()
+ @classmethod
+ def get_installed_templates_version(cls) -> str:
+ """Get the currently installed workflow templates package version."""
+ try:
+ templates_version_str = version("comfyui-workflow-templates")
+ return templates_version_str
+ except Exception:
+ return None
+
+ @classmethod
+ def get_required_templates_version(cls) -> str:
+ """Get the required workflow templates 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-workflow-templates=="):
+ version_str = line.split("==")[-1]
+ if not is_valid_version(version_str):
+ logging.error(f"Invalid templates version format in requirements.txt: {version_str}")
+ return None
+ return version_str
+ logging.error("comfyui-workflow-templates not found in requirements.txt")
+ return None
+ except FileNotFoundError:
+ logging.error("requirements.txt not found. Cannot determine required templates version.")
+ return None
+ except Exception as e:
+ logging.error(f"Error reading requirements.txt: {e}")
+ return None
+
@classmethod
def default_frontend_path(cls) -> str:
try:
diff --git a/server.py b/server.py
index 603677397..80e9d3fa7 100644
--- a/server.py
+++ b/server.py
@@ -550,6 +550,8 @@ class PromptServer():
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()
+ installed_templates_version = FrontendManager.get_installed_templates_version()
+ required_templates_version = FrontendManager.get_required_templates_version()
system_stats = {
"system": {
@@ -558,6 +560,8 @@ class PromptServer():
"ram_free": ram_free,
"comfyui_version": __version__,
"required_frontend_version": required_frontend_version,
+ "installed_templates_version": installed_templates_version,
+ "required_templates_version": required_templates_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 ce43ac564..643f04e72 100644
--- a/tests-unit/app_test/frontend_manager_test.py
+++ b/tests-unit/app_test/frontend_manager_test.py
@@ -205,3 +205,74 @@ numpy"""
# Assert
assert version is None
+
+
+def test_get_templates_version():
+ # Arrange
+ expected_version = "0.1.41"
+ mock_requirements_content = """torch
+torchsde
+comfyui-frontend-package==1.25.0
+comfyui-workflow-templates==0.1.41
+other-package==1.0.0
+numpy"""
+
+ # Act
+ with patch("builtins.open", mock_open(read_data=mock_requirements_content)):
+ version = FrontendManager.get_required_templates_version()
+
+ # Assert
+ assert version == expected_version
+
+
+def test_get_templates_version_not_found():
+ # Arrange
+ 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_templates_version()
+
+ # Assert
+ assert version is None
+
+
+def test_get_templates_version_invalid_semver():
+ # Arrange
+ mock_requirements_content = """torch
+torchsde
+comfyui-workflow-templates==1.0.0.beta
+other-package==1.0.0
+numpy"""
+
+ # Act
+ with patch("builtins.open", mock_open(read_data=mock_requirements_content)):
+ version = FrontendManager.get_required_templates_version()
+
+ # Assert
+ assert version is None
+
+
+def test_get_installed_templates_version():
+ # Arrange
+ expected_version = "0.1.40"
+
+ # Act
+ with patch("app.frontend_management.version", return_value=expected_version):
+ version = FrontendManager.get_installed_templates_version()
+
+ # Assert
+ assert version == expected_version
+
+
+def test_get_installed_templates_version_not_installed():
+ # Act
+ with patch("app.frontend_management.version", side_effect=Exception("Package not found")):
+ version = FrontendManager.get_installed_templates_version()
+
+ # Assert
+ assert version is None