refactor: improved error responses from JSON decoders and encoders

ralvarezdev · ralvarezdev · commit 731c9e4112fb · 2025-01-03T21:26:37.000-04:00
diff --git a/http/handler/common.go b/http/handler/common.go
@@ -1,15 +1,29 @@
 package handler
 
 import (
+	"errors"
 	gonethttp "github.com/ralvarezdev/go-net/http"
+	gonethttpjson "github.com/ralvarezdev/go-net/http/json"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 )
 
 // SendInternalServerError sends an internal server error response
-func SendInternalServerError(w http.ResponseWriter) {
-	http.Error(
-		w,
-		gonethttp.InternalServerError,
-		http.StatusInternalServerError,
-	)
+func SendInternalServerError(
+	w http.ResponseWriter,
+	encoder gonethttpjson.Encoder,
+) {
+	if encoder != nil {
+		_ = encoder.Encode(
+			w,
+			gonethttpresponse.NewJSONErrorResponse(errors.New(gonethttp.InternalServerError)),
+			http.StatusInternalServerError,
+		)
+	} else {
+		http.Error(
+			w,
+			gonethttp.InternalServerError,
+			http.StatusInternalServerError,
+		)
+	}
 }
diff --git a/http/handler/handler.go b/http/handler/handler.go
@@ -3,6 +3,7 @@ package handler
 import (
 	goflagsmode "github.com/ralvarezdev/go-flags/mode"
 	gonethttpjson "github.com/ralvarezdev/go-net/http/json"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 )
 
@@ -14,11 +15,14 @@ type (
 			r *http.Request,
 			data interface{},
 		) (err error)
-		HandleResponse(w http.ResponseWriter, response *Response)
+		HandleResponse(
+			w http.ResponseWriter,
+			response *gonethttpresponse.Response,
+		)
 		HandleErrorProneResponse(
 			w http.ResponseWriter,
-			successResponse *Response,
-			errorResponse *Response,
+			successResponse *gonethttpresponse.Response,
+			errorResponse *gonethttpresponse.Response,
 		)
 	}
 
@@ -66,22 +70,34 @@ func (d *DefaultHandler) HandleRequest(
 // HandleResponse handles the response
 func (d *DefaultHandler) HandleResponse(
 	w http.ResponseWriter,
-	response *Response,
+	response *gonethttpresponse.Response,
 ) {
 	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)
+	if gonethttpresponse.Code != nil {
+		if gonethttpresponse.DebugData != nil && d.mode != nil && d.mode.IsDebug() {
+			_ = d.jsonEncoder.Encode(
+				w,
+				gonethttpresponse.DebugData,
+				*gonethttpresponse.Code,
+			)
 			return
 		}
-		_ = d.jsonEncoder.Encode(w, response.Data, *response.Code)
+		_ = d.jsonEncoder.Encode(
+			w,
+			gonethttpresponse.Data,
+			*gonethttpresponse.Code,
+		)
 	} else {
-		if response.DebugData != nil && d.mode != nil && d.mode.IsDebug() {
-			_ = d.jsonEncoder.Encode(w, response.DebugData, *response.Code)
+		if gonethttpresponse.DebugData != nil && d.mode != nil && d.mode.IsDebug() {
+			_ = d.jsonEncoder.Encode(
+				w,
+				gonethttpresponse.DebugData,
+				*gonethttpresponse.Code,
+			)
 			return
 		}
 		SendInternalServerError(w)
@@ -91,8 +107,8 @@ func (d *DefaultHandler) HandleResponse(
 // HandleErrorProneResponse handles the response that may contain an error
 func (d *DefaultHandler) HandleErrorProneResponse(
 	w http.ResponseWriter,
-	successResponse *Response,
-	errorResponse *Response,
+	successResponse *gonethttpresponse.Response,
+	errorResponse *gonethttpresponse.Response,
 ) {
 	// Check if the error response is nil
 	if errorResponse != nil {
diff --git a/http/json/decoder.go b/http/json/decoder.go
@@ -3,6 +3,7 @@ package json
 import (
 	"encoding/json"
 	goflagsmode "github.com/ralvarezdev/go-flags/mode"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"io"
 	"net/http"
 )
@@ -19,12 +20,16 @@ type (
 
 	// DefaultDecoder struct
 	DefaultDecoder struct {
-		mode *goflagsmode.Flag
+		mode    *goflagsmode.Flag
+		encoder Encoder
 	}
 )
 
 // NewDefaultDecoder creates a new JSON decoder
-func NewDefaultDecoder(mode *goflagsmode.Flag) *DefaultDecoder {
+func NewDefaultDecoder(
+	mode *goflagsmode.Flag,
+	encoder Encoder,
+) *DefaultDecoder {
 	return &DefaultDecoder{
 		mode: mode,
 	}
@@ -44,21 +49,37 @@ func (d *DefaultDecoder) Decode(
 	// Get the body of the request
 	body, err := io.ReadAll(r.Body)
 	if err != nil {
-		http.Error(
-			w,
-			err.Error(),
-			http.StatusBadRequest,
-		)
+		if d.encoder != nil {
+			_ = d.encoder.Encode(
+				w,
+				gonethttpresponse.NewJSONErrorResponse(err),
+				http.StatusInternalServerError,
+			)
+		} else {
+			http.Error(
+				w,
+				err.Error(),
+				http.StatusBadRequest,
+			)
+		}
 		return err
 	}
 
 	// Decode JSON data
 	if err = json.Unmarshal(body, data); err != nil {
-		http.Error(
-			w,
-			err.Error(),
-			http.StatusBadRequest,
-		)
+		if d.encoder != nil {
+			_ = d.encoder.Encode(
+				w,
+				gonethttpresponse.NewJSONErrorResponse(err),
+				http.StatusInternalServerError,
+			)
+		} else {
+			http.Error(
+				w,
+				err.Error(),
+				http.StatusBadRequest,
+			)
+		}
 	}
 	return err
 }
diff --git a/http/json/encoder.go b/http/json/encoder.go
@@ -3,6 +3,7 @@ package json
 import (
 	"encoding/json"
 	"github.com/ralvarezdev/go-flags/mode"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 )
 
@@ -41,7 +42,11 @@ func (d *DefaultEncoder) Encode(
 	// Encode the data
 	jsonData, err := json.Marshal(data)
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		_ = d.Encode(
+			w,
+			gonethttpresponse.NewJSONErrorResponse(err),
+			http.StatusInternalServerError,
+		)
 		return err
 	}
 
diff --git a/http/json/stream_decoder.go b/http/json/stream_decoder.go
@@ -3,6 +3,7 @@ package json
 import (
 	"encoding/json"
 	goflagsmode "github.com/ralvarezdev/go-flags/mode"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 )
 
@@ -18,7 +19,8 @@ type (
 
 	// DefaultStreamDecoder is the JSON decoder struct
 	DefaultStreamDecoder struct {
-		mode *goflagsmode.Flag
+		mode          *goflagsmode.Flag
+		streamEncoder StreamEncoder
 	}
 )
 
@@ -42,11 +44,19 @@ func (d *DefaultStreamDecoder) Decode(
 
 	// Decode JSON data
 	if err = json.NewDecoder(r.Body).Decode(data); err != nil {
-		http.Error(
-			w,
-			err.Error(),
-			http.StatusBadRequest,
-		)
+		if d.streamEncoder != nil {
+			_ = d.streamEncoder.Encode(
+				w,
+				gonethttpresponse.NewJSONErrorResponse(err),
+				http.StatusInternalServerError,
+			)
+		} else {
+			http.Error(
+				w,
+				err.Error(),
+				http.StatusBadRequest,
+			)
+		}
 	}
 	return err
 }
diff --git a/http/json/stream_encoder.go b/http/json/stream_encoder.go
@@ -3,6 +3,7 @@ package json
 import (
 	"encoding/json"
 	goflagsmode "github.com/ralvarezdev/go-flags/mode"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 )
 
@@ -40,7 +41,11 @@ func (d *DefaultStreamEncoder) Encode(
 	w.WriteHeader(code)
 	w.Header().Set("Content-Type", "application/json")
 	if err = json.NewEncoder(w).Encode(data); err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		_ = d.Encode(
+			w,
+			gonethttpresponse.NewJSONErrorResponse(err),
+			http.StatusInternalServerError,
+		)
 		return err
 	}
 	return nil
diff --git a/http/jwt/validator/handler.go b/http/jwt/validator/handler.go
@@ -1,8 +1,8 @@
 package validator
 
 import (
-	gonethttpresponse "github.com/ralvarezdev/go-net/http/handler"
 	gonethttpjson "github.com/ralvarezdev/go-net/http/json"
+	gonethttpresponse "github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 )
 
diff --git a/http/middleware/auth/middleware.go b/http/middleware/auth/middleware.go
@@ -9,6 +9,7 @@ import (
 	gonethttp "github.com/ralvarezdev/go-net/http"
 	gonethttphandler "github.com/ralvarezdev/go-net/http/handler"
 	gonethttpjwtvalidator "github.com/ralvarezdev/go-net/http/jwt/validator"
+	"github.com/ralvarezdev/go-net/http/response"
 	"net/http"
 	"strings"
 )
@@ -62,7 +63,7 @@ func (m *Middleware) Authenticate(
 			if !ok {
 				m.handler.HandleResponse(
 					w,
-					gonethttphandler.NewErrorResponseWithCode(
+					response.NewErrorResponseWithCode(
 						gonethttp.ErrInvalidAuthorizationHeader,
 						http.StatusUnauthorized,
 					),
@@ -77,7 +78,7 @@ func (m *Middleware) Authenticate(
 			if len(parts) < 2 || parts[0] != gojwt.BearerPrefix {
 				m.handler.HandleResponse(
 					w,
-					gonethttphandler.NewErrorResponseWithCode(
+					response.NewErrorResponseWithCode(
 						gonethttp.ErrInvalidAuthorizationHeader,
 						http.StatusUnauthorized,
 					),
diff --git a/http/response/types.go b/http/response/types.go
@@ -1,4 +1,4 @@
-package handler
+package response
 
 type (
 	// Response struct

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`package validator`
`2`	`2`
`3`	`3`	`import (`
`4`		`- gonethttpresponse "github.com/ralvarezdev/go-net/http/handler"`
`5`	`4`	`gonethttpjson "github.com/ralvarezdev/go-net/http/json"`
	`5`	`+ gonethttpresponse "github.com/ralvarezdev/go-net/http/response"`
`6`	`6`	`"net/http"`
`7`	`7`	`)`
`8`	`8`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package handler`
	`1`	`+package response`
`2`	`2`
`3`	`3`	`type (`
`4`	`4`	`// Response struct`