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.

Remove unused GET /files API endpoint (#6714)

Chenlei Huf1059b0b8261
diff --git a/api_server/routes/internal/internal_routes.py b/api_server/routes/internal/internal_routes.py
index 8f74529ba..a66fe529b 100644
--- a/api_server/routes/internal/internal_routes.py
+++ b/api_server/routes/internal/internal_routes.py
@@ -1,7 +1,6 @@
from aiohttp import web
from typing import Optional
-from folder_paths import models_dir, user_directory, output_directory, folder_names_and_paths
-from api_server.services.file_service import FileService
+from folder_paths import folder_names_and_paths
from api_server.services.terminal_service import TerminalService
import app.logger
@@ -15,26 +14,10 @@ class InternalRoutes:
def __init__(self, prompt_server):
self.routes: web.RouteTableDef = web.RouteTableDef()
self._app: Optional[web.Application] = None
- self.file_service = FileService({
- "models": models_dir,
- "user": user_directory,
- "output": output_directory
- })
self.prompt_server = prompt_server
self.terminal_service = TerminalService(prompt_server)
def setup_routes(self):
- @self.routes.get('/files')
- async def list_files(request):
- directory_key = request.query.get('directory', '')
- try:
- file_list = self.file_service.list_files(directory_key)
- return web.json_response({"files": file_list})
- except ValueError as e:
- return web.json_response({"error": str(e)}, status=400)
- except Exception as e:
- return web.json_response({"error": str(e)}, status=500)
-
@self.routes.get('/logs')
async def get_logs(request):
return web.json_response("".join([(l["t"] + " - " + l["m"]) for l in app.logger.get_logs()]))
diff --git a/api_server/services/file_service.py b/api_server/services/file_service.py
deleted file mode 100644
index 115edccd3..000000000
--- a/api_server/services/file_service.py
+++ /dev/null
@@ -1,13 +0,0 @@
-from typing import Dict, List, Optional
-from api_server.utils.file_operations import FileSystemOperations, FileSystemItem
-
-class FileService:
- def __init__(self, allowed_directories: Dict[str, str], file_system_ops: Optional[FileSystemOperations] = None):
- self.allowed_directories: Dict[str, str] = allowed_directories
- self.file_system_ops: FileSystemOperations = file_system_ops or FileSystemOperations()
-
- def list_files(self, directory_key: str) -> List[FileSystemItem]:
- if directory_key not in self.allowed_directories:
- raise ValueError("Invalid directory key")
- directory_path: str = self.allowed_directories[directory_key]
- return self.file_system_ops.walk_directory(directory_path)
diff --git a/tests-unit/server/routes/internal_routes_test.py b/tests-unit/server/routes/internal_routes_test.py
deleted file mode 100644
index 68c846652..000000000
--- a/tests-unit/server/routes/internal_routes_test.py
+++ /dev/null
@@ -1,115 +0,0 @@
-import pytest
-from aiohttp import web
-from unittest.mock import MagicMock, patch
-from api_server.routes.internal.internal_routes import InternalRoutes
-from api_server.services.file_service import FileService
-from folder_paths import models_dir, user_directory, output_directory
-
-
-def internal_routes():
- return InternalRoutes(None)
-
-def aiohttp_client_factory(aiohttp_client, internal_routes):
- async def _get_client():
- app = internal_routes.get_app()
- return await aiohttp_client(app)
- return _get_client
-
-async def test_list_files_valid_directory(aiohttp_client_factory, internal_routes):
- mock_file_list = [
- {"name": "file1.txt", "path": "file1.txt", "type": "file", "size": 100},
- {"name": "dir1", "path": "dir1", "type": "directory"}
- ]
- internal_routes.file_service.list_files = MagicMock(return_value=mock_file_list)
- client = await aiohttp_client_factory()
- resp = await client.get('/files?directory=models')
- assert resp.status == 200
- data = await resp.json()
- assert 'files' in data
- assert len(data['files']) == 2
- assert data['files'] == mock_file_list
-
- # Check other valid directories
- resp = await client.get('/files?directory=user')
- assert resp.status == 200
- resp = await client.get('/files?directory=output')
- assert resp.status == 200
-
-async def test_list_files_invalid_directory(aiohttp_client_factory, internal_routes):
- internal_routes.file_service.list_files = MagicMock(side_effect=ValueError("Invalid directory key"))
- client = await aiohttp_client_factory()
- resp = await client.get('/files?directory=invalid')
- assert resp.status == 400
- data = await resp.json()
- assert 'error' in data
- assert data['error'] == "Invalid directory key"
-
-async def test_list_files_exception(aiohttp_client_factory, internal_routes):
- internal_routes.file_service.list_files = MagicMock(side_effect=Exception("Unexpected error"))
- client = await aiohttp_client_factory()
- resp = await client.get('/files?directory=models')
- assert resp.status == 500
- data = await resp.json()
- assert 'error' in data
- assert data['error'] == "Unexpected error"
-
-async def test_list_files_no_directory_param(aiohttp_client_factory, internal_routes):
- mock_file_list = []
- internal_routes.file_service.list_files = MagicMock(return_value=mock_file_list)
- client = await aiohttp_client_factory()
- resp = await client.get('/files')
- assert resp.status == 200
- data = await resp.json()
- assert 'files' in data
- assert len(data['files']) == 0
-
-def test_setup_routes(internal_routes):
- internal_routes.setup_routes()
- routes = internal_routes.routes
- assert any(route.method == 'GET' and str(route.path) == '/files' for route in routes)
-
-def test_get_app(internal_routes):
- app = internal_routes.get_app()
- assert isinstance(app, web.Application)
- assert internal_routes._app is not None
-
-def test_get_app_reuse(internal_routes):
- app1 = internal_routes.get_app()
- app2 = internal_routes.get_app()
- assert app1 is app2
-
-async def test_routes_added_to_app(aiohttp_client_factory, internal_routes):
- client = await aiohttp_client_factory()
- try:
- resp = await client.get('/files')
- print(f"Response received: status {resp.status}") # noqa: T201
- except Exception as e:
- print(f"Exception occurred during GET request: {e}") # noqa: T201
- raise
-
- assert resp.status != 404, "Route /files does not exist"
-
-async def test_file_service_initialization():
- with patch('api_server.routes.internal.internal_routes.FileService') as MockFileService:
- # Create a mock instance
- mock_file_service_instance = MagicMock(spec=FileService)
- MockFileService.return_value = mock_file_service_instance
- internal_routes = InternalRoutes(None)
-
- # Check if FileService was initialized with the correct parameters
- MockFileService.assert_called_once_with({
- "models": models_dir,
- "user": user_directory,
- "output": output_directory
- })
-
- # Verify that the file_service attribute of InternalRoutes is set
- assert internal_routes.file_service == mock_file_service_instance
diff --git a/tests-unit/server/services/file_service_test.py b/tests-unit/server/services/file_service_test.py
deleted file mode 100644
index 09c3efc9f..000000000
--- a/tests-unit/server/services/file_service_test.py
+++ /dev/null
@@ -1,54 +0,0 @@
-import pytest
-from unittest.mock import MagicMock
-from api_server.services.file_service import FileService
-
-def mock_file_system_ops():
- return MagicMock()
-
-def file_service(mock_file_system_ops):
- allowed_directories = {
- "models": "/path/to/models",
- "user": "/path/to/user",
- "output": "/path/to/output"
- }
- return FileService(allowed_directories, file_system_ops=mock_file_system_ops)
-
-def test_list_files_valid_directory(file_service, mock_file_system_ops):
- mock_file_system_ops.walk_directory.return_value = [
- {"name": "file1.txt", "path": "file1.txt", "type": "file", "size": 100},
- {"name": "dir1", "path": "dir1", "type": "directory"}
- ]
-
- result = file_service.list_files("models")
-
- assert len(result) == 2
- assert result[0]["name"] == "file1.txt"
- assert result[1]["name"] == "dir1"
- mock_file_system_ops.walk_directory.assert_called_once_with("/path/to/models")
-
-def test_list_files_invalid_directory(file_service):
- # Does not support walking directories outside of the allowed directories
- with pytest.raises(ValueError, match="Invalid directory key"):
- file_service.list_files("invalid_key")
-
-def test_list_files_empty_directory(file_service, mock_file_system_ops):
- mock_file_system_ops.walk_directory.return_value = []
-
- result = file_service.list_files("models")
-
- assert len(result) == 0
- mock_file_system_ops.walk_directory.assert_called_once_with("/path/to/models")
-
[email protected]("directory_key", ["models", "user", "output"])
-def test_list_files_all_allowed_directories(file_service, mock_file_system_ops, directory_key):
- mock_file_system_ops.walk_directory.return_value = [
- {"name": f"file_{directory_key}.txt", "path": f"file_{directory_key}.txt", "type": "file", "size": 100}
- ]
-
- result = file_service.list_files(directory_key)
-
- assert len(result) == 1
- assert result[0]["name"] == f"file_{directory_key}.txt"
- mock_file_system_ops.walk_directory.assert_called_once_with(f"/path/to/{directory_key}")