Add new undocumented option ReportUnreadMessageData to emit a diagnostic warning if data is left unread

src/Messaging/Messages/Distributed/DistributedBranchLevel.cs

@@ -59,6 +59,11 @@ public static DistributedBranchLevel FromByteArray(byte[] bytes)
 
             var level = reader.ReadInteger();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Distributed.BranchLevel)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new DistributedBranchLevel(level);
         }
 

src/Messaging/Messages/Distributed/DistributedBranchRoot.cs

@@ -59,6 +59,11 @@ public static DistributedBranchRoot FromByteArray(byte[] bytes)
 
             var username = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Distributed.BranchRoot)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new DistributedBranchRoot(username);
         }
 

src/Messaging/Messages/Distributed/DistributedChildDepth.cs

@@ -59,6 +59,11 @@ public static DistributedChildDepth FromByteArray(byte[] bytes)
 
             var depth = reader.ReadInteger();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Distributed.ChildDepth)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new DistributedChildDepth(depth);
         }
 

src/Messaging/Messages/Distributed/DistributedPingRequest.cs

@@ -50,6 +50,11 @@ public static DistributedPingRequest FromByteArray(byte[] bytes)
                 throw new MessageException($"Message Code mismatch creating {nameof(DistributedPingRequest)} (expected: {(int)MessageCode.Distributed.Ping}, received: {(int)code})");
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Distributed.Ping)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new DistributedPingRequest();
         }
 

src/Messaging/Messages/Distributed/DistributedPingResponse.cs

@@ -64,6 +64,11 @@ public static DistributedPingResponse FromByteArray(byte[] bytes)
                 token = reader.ReadInteger();
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Distributed.Ping)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new DistributedPingResponse(token);
         }
 

src/Messaging/Messages/Distributed/DistributedSearchRequest.cs

@@ -78,6 +78,11 @@ public static DistributedSearchRequest FromByteArray(byte[] bytes)
             var token = reader.ReadInteger();
             var query = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Distributed.SearchRequest)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new DistributedSearchRequest(username, token, query);
         }
 

src/Messaging/Messages/Initialization/PeerInit.cs

@@ -79,6 +79,11 @@ public static bool TryFromByteArray(byte[] bytes, out PeerInit response)
                 var transferType = reader.ReadString();
                 var token = reader.ReadInteger();
 
+                if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+                {
+                    Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Initialization.PeerInit)} finalized with {reader.Remaining} unread bytes");
+                }
+
                 response = new PeerInit(username, transferType, token);
                 return true;
             }

src/Messaging/Messages/Initialization/PierceFirewall.cs

@@ -63,6 +63,11 @@ public static bool TryFromByteArray(byte[] bytes, out PierceFirewall response)
 
                 var token = reader.ReadInteger();
 
+                if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+                {
+                    Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Initialization.PierceFirewall)} finalized with {reader.Remaining} unread bytes");
+                }
+
                 response = new PierceFirewall(token);
                 return true;
             }

src/Messaging/Messages/Peer/BrowseResponseFactory.cs

@@ -72,6 +72,11 @@ public static BrowseResponse FromByteArray(byte[] bytes)
                 }
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.BrowseResponse)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new BrowseResponse(directoryList, lockedDirectoryList);
         }
 

src/Messaging/Messages/Peer/FolderContentsRequest.cs

@@ -67,6 +67,11 @@ public static FolderContentsRequest FromByteArray(byte[] bytes)
             var token = reader.ReadInteger();
             var directoryName = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.FolderContentsRequest)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new FolderContentsRequest(token, directoryName);
         }
 

src/Messaging/Messages/Peer/FolderContentsResponse.cs

@@ -94,6 +94,11 @@ public static FolderContentsResponse FromByteArray(byte[] bytes)
                 directoryList.Add(reader.ReadDirectory());
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.FolderContentsResponse)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new FolderContentsResponse(token, rootDirectory, directoryList);
         }
 

src/Messaging/Messages/Peer/PeerSearchRequest.cs

@@ -67,6 +67,11 @@ public static PeerSearchRequest FromByteArray(byte[] bytes)
             var token = reader.ReadInteger();
             var query = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.SearchRequest)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new PeerSearchRequest(token, query);
         }
     }

src/Messaging/Messages/Peer/PlaceInQueueRequest.cs

@@ -59,6 +59,11 @@ public static PlaceInQueueRequest FromByteArray(byte[] bytes)
 
             var filename = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.PlaceInQueueRequest)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new PlaceInQueueRequest(filename);
         }
 

src/Messaging/Messages/Peer/PlaceInQueueResponse.cs

@@ -67,6 +67,11 @@ public static PlaceInQueueResponse FromByteArray(byte[] bytes)
             var filename = reader.ReadString();
             var placeInQueue = reader.ReadInteger();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.PlaceInQueueResponse)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new PlaceInQueueResponse(filename, placeInQueue);
         }
 

src/Messaging/Messages/Peer/QueueDownloadRequest.cs

@@ -58,6 +58,12 @@ public static QueueDownloadRequest FromByteArray(byte[] bytes)
             }
 
             var filename = reader.ReadString();
+
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.QueueDownload)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new QueueDownloadRequest(filename);
         }
 

src/Messaging/Messages/Peer/SearchResponseFactory.cs

@@ -73,6 +73,11 @@ public static SearchResponse FromByteArray(byte[] bytes)
                 lockedFileList = reader.ReadFiles(count);
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.SearchResponse)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new SearchResponse(username, token, hasFreeUploadSlot: freeUploadSlots > 0, uploadSpeed, queueLength, fileList, lockedFileList);
         }
 

src/Messaging/Messages/Peer/TransferRequest.cs

@@ -89,6 +89,11 @@ public static TransferRequest FromByteArray(byte[] bytes)
                 fileSize = reader.ReadLong();
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.TransferRequest)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new TransferRequest(direction, token, filename, fileSize);
         }
 

src/Messaging/Messages/Peer/TransferResponse.cs

@@ -100,18 +100,29 @@ public static TransferResponse FromByteArray(byte[] bytes)
             var token = reader.ReadInteger();
             var allowed = reader.ReadByte() == 1;
 
+            TransferResponse response;
+
             if (allowed && reader.HasMoreData)
             {
                 var fileSize = reader.ReadLong();
-                return new TransferResponse(token, fileSize);
+                response = new TransferResponse(token, fileSize);
             }
             else if (!allowed)
             {
                 var msg = reader.ReadString();
-                return new TransferResponse(token, msg);
+                response = new TransferResponse(token, msg);
+            }
+            else
+            {
+                response = new TransferResponse(token);
+            }
+
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.TransferResponse)} finalized with {reader.Remaining} unread bytes");
             }
 
-            return new TransferResponse(token);
+            return response;
         }
 
         /// <summary>

src/Messaging/Messages/Peer/UploadDenied.cs

@@ -67,6 +67,11 @@ public static UploadDenied FromByteArray(byte[] bytes)
             var filename = reader.ReadString();
             var msg = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.UploadDenied)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new UploadDenied(filename, msg);
         }
 

src/Messaging/Messages/Peer/UploadFailed.cs

@@ -59,6 +59,11 @@ public static UploadFailed FromByteArray(byte[] bytes)
 
             var filename = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.UploadFailed)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new UploadFailed(filename);
         }
 

src/Messaging/Messages/Peer/UserInfoResponseFactory.cs

@@ -21,10 +21,8 @@
 //     SPDX-License-Identifier: GPL-3.0-only
 // </copyright>
 
-namespace Soulseek
+namespace Soulseek.Messaging.Messages
 {
-    using Soulseek.Messaging;
-
     /// <summary>
     ///     The response to a user info request.
     /// </summary>
@@ -59,6 +57,11 @@ public static UserInfo FromByteArray(byte[] bytes)
             var queueLength = reader.ReadInteger();
             var hasFreeUploadSlot = reader.ReadByte() > 0;
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Peer.InfoResponse)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new UserInfo(description, uploadSlots, queueLength, hasFreeUploadSlot, picture);
         }
 

src/Messaging/Messages/Server/CannotConnect.cs

@@ -73,6 +73,11 @@ public static CannotConnect FromByteArray(byte[] bytes)
                 username = reader.ReadString();
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.CannotConnect)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new CannotConnect(token, username);
         }
 

src/Messaging/Messages/Server/CannotJoinRoomNotification.cs

@@ -59,6 +59,11 @@ public static CannotJoinRoomNotification FromByteArray(byte[] bytes)
 
             var roomName = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.CannotJoinRoom)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new CannotJoinRoomNotification(roomName);
         }
     }

src/Messaging/Messages/Server/ConnectToPeerResponse.cs

@@ -126,6 +126,11 @@ public static ConnectToPeerResponse FromByteArray(byte[] bytes)
             var token = reader.ReadInteger();
             var isPrivileged = reader.ReadByte() > 0;
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.ConnectToPeer)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new ConnectToPeerResponse(username, type, ipAddress, port, token, isPrivileged);
         }
     }

src/Messaging/Messages/Server/ExcludedSearchPhrasesNotification.cs

@@ -53,6 +53,11 @@ public static IReadOnlyCollection<string> FromByteArray(byte[] bytes)
                 list.Add(reader.ReadString());
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.ExcludedSearchPhrases)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return list.AsReadOnly();
         }
     }

src/Messaging/Messages/Server/GlobalMessageNotification.cs

@@ -45,6 +45,11 @@ public static string FromByteArray(byte[] bytes)
 
             var msg = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.GlobalAdminMessage)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return msg;
         }
     }

src/Messaging/Messages/Server/IntegerResponse.cs

@@ -41,7 +41,14 @@ public static int FromByteArray<T>(byte[] bytes)
             where T : Enum
         {
             var reader = new MessageReader<T>(bytes);
-            return reader.ReadInteger();
+            var value = reader.ReadInteger();
+
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {reader.ReadCode()} finalized with {reader.Remaining} unread bytes");
+            }
+
+            return value;
         }
     }
 }

src/Messaging/Messages/Server/JoinRoomResponse.cs

@@ -121,6 +121,11 @@ internal static RoomData FromByteArray(byte[] bytes)
                 }
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.JoinRoom)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new RoomData(roomName, users, owner != null, owner, operatorList);
         }
     }

src/Messaging/Messages/Server/LeaveRoomResponse.cs

@@ -59,6 +59,11 @@ public static LeaveRoomResponse FromByteArray(byte[] bytes)
 
             var roomName = reader.ReadString();
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.LeaveRoom)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new LeaveRoomResponse(roomName);
         }
     }

src/Messaging/Messages/Server/LoginResponse.cs

@@ -114,6 +114,11 @@ public static LoginResponse FromByteArray(byte[] bytes)
                 msg += string.IsNullOrWhiteSpace(detail) ? string.Empty : ": " + detail;
             }
 
+            if (SoulseekClient.ReportUnreadMessageData && reader.HasMoreData)
+            {
+                Diagnostics.GlobalDiagnostic.Warning($"Message reader for {nameof(MessageCode.Server.Login)} finalized with {reader.Remaining} unread bytes");
+            }
+
             return new LoginResponse(succeeded, msg, ipAddress, hash, isSupporter);
         }
     }