Reword end-of-stream message to be more generic. Fixes #1383

Introduce MySqlEndOfStreamException which holds the expected and read byte counts; these are logged as an error and a more generic exception message is thrown.

Author: bgrainger

src/MySqlConnector/Core/ServerSession.cs

@@ -925,6 +925,8 @@ public async ValueTask<PayloadData> ReceiveReplyAsync(IOBehavior ioBehavior, Can
 		}
 		catch (Exception ex)
 		{
+			if (ex is MySqlEndOfStreamException endOfStream)
+				Log.ExpectedToReadMoreBytes(m_logger, Id, endOfStream.ExpectedByteCount, endOfStream.ReadByteCount);
 			SetFailed(ex);
 			throw;
 		}

src/MySqlConnector/Logging/EventIds.cs

@@ -22,6 +22,7 @@ internal static class EventIds
 	public const int FailedInSendReplyAsync = 2007;
 	public const int FailedInReceiveReplyAsync = 2008;
 	public const int SettingStateToFailed = 2009;
+	public const int ExpectedToReadMoreBytes = 2010;
 	public const int ExpectedSessionState1 = 2011;
 	public const int ExpectedSessionState6 = 2016;
 

src/MySqlConnector/Logging/Log.cs

@@ -282,6 +282,9 @@ internal static partial class Log
 	[LoggerMessage(EventIds.SettingStateToFailed, LogLevel.Debug, "Session {SessionId} setting state to Failed")]
 	public static partial void SettingStateToFailed(ILogger logger, Exception exception, string sessionId);
 
+	[LoggerMessage(EventIds.ExpectedToReadMoreBytes, LogLevel.Error, "Session {SessionId} expected to read {ExpectedByteCount} bytes but only read {ReadByteCount}")]
+	public static partial void ExpectedToReadMoreBytes(ILogger logger, string sessionId, int expectedByteCount, int readByteCount);
+
 	[LoggerMessage(EventIds.ErrorPayload, LogLevel.Debug, "Session {SessionId} got error payload: {ErrorCode}, {State}, {Message}")]
 	public static partial void ErrorPayload(ILogger logger, string sessionId, int errorCode, string state, string message);
 

src/MySqlConnector/MySqlEndOfStreamException.cs

@@ -0,0 +1,15 @@
+namespace MySqlConnector;
+
+[Serializable]
+public sealed class MySqlEndOfStreamException : EndOfStreamException
+{
+	internal MySqlEndOfStreamException(int expectedByteCount, int readByteCount)
+		: base("An incomplete response was received from the server")
+	{
+		ExpectedByteCount = expectedByteCount;
+		ReadByteCount = readByteCount;
+	}
+
+	public int ExpectedByteCount { get; }
+	public int ReadByteCount { get; }
+}

src/MySqlConnector/Protocol/Serialization/CompressedPayloadHandler.cs

@@ -130,7 +130,8 @@ private async ValueTask<int> ReadBytesAsync(Memory<byte> buffer, ProtocolErrorBe
 			} while (bytesRead > 0);
 #endif
 			if (totalBytesRead != uncompressedLength && protocolErrorBehavior == ProtocolErrorBehavior.Throw)
-				throw new InvalidOperationException($"Expected to read {uncompressedLength:d} uncompressed bytes but only read {totalBytesRead:d}");
+				throw new MySqlEndOfStreamException(uncompressedLength, totalBytesRead);
+
 			m_remainingData = new(uncompressedData, 0, totalBytesRead);
 #else
 			// check CMF (Compression Method and Flags) and FLG (Flags) bytes for expected values
@@ -160,7 +161,7 @@ private async ValueTask<int> ReadBytesAsync(Memory<byte> buffer, ProtocolErrorBe
 				totalBytesRead += bytesRead;
 			} while (bytesRead > 0);
 			if (totalBytesRead != uncompressedLength && protocolErrorBehavior == ProtocolErrorBehavior.Throw)
-				throw new InvalidOperationException($"Expected to read {uncompressedLength:d} uncompressed bytes but only read {totalBytesRead:d}");
+				throw new MySqlEndOfStreamException(uncompressedLength, totalBytesRead);
 			m_remainingData = new(uncompressedData, 0, totalBytesRead);
 
 			var checksum = Adler32.Calculate(uncompressedData.AsSpan(0, totalBytesRead));

src/MySqlConnector/Protocol/Serialization/ProtocolUtility.cs

@@ -422,7 +422,7 @@ public static async ValueTask<ArraySegment<byte>> ReadPayloadAsync(BufferedByteR
 			if (headerBytes.Count < 4)
 			{
 				return protocolErrorBehavior == ProtocolErrorBehavior.Ignore ? default :
-					throw new EndOfStreamException($"Expected to read 4 header bytes but only received {headerBytes.Count:d}.");
+					throw new MySqlEndOfStreamException(4, headerBytes.Count);
 			}
 
 			// read values from the header before the memory is potentially overwritten by ReadBytesAsync
@@ -450,7 +450,7 @@ public static async ValueTask<ArraySegment<byte>> ReadPayloadAsync(BufferedByteR
 			else
 			{
 				packet = payloadBytes.Count >= payloadLength ? new(payloadBytes) :
-					protocolErrorBehavior == ProtocolErrorBehavior.Throw ? throw new EndOfStreamException($"Expected to read {payloadLength:d} payload bytes but only received {payloadBytes.Count:d}.") :
+					protocolErrorBehavior == ProtocolErrorBehavior.Throw ? throw new MySqlEndOfStreamException(payloadLength, payloadBytes.Count) :
 					default;
 			}