Skip to content

De-flake LoggerStartupSpec: gate the slow logger instead of racing a fixed delay #8621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Aaronontheweb merged 1 commit into from
Sep 24, 2026
Merged

De-flake LoggerStartupSpec: gate the slow logger instead of racing a fixed delay #8621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions src/core/Akka.Tests/Loggers/LoggerStartupSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ namespace Akka.Tests.Loggers
{
public class LoggerStartupSpec : TestKit.Xunit.TestKit
{
private const int LoggerResponseDelayMs = 1_000;

public LoggerStartupSpec(ITestOutputHelper helper) : base(nameof(LoggerStartupSpec), helper)
{
XUnitOutLogger.Helper = helper;
Expand All @@ -43,6 +41,10 @@ public async Task ActorSystem_should_start_with_loggers_timing_out(bool useAsync
var config = ConfigurationFactory.ParseString($"akka.logger-async-start = {(useAsync ? "true" : "false")}")
.WithFallback(slowLoggerConfig);

// The slow logger answers InitializeLogger only once this gate opens, and the gate stays shut
// for all of ActorSystem.Create - so the logger always misses the 100 ms startup window, and
// the LoggingBus announces it as started only after the test is already subscribed.
SlowLoggerActor.Release = new TaskCompletionSource<Done>(TaskCreationOptions.RunContinuationsAsynchronously);
ActorSystem sys = null;
try
{
Expand All @@ -53,22 +55,20 @@ public async Task ActorSystem_should_start_with_loggers_timing_out(bool useAsync
var logProbe = CreateTestProbe(sys);
sys.EventStream.Subscribe(logProbe, typeof(LogEvent));

SlowLoggerActor.Release.SetResult(Done.Instance);

// Logger actor should eventually initialize
await AwaitAssertAsync(() =>
{
var dbg = logProbe.ExpectMsg<Debug>();
dbg.Message.ToString().Should().Contain(nameof(SlowLoggerActor)).And.Contain("started");
});

await logProbe.FishForMessageAsync<Debug>(
dbg => dbg.Message.ToString().Contains(nameof(SlowLoggerActor)) && dbg.Message.ToString().Contains("started"),
TimeSpan.FromSeconds(5));

var logger = Logging.GetLogger(sys, this);
logger.Error("TEST");
await AwaitAssertAsync(() =>
{
probe.ExpectMsg<string>().Should().Be("TEST");
});
await probe.FishForMessageAsync<string>(msg => msg == "TEST", TimeSpan.FromSeconds(5));
}
finally
{
SlowLoggerActor.Release.TrySetResult(Done.Instance);
if(sys != null)
Shutdown(sys);
}
Expand Down Expand Up @@ -168,6 +168,8 @@ protected override bool Receive(object message)
private class SlowLoggerActor : ActorBase, IWithUnboundedStash, IRequiresMessageQueue<ILoggerMessageQueueSemantics>
{
public static TestProbe Probe;

public static TaskCompletionSource<Done> Release;

public SlowLoggerActor()
{
Expand All @@ -179,8 +181,7 @@ private bool Starting(object message)
switch (message)
{
case InitializeLogger _:
var sender = Sender;
Task.Delay(LoggerResponseDelayMs).PipeTo(Self, sender, success: () => Done.Instance);
Release.Task.PipeTo(Self, Sender);
Become(Initializing);
return true;
default:
Expand Down
Loading