sycommon-python-lib 0.1.56b5__py3-none-any.whl → 0.1.57b1__py3-none-any.whl

sycommon/middleware/exception.py

@@ -1,7 +1,7 @@
 from fastapi import Request, HTTPException
 from fastapi.responses import JSONResponse
 from pydantic import ValidationError
-import traceback
+from sycommon.logging.kafka_log import SYLogger
 
 
 def setup_exception_handler(app, config: dict):
@@ -15,7 +15,7 @@ def setup_exception_handler(app, config: dict):
         int_MaxBytes = int(MaxBytes) / 1024 / 1024
         return JSONResponse(
             content={
-                'code': 413, 'error': f'File size exceeds the allowed limit of {int_MaxBytes}MB.'},
+                'code': 413, 'error': f'File size exceeds the allowed limit of {int_MaxBytes}MB.', 'traceId': SYLogger.get_trace_id()},
             status_code=413
         )
 
@@ -27,7 +27,8 @@ def setup_exception_handler(app, config: dict):
             content={
                 "code": exc.status_code,
                 "message": exc.detail,
-                "path": str(request.url.path)
+                "path": str(request.url.path),
+                "traceId": SYLogger.get_trace_id()
             }
         )
 
@@ -39,7 +40,8 @@ def setup_exception_handler(app, config: dict):
             content={
                 "code": 400,
                 "message": "参数验证失败",
-                "details": exc.errors()
+                "details": exc.errors(),
+                "traceId": SYLogger.get_trace_id()
             }
         )
 
@@ -55,30 +57,22 @@ def setup_exception_handler(app, config: dict):
             status_code=exc.code,
             content={
                 "code": exc.code,
-                "message": exc.message
+                "message": exc.message,
+                "traceId": SYLogger.get_trace_id()
             }
         )
 
     # 5. 全局异常处理器（捕获所有未处理的异常）
     @app.exception_handler(Exception)
     async def global_exception_handler(request: Request, exc: Exception):
-        # 记录详细错误信息
-        error_msg = f"请求路径: {request.url}\n"
-        error_msg += f"错误类型: {type(exc).__name__}\n"
-        error_msg += f"错误信息: {str(exc)}\n"
-        error_msg += f"堆栈信息: {traceback.format_exc()}"
-
-        # 使用你的日志服务记录错误
-        from sycommon.logging.kafka_log import SYLogger
-        SYLogger.error(error_msg)
-
         # 返回统一格式的错误响应（生产环境可选择不返回详细信息）
         return JSONResponse(
             status_code=500,
             content={
                 "code": 500,
                 "message": "服务器内部错误，请稍后重试",
-                "detail": str(exc) if config.get('DEBUG', False) else "Internal Server Error"
+                "detail": str(exc) if config.get('DEBUG', False) else "Internal Server Error",
+                "traceId": SYLogger.get_trace_id()
             }
         )
 

sycommon/middleware/timeout.py

@@ -2,6 +2,7 @@
 import time
 from fastapi import Request
 from fastapi.responses import JSONResponse
+from sycommon.logging.kafka_log import SYLogger
 
 
 def setup_request_timeout_middleware(app, config: dict):
@@ -14,6 +15,6 @@ def setup_request_timeout_middleware(app, config: dict):
         response = await call_next(request)
         duration = time.time() - request.state.start_time
         if duration > REQUEST_TIMEOUT:
-            return JSONResponse(content={'code': 1, 'error': 'Request timed out'}, status_code=504)
+            return JSONResponse(content={'code': 1, 'error': 'Request timed out', 'traceId': SYLogger.get_trace_id()}, status_code=504)
         return response
     return app

sycommon/middleware/traceid.py

@@ -10,11 +10,8 @@ from sycommon.tools.snowflake import Snowflake
 def setup_trace_id_handler(app):
     @app.middleware("http")
     async def trace_id_and_log_middleware(request: Request, call_next):
-        # ========== 1. 请求阶段：确保获取/生成 x-traceId-header ==========
-        # 优先从请求头读取（兼容任意大小写）
-        trace_id = request.headers.get(
-            "x-traceId-header") or request.headers.get("x-traceid-header")
-        # 无则生成雪花ID
+        # ========== 1. 请求阶段：获取/生成 TraceID ==========
+        trace_id = request.headers.get("x-traceid-header")
         if not trace_id:
             trace_id = Snowflake.id
 
@@ -37,38 +34,30 @@ def setup_trace_id_handler(app):
 
         if is_json_content and request.method in ["POST", "PUT", "PATCH"]:
             try:
-                # 兼容纯文本格式的 JSON（先读文本再解析）
+                # 兼容纯文本格式的 JSON
                 if "text/plain" in content_type:
                     raw_text = await request.text(encoding="utf-8")
                     request_body = json.loads(raw_text)
                 else:
-                    # application/json 直接解析
                     request_body = await request.json()
-            except Exception as e:
+            except Exception:
                 try:
                     request_body = await request.json()
                 except Exception as e:
-                    # 精准捕获 JSON 解析错误（而非泛 Exception）
                     request_body = {"error": f"JSON parse failed: {str(e)}"}
 
         elif "multipart/form-data" in content_type and request.method in ["POST", "PUT"]:
             try:
-                # 从请求头中提取boundary
                 boundary = None
                 if "boundary=" in content_type:
                     boundary = content_type.split("boundary=")[1].strip()
                     boundary = boundary.encode('ascii')
 
                 if boundary:
-                    # 读取原始请求体
                     body = await request.body()
-
-                    # 尝试从原始请求体中提取文件名
                     parts = body.split(boundary)
                     for part in parts:
                         part_str = part.decode('utf-8', errors='ignore')
-
-                        # 使用正则表达式查找文件名
                         filename_match = re.search(
                             r'filename="([^"]+)"', part_str)
                         if filename_match:
@@ -82,62 +71,69 @@ def setup_trace_id_handler(app):
                 request_body = {
                     "error": f"Failed to process form data: {str(e)}"}
 
-        # 构建请求日志（包含 traceId）
+        # 构建请求日志
         request_message = {
-            "traceId": trace_id,  # 请求日志中加入 traceId
+            "traceId": trace_id,
             "method": request.method,
             "url": str(request.url),
             "query_params": query_params,
             "request_body": request_body,
             "uploaded_files": files_info if files_info else None
         }
-        request_message_str = json.dumps(request_message, ensure_ascii=False)
-        SYLogger.info(request_message_str)
+        SYLogger.info(json.dumps(request_message, ensure_ascii=False))
+
+        # 标记位：默认认为会发生异常
+        # 这样如果中途代码报错跳转到 except，finally 就不会 reset，保留 trace_id 给 Exception Handler
+        had_exception = True
 
         try:
-            # 处理请求
+            # ========== 2. 处理请求 ==========
             response = await call_next(request)
 
-            # 获取响应Content-Type（统一小写）
-            content_type = response.headers.get("content-type", "").lower()
+            # ========== 3. 响应处理阶段 ==========
+            # 注意：此阶段发生的任何异常都会被下方的 except 捕获
+            # 从而保证 trace_id 不被清除，能够透传
+
+            response_content_type = response.headers.get(
+                "content-type", "").lower()
 
-            # ========== 2. SSE 响应：仅设置 x-traceId-header，不修改其他头 ==========
-            if "text/event-stream" in content_type:
+            # 处理 SSE (Server-Sent Events)
+            if "text/event-stream" in response_content_type:
                 try:
-                    # 强制写入 x-traceId-header 到响应头
-                    response.headers["x-traceId-header"] = trace_id
-                    # 确保前端能读取（仅补充暴露头，不覆盖原有值）
+                    response.headers["x-traceid-header"] = trace_id
                     expose_headers = response.headers.get(
                         "access-control-expose-headers", "")
                     if expose_headers:
-                        if "x-traceId-header" not in expose_headers.lower():
+                        if "x-traceid-header" not in expose_headers.lower():
                             response.headers[
-                                "access-control-expose-headers"] = f"{expose_headers}, x-traceId-header"
+                                "access-control-expose-headers"] = f"{expose_headers}, x-traceid-header"
                     else:
-                        response.headers["access-control-expose-headers"] = "x-traceId-header"
-                    # SSE 必须移除 Content-Length（仅这一个额外操作）
+                        response.headers["access-control-expose-headers"] = "x-traceid-header"
+
+                    # SSE 必须移除 Content-Length
                     headers_lower = {
                         k.lower(): k for k in response.headers.keys()}
                     if "content-length" in headers_lower:
                         del response.headers[headers_lower["content-length"]]
                 except AttributeError:
-                    # 流式响应头只读：初始化时仅加入 traceId 和必要暴露头
+                    # 流式响应头只读处理
                     new_headers = dict(response.headers) if hasattr(
                         response.headers, 'items') else {}
-                    new_headers["x-traceId-header"] = trace_id  # 强制加入
-                    # 保留原有暴露头，补充 traceId
+                    new_headers["x-traceid-header"] = trace_id
                     if "access-control-expose-headers" in new_headers:
-                        if "x-traceId-header" not in new_headers["access-control-expose-headers"].lower():
-                            new_headers["access-control-expose-headers"] += ", x-traceId-header"
+                        if "x-traceid-header" not in new_headers["access-control-expose-headers"].lower():
+                            new_headers["access-control-expose-headers"] += ", x-traceid-header"
                     else:
-                        new_headers["access-control-expose-headers"] = "x-traceId-header"
-                    # 移除 Content-Length
+                        new_headers["access-control-expose-headers"] = "x-traceid-header"
                     new_headers.pop("content-length", None)
                     response.init_headers(new_headers)
+
+                # SSE 不处理 Body，直接返回
+                had_exception = False
                 return response
 
-            # ========== 3. 非 SSE 响应：强制写入 x-traceId-header，保留 CORS ==========
-            # 备份 CORS 头（防止丢失）
+            # 处理非 SSE 响应
+            # 备份 CORS 头
             cors_headers = {}
             cors_header_keys = [
                 "access-control-allow-origin",
@@ -153,7 +149,7 @@ def setup_trace_id_handler(app):
                         cors_headers[key] = response.headers[k]
                         break
 
-            # 合并 headers（非 SSE 场景）
+            # 合并 Headers
             merged_headers = merge_headers(
                 source_headers=request.headers,
                 target_headers=response.headers,
@@ -161,19 +157,20 @@ def setup_trace_id_handler(app):
                 delete_keys={'content-length', 'accept', 'content-type'}
             )
 
-            # 强制加入 x-traceId-header（优先级最高）
-            merged_headers["x-traceId-header"] = trace_id
-            # 恢复 CORS 头 + 补充 traceId 到暴露头
+            # 强制加入 x-traceid-header
+            merged_headers["x-traceid-header"] = trace_id
             merged_headers.update(cors_headers)
+
+            # 更新暴露头
             expose_headers = merged_headers.get(
                 "access-control-expose-headers", "")
             if expose_headers:
-                if "x-traceId-header" not in expose_headers.lower():
-                    merged_headers["access-control-expose-headers"] = f"{expose_headers}, x-traceId-header"
+                if "x-traceid-header" not in expose_headers.lower():
+                    merged_headers["access-control-expose-headers"] = f"{expose_headers}, x-traceid-header"
             else:
-                merged_headers["access-control-expose-headers"] = "x-traceId-header"
+                merged_headers["access-control-expose-headers"] = "x-traceid-header"
 
-            # 更新响应头
+            # 应用 Headers
             if hasattr(response.headers, 'clear'):
                 response.headers.clear()
                 for k, v in merged_headers.items():
@@ -187,27 +184,26 @@ def setup_trace_id_handler(app):
                     except (AttributeError, KeyError):
                         pass
 
-            # 处理普通响应体（JSON 加入 traceId）
+            # 处理响应体
             response_body = b""
             try:
                 async for chunk in response.body_iterator:
                     response_body += chunk
 
-                # 获取 Content-Disposition（统一小写）
                 content_disposition = response.headers.get(
                     "content-disposition", "").lower()
 
-                # JSON 响应体加入 traceId
-                if "application/json" in content_type and not content_disposition.startswith("attachment"):
+                # JSON 响应体注入 traceId
+                if "application/json" in response_content_type and not content_disposition.startswith("attachment"):
                     try:
                         data = json.loads(response_body)
                         new_body = response_body
-                        if data:
-                            data["traceId"] = trace_id  # 响应体也加入
+                        if isinstance(data, dict):
+                            data["traceId"] = trace_id
                             new_body = json.dumps(
                                 data, ensure_ascii=False).encode()
 
-                        # 重建响应，确保 header 包含 x-traceId-header
+                        # 重建 Response 以更新 Body 和 Content-Length
                         response = Response(
                             content=new_body,
                             status_code=response.status_code,
@@ -215,12 +211,12 @@ def setup_trace_id_handler(app):
                             media_type=response.media_type
                         )
                         response.headers["content-length"] = str(len(new_body))
-                        response.headers["x-traceId-header"] = trace_id  # 再次兜底
-                        # 恢复 CORS 头
+                        response.headers["x-traceid-header"] = trace_id
+                        # 恢复 CORS
                         for k, v in cors_headers.items():
                             response.headers[k] = v
                     except json.JSONDecodeError:
-                        # 非 JSON 响应：仅更新长度，强制加入 traceId
+                        # 非 JSON 或解析失败，仅更新长度
                         response = Response(
                             content=response_body,
                             status_code=response.status_code,
@@ -229,11 +225,11 @@ def setup_trace_id_handler(app):
                         )
                         response.headers["content-length"] = str(
                             len(response_body))
-                        response.headers["x-traceId-header"] = trace_id  # 强制加入
+                        response.headers["x-traceid-header"] = trace_id
                         for k, v in cors_headers.items():
                             response.headers[k] = v
                 else:
-                    # 非 JSON 响应：强制加入 traceId
+                    # 非 JSON 响应
                     response = Response(
                         content=response_body,
                         status_code=response.status_code,
@@ -242,48 +238,57 @@ def setup_trace_id_handler(app):
                     )
                     response.headers["content-length"] = str(
                         len(response_body))
-                    response.headers["x-traceId-header"] = trace_id  # 强制加入
+                    response.headers["x-traceid-header"] = trace_id
                     for k, v in cors_headers.items():
                         response.headers[k] = v
             except StopAsyncIteration:
                 pass
 
-            # 构建响应日志（包含 traceId）
+            # 构建响应日志
             response_message = {
-                "traceId": trace_id,  # 响应日志加入 traceId
+                "traceId": trace_id,
                 "status_code": response.status_code,
                 "response_body": response_body.decode('utf-8', errors='ignore'),
             }
-            response_message_str = json.dumps(
-                response_message, ensure_ascii=False)
-            SYLogger.info(response_message_str)
+            SYLogger.info(json.dumps(response_message, ensure_ascii=False))
 
-            # ========== 最终兜底：确保响应头必有 x-traceId-header ==========
+            # 兜底：确保 Header 必有 TraceId
             try:
-                response.headers["x-traceId-header"] = trace_id
+                response.headers["x-traceid-header"] = trace_id
             except AttributeError:
                 new_headers = dict(response.headers) if hasattr(
                     response.headers, 'items') else {}
-                new_headers["x-traceId-header"] = trace_id
+                new_headers["x-traceid-header"] = trace_id
                 if hasattr(response, "init_headers"):
                     response.init_headers(new_headers)
 
+            # 如果执行到这里，说明一切正常，标记为无异常
+            had_exception = False
             return response
+
         except Exception as e:
-            # 异常日志也加入 traceId
+            # ========== 4. 异常处理阶段 ==========
+            # 记录中间件层面的异常日志
             error_message = {
                 "traceId": trace_id,
-                "error": str(e),
+                "error": f"Middleware Error: {str(e)}",
                 "query_params": query_params,
                 "request_body": request_body,
                 "uploaded_files": files_info if files_info else None
             }
-            error_message_str = json.dumps(error_message, ensure_ascii=False)
-            SYLogger.error(error_message_str)
+            # 使用 SYLogger.error，由于处于 except 块，会自动捕获堆栈
+            SYLogger.error(error_message)
+
+            # 关键：重新抛出异常，让 Global Exception Handler 接管
+            # 此时 had_exception 仍为 True，finally 不会 reset，trace_id 得以保留
             raise
+
         finally:
-            # 清理上下文变量
-            SYLogger.reset_trace_id(token)
-            SYLogger.reset_headers(header_token)
+            # ========== 5. 清理阶段 ==========
+            # 只有在没有任何异常的情况下（had_exception=False），才手动清除上下文
+            if not had_exception:
+                SYLogger.reset_trace_id(token)
+                SYLogger.reset_headers(header_token)
+            # 如果 had_exception 为 True，这里什么都不做，保留 ContextVar 供 Exception Handler 读取
 
     return app

sycommon/notice/uvicorn_monitor.py

@@ -7,11 +7,12 @@ import json
 from typing import Optional
 from urllib.parse import urlparse, parse_qs, urlencode, urlunparse
 from sycommon.config.Config import Config
+from sycommon.logging.kafka_log import SYLogger
 
 
 async def send_wechat_markdown_msg(
     content: str,
-    webhook: str = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=b9992872-ea66-494f-8683-f43411b7713a"
+    webhook: str = None
 ) -> Optional[dict]:
     """
     异步发送企业微信Markdown格式的WebHook消息
@@ -50,13 +51,14 @@ async def send_wechat_markdown_msg(
                     response_text) if response_text else {}
 
                 if status == 200 and response_data.get("errcode") == 0:
-                    print(f"消息发送成功: {response_data}")
+                    SYLogger.info(f"消息发送成功: {response_data}")
                     return response_data
                 else:
-                    print(f"消息发送失败 - 状态码: {status}, 响应: {response_data}")
+                    SYLogger.info(
+                        f"消息发送失败 - 状态码: {status}, 响应: {response_data}")
                     return None
     except Exception as e:
-        print(f"错误：未知异常 - {str(e)}")
+        SYLogger.info(f"错误：未知异常 - {str(e)}")
         return None
 
 
@@ -71,10 +73,12 @@ async def send_webhook(error_info: dict = None, webhook: str = None):
     try:
         service_name = Config().config.get('Name', "未知服务")
         env = Config().config.get('Nacos', {}).get('namespaceId', '未知环境')
+        webHook = Config().config.get('llm', {}).get('WebHook', '未知环境')
     except Exception as e:
         service_name = "未知服务"
         env = "未知环境"
-        print(f"读取配置失败: {str(e)}")
+        webHook = None
+        SYLogger.info(f"读取配置失败: {str(e)}")
 
     start_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
 
@@ -92,13 +96,14 @@ async def send_webhook(error_info: dict = None, webhook: str = None):
 > 错误信息: <font color="danger">{error_msg}</font>
 > 错误堆栈: {stack_trace}"""
 
-    # 发送消息（优先使用传入的webhook，否则用默认值）
-    default_webhook = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=b9992872-ea66-494f-8683-f43411b7713a"
-    result = await send_wechat_markdown_msg(
-        content=markdown_content,
-        webhook=webhook if webhook else default_webhook
-    )
-    print(f"通知发送结果: {result}")
+    if webhook or webHook:
+        result = await send_wechat_markdown_msg(
+            content=markdown_content,
+            webhook=webhook or webHook
+        )
+        SYLogger.info(f"通知发送结果: {result}")
+    else:
+        SYLogger.info("未设置企业微信WebHook")
 
 
 def run(*args, webhook: str = None, **kwargs):
@@ -133,7 +138,7 @@ def run(*args, webhook: str = None, **kwargs):
             masked_query = urlencode(query, doseq=True)
             masked_webhook = urlunparse(
                 (parsed.scheme, parsed.netloc, parsed.path, parsed.params, masked_query, parsed.fragment))
-            print(f"自定义企业微信WebHook: {masked_webhook}")
+            SYLogger.info(f"自定义企业微信WebHook: {masked_webhook}")
 
     # 初始化错误信息
     error_info = None
@@ -146,10 +151,10 @@ def run(*args, webhook: str = None, **kwargs):
     except KeyboardInterrupt:
         # 处理用户手动中断（不算启动失败）
         elapsed = (datetime.now() - start_time).total_seconds()
-        print(f"\n{'='*50}")
-        print(f"ℹ️  应用被用户手动中断")
-        print(f"启动耗时: {elapsed:.2f} 秒")
-        print(f"{'='*50}\n")
+        SYLogger.info(f"\n{'='*50}")
+        SYLogger.info(f"ℹ️  应用被用户手动中断")
+        SYLogger.info(f"启动耗时: {elapsed:.2f} 秒")
+        SYLogger.info(f"{'='*50}\n")
         sys.exit(0)
 
     except Exception as e:
@@ -167,16 +172,16 @@ def run(*args, webhook: str = None, **kwargs):
         }
 
         # 打印错误信息
-        print(f"\n{'='*50}")
-        print(f"🚨 应用启动失败！")
-        print(f"失败时间: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
-        print(f"错误类型: {type(e).__name__}")
-        print(f"错误信息: {str(e)}")
-        print(f"\n📝 错误堆栈（关键）:")
-        print(f"-"*50)
+        SYLogger.info(f"\n{'='*50}")
+        SYLogger.info(f"🚨 应用启动失败！")
+        SYLogger.info(f"失败时间: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
+        SYLogger.info(f"错误类型: {type(e).__name__}")
+        SYLogger.info(f"错误信息: {str(e)}")
+        SYLogger.info(f"\n📝 错误堆栈（关键）:")
+        SYLogger.info(f"-"*50)
         traceback.print_exc(file=sys.stdout)
-        print(f"\n⏱️  启动耗时: {elapsed:.2f} 秒")
-        print(f"{'='*50}\n")
+        SYLogger.info(f"\n⏱️  启动耗时: {elapsed:.2f} 秒")
+        SYLogger.info(f"{'='*50}\n")
 
     finally:
         # 运行异步通知函数，传递自定义的webhook参数
@@ -186,7 +191,7 @@ def run(*args, webhook: str = None, **kwargs):
                 webhook=webhook
             ))
         except Exception as e:
-            print(f"错误：异步通知失败 - {str(e)}")
+            SYLogger.info(f"错误：异步通知失败 - {str(e)}")
         # 启动失败时退出程序
         sys.exit(1)