Changing msgpack options (dotnet#20031)

Author: tebeco

src/SignalR/common/Protocols.MessagePack/src/MessagePackHubProtocolOptions.cs

@@ -9,24 +9,31 @@ namespace Microsoft.AspNetCore.SignalR
 {
     public class MessagePackHubProtocolOptions
     {
-        private IList<IFormatterResolver> _formatterResolvers;
+        private MessagePackSerializerOptions _messagePackSerializerOptions;
 
-        public IList<IFormatterResolver> FormatterResolvers
+        /// <summary>
+        /// <para>Gets or sets the <see cref="MessagePackSerializerOptions"/> used internally by the <see cref="MessagePackSerializer" />.</para>
+        /// <para>If you override the default value, we strongly recommend that you set <see cref="MessagePackSecurity" /> to <see cref="MessagePackSecurity.UntrustedData"/> by calling:</para>
+        /// <code>customMessagePackSerializerOptions = customMessagePackSerializerOptions.WithSecurity(MessagePackSecurity.UntrustedData)</code>
+        /// If you modify the default options you must also assign the updated options back to the <see cref="SerializerOptions" /> property:
+        /// <code>options.SerializerOptions = options.SerializerOptions.WithResolver(new CustomResolver());</code>
+        /// </summary>
+        public MessagePackSerializerOptions SerializerOptions
         {
             get
             {
-                if (_formatterResolvers == null)
+                if (_messagePackSerializerOptions == null)
                 {
                     // The default set of resolvers trigger a static constructor that throws on AOT environments.
                     // This gives users the chance to use an AOT friendly formatter.
-                    _formatterResolvers = MessagePackHubProtocol.CreateDefaultFormatterResolvers();
+                    _messagePackSerializerOptions = MessagePackHubProtocol.CreateDefaultMessagePackSerializerOptions();
                 }
 
-                return _formatterResolvers;
+                return _messagePackSerializerOptions;
             }
             set
             {
-                _formatterResolvers = value;
+                _messagePackSerializerOptions = value;
             }
         }
     }

src/SignalR/common/Protocols.MessagePack/src/Protocol/MessagePackHubProtocol.cs

@@ -27,6 +27,7 @@ public class MessagePackHubProtocol : IHubProtocol
         private const int NonVoidResult = 3;
 
         private readonly MessagePackSerializerOptions _msgPackSerializerOptions;
+
         private static readonly string ProtocolName = "messagepack";
         private static readonly int ProtocolVersion = 1;
 
@@ -52,37 +53,7 @@ public MessagePackHubProtocol()
         /// <param name="options">The options used to initialize the protocol.</param>
         public MessagePackHubProtocol(IOptions<MessagePackHubProtocolOptions> options)
         {
-            var msgPackOptions = options.Value;
-            var resolver = SignalRResolver.Instance;
-            var hasCustomFormatterResolver = false;
-
-            // if counts don't match then we know users customized resolvers so we set up the options with the provided resolvers
-            if (msgPackOptions.FormatterResolvers.Count != SignalRResolver.Resolvers.Count)
-            {
-                hasCustomFormatterResolver = true;
-            }
-            else
-            {
-                // Compare each "reference" in the FormatterResolvers IList<> against the default "SignalRResolver.Resolvers" IList<>
-                for (var i = 0; i < msgPackOptions.FormatterResolvers.Count; i++)
-                {
-                    // check if the user customized the resolvers
-                    if (msgPackOptions.FormatterResolvers[i] != SignalRResolver.Resolvers[i])
-                    {
-                        hasCustomFormatterResolver = true;
-                        break;
-                    }
-                }
-            }
-
-            if (hasCustomFormatterResolver)
-            {
-                resolver = CompositeResolver.Create(Array.Empty<IMessagePackFormatter>(), (IReadOnlyList<IFormatterResolver>)msgPackOptions.FormatterResolvers);
-            }
-
-            _msgPackSerializerOptions = MessagePackSerializerOptions.Standard
-                                                                    .WithResolver(resolver)
-                                                                    .WithSecurity(MessagePackSecurity.UntrustedData);
+            _msgPackSerializerOptions = options.Value.SerializerOptions;
         }
 
         /// <inheritdoc />
@@ -656,17 +627,17 @@ private static object DeserializeObject(ref MessagePackReader reader, Type type,
             }
         }
 
-        internal static List<IFormatterResolver> CreateDefaultFormatterResolvers()
-        {
-            // Copy to allow users to add/remove resolvers without changing the static SignalRResolver list
-            return new List<IFormatterResolver>(SignalRResolver.Resolvers);
-        }
+        internal static MessagePackSerializerOptions CreateDefaultMessagePackSerializerOptions() =>
+            MessagePackSerializerOptions
+                .Standard
+                .WithResolver(SignalRResolver.Instance)
+                .WithSecurity(MessagePackSecurity.UntrustedData);
 
         internal class SignalRResolver : IFormatterResolver
         {
             public static readonly IFormatterResolver Instance = new SignalRResolver();
 
-            public static readonly IList<IFormatterResolver> Resolvers = new IFormatterResolver[]
+            public static readonly IReadOnlyList<IFormatterResolver> Resolvers = new IFormatterResolver[]
             {
                 DynamicEnumAsStringResolver.Instance,
                 ContractlessStandardResolver.Instance,

src/SignalR/server/SignalR/test/HubConnectionHandlerTests.cs

@@ -14,6 +14,7 @@
 using System.Threading.Tasks;
 using MessagePack;
 using MessagePack.Formatters;
+using MessagePack.Resolvers;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Connections;
 using Microsoft.AspNetCore.Http;
@@ -2371,7 +2372,7 @@ public async Task HubOptionsCanUseCustomMessagePackSettings()
                     services.AddSignalR()
                         .AddMessagePackProtocol(options =>
                         {
-                            options.FormatterResolvers.Insert(0, new CustomFormatter());
+                            options.SerializerOptions = MessagePackSerializerOptions.Standard.WithResolver(CompositeResolver.Create(new CustomFormatter(), options.SerializerOptions.Resolver));
                         });
                 }, LoggerFactory);