Changed options settings in ASP.NET Core SignalR MessagePack

[BrennanConroy]

Changed options settings in ASP.NET Core SignalR MessagePack

The ASP.NET Core SignalR MessagePack Hub Protocol options has been changed from a IList<MessagePack.IFormatterResolver> to use the MessagePackSerializerOptions from the MessagePack library directly.

This is a breaking change for:

• Anyone who is setting/configuring values on MessagePackHubProtocolOptions

Version introduced

5.0-preview4

Old behavior

Previously, you could add to the options as shown here:

services.AddSignalR()
    .AddMessagePackProtocol(options =>
    {
        options.FormatterResolvers.Add(MessagePack.Resolvers.StandardResolver.Instance);
    });

And replace the options as shown here:

services.AddSignalR()
    .AddMessagePackProtocol(options =>
    {
        options.FormatterResolvers = new List<MessagePack.IFormatterResolver>()
        {
            MessagePack.Resolvers.StandardResolver.Instance
        };
    });

New behavior

Now, you can add to the options with:

services.AddSignalR()
    .AddMessagePackProtocol(options =>
    {
        options.SerializerOptions =
            options.SerializeOptions.WithResolver(MessagePack.Resolvers.StandardResolver.Instance);
    });

And replace the options with:

services.AddSignalR()
    .AddMessagePackProtocol(options =>
    {
        options.SerializerOptions = MessagePackSerializerOptions
                .Standard
                .WithResolver(MessagePack.Resolvers.StandardResolver.Instance)
                .WithSecurity(MessagePackSecurity.UntrustedData);;
    });

Reason for change

This is part of our move the the MessagePack v2.x move which we announced in aspnet/Announcements#404. The v2.x library has added a new options API that is easier to use and provides more features than the list of MessagePack.IFormatterResolver that was exposed before.

Recommended action

If you are using the SignalR MessagePack Hub Protocol and modifying the options, update your usage to use the new options API as shown above.

Category

ASP.NET

Affected APIs

• Microsoft.AspNetCore.SignalR.MessagePackHubProtocolOptions

This is the discussion issue for the following announcement: aspnet/Announcements#413

---

Issue metadata

• Issue type: breaking-change

[ghost]

Thank you for contacting us. Due to a lack of activity on this discussion issue we're closing it in an effort to keep our backlog clean. If you believe there is a concern related to the ASP.NET Core framework, which hasn't been addressed yet, please file a new issue.

This issue will be locked after 30 more days of inactivity. If you still wish to discuss this subject after then, please create a new issue!