Deprecated "Sanitize JSON" related implementation is dropped. Instead, for scalars (e.g. strings) and containers (e.g. slices) use omitempty tag, and structs are to be pointers.

Author: Som-Som-CC

.gitignore

@@ -1,2 +1,3 @@
 .vscode/
-vendor/
+vendor/
+coverage.out

client.go

@@ -125,7 +125,6 @@ type Client struct {
 	// Changing its value does not change client kind.
 	Kind              string
 	httpsCfg          *HTTPSConfig
-	sanitizeJSON      bool
 	rootURL           string
 	userAgent         string
 	username          string
@@ -405,14 +404,6 @@ func (c *Client) Timeout(timeout time.Duration) *Client {
 	return c
 }
 
-// SanitizeJSON enables JSON sanitization.
-// See details at SanitizeJSONString.
-// Deprecated.
-func (c *Client) SanitizeJSON() *Client {
-	c.sanitizeJSON = true
-	return c
-}
-
 // SetBasicAuth sets Authorization header for each request sent by the client.
 // String username:password sent in HTTP header.
 //
@@ -767,9 +758,6 @@ func (c *Client) makeBodyBytes(data any) ([]byte, error) {
 		return nil, err
 	}
 
-	if c.sanitizeJSON {
-		body = SanitizeJSONBytes(body)
-	}
 	if len(body) <= len("{}") {
 		return nil, nil
 	}

client_test.go

@@ -33,14 +33,14 @@ type strType struct {
 
 type innerStruct struct {
 	String string            `json:"string,omitempty"`
-	Array  []byte            `json:"array"`
-	Map    map[string]string `json:"map"`
+	Array  []byte            `json:"array,omitempty"`
+	Map    map[string]string `json:"map,omitempty"`
 	Number int               `json:"number,omitempty"`
 }
 
 type structType struct {
-	Str    string      `json:"str,omitempty"`
-	Struct innerStruct `json:"struct"`
+	Str    string       `json:"str,omitempty"`
+	Struct *innerStruct `json:"struct,omitempty"`
 }
 
 func testMsgPackDiscoveryAccepted(t testing.TB, iters int) {
@@ -68,16 +68,16 @@ func testMsgPackDiscoveryAccepted(t testing.TB, iters int) {
 		assert.True(acceptsMsgPack(r))
 
 		// Answer
-		sendResponse(w, r, data, false)
+		sendResponse(w, r, data)
 		requestCount++
 	}))
 	defer srv.Close()
 
 	respData := structType{}
 	ctx := context.Background()
 	client := NewClient().Root(srv.URL).MsgPack(true)
-	reqData1 := structType{Str: "a", Struct: innerStruct{Number: 1, Array: []byte{1, 2, 3}}}
-	reqData2 := structType{Str: "b", Struct: innerStruct{Number: 2, Array: []byte{4, 5, 6}}}
+	reqData1 := structType{Str: "a", Struct: &innerStruct{Number: 1, Array: []byte{1, 2, 3}}}
+	reqData2 := structType{Str: "b", Struct: &innerStruct{Number: 2, Array: []byte{4, 5, 6}}}
 
 	for i := 0; i < iters; i++ {
 		_, err := client.Post(ctx, "/", &reqData1, &respData)
@@ -122,16 +122,16 @@ func testMsgPackDiscoveryRejected(t testing.TB, iters int) {
 		}
 
 		// Answer
-		sendResponse(w, r, data, false)
+		sendResponse(w, r, data)
 		requestCount++
 	}))
 	defer srv.Close()
 
 	respData := structType{}
 	ctx := context.Background()
 	client := NewClient().Root(srv.URL).MsgPack(true)
-	reqData1 := structType{Str: "a", Struct: innerStruct{Number: 1, Array: []byte{1, 2, 3}}}
-	reqData2 := structType{Str: "b", Struct: innerStruct{Number: 2, Array: []byte{4, 5, 6}}}
+	reqData1 := structType{Str: "a", Struct: &innerStruct{Number: 1, Array: []byte{1, 2, 3}}}
+	reqData2 := structType{Str: "b", Struct: &innerStruct{Number: 2, Array: []byte{4, 5, 6}}}
 
 	for i := 0; i < iters; i++ {
 		_, err := client.Post(ctx, "/", &reqData1, &respData)
@@ -188,7 +188,7 @@ func TestMethods(t *testing.T) {
 	reqData := strType{Str: "b"}
 	respData := strType{}
 	ctx := context.Background()
-	client := NewClient().Root(srv.URL).SanitizeJSON().HTTPS(&HTTPSConfig{AllowLocalhostHTTP: true})
+	client := NewClient().Root(srv.URL).HTTPS(&HTTPSConfig{AllowLocalhostHTTP: true})
 	location, err := client.Post(ctx, "/users", &reqData, &respData)
 	assert.Nil(err)
 	locationStr := location.String()
@@ -414,7 +414,7 @@ func TestMethodsError(t *testing.T) {
 	reqData := strType{Str: "b"}
 	respData := strType{}
 	ctx := context.Background()
-	client := NewClient().Root(srv.URL).SanitizeJSON()
+	client := NewClient().Root(srv.URL)
 	client.SetMaxBytesToParse(100000)
 	location, err := client.Post(ctx, "/users", &reqData, &respData)
 	assert.NotNil(err)

json.go

@@ -18,11 +18,6 @@ import (
 // You may want to set it to a smaller value, such as 4KiB, to prevent DoS attacks.
 var LambdaMaxBytesToParse = 64 * 1024 * 1024
 
-// LambdaSanitizeJSON defines whether to sanitize JSON of Lambda return or SendResp.
-// See SanitizeJSONString for details.
-// Deprecated.
-var LambdaSanitizeJSON = false
-
 // LambdaValidator tells if incoming request is to be validated.
 // Validation is done by https://github.com/go-playground/validator.
 // See its documentation for details.

json_test.go

@@ -13,7 +13,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-func getJSONBody(data any, sanitizeJSON bool) ([]byte, error) {
+func getJSONBody(data any) ([]byte, error) {
 	if data == nil {
 		return nil, nil // Otherwise "null" (4 bytes) would be returned.
 	}
@@ -22,20 +22,17 @@ func getJSONBody(data any, sanitizeJSON bool) ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
-	if sanitizeJSON {
-		body = SanitizeJSONBytes(body)
-		if len(body) == 2 && body[0] == '{' && body[1] == '}' {
-			return nil, nil
-		}
-	}
 
 	return body, nil
 }
 
-// SendJSONResponse sends an HTTP response with an optionally sanitized JSON data.
+// SendJSONResponse sends an HTTP response with a JSON data.
 // Caller may set additional headers like `w.Header().Set("Location", "https://me")` before calling this function.
-func SendJSONResponse(w http.ResponseWriter, statusCode int, data any, sanitizeJSON bool) (err error) {
-	body, err := getJSONBody(data, sanitizeJSON)
+//
+// Warning: The last boolean parameter is ignored. It is there for temporary backward compatibility only.
+// It will be removed in the near-future.
+func SendJSONResponse(w http.ResponseWriter, statusCode int, data any, _ ...bool) (err error) {
+	body, err := getJSONBody(data)
 	if body != nil {
 		w.Header().Set(ContentTypeHeader, ContentTypeApplicationJSON)
 		w.WriteHeader(statusCode)
@@ -46,7 +43,7 @@ func SendJSONResponse(w http.ResponseWriter, statusCode int, data any, sanitizeJ
 	return err
 }
 
-func sendResponse(w http.ResponseWriter, r *http.Request, data any, sanitizeJSON bool) (err error) {
+func sendResponse(w http.ResponseWriter, r *http.Request, data any) (err error) {
 	okStatus := getOkStatus(w, r, data)
 
 	if data == nil {
@@ -74,13 +71,16 @@ func sendResponse(w http.ResponseWriter, r *http.Request, data any, sanitizeJSON
 		return err
 	}
 
-	return SendJSONResponse(w, okStatus, data, sanitizeJSON)
+	return SendJSONResponse(w, okStatus, data)
 }
 
 // SendResponse sends an HTTP response with a JSON data.
 // Caller may set additional headers like `w.Header().Set("Location", "https://me")` before calling this function.
+//
+// Same as SendJSONResponse. It will be removed in the near-future.
+// Deprecated.
 func SendResponse(w http.ResponseWriter, statusCode int, data any) error {
-	return SendJSONResponse(w, statusCode, data, false)
+	return SendJSONResponse(w, statusCode, data)
 }
 
 func getOkStatus(w http.ResponseWriter, r *http.Request, data any) int {
@@ -95,19 +95,19 @@ func getOkStatus(w http.ResponseWriter, r *http.Request, data any) int {
 }
 
 // SendResp sends an HTTP response with data.
-// On no error 200/201/204 sent according to the request.
-// On error send response depending on whether the error is created by NewError and the client supports RFC 7807.
+// If the supplied err is nil, 200/201/204 is sent according to the request and if response data is supplied.
+// If err is not nil, a response is sent depending on whether the supplied error is created by NewError and the client supports RFC 7807.
 // Caller may set additional headers like `w.Header().Set("Location", "https://me")` before calling this function.
 func SendResp(w http.ResponseWriter, r *http.Request, err error, data any) error {
 	if err == nil {
-		return sendResponse(w, r, data, LambdaSanitizeJSON)
+		return sendResponse(w, r, data)
 	}
 
 	if errStr := err.Error(); errStr != "" { // In some cases status like 404 does not indicate error, just a plain result. E.g. on a distributed cache query.
 		log.Error(errStr)
 	}
 
-	body, _ := getJSONBody(data, LambdaSanitizeJSON)
+	body, _ := getJSONBody(data)
 	if body == nil {
 		return SendProblemDetails(w, r, err)
 	}
@@ -124,6 +124,11 @@ func SendEmptyResponse(w http.ResponseWriter, statusCode int) {
 }
 
 // SendLocationResponse sends an empty "201 Created" HTTP response with Location header.
+//
+// Looking at the APIs of various bodies, it seems that 201 Created responses usually send back the JSON description of the created resource.
+// So, this function is practically never used. Thus, it will be removed in the near-future.
+// One can use SendEmptyResponse instead.
+// Deprecated.
 func SendLocationResponse(w http.ResponseWriter, location string) {
 	w.Header().Set("Location", location)
 	SendEmptyResponse(w, http.StatusCreated)
@@ -201,7 +206,7 @@ func sendCustomResponse(r *http.Request, w http.ResponseWriter, body []byte, sta
 	return nil
 }
 
-// SendProblemDetails adds detailed problem description to JSON body, if available. See RFC 7807.
+// SendProblemDetails sends a response adding detailed problem description to JSON body, if available. See RFC 7807.
 func SendProblemDetails(w http.ResponseWriter, r *http.Request, err error) error {
 	if restErr, ok := err.(*restError); ok {
 		if len(restErr.body) != 0 {

mux_lambda_wrapper.go

@@ -23,7 +23,7 @@ func TestSendResponse(t *testing.T) {
 		w.Header().Set("Location", "https://me/path")
 		var a structType
 		a.Str = "hello"
-		SendJSONResponse(w, 201, &a, true)
+		SendJSONResponse(w, 201, &a)
 	})))
 	defer srv.Close()