Akka.Cluster.Sharding AK2001 cleanup
#7049
Conversation
Working on ensuring that AK2001's rules are followed inside Akka.NET's own test suites
Aaronontheweb
added
akka-cluster-sharding
api-change
rosyln-analyzer
| @@ -3,7 +3,7 @@ uid: AK2001 | |||
| title: Akka.Analyzers Rule AK2001 - "Do not use automatically handled messages in inside `Akka.Cluster.Sharding.IMessageExtractor`s." | |||
| --- | |||
|
|
|||
| # AK2000 - Warning | |||
| # AK2001 - Warning | |||
There was a problem hiding this comment.
Fixed a typo in the docs here
| @@ -70,7 +70,7 @@ If you want to see the [full set of changes made in Akka.NET v1.5.14, click here | |||
| | 1 | 1 | 1 | szaliszali |</PackageReleaseNotes> | |||
| </PropertyGroup> | |||
| <ItemGroup Label="Analyzers"> | |||
| <PackageReference Include="Akka.Analyzers" Version="0.2.0" PrivateAssets="all" /> | |||
| <PackageReference Include="Akka.Analyzers" Version="0.2.1" PrivateAssets="all" /> | |||
There was a problem hiding this comment.
Updated to the most recent version of Akka.Analyzers, which includes an important fix to the Roslyn Code Fix Provider for AK2001
| @@ -23,15 +23,15 @@ public void RouteShardEnvelope() | |||
| { | |||
| _extractor.EntityId(_m1); | |||
| _extractor.EntityMessage(_m1); | |||
| _extractor.ShardId(_m1); | |||
| _extractor.ShardId(_m1.EntityId); | |||
There was a problem hiding this comment.
Taking advantage of the new ShardId methods inside the IMessageExtractor for these benchmarks, since these are now what we try to use inside the ShardRegion s themselves.
There was a problem hiding this comment.
Removing AK2001 warnings
There was a problem hiding this comment.
Removing AK2001 warnings - all tests still pass.
There was a problem hiding this comment.
Removing AK2001 warnings - all tests still pass.
| @@ -111,10 +111,10 @@ public Implementation(int maxNumberOfShards, Func<Msg, string> entityIdExtractor | |||
| _messageExtractor = messageExtractor; | |||
| } | |||
|
|
|||
| public override string EntityId(Msg message) | |||
| public override string? EntityId(Msg message) | |||
There was a problem hiding this comment.
We applied nullability to the IMessageExtractor interface for these methods some time ago, but never applied it to the HashCodeMessageExtractor class that implements it - first that here and you'll see it show up in the API approvals as well.
| @@ -413,6 +413,7 @@ public static Config DefaultConfig() | |||
| /// This exception is thrown when the cluster member doesn't have the role specified in <paramref name="settings"/>. | |||
| /// </exception> | |||
| /// <returns>The actor ref of the <see cref="Sharding.ShardRegion"/> that is to be responsible for the shard.</returns> | |||
| [Obsolete("Use one of the overloads that accepts an IMessageExtractor instead")] | |||
There was a problem hiding this comment.
Marked all of the Start / StartAsync methods that accept any of the deprecated delegates as Obsolete - this also appears in the API approval files.
| @@ -149,7 +149,7 @@ namespace Akka.DistributedData | |||
| /// | |||
| /// In the <see cref="Update"/> message you can pass an optional request context, which the <see cref="Replicator"/> | |||
| /// does not care about, but is included in the reply messages. This is a convenient | |||
| /// way to pass contextual information (e.g. original sender) without having to use <see cref="Ask"/> | |||
| /// way to pass contextual information (e.g. original sender) without having to use Ask{T} | |||
There was a problem hiding this comment.
Fixed an XML-DOC warning
Changes
Fixing all instances of
AK2001inside Akka.Cluster.Sharding and cleaning up somenullableAPIs while we're at it.Checklist
For significant changes, please ensure that the following have been completed (delete if not relevant):