NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-08-27 12:30:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: improve error handling for API configuration errors

Browse Source 
Add error_handler utility to detect and format HTML error responses
from misconfigured API base URLs. When the API returns HTML (indicating
configuration issues), users now see a helpful message instead of raw
HTML content.
This commit is contained in:
YueGuobin 2026-03-19 00:46:49 +08:00
parent c5325fdee4
commit 01d24403d3
No known key found for this signature in database
3 changed files with 94 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
gns3server/agent/gns3_copilot/agent_service.py
View File

@ -57,6 +57,7 @@ from gns3server.agent.gns3_copilot.gns3_client.context_helpers import (
from gns3server.agent.gns3_copilot.gns3_client.context_helpers import (
set_current_llm_config,
)
from gns3server.agent.gns3_copilot.utils.error_handler import format_error_message
from gns3server.agent.gns3_copilot.utils.message_converters import (
convert_langchain_to_openai,
)
@ -499,7 +500,11 @@ class AgentService:
except Exception as e:
log.error("Error in stream_chat: %s", e, exc_info=True)
yield {"type": "error", "error": str(e), "session_id": session_id}
yield {
"type": "error",
"error": format_error_message(e),
"session_id": session_id,
}
def _convert_event_to_chunk(
self, event: Dict[str, Any], session_id: str

2
gns3server/agent/gns3_copilot/utils/__init__.py
View File

@ -37,6 +37,7 @@ Author: Yue Guobin (岳国宾)
"""
# Import main utility functions
from .error_handler import format_error_message
from .get_gns3_device_port import get_device_ports_from_topology
from .parse_tool_content import format_tool_response
from .parse_tool_content import normalize_tool_response
@ -56,6 +57,7 @@ __url__ = "https://github.com/yueguobin/gns3-copilot"
# Export main utility functions
__all__ = [
"format_error_message",
"get_device_ports_from_topology",
"parse_tool_content",
"format_tool_response",

86
gns3server/agent/gns3_copilot/utils/error_handler.py Normal file
View File

@ -0,0 +1,86 @@
# SPDX-License-Identifier: GPL-3.0-or-later
#
# GNS3-Copilot - AI-powered Network Lab Assistant for GNS3
#
# This file is part of GNS3-Copilot project.
#
# GNS3-Copilot is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
#
# GNS3-Copilot is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
# for more details.
#
# You should have have received a copy of the GNU General Public License
# along with GNS3-Copilot. If not, see <https://www.gnu.org/licenses/>.
#
# Copyright (C) 2025 Yue Guobin (岳国宾)
# Author: Yue Guobin (岳国宾)
#
# Project Home: https://github.com/yueguobin/gns3-copilot
#
"""
Error Handler for GNS3-Copilot Agent
This module provides utilities for formatting and handling errors from
the LLM API client layer (LangChain), particularly HTTP errors that
may return HTML or other unhelpful content.
"""
import logging
import re
logger = logging.getLogger(__name__)
# Patterns to detect HTML in error messages
HTML_PATTERNS = [
r"<!DOCTYPE html",
r"<html",
r"<head>",
r"<body",
r"<div",
]
def format_error_message(error: Exception) -> str:
"""
Format an error message for user display, cleaning up HTML and
extracting meaningful error information.
Args:
error: The exception to format
Returns:
A formatted, user-friendly error message
"""
error_str = str(error)
# Check if error message contains HTML
if _contains_html(error_str):
logger.warning(
"Detected HTML in error message, likely due to incorrect API "
"configuration or base URL"
)
return (
"API request failed. The error response indicates an issue with "
"your API configuration. Please check:\n"
"1. Base URL is correct (e.g., https://api.openai.com/v1 for OpenAI)\n"
"2. API key is valid\n"
"3. Provider is correctly configured"
)
# For other errors, return the original message
return error_str
def _contains_html(text: str) -> bool:
"""Check if text contains HTML tags."""
text_lower = text.lower()
for pattern in HTML_PATTERNS:
if re.search(pattern, text_lower, re.IGNORECASE):
return True
return False