Bring ShardedDaemonProcess up to date (#4571)

* Check spec does not create too many demons

* Convenience for ShardedDaemonProcess role

Author: ismaelhamed

src/contrib/cluster/Akka.Cluster.Sharding.Tests.MultiNode/ShardedDaemonProcessSpec.cs

@@ -75,7 +75,7 @@ public void ShardedDaemonProcess_Should_Init_Actor_Set()
 
             var probe = CreateTestProbe();
             ShardedDaemonProcess.Get(Sys).Init("the-fearless", 4, id => ProcessActor.Props(id, probe.Ref));
-            EnterBarrier("actor-set-initialized");
+            EnterBarrier("sharded-daemon-process-initialized");
 
             RunOn(() =>
             {
@@ -87,7 +87,7 @@ public void ShardedDaemonProcess_Should_Init_Actor_Set()
                 }).ToList();
                 startedIds.Count.Should().Be(4);
             }, _config.First);
-            EnterBarrier("actor-set-started");
+            EnterBarrier("sharded-daemon-process-started");
         }
 
         private void FormCluster(RoleName first, params RoleName[] rest)

src/contrib/cluster/Akka.Cluster.Sharding.Tests/ShardedDaemonProcessSpec.cs

@@ -100,6 +100,7 @@ public void ShardedDaemonProcess_must_start_N_actors_with_unique_ids()
 
             var started = probe.ReceiveN(5);
             started.Count.ShouldBe(5);
+            probe.ExpectNoMsg();
         }
 
         [Fact]
@@ -123,7 +124,7 @@ public void ShardedDaemonProcess_must_not_run_if_the_role_does_not_match_node_ro
             Cluster.Get(Sys).Join(Cluster.Get(Sys).SelfAddress);
 
             var probe = CreateTestProbe();
-            var settings = ShardedDaemonProcessSettings.Create(Sys).WithShardingSettings(ClusterShardingSettings.Create(Sys).WithRole("workers"));
+            var settings = ShardedDaemonProcessSettings.Create(Sys).WithRole("workers");
             ShardedDaemonProcess.Get(Sys).Init("roles", 3, id => MyActor.Props(id, probe.Ref), settings);
 
             probe.ExpectNoMsg();

src/contrib/cluster/Akka.Cluster.Sharding/ShardedDaemonProcess.cs

@@ -138,7 +138,7 @@ public void Init(string name, int numberOfInstances, Func<int, Props> propsFacto
             var numberOfShards = numberOfInstances;
             var entityIds = Enumerable.Range(0, numberOfInstances).Select(i => i.ToString()).ToArray();
 
-            // Defaults in `akka.cluster.sharding` but allow overrides specifically for actor-set   
+            // Defaults in `akka.cluster.sharding` but allow overrides specifically for sharded-daemon-process 
             var shardingBaseSettings = settings.ShardingSettings;
             if (shardingBaseSettings == null)
             {
@@ -148,7 +148,7 @@ public void Init(string name, int numberOfInstances, Func<int, Props> propsFacto
             }
 
             var shardingSettings = new ClusterShardingSettings(
-                shardingBaseSettings.Role,
+                settings.Role ?? shardingBaseSettings.Role,
                 false, // remember entities disabled
                 "",
                 "",

src/contrib/cluster/Akka.Cluster.Sharding/ShardedDaemonProcessSettings.cs

@@ -26,6 +26,11 @@ public sealed class ShardedDaemonProcessSettings
         /// </summary>
         public readonly ClusterShardingSettings ShardingSettings;
 
+        /// <summary>
+        /// Specifies that the ShardedDaemonProcess should run on nodes with a specific role.
+        /// </summary>
+        public readonly string Role;
+
         /// <summary>
         /// Create default settings for system
         /// </summary>
@@ -43,30 +48,38 @@ public static ShardedDaemonProcessSettings FromConfig(Config config)
         /// <summary>
         /// Not for user constructions, use factory methods to instantiate.
         /// </summary>
-        private ShardedDaemonProcessSettings(TimeSpan keepAliveInterval, ClusterShardingSettings shardingSettings = null)
+        private ShardedDaemonProcessSettings(TimeSpan keepAliveInterval, ClusterShardingSettings shardingSettings = null, string role = null)
         {
             KeepAliveInterval = keepAliveInterval;
             ShardingSettings = shardingSettings;
+            Role = role;
+        }
+
+        private ShardedDaemonProcessSettings Copy(TimeSpan? keepAliveInterval = null, ClusterShardingSettings shardingSettings = null, string role = null)
+        {
+            return new ShardedDaemonProcessSettings(keepAliveInterval ?? KeepAliveInterval, shardingSettings ?? ShardingSettings, role ?? Role);
         }
 
         /// <summary>
         /// NOTE: How the sharded set is kept alive may change in the future meaning this setting may go away.
         /// </summary>
         /// <param name="keepAliveInterval">The interval each parent of the sharded set is pinged from each node in the cluster.</param>
-        public ShardedDaemonProcessSettings WithKeepAliveInterval(TimeSpan keepAliveInterval)
-        {
-            return new ShardedDaemonProcessSettings(keepAliveInterval, ShardingSettings);
-        }
+        public ShardedDaemonProcessSettings WithKeepAliveInterval(TimeSpan keepAliveInterval) => Copy(keepAliveInterval: keepAliveInterval);
 
         /// <summary>
         /// Specify sharding settings that should be used for the sharded daemon process instead of loading from config.
         /// Some settings can not be changed (remember-entities and related settings, passivation, number-of-shards),
         /// changing those settings will be ignored.
         /// </summary>
         /// <param name="shardingSettings">TBD</param>
-        public ShardedDaemonProcessSettings WithShardingSettings(ClusterShardingSettings shardingSettings)
-        {
-            return new ShardedDaemonProcessSettings(KeepAliveInterval, shardingSettings);
-        }
+        public ShardedDaemonProcessSettings WithShardingSettings(ClusterShardingSettings shardingSettings) => Copy(shardingSettings: shardingSettings);
+
+        /// <summary>
+        /// Specifies that the ShardedDaemonProcess should run on nodes with a specific role.
+        /// If the role is not specified all nodes in the cluster are used. If the given role does
+        /// not match the role of the current node the ShardedDaemonProcess will not be started.
+        /// </summary>
+        /// <param name="role">TBD</param>
+        public ShardedDaemonProcessSettings WithRole(string role) => Copy(role: role);
     }
 }

src/core/Akka.API.Tests/CoreAPISpec.ApproveClusterSharding.approved.txt

@@ -230,10 +230,12 @@ namespace Akka.Cluster.Sharding
     public sealed class ShardedDaemonProcessSettings
     {
         public readonly System.TimeSpan KeepAliveInterval;
+        public readonly string Role;
         public readonly Akka.Cluster.Sharding.ClusterShardingSettings ShardingSettings;
         public static Akka.Cluster.Sharding.ShardedDaemonProcessSettings Create(Akka.Actor.ActorSystem system) { }
         public static Akka.Cluster.Sharding.ShardedDaemonProcessSettings FromConfig(Akka.Configuration.Config config) { }
         public Akka.Cluster.Sharding.ShardedDaemonProcessSettings WithKeepAliveInterval(System.TimeSpan keepAliveInterval) { }
+        public Akka.Cluster.Sharding.ShardedDaemonProcessSettings WithRole(string role) { }
         public Akka.Cluster.Sharding.ShardedDaemonProcessSettings WithShardingSettings(Akka.Cluster.Sharding.ClusterShardingSettings shardingSettings) { }
     }
     public sealed class ShardingEnvelope