feat: added DebugData field to handler Response struct

Author: ralvarezdev

http/handler/handler.go

@@ -14,13 +14,12 @@ type (
 			r *http.Request,
 			data interface{},
 		) (err error)
-		HandleSuccessResponse(w http.ResponseWriter, response *Response)
+		HandleResponse(w http.ResponseWriter, response *Response)
 		HandleErrorProneResponse(
 			w http.ResponseWriter,
 			successResponse *Response,
 			errorResponse *Response,
 		)
-		HandleErrorResponse(w http.ResponseWriter, response *Response)
 	}
 
 	// DefaultHandler struct
@@ -64,14 +63,27 @@ func (d *DefaultHandler) HandleRequest(
 	return d.jsonDecoder.Decode(w, r, data)
 }
 
-// HandleSuccessResponse handles the response
-func (d *DefaultHandler) HandleSuccessResponse(
+// HandleResponse handles the response
+func (d *DefaultHandler) HandleResponse(
 	w http.ResponseWriter,
 	response *Response,
 ) {
-	if response != nil && response.Code != nil {
+	if response == nil {
+		SendInternalServerError(w)
+		return
+	}
+
+	if response.Code != nil {
+		if response.DebugData != nil && d.mode != nil && d.mode.IsDebug() {
+			_ = d.jsonEncoder.Encode(w, response.DebugData, *response.Code)
+			return
+		}
 		_ = d.jsonEncoder.Encode(w, response.Data, *response.Code)
 	} else {
+		if response.DebugData != nil && d.mode != nil && d.mode.IsDebug() {
+			_ = d.jsonEncoder.Encode(w, response.DebugData, *response.Code)
+			return
+		}
 		SendInternalServerError(w)
 	}
 }
@@ -84,22 +96,10 @@ func (d *DefaultHandler) HandleErrorProneResponse(
 ) {
 	// Check if the error response is nil
 	if errorResponse != nil {
-		d.HandleErrorResponse(w, errorResponse)
+		d.HandleResponse(w, errorResponse)
 		return
 	}
 
 	// Handle the success response
-	d.HandleSuccessResponse(w, successResponse)
-}
-
-// HandleErrorResponse handles the error response
-func (d *DefaultHandler) HandleErrorResponse(
-	w http.ResponseWriter,
-	response *Response,
-) {
-	if response != nil && response.Code != nil {
-		_ = d.jsonEncoder.Encode(w, response.Data, *response.Code)
-	} else {
-		SendInternalServerError(w)
-	}
+	d.HandleResponse(w, successResponse)
 }

http/handler/types.go

@@ -3,8 +3,9 @@ package handler
 type (
 	// Response struct
 	Response struct {
-		Data interface{}
-		Code *int
+		Data      interface{}
+		DebugData interface{}
+		Code      *int
 	}
 
 	// JSONErrorResponse struct
@@ -13,27 +14,72 @@ type (
 	}
 )
 
+// NewJSONErrorResponse creates a new error response
+func NewJSONErrorResponse(err error) JSONErrorResponse {
+	return JSONErrorResponse{Error: err.Error()}
+}
+
+// newResponse creates a new response
+func newResponse(
+	data interface{},
+	debugData interface{},
+	code *int,
+) *Response {
+	return &Response{Data: data, DebugData: debugData, Code: code}
+}
+
+// NewDebugResponseWithCode creates a new response with a code
+func NewDebugResponseWithCode(
+	data interface{},
+	debugData interface{},
+	code int,
+) *Response {
+	return newResponse(data, debugData, &code)
+}
+
+// NewDebugErrorResponseWithCode creates a new error response with a code
+func NewDebugErrorResponseWithCode(
+	err error,
+	debugErr error,
+	code int,
+) *Response {
+	return newResponse(
+		NewJSONErrorResponse(err),
+		NewJSONErrorResponse(debugErr),
+		&code,
+	)
+}
+
 // NewResponseWithCode creates a new response with a code
 func NewResponseWithCode(data interface{}, code int) *Response {
-	return &Response{Data: data, Code: &code}
+	return newResponse(data, nil, &code)
 }
 
 // NewErrorResponseWithCode creates a new error response with a code
 func NewErrorResponseWithCode(err error, code int) *Response {
-	return &Response{Data: NewJSONErrorResponse(err), Code: &code}
+	return newResponse(NewJSONErrorResponse(err), nil, &code)
+}
+
+// NewDebugResponse creates a new response
+func NewDebugResponse(data interface{}, debugData interface{}) *Response {
+	return newResponse(data, debugData, nil)
+}
+
+// NewDebugErrorResponse creates a new error response
+func NewDebugErrorResponse(err error, debugErr error) *Response {
+	return newResponse(
+		NewJSONErrorResponse(err),
+		NewJSONErrorResponse(debugErr),
+		nil,
+	)
 }
 
 // NewResponse creates a new response
 func NewResponse(data interface{}) *Response {
-	return &Response{Data: data}
+	return newResponse(data, nil, nil)
 }
 
 // NewErrorResponse creates a new error response
 func NewErrorResponse(err error) *Response {
-	return &Response{Data: NewJSONErrorResponse(err)}
-}
-
-// NewJSONErrorResponse creates a new error response
-func NewJSONErrorResponse(err error) JSONErrorResponse {
-	return JSONErrorResponse{Error: err.Error()}
+	return newResponse(NewJSONErrorResponse(err), nil, nil)
 }