Merge pull request #286 from NikkeTryHard/main

refactor: remove dead code and update documentation

Author: NikkeTryHard

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to AI Studio Proxy API
+
+Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.
+
+## Getting Started
+
+### Fork & Clone
+
+```bash
+git clone https://github.com/YOUR_USERNAME/AIstudioProxyAPI.git
+cd AIstudioProxyAPI
+```
+
+### Install Dependencies
+
+```bash
+# Install Poetry (if not already installed)
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Install dependencies
+poetry install --with dev
+```
+
+### Run the Test Suite
+
+```bash
+poetry run pytest
+```
+
+## Making Changes
+
+1. **Create a branch**: `git checkout -b feature/your-feature`
+2. **Make your changes**
+3. **Run checks** before committing:
+   ```bash
+   poetry run ruff check .
+   poetry run ruff format .
+   poetry run pyright
+   poetry run pytest
+   ```
+4. **Commit** using [Conventional Commits](https://www.conventionalcommits.org/):
+   - `feat:` New feature
+   - `fix:` Bug fix
+   - `docs:` Documentation
+   - `refactor:` Code restructuring
+5. **Open a Pull Request**
+
+## Code Style
+
+We use:
+
+- **Ruff** for linting and formatting
+- **Pyright** for type checking
+- **80% test coverage** minimum for modified files
+
+See [Development Guide](docs/development-guide.md) for detailed coding conventions.
+
+## Reporting Issues
+
+Please include:
+
+- Steps to reproduce
+- Expected vs actual behavior
+- Python version and OS
+- Relevant logs (from `errors_py/` if available)
+
+## Questions?
+
+- Check [Troubleshooting Guide](docs/troubleshooting.md)
+- Open a Discussion or Issue
+
+## License
+
+Contributions are licensed under [AGPLv3](LICENSE).

api_utils/auth_manager.py

@@ -78,11 +78,6 @@ def mark_profile_failed(self, profile_path: Optional[str] = None) -> None:
                 "Attempted to mark profile failed but no profile provided or active."
             )
 
-    def reset_failures(self) -> None:
-        """Reset the failure tracking."""
-        self.failed_profiles.clear()
-        logger.info("Auth profile failure tracking reset.")
-
 
 # Global instance
 auth_manager = AuthManager()

api_utils/client_connection.py

@@ -1,22 +1,14 @@
 import asyncio
 from asyncio import Event, Task
 from logging import Logger
-from typing import Any, Callable, Coroutine, Dict, Protocol, Tuple
+from typing import Any, Callable, Coroutine, Dict, Tuple
 
 from fastapi import HTTPException, Request
 
 from logging_utils import set_request_id
 from models import ClientDisconnectedError
 
 
-class SupportsReceive(Protocol):
-    """Protocol for request objects that support _receive method."""
-
-    def _receive(self) -> Coroutine[Any, Any, Dict[str, Any]]:
-        """Internal method to receive messages from ASGI."""
-        ...
-
-
 async def check_client_connection(req_id: str, http_request: Request) -> bool:
     """
     Checks if the client is still connected.

api_utils/mcp_adapter.py

@@ -55,39 +55,3 @@ async def execute_mcp_tool_with_endpoint(
         except Exception:
             data = {"raw": resp.text}
     return json.dumps(data, ensure_ascii=False)
-
-
-# Synchronous helpers for use inside threads
-def execute_mcp_tool_sync(name: str, params: Dict[str, Any]) -> str:
-    ep = os.environ.get("MCP_HTTP_ENDPOINT")
-    if not ep:
-        raise RuntimeError("MCP_HTTP_ENDPOINT not configured")
-    url = f"{_normalize_endpoint(ep)}/tools/execute"
-    payload = {"name": name, "arguments": params}
-    headers = {"Content-Type": "application/json"}
-    timeout = float(os.environ.get("MCP_HTTP_TIMEOUT", "15"))
-    with httpx.Client(timeout=timeout) as client:
-        resp = client.post(url, json=payload, headers=headers)
-        resp.raise_for_status()
-        try:
-            data = resp.json()
-        except Exception:
-            data = {"raw": resp.text}
-    return json.dumps(data, ensure_ascii=False)
-
-
-def execute_mcp_tool_with_endpoint_sync(
-    endpoint: str, name: str, params: Dict[str, Any]
-) -> str:
-    url = f"{_normalize_endpoint(endpoint)}/tools/execute"
-    payload = {"name": name, "arguments": params}
-    headers = {"Content-Type": "application/json"}
-    timeout = float(os.environ.get("MCP_HTTP_TIMEOUT", "15"))
-    with httpx.Client(timeout=timeout) as client:
-        resp = client.post(url, json=payload, headers=headers)
-        resp.raise_for_status()
-        try:
-            data = resp.json()
-        except Exception:
-            data = {"raw": resp.text}
-    return json.dumps(data, ensure_ascii=False)

api_utils/response_generators.py

@@ -50,13 +50,8 @@ async def gen_sse_from_aux_stream(
     full_body_content = ""
     data_receiving = False
 
-    loop_count = 0
-
     try:
         async for raw_data in use_stream_response(req_id):
-            loop_count += 1
-            # logger.debug(f"[{req_id}] gen_sse_from_aux_stream loop iteration #{loop_count}")
-
             data_receiving = True
 
             try:

api_utils/server_state.py

@@ -99,18 +99,6 @@ def clear_debug_logs(self) -> None:
         self.console_logs = []
         self.network_log = {"requests": [], "responses": []}
 
-    def get_server_status(self) -> Dict[str, Any]:
-        """Get current server status as a dictionary."""
-        return {
-            "is_initializing": self.is_initializing,
-            "is_playwright_ready": self.is_playwright_ready,
-            "is_browser_connected": self.is_browser_connected,
-            "is_page_ready": self.is_page_ready,
-            "current_model": self.current_ai_studio_model_id,
-            "queue_size": self.request_queue.qsize() if self.request_queue else 0,
-            "worker_running": bool(self.worker_task and not self.worker_task.done()),
-        }
-
 
 # Global singleton instance
 state = ServerState()

browser_utils/__init__.py

@@ -5,7 +5,7 @@
     capture_playwright_state,
     get_texas_timestamp,
     save_comprehensive_snapshot,
-    save_error_snapshot_legacy,
+    save_error_snapshot_enhanced,
 )
 from .initialization import (
     _close_page_logic,
@@ -34,7 +34,6 @@
     save_error_snapshot,
 )
 from .page_controller import PageController
-from .script_manager import ScriptManager, script_manager
 
 __all__ = [
     # 初始化相关
@@ -60,14 +59,11 @@
     "_force_ui_state_settings",
     "_force_ui_state_with_retry",
     "_verify_and_apply_ui_state",
-    # 脚本管理相关
-    "ScriptManager",
-    "script_manager",
     # Page Controller
     "PageController",
     # Debug utilities (comprehensive error snapshots)
     "save_comprehensive_snapshot",
-    "save_error_snapshot_legacy",
+    "save_error_snapshot_enhanced",
     "get_texas_timestamp",
     "capture_dom_structure",
     "capture_playwright_state",

browser_utils/debug_utils.py

@@ -694,20 +694,3 @@ async def save_error_snapshot_enhanced(
         locators=locators,
         error_exception=error_exception,
     )
-
-
-async def save_error_snapshot_legacy(error_name: str = "error") -> None:
-    """
-    Legacy error snapshot function for backward compatibility.
-
-    DEPRECATED: Use save_error_snapshot_enhanced() or save_comprehensive_snapshot() instead.
-
-    Args:
-        error_name: Error name with optional req_id suffix (e.g., "error_hbfu521")
-    """
-    # Delegate to enhanced function with minimal context
-    await save_error_snapshot_enhanced(
-        error_name=error_name,
-        error_stage="Legacy snapshot call",
-        additional_context={"legacy_call": True},
-    )

browser_utils/operations_modules/interactions.py

@@ -349,7 +349,6 @@ async def _wait_for_response_completion(
     edit_button_locator: Locator,
     req_id: str,
     check_client_disconnected_func: Callable,
-    current_chat_id: Optional[str],
     timeout_ms=RESPONSE_COMPLETION_TIMEOUT,
     initial_wait_ms=INITIAL_WAIT_MS_BEFORE_POLLING,
 ) -> bool:

browser_utils/page_controller_modules/chat.py

@@ -290,11 +290,6 @@ async def _execute_chat_clear(
                 else:
                     raise
 
-            await self._check_disconnect(
-                check_client_disconnected,
-                f"清空聊天 - 消失检查尝试 {attempt_disappear + 1} 后",
-            )
-
     async def _dismiss_backdrops(self):
         """尝试关闭可能残留的 cdk 透明遮罩层以避免点击被拦截。"""
         try: