akkadotnet/akka.net 1.5.15

Akka.NET v1.5.15

on GitHub

1.5.15 January 9th 2024

Akka.NET v1.5.15 is a significant release for Akka.NET with some major feature additions and changes.

• Introducing Akka.Analyzers - Roslyn Analysis for Akka.NET
• Akka.Cluster.Sharding: perf optimize message extraction, automate StartEntity and ShardEnvelope handling
• Akka.Cluster.Tools: Make ClusterClient messages be serialized using ClusterClientMessageSerializer
• Akka.Persistence: Fix LocalSnapshotStore Metadata Fetch to ensure persistenceid match.
• Akka.Delivery: Fix ProducerControllerImpl<T> state bug
• Change MS.EXT and System package versioning to range - we now support all Microsoft.Extensions packages from (6.0,].
• Akka.Serialization: INoSerializationVerificationNeeded does not handle IWrappedMessage correctly

Akka.Analyzers

The core Akka NuGet package now references Akka.Analyzers, a new set of Roslyn Code Analysis and Code Fix Providers that we distribute via NuGet. You can see the full set of supported Akka.Analyzers rules here.

Akka.Cluster.Sharding Changes

In #6863 we made some major changes to the Akka.Cluster.Sharding API aimed at helping improve Cluster.Sharding's performance and ease of use. However, these changes may require some effort on the part of the end user in order to take full advantage:

• ExtractEntityId and ExtractShardId have been deprecated as they fundamentally can't be extended and can't benefit from the performance improvements introduced into Akka.NET v1.5.15. It is imperative that you migrate to using the HashCodeMessageExtractor instead.
• You no longer need to handle ShardRegion.StartEntity or ShardingEnvelope inside your IMessageExtractor implementations, and in fact AK2001 (part of Akka.Analyzers) will automatically detect this and remove those handlers for you. Akka.NET automatically handles these two message types internally now.

ClusterClient Serialization Changes

In #7032 we solved a long-standing serialization problem with the ClusterClient where Send, SendToAll, and Publish were not handled by the correct internal serializer. This has been fixed by default in Akka.NET v1.5.15, but this can potentially cause wire compatibility problems during upgrades - therefore we have introduced a configuration setting to toggle this:

# re-enable legacy serialization
akka.cluster.client.use-legacy-serialization = on

That setting is currently set to on by default, so v1.5.15 will still behave like previous versions of Akka.NET. However, if you have been affected by serialization issues with the ClusterClient (such as #6803) you should toggle this setting to off.

See "Akka.NET v1.5.15 Upgrade Advisories" for full details on some of the things you might need to do while upgrading to this version of Akka.NET.

You can see the full set of changes for Akka.NET v1.5.15 here.

Changes:

• e504c34 added v1.5.15 release notes (#7053)
• 9d2efe0 [Docs] Adding Akka.NET v1.5.15 upgrade advisories (#7052)
• f03fc68 troubleshooting ShardingRegion.StartEntity handling changes (#7051)
• b6a4a5c distribute Akka.Analyzers as transitive dependency through Akka (#7050)
• 38ad362 Akka.Cluster.Sharding AK2001 cleanup (#7049)
• 3285197 Bump Microsoft.Data.SQLite from 7.0.13 to 8.0.1 (#7048)
• 3c16fdc added AK2001 warning docs (#7047)
• 97323d1 Fix LocalSnapshotStore Metadata Fetch to ensure persistenceid match. (#7040)
• a2c0df4 Docs: defining Akka.Analyzer rules (#7039)
• 0486f97 structs in Akka.Streams with exclusively read-only members were made readonly (#6941)