remove Void

Author: blizzy78

README.md

@@ -4,7 +4,7 @@
 gojsonclient
 ============
 
-A Go package that provides a client for JSON/REST HTTP services.
+A Go package that provides a client for JSON/REST HTTP services, with automatic retry/backoff.
 
 ```go
 import "github.com/blizzy78/gojsonclient"

client.go

@@ -39,11 +39,12 @@ type RetryFunc func(ctx context.Context, httpRes *http.Response, err error) erro
 
 // Request represents a JSON/REST HTTP request.
 type Request[Req any, Res any] struct {
-	uri               string
-	method            string
-	req               Req
-	marshalRequest    MarshalJSONFunc[Req]
-	unmarshalResponse UnmarshalJSONFunc[Res]
+	uri                string
+	method             string
+	req                Req
+	ignoreResponseBody bool
+	marshalRequest     MarshalJSONFunc[Req]
+	unmarshalResponse  UnmarshalJSONFunc[Res]
 }
 
 // RequestOpt is a function that configures a Request.
@@ -58,7 +59,7 @@ type UnmarshalJSONFunc[T any] func(httpRes *http.Response, val *T) error
 // Response represents a JSON/REST HTTP response.
 type Response[T any] struct {
 	// Res is the value decoded from the response body.
-	// Res will be the default value of T if StatusCode==http.StatusNoContent, or if T is Void or *Void.
+	// Res will be the default value of T if StatusCode==http.StatusNoContent, or if the response body is ignored.
 	Res T
 
 	// StatusCode is the HTTP response status code.
@@ -68,15 +69,12 @@ type Response[T any] struct {
 	Status string
 }
 
-// Void can be used as a request type to indicate that the request has no body,
-// or as a response type to indicate that the response has no body.
-type Void struct{}
-
 type httpError string
 
 var _ error = httpError("")
 
 // New creates a new Client with the given options.
+//
 // The default options are: slog.Default() as the logger, http.DefaultClient as the HTTP client,
 // request timeout of 30s, maximum number of attempts of 5, gobackoff.New() as the backoff,
 // and a retry function that returns an error if the HTTP response status code is http.StatusBadRequest.
@@ -214,18 +212,25 @@ func WithUnmarshalResponseFunc[Req any, Res any](fun UnmarshalJSONFunc[Res]) Req
 	}
 }
 
-// Do executes req and returns the response.
+// WithIgnoreResponseBody configures a Request to ignore the response body, regardless of status code.
+// The response body will always be ignored if the status code is http.StatusNoContent.
+func WithIgnoreResponseBody[Req any, Res any]() RequestOpt[Req, Res] {
+	return func(req *Request[Req, Res]) {
+		req.ignoreResponseBody = true
+	}
+}
+
+// Do executes req with client and returns the response.
+//
+// If the request data is nil, the request will be made without a body.
+// If the response status code is http.StatusNoContent or the response body should be ignored,
+// Response.Res will be the default value of Res.
 //
 // If an HTTP request fails, it is retried using backoff according to the retry function, up to the
 // maximum number of attempts.
 // If the context is canceled, or if the retry function returns a non-nil error, Do stops and returns
 // a gobackoff.AbortError.
 //
-// If Req is Void or *Void, the request will be made without a body.
-// If the response status code is http.StatusNoContent, Response.Res will be the default value of Res.
-// If Res is Void or *Void, the response body will be ignored, and Response.Res will be the default
-// value of Res.
-//
 // Do is safe to call concurrently with the same Request.
 func Do[Req any, Res any](ctx context.Context, client *Client, req *Request[Req, Res]) (*Response[Res], error) {
 	var res *Response[Res]
@@ -296,11 +301,7 @@ func do[Req any, Res any](ctx context.Context, client *Client, req *Request[Req,
 func newHTTPRequest[Req any, Res any](ctx context.Context, client *Client, req *Request[Req, Res]) (*http.Request, error) {
 	var jsonReqData io.Reader = http.NoBody
 
-	switch any(req.req).(type) {
-	case Void:
-	case *Void:
-
-	default:
+	if any(req.req) != nil {
 		buf := bytes.Buffer{}
 
 		if err := req.marshalRequest(&buf, req.req); err != nil {
@@ -328,24 +329,14 @@ func newHTTPRequest[Req any, Res any](ctx context.Context, client *Client, req *
 }
 
 func response[Req any, Res any](httpRes *http.Response, req *Request[Req, Res]) (*Response[Res], error) {
-	if httpRes.StatusCode == http.StatusNoContent {
+	if httpRes.StatusCode == http.StatusNoContent || req.ignoreResponseBody {
 		return &Response[Res]{
 			StatusCode: httpRes.StatusCode,
 			Status:     httpRes.Status,
 		}, nil
 	}
 
 	var jsonRes Res
-
-	switch any(jsonRes).(type) {
-	case Void:
-	case *Void:
-		return &Response[Res]{
-			StatusCode: httpRes.StatusCode,
-			Status:     httpRes.Status,
-		}, nil
-	}
-
 	if err := req.unmarshalResponse(httpRes, &jsonRes); err != nil {
 		return nil, fmt.Errorf("decode response: %w", err)
 	}

client_test.go

@@ -69,7 +69,7 @@ func TestDo_Marshal(t *testing.T) {
 
 	client := New()
 
-	req := NewRequest[*testReq, *testRes](server.URL, http.MethodGet, &reqData,
+	req := NewRequest(server.URL, http.MethodGet, &reqData,
 		WithMarshalRequestFunc[*testReq, *testRes](func(writer io.Writer, val *testReq) error {
 			_, err := writer.Write([]byte(val.Message))
 			return err //nolint:wrapcheck // we don't add new info here
@@ -98,8 +98,8 @@ func TestDo_Unmarshal(t *testing.T) {
 
 	client := New()
 
-	req := NewRequest[*testReq, *testRes](server.URL, http.MethodGet, &reqData,
-		WithUnmarshalResponseFunc[*testReq, *testRes](func(httpRes *http.Response, _ **testRes) error {
+	req := NewRequest(server.URL, http.MethodGet, &reqData,
+		WithUnmarshalResponseFunc[*testReq](func(httpRes *http.Response, _ **testRes) error {
 			data, _ := io.ReadAll(httpRes.Body)
 			is.Equal(string(data), resData.Reply)
 
@@ -305,13 +305,13 @@ func TestDo_RetryMaxAttempts(t *testing.T) {
 	is.Equal(attempts, 5)
 }
 
-func TestNewHTTPRequest_Void(t *testing.T) {
+func TestNewHTTPRequest_NoBody(t *testing.T) {
 	is := is.New(t)
 
 	client := New()
 
-	req := NewRequest[*Void, *Void]("", http.MethodGet, nil,
-		WithMarshalRequestFunc[*Void, *Void](func(_ io.Writer, _ *Void) error {
+	req := NewRequest("", http.MethodGet, nil,
+		WithMarshalRequestFunc[any, any](func(_ io.Writer, _ any) error {
 			is.Fail()
 			return nil
 		}),
@@ -321,11 +321,13 @@ func TestNewHTTPRequest_Void(t *testing.T) {
 	is.NoErr(err)
 }
 
-func TestResponse_Void(t *testing.T) {
+func TestResponse_IgnoreBody(t *testing.T) {
 	is := is.New(t)
 
-	req := NewRequest[*Void, *Void]("", http.MethodGet, nil,
-		WithUnmarshalResponseFunc[*Void, *Void](func(_ *http.Response, _ **Void) error {
+	req := NewRequest("", http.MethodGet, nil,
+		WithIgnoreResponseBody[any, any](),
+
+		WithUnmarshalResponseFunc[any](func(_ *http.Response, _ *any) error {
 			is.Fail()
 			return nil
 		}),
@@ -337,15 +339,15 @@ func TestResponse_Void(t *testing.T) {
 		Body:       http.NoBody,
 	}
 
-	_, err := response[*Void, *Void](&httpRes, req)
+	_, err := response(&httpRes, req)
 	is.NoErr(err)
 }
 
 func TestResponse_NoContent(t *testing.T) {
 	is := is.New(t)
 
-	req := NewRequest[*Void, *Void]("", http.MethodGet, nil,
-		WithUnmarshalResponseFunc[*Void, *Void](func(_ *http.Response, _ **Void) error {
+	req := NewRequest("", http.MethodGet, nil,
+		WithUnmarshalResponseFunc[any](func(_ *http.Response, _ *any) error {
 			is.Fail()
 			return nil
 		}),
@@ -357,7 +359,7 @@ func TestResponse_NoContent(t *testing.T) {
 		Body:       http.NoBody,
 	}
 
-	_, err := response[*Void, *Void](&httpRes, req)
+	_, err := response(&httpRes, req)
 	is.NoErr(err)
 }