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

allow packet.Conn buffer size to be adjustable #892

Merged
merged 1 commit into from
Jun 23, 2024
Merged

allow packet.Conn buffer size to be adjustable #892

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion client/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ func (c *Conn) writeAuthHandshake() error {
}

currentSequence := c.Sequence
c.Conn = packet.NewConn(tlsConn)
c.Conn = packet.NewBufferedConn(tlsConn, c.BufferSize)
c.Sequence = currentSequence
}

Expand Down
8 changes: 7 additions & 1 deletion client/conn.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import (
"github.com/go-mysql-org/go-mysql/utils"
)

const defaultBufferSize = 65536 // 64kb

type Option func(*Conn) error

type Conn struct {
Expand All @@ -33,6 +35,9 @@ type Conn struct {
ReadTimeout time.Duration
WriteTimeout time.Duration

// The buffer size to use in the packet connection
BufferSize int

serverVersion string
// server capabilities
capability uint32
Expand Down Expand Up @@ -94,6 +99,7 @@ type Dialer func(ctx context.Context, network, address string) (net.Conn, error)
func ConnectWithDialer(ctx context.Context, network, addr, user, password, dbName string, dialer Dialer, options ...Option) (*Conn, error) {
c := new(Conn)

c.BufferSize = defaultBufferSize
Copy link
Contributor Author

Choose a reason for hiding this comment

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

init the new packet Conn with the 64kb buffer size

c.attributes = map[string]string{
"_client_name": "go-mysql",
// "_client_version": "0.1",
Expand Down Expand Up @@ -129,7 +135,7 @@ func ConnectWithDialer(ctx context.Context, network, addr, user, password, dbNam
}
}

c.Conn = packet.NewConnWithTimeout(conn, c.ReadTimeout, c.WriteTimeout)
c.Conn = packet.NewConnWithTimeout(conn, c.ReadTimeout, c.WriteTimeout, c.BufferSize)
if c.tlsConfig != nil {
seq := c.Conn.Sequence
c.Conn = packet.NewTLSConnWithTimeout(conn, c.ReadTimeout, c.WriteTimeout)
Expand Down
24 changes: 24 additions & 0 deletions driver/driver_options_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"math"
"net"
"reflect"
"strconv"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -73,6 +74,29 @@ func TestDriverOptions_ConnectTimeout(t *testing.T) {
conn.Close()
}

func TestDriverOptions_BufferSize(t *testing.T) {
log.SetLevel(log.LevelDebug)
srv := CreateMockServer(t)
defer srv.Stop()

SetDSNOptions(map[string]DriverOption{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

our application is already using SetDSNOptions so we're planning on using the same technique for the BufferSize. I didn't want to add more configuration to the public README of this project because I felt that the default for most people is probably fine and therefore no need to add more configuration options.

"bufferSize": func(c *client.Conn, value string) error {
var err error
c.BufferSize, err = strconv.Atoi(value)
return err
},
})

conn, err := sql.Open("mysql", "[email protected]:3307/test?bufferSize=4096")
require.NoError(t, err)

rows, err := conn.QueryContext(context.TODO(), "select * from table;")
require.NotNil(t, rows)
require.NoError(t, err)

conn.Close()
}

func TestDriverOptions_ReadTimeout(t *testing.T) {
log.SetLevel(log.LevelDebug)
srv := CreateMockServer(t)
Expand Down
10 changes: 7 additions & 3 deletions packet/conn.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,23 @@ type Conn struct {
}

func NewConn(conn net.Conn) *Conn {
return NewBufferedConn(conn, 65536) // 64kb
Copy link
Contributor Author

@dvilaverde dvilaverde Jun 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

keeping this NewConn function for compatibility reasons. As of now just the server code and most unit tests use this. The client code will be using NewBufferedConn.

}

func NewBufferedConn(conn net.Conn, bufferSize int) *Conn {
c := new(Conn)
c.Conn = conn

c.br = bufio.NewReaderSize(c, 65536) // 64kb
c.br = bufio.NewReaderSize(c, bufferSize)
c.reader = c.br

c.copyNBuf = make([]byte, DefaultBufferSize)

return c
}

func NewConnWithTimeout(conn net.Conn, readTimeout, writeTimeout time.Duration) *Conn {
c := NewConn(conn)
func NewConnWithTimeout(conn net.Conn, readTimeout, writeTimeout time.Duration, bufferSize int) *Conn {
c := NewBufferedConn(conn, bufferSize)
c.readTimeout = readTimeout
c.writeTimeout = writeTimeout
return c
Expand Down