Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -991,7 +991,7 @@ func (c *Conn) handleProtocolError(message string) error {
if len(data) > maxControlFramePayloadSize {
data = data[:maxControlFramePayloadSize]
}
// Make a best effor to send a close message describing the problem.
// Make a best effort to send a close message describing the problem.
_ = c.WriteControl(CloseMessage, data, time.Now().Add(writeWait))
return errors.New("websocket: " + message)
}
Expand Down Expand Up @@ -1147,7 +1147,7 @@ func (c *Conn) SetCloseHandler(h func(code int, text string) error) {
if h == nil {
h = func(code int, text string) error {
message := FormatCloseMessage(code, "")
// Make a best effor to send the close message.
// Make a best effort to send the close message.
_ = c.WriteControl(CloseMessage, message, time.Now().Add(writeWait))
return nil
}
Expand Down
8 changes: 4 additions & 4 deletions server.go
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,9 @@ func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeade
buf := brw.Writer.AvailableBuffer()

var writeBuf []byte
if u.WriteBufferPool == nil && u.WriteBufferSize == 0 && len(buf) >= maxFrameHeaderSize+256 {
if u.WriteBufferPool == nil && u.WriteBufferSize == 0 && cap(buf) >= maxFrameHeaderSize+256 {
// Reuse hijacked write buffer as connection buffer.
writeBuf = buf
writeBuf = buf[:cap(buf)]
}

c := newConn(netConn, true, u.ReadBufferSize, u.WriteBufferSize, u.WriteBufferPool, br, writeBuf)
Expand All @@ -220,7 +220,7 @@ func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeade

// Use larger of hijacked buffer and connection write buffer for header.
p := buf
if len(c.writeBuf) > len(p) {
if len(c.writeBuf) > cap(p) {
p = c.writeBuf
}
p = p[:0]
Expand Down Expand Up @@ -353,7 +353,7 @@ type brNetConn struct {

func (b *brNetConn) Read(p []byte) (n int, err error) {
if b.br != nil {
// Limit read to buferred data.
// Limit read to buffered data.
if n := b.br.Buffered(); len(p) > n {
p = p[:n]
}
Expand Down
68 changes: 68 additions & 0 deletions server_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,71 @@ func TestHijack_NotSupported(t *testing.T) {
t.Fatalf("got err=%T and status_code=%d", err, recorder.Code)
}
}

func TestWriteBufferReuse(t *testing.T) {
// Test that Upgrader.Upgrade correctly reuses the hijacked write buffer
// from bufio.Writer.AvailableBuffer(). AvailableBuffer() returns a slice
// with len==0 and cap equal to the available buffer space, so the check
// must use cap(buf) instead of len(buf).

for _, tt := range []struct {
name string
bufSize int
wantReuse bool
}{
{"large enough buffer", 4096, true},
{"too small buffer", 128, false},
} {
t.Run(tt.name, func(t *testing.T) {
var writeBuf bytes.Buffer
br := bufio.NewReaderSize(strings.NewReader(""), tt.bufSize)
bw := bufio.NewWriterSize(&writeBuf, tt.bufSize)

// Get the AvailableBuffer to compare addresses later.
availBuf := bw.AvailableBuffer()
if len(availBuf) != 0 {
t.Fatalf("AvailableBuffer len=%d, want 0", len(availBuf))
}
if cap(availBuf) != tt.bufSize {
t.Fatalf("AvailableBuffer cap=%d, want %d", cap(availBuf), tt.bufSize)
}

brw := bufio.NewReadWriter(br, bw)
resp := &reuseTestResponseWriter{
brw: brw,
ResponseWriter: httptest.NewRecorder(),
}

upgrader := Upgrader{
CheckOrigin: func(r *http.Request) bool { return true },
}
c, err := upgrader.Upgrade(resp, &http.Request{
Method: http.MethodGet,
Header: http.Header{
"Upgrade": []string{"websocket"},
"Connection": []string{"upgrade"},
"Sec-Websocket-Key": []string{"dGhlIHNhbXBsZSBub25jZQ=="},
"Sec-Websocket-Version": []string{"13"},
},
}, nil)
if err != nil {
t.Fatalf("Upgrade: %v", err)
}
defer c.Close()

if tt.wantReuse {
// When the buffer is large enough, the connection write buffer
// should be backed by the same underlying array as the hijacked
// writer's AvailableBuffer.
if cap(availBuf) > 0 && len(c.writeBuf) > 0 && &c.writeBuf[0] != &availBuf[:cap(availBuf)][0] {
t.Error("write buffer was not reused from hijacked connection")
}
} else {
// When the buffer is too small, a new buffer should be allocated.
if cap(availBuf) > 0 && len(c.writeBuf) > 0 && &c.writeBuf[0] == &availBuf[:cap(availBuf)][0] {
t.Error("write buffer was unexpectedly reused from small hijacked buffer")
}
}
})
}
}