From 5b880eadd917d5af4c6f84bea3b1640d63a65722 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?=
 <fandabohacek@gmail.com>
Date: Sat, 22 Jan 2022 18:07:06 +0100
Subject: [PATCH] feat(packets)!: let the user add the default packet
 converters

---
 .../PacketTypesRepositoryExtensions.cs        | 42 +++++++++++++++++++
 .../Extensions/ServiceCollectionExtensions.cs | 19 +--------
 .../Packets/IPacketTypesRepository.cs         | 13 ++++++
 .../Packets/PacketTypesRepository.cs          | 28 +++++++++++--
 4 files changed, 81 insertions(+), 21 deletions(-)
 create mode 100644 Packets/NosSmooth.PacketSerializer/Extensions/PacketTypesRepositoryExtensions.cs

diff --git a/Packets/NosSmooth.PacketSerializer/Extensions/PacketTypesRepositoryExtensions.cs b/Packets/NosSmooth.PacketSerializer/Extensions/PacketTypesRepositoryExtensions.cs
new file mode 100644
index 0000000..3782ce2
--- /dev/null
+++ b/Packets/NosSmooth.PacketSerializer/Extensions/PacketTypesRepositoryExtensions.cs
@@ -0,0 +1,42 @@
+//
+//  PacketTypesRepositoryExtensions.cs
+//
+//  Copyright (c) František Boháček. All rights reserved.
+//  Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Linq;
+using System.Reflection;
+using NosSmooth.Packets.Packets;
+using Remora.Results;
+
+namespace NosSmooth.Packets.Extensions;
+
+/// <summary>
+/// Extension methods for <see cref="IPacketTypesRepository"/>.
+/// </summary>
+public static class PacketTypesRepositoryExtensions
+{
+    /// <summary>
+    /// Add packets from the given assembly.
+    /// </summary>
+    /// <param name="packetTypesRepository">The packet types repository.</param>
+    /// <param name="assembly">The assembly to add packets from.</param>
+    /// <returns>A result that may or may not have succeeded.</returns>
+    public static Result AddPacketTypes(this IPacketTypesRepository packetTypesRepository, Assembly assembly)
+    {
+        var packetTypes = assembly
+            .GetExportedTypes()
+            .Where(x => x != typeof(UnresolvedPacket) && !x.IsAbstract && typeof(IPacket).IsAssignableFrom(x));
+        return packetTypesRepository.AddPacketTypes(packetTypes);
+    }
+
+    /// <summary>
+    /// Adds the default NosSmooth packets.
+    /// </summary>
+    /// <param name="packetTypesRepository">The packet types repository.</param>
+    /// <returns>A result tht may or may not have succeeded.</returns>
+    public static Result AddDefaultPackets(this IPacketTypesRepository packetTypesRepository)
+    {
+        return packetTypesRepository.AddPacketTypes(typeof(IPacket).Assembly);
+    }
+}
\ No newline at end of file
diff --git a/Packets/NosSmooth.PacketSerializer/Extensions/ServiceCollectionExtensions.cs b/Packets/NosSmooth.PacketSerializer/Extensions/ServiceCollectionExtensions.cs
index c4e2baf..e9dcea3 100644
--- a/Packets/NosSmooth.PacketSerializer/Extensions/ServiceCollectionExtensions.cs
+++ b/Packets/NosSmooth.PacketSerializer/Extensions/ServiceCollectionExtensions.cs
@@ -38,24 +38,7 @@ public static class ServiceCollectionExtensions
             .AddSingleton<IStringConverterRepository, StringConverterRepository>()
             .AddSingleton<IStringSerializer, StringSerializer>()
             .AddSingleton<IPacketSerializer, PacketSerializer>()
-            .AddSingleton<IPacketTypesRepository>(p =>
-            {
-                var repository = new PacketTypesRepository(p.GetRequiredService<IStringConverterRepository>());
-                var packetTypes = typeof(IPacket).Assembly
-                    .GetExportedTypes()
-                    .Where(x => x != typeof(UnresolvedPacket) && !x.IsAbstract && typeof(IPacket).IsAssignableFrom(x));
-                foreach (var packetType in packetTypes)
-                {
-                    var result = repository.AddPacketType(packetType);
-                    if (!result.IsSuccess)
-                    {
-                        // TODO: figure out how to handle this.
-                        throw new Exception(packetType + ": " + result.Error.Message);
-                    }
-                }
-
-                return repository;
-            })
+            .AddSingleton<IPacketTypesRepository, PacketTypesRepository>()
             .AddGeneratedSerializers(typeof(IPacket).Assembly)
             .AddBasicConverters();
     }
diff --git a/Packets/NosSmooth.PacketSerializer/Packets/IPacketTypesRepository.cs b/Packets/NosSmooth.PacketSerializer/Packets/IPacketTypesRepository.cs
index 89923c1..4760252 100644
--- a/Packets/NosSmooth.PacketSerializer/Packets/IPacketTypesRepository.cs
+++ b/Packets/NosSmooth.PacketSerializer/Packets/IPacketTypesRepository.cs
@@ -25,6 +25,19 @@ public interface IPacketTypesRepository
     /// <returns>A result that may or may not have succeeded.</returns>
     public Result AddPacketType(Type type);
 
+    /// <summary>
+    /// Add all of the given packet types.
+    /// </summary>
+    /// <remarks>
+    /// If there is an error, it will continue to add the rest of the types
+    /// and then return an aggregate error containing all the errors.
+    ///
+    /// The application can still run, but without the errorful packets.
+    /// </remarks>
+    /// <param name="packetTypes">The types add.</param>
+    /// <returns>A result that may or may not have succeeded.</returns>
+    public Result AddPacketTypes(IEnumerable<Type> packetTypes);
+
     /// <summary>
     /// Gets the type of a packet that corresponds to the given header.
     /// </summary>
diff --git a/Packets/NosSmooth.PacketSerializer/Packets/PacketTypesRepository.cs b/Packets/NosSmooth.PacketSerializer/Packets/PacketTypesRepository.cs
index b6d8024..fd091ef 100644
--- a/Packets/NosSmooth.PacketSerializer/Packets/PacketTypesRepository.cs
+++ b/Packets/NosSmooth.PacketSerializer/Packets/PacketTypesRepository.cs
@@ -46,13 +46,13 @@ public class PacketTypesRepository : IPacketTypesRepository
     {
         if (!typeof(IPacket).IsAssignableFrom(type))
         {
-            return new ArgumentInvalidError(nameof(type), "The type has to be assignable to IPacket.");
+            return new ArgumentInvalidError(nameof(type), $"The type has to be assignable to IPacket. {type.FullName} isn't.");
         }
 
         var header = type.GetCustomAttribute<PacketHeaderAttribute>();
         if (header is null)
         {
-            return new ArgumentInvalidError(nameof(type), "Every packet has to specify the header.");
+            return new ArgumentInvalidError(nameof(type), $"Every packet has to specify the header. {type.FullName} didn't.");
         }
 
         var converterResult = _stringConverterRepository.GetTypeConverter(type);
@@ -91,6 +91,27 @@ public class PacketTypesRepository : IPacketTypesRepository
         return Result.FromSuccess();
     }
 
+    /// <inheritdoc />
+    public Result AddPacketTypes(IEnumerable<Type> packetTypes)
+    {
+        var errorResults = new List<IResult>();
+        foreach (var packetType in packetTypes)
+        {
+            var result = AddPacketType(packetType);
+            if (!result.IsSuccess)
+            {
+                errorResults.Add(result);
+            }
+        }
+
+        return errorResults.Count switch
+        {
+            0 => Result.FromSuccess(),
+            1 => (Result)errorResults[0],
+            _ => new AggregateError(errorResults)
+        };
+    }
+
     /// <summary>
     /// Gets the type of a packet that corresponds to the given header.
     /// </summary>
@@ -133,7 +154,8 @@ public class PacketTypesRepository : IPacketTypesRepository
     /// </summary>
     /// <typeparam name="TPacket">The type of the packet.</typeparam>
     /// <returns>Info that stores the packet's info. Or an error, if not found.</returns>
-    public Result<PacketInfo> FindPacketInfo<TPacket>() where TPacket : IPacket
+    public Result<PacketInfo> FindPacketInfo<TPacket>()
+        where TPacket : IPacket
         => FindPacketInfo(typeof(TPacket));
 
     /// <summary>
-- 
2.49.0