From 565721b2bf7363d08bad63c6fa5164e366104f32 Mon Sep 17 00:00:00 2001 From: Eli Pozniansky Date: Tue, 16 Jun 2020 10:03:01 -0700 Subject: [PATCH 1/5] Added support for TrackReceivedGtids --- AUTHORS | 1 + connection.go | 1 + const.go | 7 +++++++ dsn.go | 1 + packets.go | 45 ++++++++++++++++++++++++++++++++++++++------- 5 files changed, 48 insertions(+), 7 deletions(-) diff --git a/AUTHORS b/AUTHORS index 8ba3db6b3..a8b94a0d8 100644 --- a/AUTHORS +++ b/AUTHORS @@ -31,6 +31,7 @@ Daniël van Eeden Dave Protasowski DisposaBoy Egor Smolyakov +Eli Pozniansky Erwan Martin Evan Shaw Frederick Mayle diff --git a/connection.go b/connection.go index d1d8b29fe..660003efa 100644 --- a/connection.go +++ b/connection.go @@ -26,6 +26,7 @@ type mysqlConn struct { rawConn net.Conn // underlying connection when netConn is TLS connection. affectedRows uint64 insertId uint64 + recvGtids string cfg *Config maxAllowedPacket int maxWriteSize int diff --git a/const.go b/const.go index b1e6b85ef..075de7c95 100644 --- a/const.go +++ b/const.go @@ -172,3 +172,10 @@ const ( cachingSha2PasswordFastAuthSuccess = 3 cachingSha2PasswordPerformFullAuthentication = 4 ) + +const ( + sessionTrackSystemVariables = 0 + sessionTrackSchema = 1 + sessionTrackStateChange = 2 + sessionTrackGtids = 3 +) \ No newline at end of file diff --git a/dsn.go b/dsn.go index 93f3548cb..8a0d1ef6f 100644 --- a/dsn.go +++ b/dsn.go @@ -62,6 +62,7 @@ type Config struct { MultiStatements bool // Allow multiple statements in one query ParseTime bool // Parse time values to time.Time RejectReadOnly bool // Reject read-only connections + TrackReceivedGtids bool // Track received gtids } // NewConfig creates a new Config and sets default values. diff --git a/packets.go b/packets.go index 8e2f5e76f..bbbc50c96 100644 --- a/packets.go +++ b/packets.go @@ -301,6 +301,10 @@ func (mc *mysqlConn) writeHandshakeResponsePacket(authResp []byte, plugin string clientFlags |= clientMultiStatements } + if mc.cfg.TrackReceivedGtids { + clientFlags |= clientSessionTrack + } + // encode length of the auth plugin data var authRespLEIBuf [9]byte authRespLen := len(authResp) @@ -610,23 +614,50 @@ func readStatus(b []byte) statusFlag { // Ok Packet // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-OK_Packet func (mc *mysqlConn) handleOkPacket(data []byte) error { - var n, m int + var c, n int // 0x00 [1 byte] + c = 1 // Affected rows [Length Coded Binary] - mc.affectedRows, _, n = readLengthEncodedInteger(data[1:]) + mc.affectedRows, _, n = readLengthEncodedInteger(data[c:]) + c += n // Insert id [Length Coded Binary] - mc.insertId, _, m = readLengthEncodedInteger(data[1+n:]) + mc.insertId, _, n = readLengthEncodedInteger(data[c:]) + c += n // server_status [2 bytes] - mc.status = readStatus(data[1+n+m : 1+n+m+2]) - if mc.status&statusMoreResultsExists != 0 { - return nil - } + mc.status = readStatus(data[c : c+2]) + c += 2 // warning count [2 bytes] + c += 2 + + if mc.flags&clientSessionTrack != 0 && mc.status&statusSessionStateChanged != 0 { + // Human readable status information + num, _, n := readLengthEncodedInteger(data[c:]) + if num < 1 { + return io.EOF + } + c += n + int(num) + + for t := 0; t < int(num); { + infoType := data[c] + c += 1 + m, _, n := readLengthEncodedInteger(data[c:]) + if m < 1 { + return io.EOF + } + c += n + + if infoType == sessionTrackGtids { + mc.recvGtids = string(data[c : c+int(m)]) + } + c += int(m) + t += 1 + n + int(m) + } + } return nil } From aaedc7a1d399ab0ded432bcdafefb4596087c26e Mon Sep 17 00:00:00 2001 From: Eli Pozniansky Date: Tue, 16 Jun 2020 11:30:40 -0700 Subject: [PATCH 2/5] Fix go-fmt --- const.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/const.go b/const.go index 075de7c95..3300c3f61 100644 --- a/const.go +++ b/const.go @@ -178,4 +178,4 @@ const ( sessionTrackSchema = 1 sessionTrackStateChange = 2 sessionTrackGtids = 3 -) \ No newline at end of file +) From 353b4561d7dabba063da6169962423fe129248b0 Mon Sep 17 00:00:00 2001 From: Eli Pozniansky Date: Tue, 16 Jun 2020 13:29:12 -0700 Subject: [PATCH 3/5] Added TestReadOkPacketWithTrackReceivedGtids test --- packets.go | 11 ++++++++++- packets_test.go | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 55 insertions(+), 3 deletions(-) diff --git a/packets.go b/packets.go index bbbc50c96..ff6895fa0 100644 --- a/packets.go +++ b/packets.go @@ -634,14 +634,22 @@ func (mc *mysqlConn) handleOkPacket(data []byte) error { // warning count [2 bytes] c += 2 + mc.recvGtids = "" + if mc.flags&clientSessionTrack != 0 && mc.status&statusSessionStateChanged != 0 { - // Human readable status information + // Human readable status information (ignored) num, _, n := readLengthEncodedInteger(data[c:]) if num < 1 { return io.EOF } c += n + int(num) + // Length of session state changes + num, _, n = readLengthEncodedInteger(data[c:]) + if num < 1 { + return io.EOF + } + c += n for t := 0; t < int(num); { infoType := data[c] c += 1 @@ -653,6 +661,7 @@ func (mc *mysqlConn) handleOkPacket(data []byte) error { if infoType == sessionTrackGtids { mc.recvGtids = string(data[c : c+int(m)]) + return nil } c += int(m) t += 1 + n + int(m) diff --git a/packets_test.go b/packets_test.go index b61e4dbf7..815cc39b9 100644 --- a/packets_test.go +++ b/packets_test.go @@ -179,7 +179,7 @@ func TestReadPacketSplit(t *testing.T) { data[4] = 0x11 data[maxPacketSize+3] = 0x22 - // 2nd packet has payload length 0 and squence id 1 + // 2nd packet has payload length 0 and sequence id 1 // 00 00 00 01 data[pkt2ofs+3] = 0x01 @@ -211,7 +211,7 @@ func TestReadPacketSplit(t *testing.T) { data[pkt2ofs+4] = 0x33 data[pkt2ofs+maxPacketSize+3] = 0x44 - // 3rd packet has payload length 0 and squence id 2 + // 3rd packet has payload length 0 and sequence id 2 // 00 00 00 02 data[pkt3ofs+3] = 0x02 @@ -334,3 +334,46 @@ func TestRegression801(t *testing.T) { t.Errorf("expected authData '%v', got '%v'", expectedAuthData, authData) } } + +func TestReadOkPacketWithTrackReceivedGtids(t *testing.T) { + conn := new(mockConn) + mc := &mysqlConn{ + buf: newBuffer(conn), + flags: clientSessionTrack, + } + + data := make([]byte, maxPacketSize) + + // 1st packet has maxPacketSize length and sequence id 0 + // ff ff ff 00 ... + data[0] = 0x00 + data[1] = 0x42 // affected rows + data[2] = 0x17 // insert id + data[3] = 0x00 // first byte of status + data[4] = byte(statusSessionStateChanged >> 8) // second byte of status + data[5] = 0x00 // warning count + data[6] = 0x00 // warning count + data[7] = 0x01 // Human readable status information length + data[8] = 0x00 // Human readable status information string + data[9] = 0x0A // Length of session_state_changes + data[10] = 0x02 // SESSION_TRACK_STATE_CHANGE == 0x02 + data[11] = 0x02 // length + data[12] = 0x58 // 'X' + data[13] = 0x58 // 'X' + data[14] = 0x03 // SESSION_TRACK_GTIDS == 0x03 + data[15] = 0x04 // GTIDs length + data[16] = 0x47 // 'G' + data[17] = 0x54 // 'T' + data[18] = 0x49 // 'I' + data[19] = 0x44 // 'D' + + conn.data = data + err := mc.handleOkPacket(data) + if err != nil { + t.Fatalf("got error: %v", err) + } + + if mc.recvGtids != "GTID" { + t.Fatalf("could not parse GTIDs from session tracking. got: %v", mc.recvGtids) + } +} From 1d9d4b57aa7f795a8649c0300da967efdf93a3ce Mon Sep 17 00:00:00 2001 From: Eli Pozniansky Date: Tue, 16 Jun 2020 13:31:58 -0700 Subject: [PATCH 4/5] comment fixes --- packets_test.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packets_test.go b/packets_test.go index 815cc39b9..267e3251e 100644 --- a/packets_test.go +++ b/packets_test.go @@ -344,8 +344,7 @@ func TestReadOkPacketWithTrackReceivedGtids(t *testing.T) { data := make([]byte, maxPacketSize) - // 1st packet has maxPacketSize length and sequence id 0 - // ff ff ff 00 ... + // https://dev.mysql.com/doc/internals/en/packet-OK_Packet.html data[0] = 0x00 data[1] = 0x42 // affected rows data[2] = 0x17 // insert id From f9847d5e22b2a6222225cb0b005d11f0c4cadf03 Mon Sep 17 00:00:00 2001 From: Eli Pozniansky Date: Tue, 16 Jun 2020 14:17:23 -0700 Subject: [PATCH 5/5] Extend tests to check failures --- packets_test.go | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/packets_test.go b/packets_test.go index 267e3251e..8b432eb20 100644 --- a/packets_test.go +++ b/packets_test.go @@ -11,6 +11,7 @@ package mysql import ( "bytes" "errors" + "io" "net" "testing" "time" @@ -343,6 +344,7 @@ func TestReadOkPacketWithTrackReceivedGtids(t *testing.T) { } data := make([]byte, maxPacketSize) + conn.data = data // https://dev.mysql.com/doc/internals/en/packet-OK_Packet.html data[0] = 0x00 @@ -366,8 +368,38 @@ func TestReadOkPacketWithTrackReceivedGtids(t *testing.T) { data[18] = 0x49 // 'I' data[19] = 0x44 // 'D' + // Error 1 + saved := data[7] + data[7] = 0x00 conn.data = data err := mc.handleOkPacket(data) + if err != io.EOF { + t.Fatalf("got error: %v", err) + } + data[7] = saved + + // Error 2 + saved = data[9] + data[9] = 0x00 + conn.data = data + err = mc.handleOkPacket(data) + if err != io.EOF { + t.Fatalf("got error: %v", err) + } + data[9] = saved + + // Error 3 + saved = data[11] + data[11] = 0x00 + conn.data = data + err = mc.handleOkPacket(data) + if err != io.EOF { + t.Fatalf("got error: %v", err) + } + data[11] = saved + + // Success + err = mc.handleOkPacket(data) if err != nil { t.Fatalf("got error: %v", err) }