sycommon-python-lib 0.1.56__py3-none-any.whl → 0.1.56b2__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
-from sycommon.logging.kafka_log import SYLogger
+import traceback
 
 
 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.', 'traceId': SYLogger.get_trace_id()},
+                'code': 413, 'error': f'File size exceeds the allowed limit of {int_MaxBytes}MB.'},
             status_code=413
         )
 
@@ -27,8 +27,7 @@ def setup_exception_handler(app, config: dict):
             content={
                 "code": exc.status_code,
                 "message": exc.detail,
-                "path": str(request.url.path),
-                "traceId": SYLogger.get_trace_id()
+                "path": str(request.url.path)
             }
         )
 
@@ -40,8 +39,7 @@ def setup_exception_handler(app, config: dict):
             content={
                 "code": 400,
                 "message": "参数验证失败",
-                "details": exc.errors(),
-                "traceId": SYLogger.get_trace_id()
+                "details": exc.errors()
             }
         )
 
@@ -57,22 +55,30 @@ def setup_exception_handler(app, config: dict):
             status_code=exc.code,
             content={
                 "code": exc.code,
-                "message": exc.message,
-                "traceId": SYLogger.get_trace_id()
+                "message": exc.message
             }
         )
 
     # 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",
-                "traceId": SYLogger.get_trace_id()
+                "detail": str(exc) if config.get('DEBUG', False) else "Internal Server Error"
             }
         )
 

sycommon/middleware/timeout.py

@@ -2,7 +2,6 @@
 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):
@@ -15,6 +14,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', 'traceId': SYLogger.get_trace_id()}, status_code=504)
+            return JSONResponse(content={'code': 1, 'error': 'Request timed out'}, status_code=504)
         return response
     return app

sycommon/middleware/traceid.py

@@ -10,8 +10,11 @@ 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. 请求阶段：获取/生成 TraceID ==========
-        trace_id = request.headers.get("x-traceid-header")
+        # ========== 1. 请求阶段：确保获取/生成 x-traceId-header ==========
+        # 优先从请求头读取（兼容任意大小写）
+        trace_id = request.headers.get(
+            "x-traceId-header") or request.headers.get("x-traceid-header")
+        # 无则生成雪花ID
         if not trace_id:
             trace_id = Snowflake.id
 
@@ -34,30 +37,38 @@ 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:
+            except Exception as e:
                 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:
@@ -71,69 +82,62 @@ def setup_trace_id_handler(app):
                 request_body = {
                     "error": f"Failed to process form data: {str(e)}"}
 
-        # 构建请求日志
+        # 构建请求日志（包含 traceId）
         request_message = {
-            "traceId": trace_id,
+            "traceId": trace_id,  # 请求日志中加入 traceId
             "method": request.method,
             "url": str(request.url),
             "query_params": query_params,
             "request_body": request_body,
             "uploaded_files": files_info if files_info else None
         }
-        SYLogger.info(json.dumps(request_message, ensure_ascii=False))
-
-        # 标记位：默认认为会发生异常
-        # 这样如果中途代码报错跳转到 except，finally 就不会 reset，保留 trace_id 给 Exception Handler
-        had_exception = True
+        request_message_str = json.dumps(request_message, ensure_ascii=False)
+        SYLogger.info(request_message_str)
 
         try:
-            # ========== 2. 处理请求 ==========
+            # 处理请求
             response = await call_next(request)
 
-            # ========== 3. 响应处理阶段 ==========
-            # 注意：此阶段发生的任何异常都会被下方的 except 捕获
-            # 从而保证 trace_id 不被清除，能够透传
-
-            response_content_type = response.headers.get(
-                "content-type", "").lower()
+            # 获取响应Content-Type（统一小写）
+            content_type = response.headers.get("content-type", "").lower()
 
-            # 处理 SSE (Server-Sent Events)
-            if "text/event-stream" in response_content_type:
+            # ========== 2. SSE 响应：仅设置 x-traceId-header，不修改其他头 ==========
+            if "text/event-stream" in content_type:
                 try:
-                    response.headers["x-traceid-header"] = trace_id
+                    # 强制写入 x-traceId-header 到响应头
+                    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
+                    new_headers["x-traceId-header"] = trace_id  # 强制加入
+                    # 保留原有暴露头，补充 traceId
                     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"
+                        new_headers["access-control-expose-headers"] = "x-traceId-header"
+                    # 移除 Content-Length
                     new_headers.pop("content-length", None)
                     response.init_headers(new_headers)
-
-                # SSE 不处理 Body，直接返回
-                had_exception = False
                 return response
 
-            # 处理非 SSE 响应
-            # 备份 CORS 头
+            # ========== 3. 非 SSE 响应：强制写入 x-traceId-header，保留 CORS ==========
+            # 备份 CORS 头（防止丢失）
             cors_headers = {}
             cors_header_keys = [
                 "access-control-allow-origin",
@@ -149,7 +153,7 @@ def setup_trace_id_handler(app):
                         cors_headers[key] = response.headers[k]
                         break
 
-            # 合并 Headers
+            # 合并 headers（非 SSE 场景）
             merged_headers = merge_headers(
                 source_headers=request.headers,
                 target_headers=response.headers,
@@ -157,20 +161,19 @@ def setup_trace_id_handler(app):
                 delete_keys={'content-length', 'accept', 'content-type'}
             )
 
-            # 强制加入 x-traceid-header
-            merged_headers["x-traceid-header"] = trace_id
+            # 强制加入 x-traceId-header（优先级最高）
+            merged_headers["x-traceId-header"] = trace_id
+            # 恢复 CORS 头 + 补充 traceId 到暴露头
             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():
@@ -184,26 +187,27 @@ 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 response_content_type and not content_disposition.startswith("attachment"):
+                # JSON 响应体加入 traceId
+                if "application/json" in content_type and not content_disposition.startswith("attachment"):
                     try:
                         data = json.loads(response_body)
                         new_body = response_body
-                        if isinstance(data, dict):
-                            data["traceId"] = trace_id
+                        if data:
+                            data["traceId"] = trace_id  # 响应体也加入
                             new_body = json.dumps(
                                 data, ensure_ascii=False).encode()
 
-                        # 重建 Response 以更新 Body 和 Content-Length
+                        # 重建响应，确保 header 包含 x-traceId-header
                         response = Response(
                             content=new_body,
                             status_code=response.status_code,
@@ -211,12 +215,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 或解析失败，仅更新长度
+                        # 非 JSON 响应：仅更新长度，强制加入 traceId
                         response = Response(
                             content=response_body,
                             status_code=response.status_code,
@@ -225,11 +229,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 响应
+                    # 非 JSON 响应：强制加入 traceId
                     response = Response(
                         content=response_body,
                         status_code=response.status_code,
@@ -238,57 +242,48 @@ 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": trace_id,  # 响应日志加入 traceId
                 "status_code": response.status_code,
                 "response_body": response_body.decode('utf-8', errors='ignore'),
             }
-            SYLogger.info(json.dumps(response_message, ensure_ascii=False))
+            response_message_str = json.dumps(
+                response_message, ensure_ascii=False)
+            SYLogger.info(response_message_str)
 
-            # 兜底：确保 Header 必有 TraceId
+            # ========== 最终兜底：确保响应头必有 x-traceId-header ==========
             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:
-            # ========== 4. 异常处理阶段 ==========
-            # 记录中间件层面的异常日志
+            # 异常日志也加入 traceId
             error_message = {
                 "traceId": trace_id,
-                "error": f"Middleware Error: {str(e)}",
+                "error": str(e),
                 "query_params": query_params,
                 "request_body": request_body,
                 "uploaded_files": files_info if files_info else None
             }
-            # 使用 SYLogger.error，由于处于 except 块，会自动捕获堆栈
-            SYLogger.error(error_message)
-
-            # 关键：重新抛出异常，让 Global Exception Handler 接管
-            # 此时 had_exception 仍为 True，finally 不会 reset，trace_id 得以保留
+            error_message_str = json.dumps(error_message, ensure_ascii=False)
+            SYLogger.error(error_message_str)
             raise
-
         finally:
-            # ========== 5. 清理阶段 ==========
-            # 只有在没有任何异常的情况下（had_exception=False），才手动清除上下文
-            if not had_exception:
-                SYLogger.reset_trace_id(token)
-                SYLogger.reset_headers(header_token)
-            # 如果 had_exception 为 True，这里什么都不做，保留 ContextVar 供 Exception Handler 读取
+            # 清理上下文变量
+            SYLogger.reset_trace_id(token)
+            SYLogger.reset_headers(header_token)
 
     return app