http.EncodeJSONResponse body writing is not compatible with net/http  #1291

Activity

1. kerma

   added

   bug

   on May 10, 2024
2. peterbourgon commented on May 10, 2024

   

   peterbourgon

   on May 10, 2024

   Member

   More actions

   Oops. Seems like a simple PR to fix.
3. kerma commented on May 11, 2024

   

   kerma

   on May 11, 2024

   Author

   More actions

   Using this fix myself:

   func EncodeJSONResponse(_ context.Context, w http.ResponseWriter, response any) error {
   	w.Header().Set("Content-Type", "application/json; charset=utf-8")
   	if headerer, ok := response.(http.Headerer); ok {
   		for k, values := range headerer.Headers() {
   			for _, v := range values {
   				w.Header().Add(k, v)
   			}
   		}
   	}
   	code := http.StatusOK
   	if sc, ok := response.(http.StatusCoder); ok {
   		code = sc.StatusCode()
   	}
   	w.WriteHeader(code)
   	if !bodyAllowedForStatus(code) {
   		return nil
   	}
   	return json.NewEncoder(w).Encode(response)
   }
   
   // bodyAllowedForStatus reports whether a given response status code
   // permits a body. See RFC 7230, section 3.3.
   // forked from net/http/transfer.go
   func bodyAllowedForStatus(status int) bool {
   	switch {
   	case status >= 100 && status <= 199:
   		return false
   	case status == 204:
   		return false
   	case status == 304:
   		return false
   	}
   	return true
   }
4. kerma

   added 2 commits that reference this issue on Jul 10, 2024

   Fixed EncodeJSONResponse body writing go-kit#1291

   0cdcd43

   Fixed EncodeJSONResponse body writing go-kit#1291

   4b24982
5. Yanhu007

   added a commit that references this issue on Apr 13, 2026

   fix: skip body encoding for all no-body HTTP status codes

   ...

   This issue will close once commit ab97492 is merged into the 'master' branch.

   ab97492