From f2348f6d5ffcc3159a7d0651ff07d31b52cbbf92 Mon Sep 17 00:00:00 2001
From: elliotxx <951376975@qq.com>
Date: Wed, 8 Jan 2025 16:57:11 +0800
Subject: [PATCH] refactor: enhance error handling and API documentation

- Add `github.com/KusionStack/karpor/pkg/core/handler` import
- Replace direct `http.Error` calls with `handler.FailureRender`
- Add new HTTP status codes (401, 429, 404) to API documentation
- Log the start of the YAML interpretation process

These changes centralize error handling and provide more detailed API documentation, improving maintainability and user feedback.
---
 pkg/core/handler/detail/interpret.go | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/pkg/core/handler/detail/interpret.go b/pkg/core/handler/detail/interpret.go
index aad287f4..27142774 100644
--- a/pkg/core/handler/detail/interpret.go
+++ b/pkg/core/handler/detail/interpret.go
@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"net/http"
 
+	"github.com/KusionStack/karpor/pkg/core/handler"
 	"github.com/KusionStack/karpor/pkg/core/manager/ai"
 	"github.com/KusionStack/karpor/pkg/util/ctxutil"
 	"k8s.io/apiserver/pkg/server"
@@ -40,6 +41,9 @@ type InterpretRequest struct {
 // @Param        request  body      InterpretRequest  true  "The YAML content to interpret"
 // @Success      200      {object}  ai.InterpretEvent
 // @Failure      400      {string}  string  "Bad Request"
+// @Failure      401      {string}  string  "Unauthorized"
+// @Failure      429      {string}  string  "Too Many Requests"
+// @Failure      404      {string}  string  "Not Found"
 // @Failure      500      {string}  string  "Internal Server Error"
 // @Router       /insight/yaml/interpret/stream [post]
 func InterpretYAML(aiMgr *ai.AIManager, c *server.CompletedConfig) http.HandlerFunc {
@@ -48,16 +52,19 @@ func InterpretYAML(aiMgr *ai.AIManager, c *server.CompletedConfig) http.HandlerF
 		ctx := r.Context()
 		logger := ctxutil.GetLogger(ctx)
 
+		// Begin the interpretation process, logging the start
+		logger.Info("Starting YAML interpretation in handler ...")
+
 		// Parse request body
 		var req InterpretRequest
 		if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
-			http.Error(w, fmt.Sprintf("invalid request format: %v", err), http.StatusBadRequest)
+			handler.FailureRender(ctx, w, r, fmt.Errorf("invalid request format: %v", err))
 			return
 		}
 
 		// Validate request
 		if req.YAML == "" {
-			http.Error(w, "YAML content is required", http.StatusBadRequest)
+			handler.FailureRender(ctx, w, r, fmt.Errorf("YAML content is required"))
 			return
 		}
 		if req.Language == "" {
@@ -73,7 +80,7 @@ func InterpretYAML(aiMgr *ai.AIManager, c *server.CompletedConfig) http.HandlerF
 
 		flusher, ok := w.(http.Flusher)
 		if !ok {
-			http.Error(w, "Streaming unsupported", http.StatusInternalServerError)
+			handler.FailureRender(ctx, w, r, fmt.Errorf("streaming unsupported"))
 			return
 		}