Fix OK payload parsing.

Server Session State Change information should only be read if CLIENT_SESSION_TRACK was set in the initial handshake. Fixes #603.

Author: bgrainger

src/MySqlConnector/Core/ResultSet.cs

@@ -45,7 +45,7 @@ public async Task<ResultSet> ReadResultSetHeaderAsync(IOBehavior ioBehavior)
 					var firstByte = payload.HeaderByte;
 					if (firstByte == OkPayload.Signature)
 					{
-						var ok = OkPayload.Create(payload.AsSpan());
+						var ok = OkPayload.Create(payload.AsSpan(), Session.SupportsDeprecateEof, Session.SupportsDeprecateEof);
 						RecordsAffected = (RecordsAffected ?? 0) + ok.AffectedRowCount;
 						LastInsertId = unchecked((long) ok.LastInsertId);
 						WarningCount = ok.WarningCount;
@@ -231,7 +231,7 @@ Row ScanRowAsyncRemainder(PayloadData payload, Row row_)
 					var span = payload.AsSpan();
 					if (Session.SupportsDeprecateEof && OkPayload.IsOk(span, Session.SupportsDeprecateEof))
 					{
-						var ok = OkPayload.Create(span, Session.SupportsDeprecateEof);
+						var ok = OkPayload.Create(span, Session.SupportsDeprecateEof, Session.SupportsSessionTrack);
 						BufferState = (ok.ServerStatus & ServerStatus.MoreResultsExist) == 0 ? ResultSetState.NoMoreData : ResultSetState.HasMoreData;
 						m_rowBuffered = null;
 						return null;

src/MySqlConnector/Core/ServerSession.cs

@@ -60,6 +60,7 @@ public ServerSession(ConnectionPool pool, int poolGeneration, int id)
 		public IPAddress IPAddress => (m_tcpClient?.Client.RemoteEndPoint as IPEndPoint)?.Address;
 		public WeakReference<MySqlConnection> OwningConnection { get; set; }
 		public bool SupportsDeprecateEof => m_supportsDeprecateEof;
+		public bool SupportsSessionTrack => m_supportsSessionTrack;
 		public bool ProcAccessDenied { get; set; }
 
 		public void ReturnToPool()
@@ -186,7 +187,7 @@ public void FinishQuerying()
 				var payload = QueryPayload.Create("DO SLEEP(0);");
 				SendAsync(payload, IOBehavior.Synchronous, CancellationToken.None).GetAwaiter().GetResult();
 				payload = ReceiveReplyAsync(IOBehavior.Synchronous, CancellationToken.None).GetAwaiter().GetResult();
-				OkPayload.Create(payload.AsSpan());
+				OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 			}
 
 			lock (m_lock)
@@ -310,12 +311,13 @@ public async Task ConnectAsync(ConnectionSettings cs, ILoadBalancer loadBalancer
 
 					m_supportsConnectionAttributes = (initialHandshake.ProtocolCapabilities & ProtocolCapabilities.ConnectionAttributes) != 0;
 					m_supportsDeprecateEof = (initialHandshake.ProtocolCapabilities & ProtocolCapabilities.DeprecateEof) != 0;
+					m_supportsSessionTrack = (initialHandshake.ProtocolCapabilities & ProtocolCapabilities.SessionTrack) != 0;
 					var serverSupportsSsl = (initialHandshake.ProtocolCapabilities & ProtocolCapabilities.Ssl) != 0;
 					m_characterSet = ServerVersion.Version >= ServerVersions.SupportsUtf8Mb4 ? CharacterSet.Utf8Mb4GeneralCaseInsensitive : CharacterSet.Utf8GeneralCaseInsensitive;
 
-					Log.Info("Session{0} made connection; ServerVersion={1}; ConnectionId={2}; Compression={3}; Attributes={4}; DeprecateEof={5}; Ssl={6}",
+					Log.Info("Session{0} made connection; ServerVersion={1}; ConnectionId={2}; Compression={3}; Attributes={4}; DeprecateEof={5}; Ssl={6}; SessionTrack={7}",
 						m_logArguments[0], ServerVersion.OriginalString, ConnectionId,
-						m_useCompression, m_supportsConnectionAttributes, m_supportsDeprecateEof, serverSupportsSsl);
+						m_useCompression, m_supportsConnectionAttributes, m_supportsDeprecateEof, serverSupportsSsl, m_supportsSessionTrack);
 
 					if (cs.SslMode != MySqlSslMode.None && (cs.SslMode != MySqlSslMode.Preferred || serverSupportsSsl))
 					{
@@ -363,7 +365,7 @@ public async Task ConnectAsync(ConnectionSettings cs, ILoadBalancer loadBalancer
 					payload = await SwitchAuthenticationAsync(cs, payload, ioBehavior, cancellationToken).ConfigureAwait(false);
 				}
 
-				OkPayload.Create(payload.AsSpan());
+				OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 
 				if (m_useCompression)
 					m_payloadHandler = new CompressedPayloadHandler(m_payloadHandler.ByteHandler);
@@ -398,12 +400,12 @@ public async Task<bool> TryResetConnectionAsync(ConnectionSettings cs, IOBehavio
 					Log.Debug("Session{0} ServerVersion={1} supports reset connection; sending reset connection request", m_logArguments);
 					await SendAsync(ResetConnectionPayload.Instance, ioBehavior, cancellationToken).ConfigureAwait(false);
 					var payload = await ReceiveReplyAsync(ioBehavior, cancellationToken).ConfigureAwait(false);
-					OkPayload.Create(payload.AsSpan());
+					OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 
 					// the "reset connection" packet also resets the connection charset, so we need to change that back to our default
 					await SendAsync(s_setNamesUtf8mb4Payload, ioBehavior, cancellationToken).ConfigureAwait(false);
 					payload = await ReceiveReplyAsync(ioBehavior, cancellationToken).ConfigureAwait(false);
-					OkPayload.Create(payload.AsSpan());
+					OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 				}
 				else
 				{
@@ -428,7 +430,7 @@ public async Task<bool> TryResetConnectionAsync(ConnectionSettings cs, IOBehavio
 						Log.Debug("Session{0} optimistic reauthentication failed; logging in again", m_logArguments);
 						payload = await SwitchAuthenticationAsync(cs, payload, ioBehavior, cancellationToken).ConfigureAwait(false);
 					}
-					OkPayload.Create(payload.AsSpan());
+					OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 				}
 
 				return true;
@@ -609,7 +611,7 @@ public async ValueTask<bool> TryPingAsync(IOBehavior ioBehavior, CancellationTok
 				Log.Debug("Session{0} pinging server", m_logArguments);
 				await SendAsync(PingPayload.Instance, ioBehavior, cancellationToken).ConfigureAwait(false);
 				var payload = await ReceiveReplyAsync(ioBehavior, cancellationToken).ConfigureAwait(false);
-				OkPayload.Create(payload.AsSpan());
+				OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 				Log.Info("Session{0} successfully pinged server", m_logArguments);
 				return true;
 			}
@@ -1163,7 +1165,7 @@ void ReadRow(ReadOnlySpan<byte> span, out int? connectionId_, out string serverV
 				// OK/EOF payload
 				payload = await ReceiveReplyAsync(ioBehavior, CancellationToken.None).ConfigureAwait(false);
 				if (OkPayload.IsOk(payload.AsSpan(), SupportsDeprecateEof))
-					OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof);
+					OkPayload.Create(payload.AsSpan(), SupportsDeprecateEof, SupportsSessionTrack);
 				else
 					EofPayload.Create(payload.AsSpan());
 
@@ -1410,6 +1412,7 @@ private enum State
 		bool m_isSecureConnection;
 		bool m_supportsConnectionAttributes;
 		bool m_supportsDeprecateEof;
+		bool m_supportsSessionTrack;
 		CharacterSet m_characterSet;
 		Dictionary<string, PreparedStatements> m_preparedStatements;
 	}

src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnection.cs

@@ -188,7 +188,7 @@ private async Task ChangeDatabaseAsync(IOBehavior ioBehavior, string databaseNam
 			using (var initDatabasePayload = InitDatabasePayload.Create(databaseName))
 				await m_session.SendAsync(initDatabasePayload, ioBehavior, cancellationToken).ConfigureAwait(false);
 			var payload = await m_session.ReceiveReplyAsync(ioBehavior, cancellationToken).ConfigureAwait(false);
-			OkPayload.Create(payload.AsSpan());
+			OkPayload.Create(payload.AsSpan(), m_session.SupportsDeprecateEof, m_session.SupportsSessionTrack);
 			m_session.DatabaseOverride = databaseName;
 		}
 

src/MySqlConnector/Protocol/Payloads/OkPayload.cs

@@ -16,7 +16,7 @@ internal sealed class OkPayload
 		public const byte Signature = 0x00;
 
 		/* See
-		 * http://web.archive.org/web/20160604101747/http://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
+		 * https://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
 		 * https://mariadb.com/kb/en/the-mariadb-library/resultset/
 		 * https://github.com/MariaDB/mariadb-connector-j/blob/5fa814ac6e1b4c9cb6d141bd221cbd5fc45c8a78/src/main/java/org/mariadb/jdbc/internal/com/read/resultset/SelectResultSet.java#L443-L444
 		 */
@@ -25,9 +25,7 @@ public static bool IsOk(ReadOnlySpan<byte> span, bool deprecateEof) =>
 				(span.Length > 6 && span[0] == Signature ||
 				 deprecateEof && span.Length < 0xFF_FFFF && span[0] == EofPayload.Signature);
 
-		public static OkPayload Create(ReadOnlySpan<byte> span) => Create(span, false);
-
-		public static OkPayload Create(ReadOnlySpan<byte> span, bool deprecateEof)
+		public static OkPayload Create(ReadOnlySpan<byte> span, bool deprecateEof, bool clientSessionTrack)
 		{
 			var reader = new ByteArrayReader(span);
 			var signature = reader.ReadByte();
@@ -39,7 +37,7 @@ public static OkPayload Create(ReadOnlySpan<byte> span, bool deprecateEof)
 			var warningCount = (int) reader.ReadUInt16();
 			string newSchema = null;
 
-			if ((serverStatus & ServerStatus.SessionStateChanged) == ServerStatus.SessionStateChanged)
+			if (clientSessionTrack && (serverStatus & ServerStatus.SessionStateChanged) == ServerStatus.SessionStateChanged)
 			{
 				reader.ReadLengthEncodedByteString(); // human-readable info