Skip to content

Commit

Permalink
Akka.Cluster.Tools: deprecate ClustersSingletonManagerSettings.Consid…
Browse files Browse the repository at this point in the history 
…erAppVersion (#7302)

* Akka.Cluster.Tools: deprecate ClustersSingletonManagerSettings.ConsiderAppVersion

* added API approvals
  • Loading branch information
@Aaronontheweb
Aaronontheweb authored Jul 25, 2024
1 parent 7180810 commit 6a81fd3
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 62 deletions.
91 changes: 29 additions & 62 deletions src/contrib/cluster/Akka.Cluster.Tools/Singleton/ClusterSingletonManager.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public interface IClusterSingletonMessage { }
[Serializable]
internal sealed class HandOverToMe : IClusterSingletonMessage, IDeadLetterSuppression
{
/// <summary>
/// TBD
/// </summary>
public static HandOverToMe Instance { get; } = new();
private HandOverToMe() { }
}
Expand All @@ -49,9 +46,6 @@ private HandOverToMe() { }
[Serializable]
internal sealed class HandOverInProgress : IClusterSingletonMessage
{
/// <summary>
/// TBD
/// </summary>
public static HandOverInProgress Instance { get; } = new();
private HandOverInProgress() { }
}
Expand All @@ -64,9 +58,6 @@ private HandOverInProgress() { }
[Serializable]
internal sealed class HandOverDone : IClusterSingletonMessage
{
/// <summary>
/// TBD
/// </summary>
public static HandOverDone Instance { get; } = new();
private HandOverDone() { }
}
Expand Down Expand Up @@ -113,72 +104,47 @@ private StartOldestChangedBuffer() { }
internal sealed record HandOverRetry(int Count);

/// <summary>
/// TBD
/// Used to retry a failed takeover operation.
/// </summary>
/// <param name="Count">The number of retries</param>
[Serializable]
internal sealed class TakeOverRetry
{
/// <summary>
/// TBD
/// </summary>
public int Count { get; }
internal sealed record TakeOverRetry(int Count);

/// <summary>
/// TBD
/// </summary>
/// <param name="count">TBD</param>
public TakeOverRetry(int count)
{
Count = count;
}
}

/// <summary>
/// TBD
/// </summary>
[Serializable]
internal sealed class LeaseRetry: INoSerializationVerificationNeeded
{
/// <summary>
/// TBD
/// </summary>
public static LeaseRetry Instance { get; } = new();
private LeaseRetry() { }
}

/// <summary>
/// TBD
/// The data type used by the <see cref="ClusterSingletonManager"/>
/// </summary>
public interface IClusterSingletonData { }

/// <summary>
/// TBD
/// The initial state of the cluster singleton manager at startup before it receives any data.
/// </summary>
[Serializable]
internal sealed class Uninitialized : IClusterSingletonData
{
/// <summary>
/// TBD
/// </summary>
public static Uninitialized Instance { get; } = new();
private Uninitialized() { }
}

/// <summary>
/// TBD
/// The state used after we've initialized and are aware of all of the other
/// older members currently present in the cluster.
/// </summary>
[Serializable]
internal sealed class YoungerData : IClusterSingletonData
{
/// <summary>
/// TBD
/// The age-ordered (ascending) set of addresses of older nodes than us in the cluster.
/// </summary>
public ImmutableList<UniqueAddress> Oldest { get; }

/// <summary>
/// TBD
/// </summary>
/// <param name="oldest">TBD</param>

public YoungerData(ImmutableList<UniqueAddress> oldest)
{
Oldest = oldest;
Expand Down Expand Up @@ -449,19 +415,19 @@ public enum ClusterSingletonState
/// </summary>
WasOldest,
/// <summary>
/// We are c
/// We are handing over our singleton to the new oldest node.
/// </summary>
HandingOver,
/// <summary>
/// TBD
/// Not used
/// </summary>
TakeOver,
/// <summary>
/// TBD
/// We are shutting down.
/// </summary>
Stopping,
/// <summary>
/// TBD
/// We have shut down and are terminating.
/// </summary>
End
}
Expand Down Expand Up @@ -537,7 +503,7 @@ public static Config DefaultConfig()
/// </summary>
/// <param name="singletonProps"><see cref="Actor.Props"/> of the singleton actor instance.</param>
/// <param name="settings">Cluster singleton manager settings.</param>
/// <returns>TBD</returns>
/// <returns>Props for the <see cref="ClusterSingletonManager"/>.</returns>
public static Props Props(Props singletonProps, ClusterSingletonManagerSettings settings)
{
return Props(singletonProps, PoisonPill.Instance, settings);
Expand All @@ -554,7 +520,7 @@ public static Props Props(Props singletonProps, ClusterSingletonManagerSettings
/// perfectly fine <paramref name="terminationMessage"/> if you only need to stop the actor.
/// </param>
/// <param name="settings">Cluster singleton manager settings.</param>
/// <returns>TBD</returns>
/// <returns>Props for the <see cref="ClusterSingletonManager"/>.</returns>
public static Props Props(Props singletonProps, object terminationMessage, ClusterSingletonManagerSettings settings)
{
return Actor.Props.Create(() => new ClusterSingletonManager(singletonProps, terminationMessage, settings))
Expand All @@ -576,32 +542,22 @@ public static Props Props(Props singletonProps, object terminationMessage, Clust
private bool _selfExited;

// started when self member is Up
private IActorRef _oldestChangedBuffer;
private IActorRef? _oldestChangedBuffer;
// keep track of previously removed members
private ImmutableDictionary<UniqueAddress, Deadline> _removed = ImmutableDictionary<UniqueAddress, Deadline>.Empty;
private readonly TimeSpan _removalMargin;
private readonly int _maxHandOverRetries;
private readonly int _maxTakeOverRetries;
private readonly Cluster _cluster = Cluster.Get(Context.System);
private readonly UniqueAddress _selfUniqueAddress;
private ILoggingAdapter _log;

private readonly CoordinatedShutdown _coordShutdown = CoordinatedShutdown.Get(Context.System);
private readonly TaskCompletionSource<Done> _memberExitingProgress = new();

private readonly string _singletonLeaseName;
private readonly Lease? _lease;
private readonly TimeSpan _leaseRetryInterval = TimeSpan.FromSeconds(5); // won't be used

/// <summary>
/// TBD
/// </summary>
/// <param name="singletonProps">TBD</param>
/// <param name="terminationMessage">TBD</param>
/// <param name="settings">TBD</param>
/// <exception cref="ArgumentException">TBD</exception>
/// <exception cref="ConfigurationException">TBD</exception>
/// <returns>TBD</returns>

public ClusterSingletonManager(Props singletonProps, object terminationMessage, ClusterSingletonManagerSettings settings)
{
var role = settings.Role;
Expand All @@ -619,6 +575,17 @@ public ClusterSingletonManager(Props singletonProps, object terminationMessage,
.GetLease(_singletonLeaseName, settings.LeaseSettings.LeaseImplementation, _cluster.SelfAddress.HostPort());
_leaseRetryInterval = settings.LeaseSettings.LeaseRetryInterval;
}

// Added in v1.5.27 to signal to users who were considering AppVersion
// in their singleton placement decisions that we don't do that any more
#pragma warning disable CS0618 // Type or member is obsolete
if (settings.ConsiderAppVersion)
#pragma warning restore CS0618 // Type or member is obsolete
{
Log.Warning("As of Akka.NET v1.5.27, The 'ConsiderAppVersion' setting is no longer supported and will " +
"be removed in a future version because this setting is inherently unsafe and can result in split brains. " +
"Singleton instances will always be created on the oldest member.");
}

_removalMargin = (settings.RemovalMargin <= TimeSpan.Zero) ? _cluster.DowningProvider.DownRemovalMargin : settings.RemovalMargin;

Expand Down Expand Up @@ -661,7 +628,7 @@ private void SetupCoordinatedShutdown()
});
}

private ILoggingAdapter Log { get { return _log ??= Context.GetLogger(); } }
private ILoggingAdapter Log { get; } = Context.GetLogger();

/// <inheritdoc cref="ActorBase.PreStart"/>
protected override void PreStart()
Expand Down
3 changes: 3 additions & 0 deletions src/contrib/cluster/Akka.Cluster.Tools/Singleton/ClusterSingletonManagerSettings.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ private static string RoleOption(string role)
/// When set to false, singleton instance will always be created on oldest member.
/// When set to true, singleton instance will be created on the oldest member with the highest <see cref="Member.AppVersion"/> number.
/// </summary>
[Obsolete("ConsiderAppVersion is not used anymore and will be removed in future versions.")]
public bool ConsiderAppVersion { get; }

/// <summary>
Expand Down Expand Up @@ -188,7 +189,9 @@ public ClusterSingletonManagerSettings(
RemovalMargin = removalMargin;
HandOverRetryInterval = handOverRetryInterval;
LeaseSettings = leaseSettings;
#pragma warning disable CS0618 // Type or member is obsolete
ConsiderAppVersion = considerAppVersion;
#pragma warning restore CS0618 // Type or member is obsolete
}

/// <summary>
Expand Down
1 change: 1 addition & 0 deletions src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveClusterTools.DotNet.verified.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ namespace Akka.Cluster.Tools.Singleton
{
public ClusterSingletonManagerSettings(string singletonName, string role, System.TimeSpan removalMargin, System.TimeSpan handOverRetryInterval, bool considerAppVersion) { }
public ClusterSingletonManagerSettings(string singletonName, string role, System.TimeSpan removalMargin, System.TimeSpan handOverRetryInterval, Akka.Coordination.LeaseUsageSettings leaseSettings, bool considerAppVersion) { }
[System.ObsoleteAttribute("ConsiderAppVersion is not used anymore and will be removed in future versions.")]
public bool ConsiderAppVersion { get; }
public System.TimeSpan HandOverRetryInterval { get; }
public Akka.Coordination.LeaseUsageSettings LeaseSettings { get; }
Expand Down
1 change: 1 addition & 0 deletions src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveClusterTools.Net.verified.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ namespace Akka.Cluster.Tools.Singleton
{
public ClusterSingletonManagerSettings(string singletonName, string role, System.TimeSpan removalMargin, System.TimeSpan handOverRetryInterval, bool considerAppVersion) { }
public ClusterSingletonManagerSettings(string singletonName, string role, System.TimeSpan removalMargin, System.TimeSpan handOverRetryInterval, Akka.Coordination.LeaseUsageSettings leaseSettings, bool considerAppVersion) { }
[System.ObsoleteAttribute("ConsiderAppVersion is not used anymore and will be removed in future versions.")]
public bool ConsiderAppVersion { get; }
public System.TimeSpan HandOverRetryInterval { get; }
public Akka.Coordination.LeaseUsageSettings LeaseSettings { get; }
Expand Down

0 comments on commit 6a81fd3

Please sign in to comment.