Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix premature response.Body closing in case of "binary" encoding #117

Closed
wants to merge 1 commit into from
Closed

Fix premature response.Body closing in case of "binary" encoding #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion common/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ import (
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// CloseableBuffer is a bytes.Buffer which implements the io.ReadCloser interface for compatibility
type CloseableBuffer struct {
*bytes.Buffer
}

// Close implements io.ReadCloser.Close() without doing anything, because of Buffer's in-memory essence
func (CloseableBuffer) Close() error { return nil }

// Make sure CloseableBuffer implements io.ReadCloser
var _ io.ReadCloser = &CloseableBuffer{}

func isNil(v reflect.Value) bool {
return v.Kind() == reflect.Ptr && v.IsNil()
}
Expand Down Expand Up @@ -774,7 +785,12 @@ func addFromBody(response *http.Response, value *reflect.Value, field reflect.St
var iVal interface{}
switch encoding {
case "binary":
value.Set(reflect.ValueOf(response.Body))
byteArr, e := ioutil.ReadAll(response.Body)
Copy link
Contributor

@jasonyin jasonyin Jul 5, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for string/binary in open api 2.0, it means a stream "octet-stream" (https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md), a stream might not be able to fully loaded at this time, it might still streaming from server. So I am a bit concern here about load the stream to a buffer. (BTW, it works in kubeconfig case).

I am thinking to return the stream back to user without close it if it is a binary, thoughts?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jasonyin , yes that was also my thinking at the beginning, and I just saw later that the implementation is also used for object storage calls for example. So yes I think not closing the stream in these cases is the correct way. Should I change the implementation like that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that would be great, just wondering how do you plan to do it. There's a auto generated method common.ClostBodyIfValid in every operations, I am thinking to change the template for it. If you have better ways to handle it, just let me know, thanks!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the method common.ClostBodyIfValid autogenerated, or the callsites or both?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all common code are not autogen, just other files using it.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The getObject call in the objectstorage client does not have that close body call. It looks like to me, that it somehow already solved in some part of the generator. Maybe the same solution should be applicable here as well?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bonifaido , I think you can use this change to unblock yourself for now. I am going to do a fix on generation part which will be release out on next Thursday.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks @jasonyin, than we will wait for the fix next Thursday, until then we will use this fix in our branch.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool, I am closing this PR now.

if e != nil {
return e
}
body := &CloseableBuffer{Buffer: bytes.NewBuffer(byteArr)}
value.Set(reflect.ValueOf(body))
return
case "plain-text":
//Expects UTF-8
Expand Down