retrieveDeviceAuth: Call r.Body.Close() #750
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
| @@ -112,6 +112,7 @@ func retrieveDeviceAuth(ctx context.Context, c *Config, v url.Values) (*DeviceAu | |||
| } | |||
|
|
|||
| body, err := io.ReadAll(io.LimitReader(r.Body, 1<<20)) | |||
| r.Body.Close() | |||
| if err != nil { | |||
There was a problem hiding this comment.
it should be defer r.Body.Close() before reading all the content.
defer r.Body.Close()
body, err := io.ReadAll(io.LimitReader(r.Body, 1<<20))
There was a problem hiding this comment.
Hm, I'm not sure why we need to use defer, unless io.ReadAll(io.LimitReader(r.Body, 1<<20)) can panic? Anyway, I implemented your suggestion in https://github.com/golang/oauth2/compare/ffeca96aa76167a098068334a567bb7c0975acc8..8499b419ad4097ac16cd5b264b8efe53791ae259. Thanks for reviewing!
There was a problem hiding this comment.
Your solution is not wrong, but it's very common in golang to use the defer reader.Close() pattern.
A more precise version that can handle all kind of errors would be:
body, err := io.ReadAll(io.LimitReader(r.Body, 1<<20))
if err != nil {
r.Body.Close() // ignore _this_ error - we already have one
...
return ...
}
err = r.Body.Close()
if err != nil {
return ...
}
But this would make the code more unreadable. In most cases it is ok to ignore the close error.
Close the response body after reading it in the DeviceAuth logic. The retrieveDeviceAuth function did not close the response body. However, the net/http documentation states that one is expected to close the response body after one sends an HTTP request and reads the response body. In addition, the doTokenRoundTrip function *does* call r.Body.Close(). (Some other functions use a client with a custom Transport that automatically closes the body, but that is not the case for retrieveDeviceAuth or doTokenRoundTrip.) Follow-up to commit e3fb0fb. * deviceauth.go (retrieveDeviceAuth): Call r.Body.Close() after reading r.Body.
Miciah
force-pushed
the
retrieveDeviceAuth-call-r.Body.Close
branch
from
ffeca96 to
8499b41
Compare
Close the response body after reading it in the DeviceAuth logic.
The
retrieveDeviceAuthfunction did not close the response body. However, the net/http documentation states that one is expected to close the response body after one sends an HTTP request and reads the response body. In addition, thedoTokenRoundTripfunction does callr.Body.Close(). (Some other functions use a client with a custom Transport that automatically closes the body, but that is not the case forretrieveDeviceAuthordoTokenRoundTrip.)Follow-up to commit e3fb0fb.
I noticed the missing
r.Body.Close()call while reviewing a vendor bump in a project that I help maintain. This project doesn't actually use DeviceAuth; I was just skimming through the newly vendored code when I noticed the questionable logic.