Implement CLIENT_DEPRECATE_EOF. Fixes #322

Author: bgrainger

src/MySqlConnector/MySqlClient/Results/ResultSet.cs

@@ -92,8 +92,11 @@ public async Task<ResultSet> ReadResultSetHeaderAsync(IOBehavior ioBehavior)
 							ColumnDefinitions[column] = ColumnDefinitionPayload.Create(payload);
 						}
 
-						payload = await Session.ReceiveReplyAsync(ioBehavior, CancellationToken.None).ConfigureAwait(false);
-						EofPayload.Create(payload);
+						if (!Session.SupportsDeprecateEof)
+						{
+							payload = await Session.ReceiveReplyAsync(ioBehavior, CancellationToken.None).ConfigureAwait(false);
+							EofPayload.Create(payload);
+						}
 
 						LastInsertId = -1;
 						State = ResultSetState.ReadResultSetHeader;
@@ -192,12 +195,22 @@ async Task<Row> ScanRowAsyncAwaited(Task<PayloadData> payloadTask, CancellationT
 
 			Row ScanRowAsyncRemainder(PayloadData payload)
 			{
-				if (EofPayload.IsEof(payload))
+				if (payload.HeaderByte == EofPayload.Signature)
 				{
-					var eof = EofPayload.Create(payload);
-					BufferState = (eof.ServerStatus & ServerStatus.MoreResultsExist) == 0 ? ResultSetState.NoMoreData : ResultSetState.HasMoreData;
-					m_rowBuffered = null;
-					return null;
+					if (Session.SupportsDeprecateEof && OkPayload.IsOk(payload, Session.SupportsDeprecateEof))
+					{
+						var ok = OkPayload.Create(payload, Session.SupportsDeprecateEof);
+						BufferState = (ok.ServerStatus & ServerStatus.MoreResultsExist) == 0 ? ResultSetState.NoMoreData : ResultSetState.HasMoreData;
+						m_rowBuffered = null;
+						return null;
+					}
+					if (!Session.SupportsDeprecateEof && EofPayload.IsEof(payload))
+					{
+						var eof = EofPayload.Create(payload);
+						BufferState = (eof.ServerStatus & ServerStatus.MoreResultsExist) == 0 ? ResultSetState.NoMoreData : ResultSetState.HasMoreData;
+						m_rowBuffered = null;
+						return null;
+					}
 				}
 
 				var reader = new ByteArrayReader(payload.ArraySegment);

src/MySqlConnector/Serialization/EofPayload.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace MySql.Data.Serialization
 {
@@ -32,7 +32,7 @@ public static EofPayload Create(PayloadData payload)
 		public static bool IsEof(PayloadData payload) =>
 			payload.ArraySegment.Count > 0 && payload.ArraySegment.Count < 9 && payload.ArraySegment.Array[payload.ArraySegment.Offset] == Signature;
 
-		private const byte Signature = 0xFE;
+		public const byte Signature = 0xFE;
 
 		private EofPayload(int warningCount, ServerStatus status)
 		{

src/MySqlConnector/Serialization/HandshakeResponse41Packet.cs

@@ -1,4 +1,4 @@
-namespace MySql.Data.Serialization
+namespace MySql.Data.Serialization
 {
 	internal sealed class HandshakeResponse41Packet
 	{
@@ -20,6 +20,7 @@ private static PayloadWriter CreateCapabilitiesPayload(ProtocolCapabilities serv
 				(cs.UseAffectedRows ? 0 : ProtocolCapabilities.FoundRows) |
 				(useCompression ? ProtocolCapabilities.Compress : ProtocolCapabilities.None) |
 				(serverCapabilities & ProtocolCapabilities.ConnectionAttributes) |
+				(serverCapabilities & ProtocolCapabilities.DeprecateEof) |
 				additionalCapabilities));
 			writer.WriteInt32(0x4000_0000);
 			writer.WriteByte((byte) CharacterSet.Utf8Mb4Binary);

src/MySqlConnector/Serialization/MySqlSession.cs

@@ -46,6 +46,7 @@ public MySqlSession(ConnectionPool pool, int poolGeneration, int id)
 		public string DatabaseOverride { get; set; }
 		public IPAddress IPAddress => (m_tcpClient?.Client.RemoteEndPoint as IPEndPoint)?.Address;
 		public WeakReference<MySqlConnection> OwningConnection { get; set; }
+		public bool SupportsDeprecateEof => m_supportsDeprecateEof;
 
 		public void ReturnToPool()
 		{
@@ -236,6 +237,8 @@ public async Task ConnectAsync(ConnectionSettings cs, IOBehavior ioBehavior, Can
 			if (m_supportsConnectionAttributes && s_connectionAttributes == null)
 				s_connectionAttributes = CreateConnectionAttributes();
 
+			m_supportsDeprecateEof = (initialHandshake.ProtocolCapabilities & ProtocolCapabilities.DeprecateEof) != 0;
+
 			var response = HandshakeResponse41Packet.Create(initialHandshake, cs, m_useCompression, m_supportsConnectionAttributes ? s_connectionAttributes : null);
 			payload = new PayloadData(new ArraySegment<byte>(response));
 			await SendReplyAsync(payload, ioBehavior, cancellationToken).ConfigureAwait(false);
@@ -896,5 +899,6 @@ private enum State
 		bool m_useCompression;
 		bool m_isSecureConnection;
 		bool m_supportsConnectionAttributes;
+		bool m_supportsDeprecateEof;
 	}
 }

src/MySqlConnector/Serialization/OkPayload.cs

@@ -1,4 +1,6 @@
-namespace MySql.Data.Serialization
+using System;
+
+namespace MySql.Data.Serialization
 {
 	internal sealed class OkPayload
 	{
@@ -9,10 +11,24 @@ internal sealed class OkPayload
 
 		public const byte Signature = 0x00;
 
-		public static OkPayload Create(PayloadData payload)
+		/* See
+		 * http://web.archive.org/web/20160604101747/http://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
+		 */
+		public static bool IsOk(PayloadData payload, bool deprecateEof) =>
+			payload.ArraySegment.Array != null && payload.ArraySegment.Count > 0 &&
+				((payload.ArraySegment.Count > 6 && payload.ArraySegment.Array[payload.ArraySegment.Offset] == Signature) ||
+				(deprecateEof && payload.ArraySegment.Count < 0xFF_FFFF && payload.ArraySegment.Array[payload.ArraySegment.Offset] == EofPayload.Signature));
+
+		public static OkPayload Create(PayloadData payload) => Create(payload, false);
+
+		public static OkPayload Create(PayloadData payload, bool deprecateEof)
 		{
 			var reader = new ByteArrayReader(payload.ArraySegment);
-			reader.ReadByte(Signature);
+			var signature = reader.ReadByte();
+			if (signature != Signature && (!deprecateEof || signature != EofPayload.Signature))
+				throw new FormatException("Expected to read 0x00 or 0xFE but got 0x{0:X2}".FormatInvariant(signature));
 			var affectedRowCount = checked((int) reader.ReadLengthEncodedInteger());
 			var lastInsertId = checked((long) reader.ReadLengthEncodedInteger());
 			var serverStatus = (ServerStatus) reader.ReadUInt16();