Skip to content

Commit

Permalink
added end to end repro for akkadotnet#7196
Browse files Browse the repository at this point in the history 
close akkadotnet#7196
  • Loading branch information
@Aaronontheweb
Aaronontheweb committed May 31, 2024
1 parent 620e533 commit 96c3c9b
Show file tree
Hide file tree
Showing 2 changed files with 297 additions and 186 deletions.
303 changes: 117 additions & 186 deletions src/contrib/cluster/Akka.Cluster.Tools.Tests/Singleton/OldChangedBufferSpecs.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,217 +4,148 @@
// Copyright (C) 2013-2024 .NET Foundation <https://github.com/akkadotnet/akka.net>
// </copyright>
// -----------------------------------------------------------------------

#nullable enable
using System;
using System.Collections.Immutable;
using System.Linq;
using System.Threading.Tasks;
using Akka.Actor;
using Akka.Cluster.Tools.Singleton;
using Akka.Util;
using Akka.Configuration;
using Akka.TestKit;
using FluentAssertions;
using Xunit;
using Xunit.Abstractions;

namespace Akka.Cluster.Tools.Tests.Singleton;

/// <summary>
/// Reproduction for https://github.com/akkadotnet/akka.net/issues/7196 - clearly, what we did
/// </summary>
// public class OldChangedBufferSpecs : AkkaSpec
// {
// public IActorRef CreateOldestChangedBuffer(string role, bool considerAppVersion)
// {
// return Sys.ActorOf(Props.Create(() => new OldestChangedBuffer(role, considerAppVersion)));
// }
//
// private readonly ActorSystem _otherNodeV1;
// private readonly ActorSystem _nonHostingNode;
// private ActorSystem? _otherNodeV2;
//
// public OldChangedBufferSpecs(ITestOutputHelper output) : base("""
//
// akka.loglevel = INFO
// akka.actor.provider = "cluster"
// akka.cluster.roles = [singleton]
// akka.cluster.auto-down-unreachable-after = 2s
// akka.cluster.singleton.min-number-of-hand-over-retries = 5
// akka.remote {
// dot-netty.tcp {
// hostname = "127.0.0.1"
// port = 0
// }
// }
// """, output)
// {
// _otherNodeV1 = ActorSystem.Create(Sys.Name, Sys.Settings.Config);
// _nonHostingNode = ActorSystem.Create(Sys.Name, ConfigurationFactory.ParseString("akka.cluster.roles = [other]")
// .WithFallback(Sys.Settings.Config));
// }
//
// [Fact(DisplayName = "Singletons should not move to higher AppVersion nodes until after older incarnation is downed")]
// public async Task Bugfix7196Spec()
// {
//
// }
// }

public class OldestChangedBufferStateSpecs
public class OldChangedBufferSpecs : AkkaSpec
{
[Fact]
public void OldestChangedBuffer_should_initially_only_consider_nodes_with_matching_role()
private readonly ActorSystem _hostNodeV1;
private readonly ActorSystem _otherNodeV2;

private static Config OriginalNodeConfig() => """
akka.loglevel = INFO
akka.actor.provider = "cluster"
akka.cluster.roles = [non-singleton]
akka.cluster.auto-down-unreachable-after = 2s
akka.cluster.singleton.min-number-of-hand-over-retries = 5
akka.cluster.app-version = "1.0.0"
akka.remote {
dot-netty.tcp {
hostname = "127.0.0.1"
port = 0
}
}
""";

private static Config V2NodeConfig(ActorSystem originalSys) => ConfigurationFactory.ParseString(
"akka.cluster.app-version = \"1.0.2\"").WithFallback(originalSys.Settings.Config);

public OldChangedBufferSpecs(ITestOutputHelper output) : base(OriginalNodeConfig(), output)
{
// Arrange
var targetRole = "target-role";
var targetRoles = ImmutableHashSet.Create("role1", "role2", targetRole);
var winningAddress = Address.Parse("akka://sys@darkstar:1112");
var nonTargetRoles = ImmutableHashSet.Create("role1", "role2");
var initialMembersByAge = ImmutableSortedSet<Member>.Empty
.Add(Create(winningAddress, roles:targetRoles, upNumber: 3))
.Add(Create(Address.Parse("akka://sys@darkstar:1113"), roles:nonTargetRoles, upNumber: 1))
.Add(Create(Address.Parse("akka://sys@darkstar:1111"), roles:targetRoles, upNumber: 9))
.WithComparer(MemberAgeOrdering.DescendingWithAppVersion);

// Act
var state = new OldestChangedBufferState(initialMembersByAge, targetRole);

// Assert
var oldest = state.CurrentOldest;
oldest.Should().NotBeNull();
oldest!.Address.Should().Be(winningAddress);
_hostNodeV1 = ActorSystem.Create(Sys.Name,
ConfigurationFactory.ParseString("akka.cluster.roles = [singleton]").WithFallback(Sys.Settings.Config));
_otherNodeV2 = ActorSystem.Create(Sys.Name,
ConfigurationFactory.ParseString("akka.cluster.roles = [singleton]").WithFallback(V2NodeConfig(Sys)));
}

[Fact]
public void OldestChangedBuffer_should_not_change_leader_when_higher_AppVersion_added()
[Fact(DisplayName =
"Singletons should not move to higher AppVersion nodes until after older incarnation is downed")]
public async Task Bugfix7196Spec()
{
// Arrange
var winningAddress = Address.Parse("akka://sys@darkstar:1112");
var appVersion1 = AppVersion.Create("1.0.0");
var appVersion2 = AppVersion.Create("1.0.2");
var initialMembersByAge = ImmutableSortedSet<Member>.Empty
.Add(Create(winningAddress, upNumber: 3, appVersion: appVersion1))
.Add(Create(Address.Parse("akka://sys@darkstar:1111"), upNumber: 9, appVersion: appVersion1))
.WithComparer(MemberAgeOrdering.DescendingWithAppVersion);

// Act
var state = new OldestChangedBufferState(initialMembersByAge, string.Empty);
var oldest = state.CurrentOldest;

// higher upNumber - should not affect leader
var newMemberSameVersion = Create(Address.Parse("akka://sys@darkstar:1113"), upNumber: 10, appVersion: appVersion1);

// higher upNumber AND version - should not affect leader
var newMemberNewVersion = Create(Address.Parse("akka://sys@darkstar:1114"), upNumber: 11, appVersion: appVersion2);

// Act
var (state1, oldestChanged1) = state.AddMember(newMemberSameVersion);
var (state2, oldestChanged2) = state1.AddMember(newMemberNewVersion);

// Assert
oldest.Should().NotBeNull();
oldest!.Address.Should().Be(winningAddress);

state1.CurrentOldest.Should().Be(oldest);
oldestChanged1.Should().BeFalse();

state2.CurrentOldest.Should().Be(oldest);
oldestChanged2.Should().BeFalse();
await JoinAsync(Sys, Sys); // have to do a self join first
await JoinAsync(_hostNodeV1, Sys);

// the members by age system is going to chose the appVersion over the upNumber
state2.MembersByAge.FirstOrDefault().Should().NotBe(oldest);
state2.MembersByAge.FirstOrDefault()!.AppVersion.Should().Be(appVersion2);
var proxy = Sys.ActorOf(
ClusterSingletonProxy.Props("user/echo",
ClusterSingletonProxySettings.Create(Sys).WithRole("singleton")), "proxy3");

// confirm that singleton is on _hostNodeV1
await AssertSingletonHostedOn(proxy, _hostNodeV1);

// have _otherNodeV2 join the cluster
await JoinAsync(_otherNodeV2, Sys);

// confirm that singleton is STILL on _hostNodeV1
await AssertSingletonHostedOn(proxy, _hostNodeV1);

// now, down the original node
Cluster.Get(Sys).Leave(Cluster.Get(_hostNodeV1).SelfAddress);

// validate that _hostNodeV1 is no longer in the cluster
await WithinAsync(TimeSpan.FromSeconds(5), () =>
{
return AwaitAssertAsync(() =>
{
Cluster.Get(Sys).State.Members.Select(x => x.UniqueAddress).Should()
.NotContain(Cluster.Get(_hostNodeV1).SelfUniqueAddress);
});
});

// validate that the singleton has moved to _otherNodeV2
await AssertSingletonHostedOn(proxy, _otherNodeV2);
}

[Fact]
public void OldestChangedBuffer_should_change_Oldest_when_previous_Oldest_removed()
{
// Arrange
var winningAddress = Address.Parse("akka://sys@darkstar:1112");
var appVersion1 = AppVersion.Create("1.0.0");
var appVersion2 = AppVersion.Create("1.0.2");

var originalOldest = Create(winningAddress, upNumber: 3, appVersion: appVersion1);

var initialMembersByAge = ImmutableSortedSet<Member>.Empty
.Add(originalOldest)
.Add(Create(Address.Parse("akka://sys@darkstar:1111"), upNumber: 9, appVersion: appVersion1))
.WithComparer(MemberAgeOrdering.DescendingWithAppVersion);

// Act
var state = new OldestChangedBufferState(initialMembersByAge, string.Empty);
var oldest = state.CurrentOldest;

// higher upNumber, same version - won't affect leader
var newMemberSameVersion = Create(Address.Parse("akka://sys@darkstar:1113"), upNumber: 4, appVersion: appVersion1);

// lower upNumber AND version - won't affect the leader until it gets removed
var newMemberHigherVersion = Create(Address.Parse("akka://sys@darkstar:1114"), upNumber: 11, appVersion: appVersion2);

// Act
var (state1, oldestChanged1) = state.AddMember(newMemberSameVersion);
var (state2, oldestChanged2) = state1.AddMember(newMemberHigherVersion);
var (state3, oldestChanged3) = state2.RemoveMember(originalOldest);

// Assert
oldest.Should().NotBeNull();
oldest!.Address.Should().Be(winningAddress);

state1.CurrentOldest.Should().Be(originalOldest);
oldestChanged1.Should().BeFalse();

state2.CurrentOldest.Should().Be(originalOldest);
oldestChanged2.Should().BeFalse();

state3.CurrentOldest.Should().Be(newMemberHigherVersion);
oldestChanged3.Should().BeTrue();
private async Task AssertSingletonHostedOn(IActorRef proxy, ActorSystem targetNode)
{
await WithinAsync(TimeSpan.FromSeconds(5), () =>
{
return AwaitAssertAsync(() =>
{
var probe = CreateTestProbe(Sys);
proxy.Tell("hello", probe.Ref);
probe.ExpectMsg<UniqueAddress>(TimeSpan.FromSeconds(1))
.Should()
.Be(Cluster.Get(targetNode).SelfUniqueAddress);
});
});
}

[Fact]
public void OldestChangedBuffer_should_not_change_Oldest_when_nonOldest_node_removed()

public async Task JoinAsync(ActorSystem from, ActorSystem to)
{
// Arrange
var winningAddress = Address.Parse("akka://sys@darkstar:1112");
var appVersion1 = AppVersion.Create("1.0.0");
var appVersion2 = AppVersion.Create("1.0.2");
var initialMembersByAge = ImmutableSortedSet<Member>.Empty
.Add(Create(winningAddress, upNumber: 3, appVersion: appVersion1))
.Add(Create(Address.Parse("akka://sys@darkstar:1111"), upNumber: 9, appVersion: appVersion1))
.WithComparer(MemberAgeOrdering.DescendingWithAppVersion);

// Act
var state = new OldestChangedBufferState(initialMembersByAge, string.Empty);
var oldest = state.CurrentOldest;

// higher upNumber - should not affect leader
var newMemberSameVersion = Create(Address.Parse("akka://sys@darkstar:1113"), upNumber: 10, appVersion: appVersion1);

// higher upNumber AND version - should not affect leader
var newMemberNewVersion = Create(Address.Parse("akka://sys@darkstar:1114"), upNumber: 11, appVersion: appVersion2);

// Act
var (state1, oldestChanged1) = state.AddMember(newMemberSameVersion);
var (state2, oldestChanged2) = state1.AddMember(newMemberNewVersion);
var (state3, oldestChanged3) = state2.RemoveMember(newMemberSameVersion);

// Assert
oldest.Should().NotBeNull();
oldest!.Address.Should().Be(winningAddress);

state1.CurrentOldest.Should().Be(oldest);
oldestChanged1.Should().BeFalse();

state2.CurrentOldest.Should().Be(oldest);
oldestChanged2.Should().BeFalse();
if (Cluster.Get(from).SelfRoles.Contains("singleton"))
{
from.ActorOf(ClusterSingletonManager.Props(Props.Create(() => new Singleton()),
PoisonPill.Instance,
ClusterSingletonManagerSettings.Create(from).WithRole("singleton")), "echo");
}


state3.CurrentOldest.Should().Be(oldest);
oldestChanged3.Should().BeFalse();
await WithinAsync(TimeSpan.FromSeconds(45), () =>
{
AwaitAssert(() =>
{
Cluster.Get(from).Join(Cluster.Get(to).SelfAddress);
Cluster.Get(from).State.Members.Select(x => x.UniqueAddress).Should()
.Contain(Cluster.Get(from).SelfUniqueAddress);
Cluster.Get(from)
.State.Members.Select(x => x.Status)
.ToImmutableHashSet()
.Should()
.Equal(ImmutableHashSet<MemberStatus>.Empty.Add(MemberStatus.Up));
});
return Task.CompletedTask;
});
}

public static Member Create(
Address address,
MemberStatus status = MemberStatus.Up,
ImmutableHashSet<string>? roles = null,
int uid = 0,
int upNumber = 0,
AppVersion? appVersion = null)

public class Singleton : ReceiveActor
{
public Singleton()
{
ReceiveAny(_ => { Sender.Tell(Cluster.Get(Context.System).SelfUniqueAddress); });
}
}

protected override void AfterAll()
{
return Member.Create(new UniqueAddress(address, uid), upNumber, status, roles ?? ImmutableHashSet<string>.Empty, appVersion ?? AppVersion.Zero);
Shutdown(_hostNodeV1);
Shutdown(_otherNodeV2);
base.AfterAll();
}
}
Loading

0 comments on commit 96c3c9b

Please sign in to comment.