refactor!: remove Empty type (use any instead) (#135)

abemedia · May 14, 2023 · 72848e8 · 72848e8
1 parent 827209b
commit 72848e8
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ func Greet(ctx context.Context, req GreetRequest) (*GreetResponse, error) {
   return res, nil
 }
 
-func Pong(context.Context, don.Empty) (string, error) {
+func Pong(context.Context, any) (string, error) {
   return "pong", nil
 }
 

diff --git a/api.go b/api.go
@@ -9,10 +9,6 @@ import (
 	"github.com/valyala/fasthttp"
 )
 
-// Empty is the type used when an API handler contains either no request or no
-// response.
-type Empty struct{}
-
 // DefaultEncoding contains the media type of the default encoding to fall back
 // on if no `Accept` or `Content-Type` header was provided.
 var DefaultEncoding = "text/plain"

diff --git a/benchmarks/http_test.go b/benchmarks/http_test.go
@@ -15,7 +15,7 @@ import (
 
 func BenchmarkDon_HTTP(b *testing.B) {
 	api := don.New(nil)
-	api.Get("/:path", don.H(func(ctx context.Context, req don.Empty) (string, error) {
+	api.Get("/:path", don.H(func(ctx context.Context, req any) (string, error) {
 		return "foo", nil
 	}))
 

diff --git a/errors.go b/errors.go
@@ -15,7 +15,7 @@ import (
 )
 
 func E(err error) fasthttp.RequestHandler {
-	h := H(func(context.Context, Empty) (*Empty, error) { return nil, err })
+	h := H(func(context.Context, any) (any, error) { return nil, err })
 	return func(ctx *fasthttp.RequestCtx) { h(ctx, nil) }
 }
 

diff --git a/examples/simple/main.go b/examples/simple/main.go
@@ -13,11 +13,11 @@ import (
 )
 
 // Returns 204 - No Content
-func Empty(context.Context, *don.Empty) (interface{}, error) {
+func Empty(context.Context, any) (any, error) {
 	return nil, nil
 }
 
-func Ping(context.Context, *don.Empty) (string, error) {
+func Ping(context.Context, any) (string, error) {
 	return "pong", nil
 }
 

diff --git a/handler_test.go b/handler_test.go
@@ -83,7 +83,7 @@ func TestHandlerResponse(t *testing.T) {
 					"Content-Type":   "text/plain; charset=utf-8",
 				},
 			},
-			handler: don.H(func(ctx context.Context, req don.Empty) (any, error) {
+			handler: don.H(func(ctx context.Context, req any) (any, error) {
 				return nil, nil
 			}),
 		},
@@ -98,7 +98,7 @@ func TestHandlerResponse(t *testing.T) {
 				},
 			},
 			config: &don.Config{DefaultEncoding: "application/json", DisableNoContent: true},
-			handler: don.H(func(ctx context.Context, req don.Empty) (any, error) {
+			handler: don.H(func(ctx context.Context, req any) (any, error) {
 				return nil, nil
 			}),
 		},
@@ -111,7 +111,7 @@ func TestHandlerResponse(t *testing.T) {
 					"Foo":          "bar",
 				},
 			},
-			handler: don.H(func(ctx context.Context, req don.Empty) (any, error) {
+			handler: don.H(func(ctx context.Context, req any) (any, error) {
 				return &headerer{}, nil
 			}),
 		},
@@ -134,7 +134,7 @@ func TestHandlerResponse(t *testing.T) {
 				Body:   "Not Acceptable\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
-			handler: don.H(func(ctx context.Context, req don.Empty) ([]string, error) {
+			handler: don.H(func(ctx context.Context, req any) ([]string, error) {
 				return []string{"foo", "bar"}, nil
 			}),
 			request: request{header: map[string]string{"Accept": "text/plain; charset=utf-8"}},
@@ -146,7 +146,7 @@ func TestHandlerResponse(t *testing.T) {
 				Body:   "Not Acceptable\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
-			handler: don.H(func(ctx context.Context, req don.Empty) (any, error) {
+			handler: don.H(func(ctx context.Context, req any) (any, error) {
 				return nil, nil
 			}),
 			request: request{header: map[string]string{"Accept": "application/msword"}},
@@ -158,7 +158,7 @@ func TestHandlerResponse(t *testing.T) {
 				Body:   "Unsupported Media Type\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
-			handler: don.H(func(ctx context.Context, req don.Empty) (any, error) {
+			handler: don.H(func(ctx context.Context, req any) (any, error) {
 				return nil, nil
 			}),
 			request: request{
@@ -231,7 +231,7 @@ func TestHandlerResponse(t *testing.T) {
 				Body:   "test\n",
 				Header: map[string]string{"Content-Type": "text/plain; charset=utf-8"},
 			},
-			handler: don.H(func(ctx context.Context, req don.Empty) (any, error) {
+			handler: don.H(func(ctx context.Context, req any) (any, error) {
 				return nil, errors.New("test")
 			}),
 		},

diff --git a/nilcheck.go b/nilcheck.go
@@ -11,14 +11,6 @@ func makeNilCheck(zero any) func(v any) bool {
 		return func(v any) bool { return v == nil }
 	}
 
-	// Return true for don.Empty.
-	if _, ok := zero.(Empty); ok {
-		return func(v any) bool { return true }
-	}
-	if _, ok := zero.(*Empty); ok {
-		return func(v any) bool { return true }
-	}
-
 	switch reflect.TypeOf(zero).Kind() {
 	case reflect.String, reflect.Ptr:
 		// Return true for empty strings and nil pointer.

diff --git a/nilcheck_test.go b/nilcheck_test.go
@@ -27,8 +27,8 @@ func TestNilCheck(t *testing.T) {
 		},
 		{
 			message:  "nil struct",
-			typ:      (*don.Empty)(nil),
-			data:     (*don.Empty)(nil),
+			typ:      (*struct{})(nil),
+			data:     (*struct{})(nil),
 			expected: true,
 		},
 		{
@@ -37,12 +37,6 @@ func TestNilCheck(t *testing.T) {
 			data:     struct{}{},
 			expected: false,
 		},
-		{
-			message:  "don.Empty",
-			typ:      don.Empty{},
-			data:     don.Empty{},
-			expected: true,
-		},
 		{
 			message:  "nil map",
 			typ:      (map[string]string)(nil),