go-chi / go-chi/render

Using render.JSON with no http Request object throws an error

Open
#28 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
339
Forks
66
PR merge metrics
No merged PRs in 30d

Description

In the responder, render.JSON() function takes in an "http.Request" object which will be used to get the http response status code

I'm customizing the behavior of the function, by wrapping it with a wrapper function in my project. So I can call one function to pass in the response body as well as the status code, like so

```
func (r *responder) JSON(w http.ResponseWriter, v interface{}, s int) {
// Write http response status
w.WriteHeader(s)
render.JSON(w, nil, v)
}
```

When "nil" is passed is shown above instead of an http.Request object, the function throws an error.

```
--- FAIL: TestJSON (0.00s)
panic: runtime error: invalid memory address or nil pointer dereference [recovered]
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0xf0 pc=0x12a9ca0]

```

Here is the test I wrote to test the wrapper:

```
func TestJSON(t *testing.T) {
type mockResponse struct {
MockField string `json:"field"`
}
responder := NewResponder()

recorder := httptest.NewRecorder()
responder.JSON(recorder, mockResponse{MockField: "test"}, http.StatusOK)
assert.Equal(t, recorder.Code, 200)
assert.JSONEq(t, `{"field": "test"}`, recorder.Body.String())
}
```

I did some debugging, it seems like the error is caused by [line 103 in JSON function in responder.go](https://github.com/go-chi/render/blob/master/responder.go), which is the following:
```
if status, ok := r.Context().Value(StatusCtxKey).(int); ok {
w.WriteHeader(status)
}
```

How about adding a check for when the request object is nil, it skips this whole check and only writes the body to the buffer?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.