Add projects

backend/internal/logging/gin_logger.go

@@ -0,0 +1,166 @@
+// Package logging provides Gin middleware for HTTP request logging and panic recovery.
+// It integrates Gin web framework with logrus for structured logging of HTTP requests,
+// responses, and error handling with panic recovery capabilities.
+package logging
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"runtime/debug"
+	"strings"
+	"time"
+
+	"github.com/gin-gonic/gin"
+	"github.com/router-for-me/CLIProxyAPI/v7/internal/util"
+	log "github.com/sirupsen/logrus"
+)
+
+// aiAPIPrefixes defines path prefixes for AI API requests that should have request ID tracking.
+var aiAPIPrefixes = []string{
+	"/v1",
+	"/v1beta",
+	"/openai/v1",
+	"/backend-api/codex",
+}
+
+const (
+	skipGinLogKey  = "__gin_skip_request_logging__"
+	creditsUsedKey = "__antigravity_credits_used__"
+)
+
+// GinLogrusLogger returns a Gin middleware handler that logs HTTP requests and responses
+// using logrus. It captures request details including method, path, status code, latency,
+// client IP, and any error messages. Request ID is only added for AI API requests.
+//
+// Output format (AI API): [2025-12-23 20:14:10] [info ] | a1b2c3d4 | 200 |       23.559s | ...
+// Output format (others): [2025-12-23 20:14:10] [info ] | -------- | 200 |       23.559s | ...
+//
+// Returns:
+//   - gin.HandlerFunc: A middleware handler for request logging
+func GinLogrusLogger() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		start := time.Now()
+		path := c.Request.URL.Path
+		raw := util.MaskSensitiveQuery(c.Request.URL.RawQuery)
+
+		// Only generate request ID for AI API paths
+		var requestID string
+		if isAIAPIPath(path) {
+			requestID = GenerateRequestID()
+			SetGinRequestID(c, requestID)
+			ctx := WithRequestID(c.Request.Context(), requestID)
+			c.Request = c.Request.WithContext(ctx)
+		}
+
+		c.Next()
+
+		if shouldSkipGinRequestLogging(c) {
+			return
+		}
+
+		if raw != "" {
+			path = path + "?" + raw
+		}
+
+		latency := time.Since(start)
+		if latency > time.Minute {
+			latency = latency.Truncate(time.Second)
+		} else {
+			latency = latency.Truncate(time.Millisecond)
+		}
+
+		statusCode := c.Writer.Status()
+		clientIP := c.ClientIP()
+		method := c.Request.Method
+		errorMessage := c.Errors.ByType(gin.ErrorTypePrivate).String()
+
+		if requestID == "" {
+			requestID = "--------"
+		}
+		logLine := fmt.Sprintf("%3d | %13v | %15s | %-7s \"%s\"", statusCode, latency, clientIP, method, path)
+		if creditsUsed(c) {
+			logLine += " [credits]"
+		}
+		if errorMessage != "" {
+			logLine = logLine + " | " + errorMessage
+		}
+
+		entry := log.WithField("request_id", requestID)
+
+		switch {
+		case statusCode >= http.StatusInternalServerError:
+			entry.Error(logLine)
+		case statusCode >= http.StatusBadRequest:
+			entry.Warn(logLine)
+		default:
+			entry.Info(logLine)
+		}
+	}
+}
+
+// isAIAPIPath checks if the given path is an AI API endpoint that should have request ID tracking.
+func isAIAPIPath(path string) bool {
+	for _, prefix := range aiAPIPrefixes {
+		if path == prefix || strings.HasPrefix(path, prefix+"/") {
+			return true
+		}
+	}
+	return false
+}
+
+// GinLogrusRecovery returns a Gin middleware handler that recovers from panics and logs
+// them using logrus. When a panic occurs, it captures the panic value, stack trace,
+// and request path, then returns a 500 Internal Server Error response to the client.
+//
+// Returns:
+//   - gin.HandlerFunc: A middleware handler for panic recovery
+func GinLogrusRecovery() gin.HandlerFunc {
+	return gin.CustomRecovery(func(c *gin.Context, recovered interface{}) {
+		if err, ok := recovered.(error); ok && errors.Is(err, http.ErrAbortHandler) {
+			// Let net/http handle ErrAbortHandler so the connection is aborted without noisy stack logs.
+			panic(http.ErrAbortHandler)
+		}
+
+		log.WithFields(log.Fields{
+			"panic": recovered,
+			"stack": string(debug.Stack()),
+			"path":  c.Request.URL.Path,
+		}).Error("recovered from panic")
+
+		c.AbortWithStatus(http.StatusInternalServerError)
+	})
+}
+
+// SkipGinRequestLogging marks the provided Gin context so that GinLogrusLogger
+// will skip emitting a log line for the associated request.
+func SkipGinRequestLogging(c *gin.Context) {
+	if c == nil {
+		return
+	}
+	c.Set(skipGinLogKey, true)
+}
+
+func shouldSkipGinRequestLogging(c *gin.Context) bool {
+	if c == nil {
+		return false
+	}
+	val, exists := c.Get(skipGinLogKey)
+	if !exists {
+		return false
+	}
+	flag, ok := val.(bool)
+	return ok && flag
+}
+
+func creditsUsed(c *gin.Context) bool {
+	if c == nil {
+		return false
+	}
+	val, exists := c.Get(creditsUsedKey)
+	if !exists {
+		return false
+	}
+	flag, ok := val.(bool)
+	return ok && flag
+}