allow empty payloads in post,put,patch, issue #580 (#581)

* allow empty payloads in post,put,patch, issue #580

* remove content-length check in route detection

* detect mismatched content-type #580

* more tests

* remove 415 check in accept check

* update hist

Author: emicklei

CHANGES.md

@@ -1,5 +1,8 @@
 # Change history of go-restful
 
+## [v3.12.2] - 2025-02-21
+
+- allow empty payloads in post,put,patch, issue #580 ( thanks @liggitt, Jordan Liggitt)
 
 ## [v3.12.1] - 2024-05-28
 

jsr311.go

@@ -65,7 +65,7 @@ func (RouterJSR311) extractParams(pathExpr *pathExpression, matches []string) ma
 	return params
 }
 
-// http://jsr311.java.net/nonav/releases/1.1/spec/spec3.html#x3-360003.7.2
+// https://download.oracle.com/otndocs/jcp/jaxrs-1.1-mrel-eval-oth-JSpec/
 func (r RouterJSR311) detectRoute(routes []Route, httpRequest *http.Request) (*Route, error) {
 	candidates := make([]*Route, 0, 8)
 	for i, each := range routes {
@@ -126,9 +126,7 @@ func (r RouterJSR311) detectRoute(routes []Route, httpRequest *http.Request) (*R
 		if trace {
 			traceLogger.Printf("no Route found (from %d) that matches HTTP Content-Type: %s\n", len(previous), contentType)
 		}
-		if httpRequest.ContentLength > 0 {
-			return nil, NewError(http.StatusUnsupportedMediaType, "415: Unsupported Media Type")
-		}
+		return nil, NewError(http.StatusUnsupportedMediaType, "415: Unsupported Media Type")
 	}
 
 	// accept
@@ -151,20 +149,9 @@ func (r RouterJSR311) detectRoute(routes []Route, httpRequest *http.Request) (*R
 		for _, candidate := range previous {
 			available = append(available, candidate.Produces...)
 		}
-		// if POST,PUT,PATCH without body
-		method, length := httpRequest.Method, httpRequest.Header.Get("Content-Length")
-		if (method == http.MethodPost ||
-			method == http.MethodPut ||
-			method == http.MethodPatch) && (length == "" || length == "0") {
-			return nil, NewError(
-				http.StatusUnsupportedMediaType,
-				fmt.Sprintf("415: Unsupported Media Type\n\nAvailable representations: %s", strings.Join(available, ", ")),
-			)
-		}
 		return nil, NewError(
 			http.StatusNotAcceptable,
-			fmt.Sprintf("406: Not Acceptable\n\nAvailable representations: %s", strings.Join(available, ", ")),
-		)
+			fmt.Sprintf("406: Not Acceptable\n\nAvailable representations: %s", strings.Join(available, ", ")))
 	}
 	// return r.bestMatchByMedia(outputMediaOk, contentType, accept), nil
 	return candidates[0], nil

route.go

@@ -111,6 +111,8 @@ func (r Route) matchesAccept(mimeTypesWithQuality string) bool {
 }
 
 // Return whether this Route can consume content with a type specified by mimeTypes (can be empty).
+// If the route does not specify Consumes then return true (*/*).
+// If no content type is set then return true for GET,HEAD,OPTIONS,DELETE and TRACE.
 func (r Route) matchesContentType(mimeTypes string) bool {
 
 	if len(r.Consumes) == 0 {

web_service_test.go

@@ -124,19 +124,113 @@ Available representations: text/plain, application/json`
 	}
 }
 
-func TestUnsupportedMedia_Issue492(t *testing.T) {
+func TestUnsupportedMedia_AcceptOnly(t *testing.T) {
+	tearDown()
+	Add(newPostTestService())
+	for _, method := range []string{"POST", "PUT", "PATCH"} {
+		httpRequest, _ := http.NewRequest(method, "http://here.com/test", nil) // no content
+		httpRequest.Header.Set("Accept", "application/json")
+		httpWriter := httptest.NewRecorder()
+		DefaultContainer.dispatch(httpWriter, httpRequest)
+		if http.StatusUnsupportedMediaType != httpWriter.Code {
+			t.Errorf("[%s] 415 expected got %d", method, httpWriter.Code)
+		}
+	}
+}
+func TestUnsupportedMedia_AcceptOnlyWithZeroContentLength(t *testing.T) {
 	tearDown()
 	Add(newPostTestService())
 	for _, method := range []string{"POST", "PUT", "PATCH"} {
 		httpRequest, _ := http.NewRequest(method, "http://here.com/test", nil)
 		httpRequest.Header.Set("Accept", "application/json")
+		httpRequest.Header.Set("Content-length", "0")
 		httpWriter := httptest.NewRecorder()
 		DefaultContainer.dispatch(httpWriter, httpRequest)
-		if 415 != httpWriter.Code {
+		if http.StatusUnsupportedMediaType != httpWriter.Code {
 			t.Errorf("[%s] 415 expected got %d", method, httpWriter.Code)
 		}
 	}
 }
+func TestUnsupportedMedia_ContentTypeOnly(t *testing.T) { // If Accept is not set then */* is used.
+	tearDown()
+	Add(newPostTestService())
+	for _, method := range []string{"POST", "PUT", "PATCH"} {
+		httpRequest, _ := http.NewRequest(method, "http://here.com/test", nil) // no content
+		httpRequest.Header.Set("Content-type", "application/json")
+		httpWriter := httptest.NewRecorder()
+		DefaultContainer.dispatch(httpWriter, httpRequest)
+		if http.StatusOK != httpWriter.Code {
+			t.Errorf("[%s] 200 expected got %d", method, httpWriter.Code)
+		}
+	}
+}
+
+func TestGetWithNonMatchingContentType(t *testing.T) { // If Accept is not set then */* is used.
+	tearDown()
+	Add(newGetOnlyJsonOnlyService())
+	httpRequest, _ := http.NewRequest("GET", "http://here.com/get", nil) // no content
+	httpRequest.Header.Set("Content-type", "application/yaml")
+	httpWriter := httptest.NewRecorder()
+	DefaultContainer.dispatch(httpWriter, httpRequest)
+	if httpWriter.Code != http.StatusUnsupportedMediaType {
+		t.Errorf("[%s] 415 expected got %d", "GET", httpWriter.Code)
+	}
+}
+
+func TestPostWithNonMatchingContentType(t *testing.T) { // If Accept is not set then */* is used.
+	tearDown()
+	Add(newPostNoConsumesService())
+	httpRequest, _ := http.NewRequest("POST", "http://here.com/post", nil) // no content
+	httpRequest.Header.Set("Content-type", "application/yaml")
+	httpWriter := httptest.NewRecorder()
+	DefaultContainer.dispatch(httpWriter, httpRequest)
+	if httpWriter.Code != http.StatusNoContent {
+		t.Errorf("[%s] 204 expected got %d", "POST", httpWriter.Code)
+	}
+}
+
+func TestPostWithNonMatchingAccept(t *testing.T) {
+	tearDown()
+	// consumes and produces JSON on POST,PUT and PATCH
+	Add(newPostTestService())
+	httpRequest, _ := http.NewRequest("POST", "http://here.com/test", nil) // no content
+	httpRequest.Header.Set("Content-type", "application/json")
+	httpRequest.Header.Set("Accept", "application/yaml")
+	httpWriter := httptest.NewRecorder()
+	DefaultContainer.dispatch(httpWriter, httpRequest)
+	if httpWriter.Code != http.StatusNotAcceptable {
+		t.Errorf("[%s] 406 expected got %d", "POST", httpWriter.Code)
+	}
+}
+
+func TestPostEmptyBody(t *testing.T) {
+	tearDown()
+	// consumes and produces JSON on POST,PUT and PATCH
+	Add(newPostTestService())
+	httpRequest, _ := http.NewRequest("POST", "http://here.com/test", nil) // no content
+	httpRequest.Header.Set("Content-type", "application/json")
+	httpRequest.Header.Set("Accept", "application/json")
+	httpWriter := httptest.NewRecorder()
+	DefaultContainer.dispatch(httpWriter, httpRequest)
+	if httpWriter.Code != http.StatusOK {
+		t.Errorf("[%s] 200 expected got %d", "POST", httpWriter.Code)
+	}
+}
+
+func TestPostEmptyBodyZeroContentLength(t *testing.T) {
+	tearDown()
+	// consumes and produces JSON on POST,PUT and PATCH
+	Add(newPostTestService())
+	httpRequest, _ := http.NewRequest("POST", "http://here.com/test", nil) // no content
+	httpRequest.Header.Set("Content-type", "application/json")
+	httpRequest.Header.Set("Content-length", "0")
+	httpRequest.Header.Set("Accept", "application/json")
+	httpWriter := httptest.NewRecorder()
+	DefaultContainer.dispatch(httpWriter, httpRequest)
+	if httpWriter.Code != http.StatusOK {
+		t.Errorf("[%s] 200 expected got %d", "POST", httpWriter.Code)
+	}
+}
 
 func TestSelectedRoutePath_Issue100(t *testing.T) {
 	tearDown()
@@ -390,6 +484,7 @@ func newPostNoConsumesService() *WebService {
 	return ws
 }
 
+// consumes and produces JSON on POST,PUT and PATCH
 func newPostTestService() *WebService {
 	ws := new(WebService).Path("")
 	ws.Consumes("application/json")