Akka.Cluster: Fix AK1004 warnings #7279
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
resolve a few warnings from https://getakka.net/articles/debugging/rules/AK1004.html inside Akka.Cluster
Aaronontheweb
added
akka-cluster
rosyln-analyzer
Aaronontheweb
commented
Jul 10, 2024
| @@ -31,7 +31,7 @@ public interface IClusterMessage | |||
| /// <summary> | |||
| /// Cluster commands sent by the USER via <see cref="Cluster"/> extension. | |||
| /// </summary> | |||
| internal class ClusterUserAction | |||
| internal static class ClusterUserAction | |||
There was a problem hiding this comment.
This class is never instantiated, should be made static to resolve some compiler grumbling.
| @@ -127,7 +120,7 @@ public Down(Address address) | |||
| /// <summary> | |||
| /// Command to join the cluster. Sent when a node wants to join another node (the receiver). | |||
| /// </summary> | |||
| internal sealed class InternalClusterAction | |||
| internal static class InternalClusterAction | |||
There was a problem hiding this comment.
This class is never instantiated, should be made static to resolve some compiler grumbling.
| @@ -924,13 +917,13 @@ private void CreateChildren(Cluster cluster) | |||
| /// | |||
| /// Actor used to power the guts of the Akka.Cluster membership and gossip protocols. | |||
| /// </summary> | |||
| internal class ClusterCoreDaemon : UntypedActor, IRequiresMessageQueue<IUnboundedMessageQueueSemantics> | |||
| internal sealed class ClusterCoreDaemon : UntypedActor, IRequiresMessageQueue<IUnboundedMessageQueueSemantics>, IWithTimers | |||
There was a problem hiding this comment.
Always try to seal classes that shouldn't be inherited. Also, added IWIthTimers support here as part of resolving AK1004.
| { | ||
| private readonly Cluster _cluster; | ||
| /// <summary> | ||
| /// The current self-unique address. | ||
| /// </summary> | ||
| protected readonly UniqueAddress SelfUniqueAddress; |
There was a problem hiding this comment.
Resolved a compiler warning here (occurred after I sealed the class.)
| @@ -1914,7 +1907,9 @@ public ReceiveGossipType ReceiveGossip(GossipEnvelope envelope) | |||
|
|
|||
| if (comparison == VectorClock.Ordering.Concurrent) | |||
| { | |||
| _log.Debug(@"""Couldn't establish a causal relationship between ""remote"" gossip and ""local"" gossip - Remote[{0}] - Local[{1}] - merged them into [{2}]""", | |||
| _log.Debug(""" | |||
| _cluster.Scheduler.ScheduleTellOnce(new TimeSpan(_cluster.Settings.GossipInterval.Ticks * 2 / 3), Self, | ||
| InternalClusterAction.GossipSpeedupTick.Instance, ActorRefs.NoSender); | ||
|
|
||
| Timers.StartSingleTimer("gossip-speedup-1", InternalClusterAction.GossipSpeedupTick.Instance, new TimeSpan(_cluster.Settings.GossipInterval.Ticks / 3)); |
There was a problem hiding this comment.
Replace calls to scheduler with IWithTimers instead.
| @@ -63,7 +63,7 @@ public static Props Props(Cluster getCluster) | |||
| /// <summary> | |||
| /// INTERNAL API | |||
| /// </summary> | |||
| internal class ClusterHeartbeatSender : ReceiveActor | |||
| internal class ClusterHeartbeatSender : ReceiveActor, IWithTimers | |||
There was a problem hiding this comment.
This class is inherited for testing purposes, no sealing. But did add IWithTimers.
| Self, | ||
| new ExpectedFirstHeartbeat(to), | ||
| Self); | ||
| Timers.StartSingleTimer(to.Address, new ExpectedFirstHeartbeat(to), _cluster.Settings.HeartbeatExpectedResponseAfter); |
There was a problem hiding this comment.
Replace calls to scheduler with IWithTimers instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
resolve a few warnings from https://getakka.net/articles/debugging/rules/AK1004.html inside Akka.Cluster
Checklist
For significant changes, please ensure that the following have been completed (delete if not relevant):