Overriding status code from `response.Response`

[luiz-otavio]

Is your feature request related to a problem? Please describe.
Yes. Recently I had the usecase to return code 204 ("No Content") in a route for listing products and I had no choice than putting it in the envelope, so the application knows that the status code of the response.

Describe the solution you'd like
A property called StatusCode in response.Response would be awesome.

Describe alternatives you've considered
None.

Additional context
None.

[coolwednesday]

Hey @luiz-otavio ! We support setting status codes for errors. However in success cases we do not allow setting status codes. Can I know the usecase of sending 204 ?

[Umang01-hash]

@luiz-otavio You can refer here for setting custom status code through errors: https://gofr.dev/docs/advanced-guide/gofr-errors#custom-errors

[luiz-otavio]

Hey @luiz-otavio ! We support setting status codes for errors. However in success cases we do not allow setting status codes. Can I know the usecase of sending 204 ?

I have the situation where my user can list through a GET method some recent orders from a restaurant system. In that case, if the list is empty I send the response with an empty array but with a status code 204 to notify the user about it, instead of letting him checking the number of items by the array

[luiz-otavio]

@luiz-otavio You can refer here for setting custom status code through errors: https://gofr.dev/docs/advanced-guide/gofr-errors#custom-errors

I can do the same thing for other structs, right? Like:

struct MyResponse struct {
    Data []interface{} `json:"data"`
}

func (m MyResponse) StatusCode() int {
     if len(m.Data) == 0 {
         return 204
     }

     return 200
}

[Umang01-hash]

@luiz-otavio Unfortunately no, the struct shoud implement the Error() interface, then only it will be able to set a custom status code. We only let the user change the status code in case of an error response being returned, for success responses GoFr automatically sends the right status code as per standards.

204 No Content is meant to indicate a successful request, but with no body in the response.
According to the HTTP specification, the response must not include a message body (i.e., no JSON, not even an empty array).

Returning an empty array with a 204 is a contradiction: a 204 implies no body, whereas an empty array is still a body.

[aryanmehrotra]

@luiz-otavio you should return gofr Error entity not found in this case - as the correct status code would be StatusNotFound (404)

https://gofr.dev/docs/advanced-guide/gofr-errors#database-errors

[luiz-otavio]

@luiz-otavio you should return gofr Error entity not found in this case - as the correct status code would be StatusNotFound (404)

https://gofr.dev/docs/advanced-guide/gofr-errors#database-errors

I don't think 404 is good for my usecase. As @Umang01-hash mentioned, it's a sucessfully request, but with no body since it's empty at all.

Actually, my only option here is to make an envelope to send over body the actual status code of the request to ensure what's getting on other side.