removed ClusterShardingSettings from sharding extensions (#20)

akkadotnet · Mar 31, 2022 · cb07248 · cb07248
1 parent c6daf19
commit cb07248
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 115 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,2 +1,2 @@
-## [0.1.1] / 18 March 2022
-- Upgraded to [Akka.NET v1.4.35](https://github.com/akkadotnet/akka.net/releases/tag/1.4.35)
+## [0.1.2] / 31 March 2022
+- Removed all `Cluster.Sharding` methods that rely on `ClusterShardingSettings`, since it's not practical to create those prior to starting the `ActorSystem`.
diff --git a/src/Akka.Cluster.Hosting/AkkaClusterHostingExtensions.cs b/src/Akka.Cluster.Hosting/AkkaClusterHostingExtensions.cs
@@ -97,85 +97,6 @@ public static AkkaConfigurationBuilder WithClustering(this AkkaConfigurationBuil
             return hoconBuilder.WithActorRefProvider(ProviderSelection.Cluster.Instance);
         }
 
-        /// <summary>
-        /// Starts a <see cref="ShardRegion"/> actor for the given entity <see cref="typeName"/>
-        /// and registers the ShardRegion <see cref="IActorRef"/> with <see cref="TKey"/> in the
-        /// <see cref="ActorRegistry"/> for this <see cref="ActorSystem"/>.
-        /// </summary>
-        /// <param name="builder">The builder instance being configured.</param>
-        /// <param name="typeName">The name of the entity type</param>
-        /// <param name="entityPropsFactory">
-        /// Function that, given an entity id, returns the <see cref="Actor.Props"/> of the entity actors that will be created by the <see cref="Sharding.ShardRegion"/>
-        /// </param>
-        /// <param name="settings">Configuration settings, see <see cref="ClusterShardingSettings"/></param>
-        /// <param name="messageExtractor">
-        /// Functions to extract the entity id, shard id, and the message to send to the entity from the incoming message.
-        /// </param>
-        /// <param name="allocationStrategy">Possibility to use a custom shard allocation and rebalancing logic</param>
-        /// <param name="handOffStopMessage">
-        /// The message that will be sent to entities when they are to be stopped for a rebalance or
-        /// graceful shutdown of a <see cref="Sharding.ShardRegion"/>, e.g. <see cref="PoisonPill"/>.
-        /// </param>
-        /// <typeparam name="TKey">The type key to use to retrieve the <see cref="IActorRef"/> for this <see cref="ShardRegion"/>.</typeparam>
-        /// <returns>The same <see cref="AkkaConfigurationBuilder"/> instance originally passed in.</returns>
-        public static AkkaConfigurationBuilder WithShardRegion<TKey>(this AkkaConfigurationBuilder builder,
-            string typeName,
-            Func<string, Props> entityPropsFactory, IMessageExtractor messageExtractor,
-            ClusterShardingSettings settings,
-            IShardAllocationStrategy allocationStrategy,
-            object handOffStopMessage)
-        {
-            return builder.WithActors(async (system, registry) =>
-            {
-                var shardRegion = await ClusterSharding.Get(system).StartAsync(typeName, entityPropsFactory, settings,
-                    messageExtractor,
-                    allocationStrategy, handOffStopMessage);
-                registry.TryRegister<TKey>(shardRegion);
-            });
-        }
-
-        /// <summary>
-        /// Starts a <see cref="ShardRegion"/> actor for the given entity <see cref="typeName"/>
-        /// and registers the ShardRegion <see cref="IActorRef"/> with <see cref="TKey"/> in the
-        /// <see cref="ActorRegistry"/> for this <see cref="ActorSystem"/>.
-        /// </summary>
-        /// <param name="builder">The builder instance being configured.</param>
-        /// <param name="typeName">The name of the entity type</param>
-        /// <param name="entityPropsFactory">
-        /// Function that, given an entity id, returns the <see cref="Actor.Props"/> of the entity actors that will be created by the <see cref="Sharding.ShardRegion"/>
-        /// </param>
-        /// <param name="settings">Configuration settings, see <see cref="ClusterShardingSettings"/></param>
-        /// <param name="extractEntityId">
-        /// Partial function to extract the entity id and the message to send to the entity from the incoming message,
-        /// if the partial function does not match the message will be `unhandled`,
-        /// i.e.posted as `Unhandled` messages on the event stream
-        /// </param>
-        /// <param name="extractShardId">
-        /// Function to determine the shard id for an incoming message, only messages that passed the `extractEntityId` will be used
-        /// </param>
-        /// <param name="allocationStrategy">Possibility to use a custom shard allocation and rebalancing logic</param>
-        /// <param name="handOffStopMessage">
-        /// The message that will be sent to entities when they are to be stopped for a rebalance or
-        /// graceful shutdown of a <see cref="Sharding.ShardRegion"/>, e.g. <see cref="PoisonPill"/>.
-        /// </param>
-        /// <typeparam name="TKey">The type key to use to retrieve the <see cref="IActorRef"/> for this <see cref="ShardRegion"/>.</typeparam>
-        /// <returns>The same <see cref="AkkaConfigurationBuilder"/> instance originally passed in.</returns>
-        public static AkkaConfigurationBuilder WithShardRegion<TKey>(this AkkaConfigurationBuilder builder,
-            string typeName,
-            Func<string, Props> entityPropsFactory, ExtractEntityId extractEntityId, ExtractShardId extractShardId,
-            ClusterShardingSettings settings,
-            IShardAllocationStrategy allocationStrategy,
-            object handOffStopMessage)
-        {
-            return builder.WithActors(async (system, registry) =>
-            {
-                var shardRegion = await ClusterSharding.Get(system)
-                    .StartAsync(typeName, entityPropsFactory, settings, extractEntityId, extractShardId,
-                        allocationStrategy, handOffStopMessage);
-                registry.TryRegister<TKey>(shardRegion);
-            });
-        }
-
         /// <summary>
         /// Starts a <see cref="ShardRegion"/> actor for the given entity <see cref="typeName"/>
         /// and registers the ShardRegion <see cref="IActorRef"/> with <see cref="TKey"/> in the
@@ -217,36 +138,6 @@ public static AkkaConfigurationBuilder WithShardRegion<TKey>(this AkkaConfigurat
         /// <param name="entityPropsFactory">
         /// Function that, given an entity id, returns the <see cref="Actor.Props"/> of the entity actors that will be created by the <see cref="Sharding.ShardRegion"/>
         /// </param>
-        /// <param name="settings">Configuration settings, see <see cref="ClusterShardingSettings"/></param>
-        /// <param name="messageExtractor">
-        /// Functions to extract the entity id, shard id, and the message to send to the entity from the incoming message.
-        /// </param>
-        /// <typeparam name="TKey">The type key to use to retrieve the <see cref="IActorRef"/> for this <see cref="ShardRegion"/>.</typeparam>
-        /// <returns>The same <see cref="AkkaConfigurationBuilder"/> instance originally passed in.</returns>
-        public static AkkaConfigurationBuilder WithShardRegion<TKey>(this AkkaConfigurationBuilder builder,
-            string typeName,
-            Func<string, Props> entityPropsFactory, IMessageExtractor messageExtractor,
-            ClusterShardingSettings settings)
-        {
-            return builder.WithActors(async (system, registry) =>
-            {
-                var shardRegion = await ClusterSharding.Get(system).StartAsync(typeName, entityPropsFactory,
-                    settings, messageExtractor);
-                registry.TryRegister<TKey>(shardRegion);
-            });
-        }
-
-        /// <summary>
-        /// Starts a <see cref="ShardRegion"/> actor for the given entity <see cref="typeName"/>
-        /// and registers the ShardRegion <see cref="IActorRef"/> with <see cref="TKey"/> in the
-        /// <see cref="ActorRegistry"/> for this <see cref="ActorSystem"/>.
-        /// </summary>
-        /// <param name="builder">The builder instance being configured.</param>
-        /// <param name="typeName">The name of the entity type</param>
-        /// <param name="entityPropsFactory">
-        /// Function that, given an entity id, returns the <see cref="Actor.Props"/> of the entity actors that will be created by the <see cref="Sharding.ShardRegion"/>
-        /// </param>
-        /// <param name="settings">Configuration settings, see <see cref="ClusterShardingSettings"/></param>
         /// <param name="extractEntityId">
         /// Partial function to extract the entity id and the message to send to the entity from the incoming message,
         /// if the partial function does not match the message will be `unhandled`,
@@ -255,17 +146,21 @@ public static AkkaConfigurationBuilder WithShardRegion<TKey>(this AkkaConfigurat
         /// <param name="extractShardId">
         /// Function to determine the shard id for an incoming message, only messages that passed the `extractEntityId` will be used
         /// </param>
+        /// <param name="shardOptions">The set of options for configuring <see cref="ClusterShardingSettings"/></param>
         /// <typeparam name="TKey">The type key to use to retrieve the <see cref="IActorRef"/> for this <see cref="ShardRegion"/>.</typeparam>
         /// <returns>The same <see cref="AkkaConfigurationBuilder"/> instance originally passed in.</returns>
         public static AkkaConfigurationBuilder WithShardRegion<TKey>(this AkkaConfigurationBuilder builder,
             string typeName,
             Func<string, Props> entityPropsFactory, ExtractEntityId extractEntityId, ExtractShardId extractShardId,
-            ClusterShardingSettings settings)
+            ShardOptions shardOptions)
         {
             return builder.WithActors(async (system, registry) =>
             {
                 var shardRegion = await ClusterSharding.Get(system).StartAsync(typeName, entityPropsFactory,
-                    settings, extractEntityId, extractShardId);
+                    ClusterShardingSettings.Create(system)
+                        .WithRole(shardOptions.Role)
+                        .WithRememberEntities(shardOptions.RememberEntities)
+                        .WithStateStoreMode(shardOptions.StateStoreMode), extractEntityId, extractShardId);
                 registry.TryRegister<TKey>(shardRegion);
             });
         }

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -2,8 +2,8 @@
   <PropertyGroup>
    <Copyright>Copyright © 2013-2022 Akka.NET Team</Copyright>
     <Authors>Akka.NET Team</Authors>
-    <VersionPrefix>0.1.0</VersionPrefix>
-    <PackageReleaseNotes>• Initial release of Akka.Hosting%2C Akka.Remote.Hosting%2C Akka.Cluster.Hosting%2C and Akka.Persistence.SqlServer.Hosting</PackageReleaseNotes>
+    <VersionPrefix>0.1.2</VersionPrefix>
+    <PackageReleaseNotes>• Removed all Cluster.Sharding methods that rely on ClusterShardingSettings%2C since it's not practical to create those prior to starting the ActorSystem.</PackageReleaseNotes>
     <PackageIconUrl>
     </PackageIconUrl>
     <PackageProjectUrl>