feat: better error handling, minor refactor (#58)

Author: abemedia

Makefile

@@ -10,4 +10,4 @@ test:
 	@go test ./...
 
 bench:
-	@go test -bench=. -benchmem ./benchmarks
+	@cd ./benchmarks && go test -bench=. -benchmem .

benchmarks/binding_test.go

@@ -6,9 +6,9 @@ import (
 	"testing"
 
 	"github.com/abemedia/go-don"
+	_ "github.com/abemedia/go-don/encoding/text"
 	"github.com/abemedia/go-don/pkg/httptest"
 	"github.com/gin-gonic/gin"
-	"github.com/valyala/fasthttp"
 )
 
 func BenchmarkDon_BindRequest(b *testing.B) {
@@ -19,14 +19,12 @@ func BenchmarkDon_BindRequest(b *testing.B) {
 	}
 
 	api := don.New(nil)
-
 	api.Post("/:path", don.H(func(ctx context.Context, req request) (any, error) {
 		return nil, nil
 	}))
 
 	h := api.RequestHandler()
-
-	ctx := httptest.NewRequest(fasthttp.MethodPost, "/path?query=query", "", map[string]string{"header": "header"})
+	ctx := httptest.NewRequest("POST", "/path?query=query", "", map[string]string{"header": "header"})
 
 	for i := 0; i < b.N; i++ {
 		h(ctx)

benchmarks/http_test.go

@@ -8,14 +8,14 @@ import (
 	"testing"
 
 	"github.com/abemedia/go-don"
+	_ "github.com/abemedia/go-don/encoding/text"
 	"github.com/gin-gonic/gin"
 	"github.com/valyala/fasthttp"
 )
 
 func BenchmarkDon_HTTP(b *testing.B) {
 	api := don.New(nil)
-
-	api.Post("/:path", don.H(func(ctx context.Context, req don.Empty) (string, error) {
+	api.Get("/:path", don.H(func(ctx context.Context, req don.Empty) (string, error) {
 		return "foo", nil
 	}))
 
@@ -37,13 +37,12 @@ func BenchmarkDon_HTTP(b *testing.B) {
 }
 
 func BenchmarkGin_HTTP(b *testing.B) {
-	h := func(c *gin.Context) {
-		c.String(200, "foo")
-	}
-
 	gin.SetMode("release")
+
 	router := gin.New()
-	router.POST("/:path", h)
+	router.GET("/:path", func(c *gin.Context) {
+		c.String(200, "foo")
+	})
 
 	ln, err := net.Listen("tcp", "localhost:0")
 	if err != nil {

encoding/text/text.go

@@ -159,8 +159,7 @@ func encodeText(ctx *fasthttp.RequestCtx, v interface{}) error {
 			error:
 
 		default:
-			ctx.Error(fasthttp.StatusMessage(fasthttp.StatusNotAcceptable), fasthttp.StatusNotAcceptable)
-			return nil
+			return don.ErrNotAcceptable
 		}
 	}
 

errors.go

@@ -9,6 +9,7 @@ import (
 	"net/http"
 	"strconv"
 
+	"github.com/abemedia/go-don/internal/byteconv"
 	"github.com/goccy/go-json"
 	"github.com/valyala/fasthttp"
 	"gopkg.in/yaml.v3"
@@ -51,7 +52,7 @@ func (e *HTTPError) MarshalText() ([]byte, error) {
 		return m.MarshalText()
 	}
 
-	return []byte(e.Error()), nil
+	return byteconv.Atob(e.Error()), nil
 }
 
 func (e *HTTPError) MarshalJSON() ([]byte, error) {
@@ -94,3 +95,56 @@ var (
 	_ xml.Marshaler          = (*HTTPError)(nil)
 	_ yaml.Marshaler         = (*HTTPError)(nil)
 )
+
+// StatusError creates an error from an HTTP status code.
+type StatusError int
+
+const (
+	ErrBadRequest           = StatusError(fasthttp.StatusBadRequest)
+	ErrUnauthorized         = StatusError(fasthttp.StatusUnauthorized)
+	ErrForbidden            = StatusError(fasthttp.StatusForbidden)
+	ErrNotFound             = StatusError(fasthttp.StatusNotFound)
+	ErrMethodNotAllowed     = StatusError(fasthttp.StatusMethodNotAllowed)
+	ErrNotAcceptable        = StatusError(fasthttp.StatusNotAcceptable)
+	ErrUnsupportedMediaType = StatusError(fasthttp.StatusUnsupportedMediaType)
+	ErrInternalServerError  = StatusError(fasthttp.StatusInternalServerError)
+)
+
+func (e StatusError) Error() string {
+	return fasthttp.StatusMessage(int(e))
+}
+
+func (e StatusError) StatusCode() int {
+	return int(e)
+}
+
+func (e StatusError) MarshalText() ([]byte, error) {
+	return byteconv.Atob(e.Error()), nil
+}
+
+func (e StatusError) MarshalJSON() ([]byte, error) {
+	var buf bytes.Buffer
+
+	buf.WriteString(`{"message":`)
+	buf.WriteString(strconv.Quote(e.Error()))
+	buf.WriteRune('}')
+
+	return buf.Bytes(), nil
+}
+
+func (e StatusError) MarshalXML(enc *xml.Encoder, _ xml.StartElement) error {
+	start := xml.StartElement{Name: xml.Name{Local: "message"}}
+	return enc.EncodeElement(e.Error(), start)
+}
+
+func (e StatusError) MarshalYAML() (interface{}, error) {
+	return map[string]string{"message": e.Error()}, nil
+}
+
+var (
+	_ error                  = (*StatusError)(nil)
+	_ encoding.TextMarshaler = (*StatusError)(nil)
+	_ json.Marshaler         = (*StatusError)(nil)
+	_ xml.Marshaler          = (*StatusError)(nil)
+	_ yaml.Marshaler         = (*StatusError)(nil)
+)

handler.go

@@ -36,22 +36,13 @@ func H[T, O any](handle Handle[T, O]) httprouter.Handle { //nolint:gocognit,cycl
 	{
 		var t T
 		if hasTag(t, headerTag) {
-			dec, err := decoder.NewHeaderDecoder(t, headerTag)
-			if err == nil {
-				decodeHeader = dec
-			}
+			decodeHeader, _ = decoder.NewHeaderDecoder(t, headerTag)
 		}
 		if hasTag(t, queryTag) {
-			dec, err := decoder.NewArgsDecoder(t, queryTag)
-			if err == nil {
-				decodeQuery = dec
-			}
+			decodeQuery, _ = decoder.NewArgsDecoder(t, queryTag)
 		}
 		if hasTag(t, pathTag) {
-			dec, err := decoder.NewParamsDecoder(t, pathTag)
-			if err == nil {
-				decodePath = dec
-			}
+			decodePath, _ = decoder.NewParamsDecoder(t, pathTag)
 		}
 	}
 
@@ -60,7 +51,7 @@ func H[T, O any](handle Handle[T, O]) httprouter.Handle { //nolint:gocognit,cycl
 
 		enc, err := getEncoder(contentType)
 		if err != nil {
-			ctx.Error(fasthttp.StatusMessage(fasthttp.StatusNotAcceptable), fasthttp.StatusNotAcceptable)
+			handleError(ctx, ErrNotAcceptable)
 			return
 		}
 
@@ -142,10 +133,20 @@ func H[T, O any](handle Handle[T, O]) httprouter.Handle { //nolint:gocognit,cycl
 		}
 
 		if err = enc(ctx, res); err != nil {
-			ctx.Logger().Printf("%v", err)
-			ctx.Error(fasthttp.StatusMessage(fasthttp.StatusInternalServerError), fasthttp.StatusInternalServerError)
+			handleError(ctx, err)
+		}
+	}
+}
+
+func handleError(ctx *fasthttp.RequestCtx, err error) {
+	if statusCoder, ok := err.(StatusCoder); ok { //nolint:errorlint
+		if sc := statusCoder.StatusCode(); sc < http.StatusInternalServerError {
+			ctx.Error(err.Error()+"\n", sc)
+			return
 		}
 	}
+	ctx.Error(fasthttp.StatusMessage(http.StatusInternalServerError)+"\n", http.StatusInternalServerError)
+	ctx.Logger().Printf("%v", err)
 }
 
 func getEncoding(b []byte) string {

handler_test.go

@@ -2,7 +2,6 @@ package don_test
 
 import (
 	"context"
-	"net/http"
 	"testing"
 
 	"github.com/abemedia/go-don"
@@ -32,7 +31,7 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should return no content",
 			expected: response{
-				Code: http.StatusNoContent,
+				Code: fasthttp.StatusNoContent,
 				Body: "",
 				Header: map[string]string{
 					"Content-Length": "0",
@@ -47,7 +46,7 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should return null",
 			expected: response{
-				Code: http.StatusOK,
+				Code: fasthttp.StatusOK,
 				Body: "null\n",
 				Header: map[string]string{
 					"Content-Length": "0",
@@ -62,7 +61,7 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should JSON encode map",
 			expected: response{
-				Code:   http.StatusOK,
+				Code:   fasthttp.StatusOK,
 				Body:   `{"foo":"bar"}` + "\n",
 				Header: map[string]string{"Content-Type": "application/json; charset=utf-8"},
 			},
@@ -74,7 +73,7 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should return error on unprocessable request",
 			expected: response{
-				Code:   http.StatusUnsupportedMediaType,
+				Code:   fasthttp.StatusUnsupportedMediaType,
 				Body:   "Unsupported Media Type\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
@@ -87,8 +86,8 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should return error on unacceptable",
 			expected: response{
-				Code:   http.StatusNotAcceptable,
-				Body:   "Not Acceptable",
+				Code:   fasthttp.StatusNotAcceptable,
+				Body:   "Not Acceptable\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
 			config: &don.Config{DefaultEncoding: "text/plain"},
@@ -100,8 +99,8 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should return error on unsupported accept",
 			expected: response{
-				Code:   http.StatusNotAcceptable,
-				Body:   "Not Acceptable",
+				Code:   fasthttp.StatusNotAcceptable,
+				Body:   "Not Acceptable\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
 			config: &don.Config{DefaultEncoding: "text/plain"},
@@ -113,7 +112,7 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should return error on unsupported content type",
 			expected: response{
-				Code:   http.StatusUnsupportedMediaType,
+				Code:   fasthttp.StatusUnsupportedMediaType,
 				Body:   "Unsupported Media Type\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
@@ -127,7 +126,7 @@ func TestHandler(t *testing.T) {
 		{
 			message: "should read text request",
 			expected: response{
-				Code:   http.StatusOK,
+				Code:   fasthttp.StatusOK,
 				Body:   "foo\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},

pkg/httptest/request.go

@@ -1,7 +1,7 @@
 package httptest
 
 import (
-	"bytes"
+	"strings"
 
 	"github.com/valyala/fasthttp"
 )
@@ -15,8 +15,7 @@ func NewRequest(method, url, body string, header map[string]string) *fasthttp.Re
 		ctx.Request.Header.Set(k, v)
 	}
 
-	b := []byte(body)
-	ctx.Request.SetBodyStream(bytes.NewReader(b), len(b))
+	ctx.Request.SetBodyStream(strings.NewReader(body), len(body))
 
 	return ctx
 }