From d247bc5a9cd624abe38fee7ac80ec03fda764845 Mon Sep 17 00:00:00 2001
From: Robin Huang <robin.j.huang@gmail.com>
Date: Thu, 12 Sep 2024 14:52:06 +0900
Subject: [PATCH] Expand variables in base_path for extra_config_paths.yaml.
 (#4893)

* Expand variables in base_path for extra_config_paths.yaml.

* Fix comments.
---
 tests-unit/utils/extra_config_test.py | 55 +++++++++++++++++++++++++++
 utils/extra_config.py                 |  2 +-
 2 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/tests-unit/utils/extra_config_test.py b/tests-unit/utils/extra_config_test.py
index f56dd3e2..06349560 100644
--- a/tests-unit/utils/extra_config_test.py
+++ b/tests-unit/utils/extra_config_test.py
@@ -19,6 +19,24 @@ def mock_yaml_content():
 def mock_expanded_home():
     return '/home/user'
 
+@pytest.fixture
+def yaml_config_with_appdata():
+    return """
+    test_config:
+      base_path: '%APPDATA%/ComfyUI'
+      checkpoints: 'models/checkpoints'
+    """
+
+@pytest.fixture
+def mock_yaml_content_appdata(yaml_config_with_appdata):
+    return yaml.safe_load(yaml_config_with_appdata)
+
+@pytest.fixture
+def mock_expandvars_appdata():
+    mock = Mock()
+    mock.side_effect = lambda path: path.replace('%APPDATA%', 'C:/Users/TestUser/AppData/Roaming')
+    return mock
+
 @pytest.fixture
 def mock_add_model_folder_path():
     return Mock()
@@ -67,3 +85,40 @@ def test_load_extra_model_paths_expands_userpath(
 
     # Check if open was called with the correct file path
     mock_file.assert_called_once_with(dummy_yaml_file_name, 'r')
+
+@patch('builtins.open', new_callable=mock_open)
+def test_load_extra_model_paths_expands_appdata(
+    mock_file,
+    monkeypatch,
+    mock_add_model_folder_path,
+    mock_expandvars_appdata,
+    yaml_config_with_appdata,
+    mock_yaml_content_appdata
+):
+    # Set the mock_file to return yaml with appdata as a variable 
+    mock_file.return_value.read.return_value = yaml_config_with_appdata
+
+    # Attach mocks
+    monkeypatch.setattr(folder_paths, 'add_model_folder_path', mock_add_model_folder_path)
+    monkeypatch.setattr(os.path, 'expandvars', mock_expandvars_appdata)
+    monkeypatch.setattr(yaml, 'safe_load', Mock(return_value=mock_yaml_content_appdata))
+
+    # Mock expanduser to do nothing (since we're not testing it here)
+    monkeypatch.setattr(os.path, 'expanduser', lambda x: x)
+
+    dummy_yaml_file_name = 'dummy_path.yaml'
+    load_extra_path_config(dummy_yaml_file_name)
+
+    expected_base_path = 'C:/Users/TestUser/AppData/Roaming/ComfyUI'
+    expected_calls = [
+        ('checkpoints', os.path.join(expected_base_path, 'models/checkpoints')),
+    ]
+
+    assert mock_add_model_folder_path.call_count == len(expected_calls)
+    
+    # Check the base path variable was expanded
+    for actual_call, expected_call in zip(mock_add_model_folder_path.call_args_list, expected_calls):
+        assert actual_call.args == expected_call
+
+    # Verify that expandvars was called
+    assert mock_expandvars_appdata.called
diff --git a/utils/extra_config.py b/utils/extra_config.py
index 23c2d791..7ac3650a 100644
--- a/utils/extra_config.py
+++ b/utils/extra_config.py
@@ -13,7 +13,7 @@ def load_extra_path_config(yaml_path):
         base_path = None
         if "base_path" in conf:
             base_path = conf.pop("base_path")
-            base_path = os.path.expanduser(base_path)
+            base_path = os.path.expandvars(os.path.expanduser(base_path))
         for x in conf:
             for y in conf[x].split("\n"):
                 if len(y) == 0: