Add Serilog async sink to eliminate blocking when logging to console

Agent/Phantom.Agent.Minecraft/Instance/InstanceProcess.cs

@@ -1,5 +1,4 @@
-using System.Diagnostics;
-using Phantom.Utils.Collections;
+using Phantom.Utils.Collections;
 using Phantom.Utils.Runtime;
 
 namespace Phantom.Agent.Minecraft.Instance; 
@@ -19,10 +18,8 @@ public sealed class InstanceProcess : IDisposable {
 	internal InstanceProcess(InstanceProperties instanceProperties, Process process) {
 		this.InstanceProperties = instanceProperties;
 		this.process = process;
-		this.process.EnableRaisingEvents = true;
 		this.process.Exited += ProcessOnExited;
-		this.process.OutputDataReceived += HandleOutputLine;
-		this.process.ErrorDataReceived += HandleOutputLine;
+		this.process.OutputReceived += ProcessOutputReceived;
 	}
 
 	public async Task SendCommand(string command, CancellationToken cancellationToken) {
@@ -41,11 +38,9 @@ public sealed class InstanceProcess : IDisposable {
 		OutputEvent -= listener;
 	}
 
-	private void HandleOutputLine(object sender, DataReceivedEventArgs args) {
-		if (args.Data is {} line) {
-			outputBuffer.Add(line);
-			OutputEvent?.Invoke(this, line);
-		}
+	private void ProcessOutputReceived(object? sender, Process.Output output) {
+		outputBuffer.Add(output.Line);
+		OutputEvent?.Invoke(this, output.Line);
 	}
 
 	private void ProcessOnExited(object? sender, EventArgs e) {

Agent/Phantom.Agent.Minecraft/Launcher/BaseLauncher.cs

@@ -1,10 +1,10 @@
-using System.Diagnostics;
-using System.Text;
+using System.Text;
 using Kajabity.Tools.Java;
 using Phantom.Agent.Minecraft.Instance;
 using Phantom.Agent.Minecraft.Java;
 using Phantom.Agent.Minecraft.Server;
 using Phantom.Common.Minecraft;
+using Phantom.Utils.Runtime;
 using Serilog;
 
 namespace Phantom.Agent.Minecraft.Launcher;
@@ -55,20 +55,17 @@ public abstract class BaseLauncher : IServerLauncher {
 			return new LaunchResult.CouldNotConfigureMinecraftServer();
 		}
 		
-		var startInfo = new ProcessStartInfo {
+		var processConfigurator = new ProcessConfigurator {
 			FileName = javaRuntimeExecutable.ExecutablePath,
 			WorkingDirectory = instanceProperties.InstanceFolder,
-			RedirectStandardInput = true,
-			RedirectStandardOutput = true,
-			RedirectStandardError = true,
-			UseShellExecute = false,
-			CreateNoWindow = false
+			RedirectInput = true,
+			UseShellExecute = false
 		};
 		
 		var jvmArguments = new JvmArgumentBuilder(instanceProperties.JvmProperties, instanceProperties.JvmArguments);
 		CustomizeJvmArguments(jvmArguments);
 
-		var processArguments = startInfo.ArgumentList;
+		var processArguments = processConfigurator.ArgumentList;
 		jvmArguments.Build(processArguments);
 		
 		foreach (var extraArgument in serverJar.ExtraArgs) {
@@ -79,13 +76,11 @@ public abstract class BaseLauncher : IServerLauncher {
 		processArguments.Add(serverJar.FilePath);
 		processArguments.Add("nogui");
 
-		var process = new Process { StartInfo = startInfo };
+		var process = processConfigurator.CreateProcess();
 		var instanceProcess = new InstanceProcess(instanceProperties, process);
 
 		try {
 			process.Start();
-			process.BeginOutputReadLine();
-			process.BeginErrorReadLine();
 		} catch (Exception launchException) {
 			logger.Error(launchException, "Caught exception launching the server process.");
 			

Agent/Phantom.Agent.Services/Backups/BackupCompressor.cs

@@ -1,5 +1,4 @@
-using System.Diagnostics;
-using Phantom.Common.Logging;
+using Phantom.Common.Logging;
 using Phantom.Utils.Runtime;
 using Serilog;
 
@@ -41,7 +40,7 @@ static class BackupCompressor {
 			return false;
 		}
 
-		var startInfo = new ProcessStartInfo {
+		var launcher = new ProcessConfigurator {
 			FileName = "zstd",
 			WorkingDirectory = workingDirectory,
 			ArgumentList = {
@@ -57,14 +56,14 @@ static class BackupCompressor {
 			}
 		};
 
-		static void OnZstdOutput(object? sender, DataReceivedEventArgs e) {
-			if (!string.IsNullOrWhiteSpace(e.Data)) {
-				ZstdLogger.Debug("[Output] {Line}", e.Data);
+		static void OnZstdOutput(object? sender, Process.Output output) {
+			if (!string.IsNullOrWhiteSpace(output.Line)) {
+				ZstdLogger.Debug("[Output] {Line}", output.Line);
 			}
 		}
 
-		var process = new OneShotProcess(ZstdLogger, startInfo);
-		process.Output += OnZstdOutput;
+		var process = new OneShotProcess(ZstdLogger, launcher);
+		process.OutputReceived += OnZstdOutput;
 		return await process.Run(cancellationToken);
 	}
 }

Agent/Phantom.Agent.Services/Backups/BackupServerCommandDispatcher.cs

@@ -1,6 +1,7 @@
 using System.Text.RegularExpressions;
 using Phantom.Agent.Minecraft.Command;
 using Phantom.Agent.Minecraft.Instance;
+using Phantom.Utils.Runtime;
 using Serilog;
 
 namespace Phantom.Agent.Services.Backups;
@@ -13,9 +14,9 @@ sealed partial class BackupServerCommandDispatcher : IDisposable {
 	private readonly InstanceProcess process;
 	private readonly CancellationToken cancellationToken;
 
-	private readonly TaskCompletionSource automaticSavingDisabled = new ();
-	private readonly TaskCompletionSource savedTheGame = new ();
-	private readonly TaskCompletionSource automaticSavingEnabled = new ();
+	private readonly TaskCompletionSource automaticSavingDisabled = Tasks.CreateCompletionSource();
+	private readonly TaskCompletionSource savedTheGame = Tasks.CreateCompletionSource();
+	private readonly TaskCompletionSource automaticSavingEnabled = Tasks.CreateCompletionSource();
 
 	public BackupServerCommandDispatcher(ILogger logger, InstanceProcess process, CancellationToken cancellationToken) {
 		this.logger = logger;

Common/Phantom.Common.Logging/Phantom.Common.Logging.csproj

@@ -8,6 +8,7 @@
   
   <ItemGroup>
     <PackageReference Include="Serilog" />
+    <PackageReference Include="Serilog.Sinks.Async" />
     <PackageReference Include="Serilog.Sinks.Console" />
   </ItemGroup>
 

Common/Phantom.Common.Logging/PhantomLogger.cs

@@ -18,7 +18,7 @@ public static class PhantomLogger {
 		       .MinimumLevel.Override("Microsoft.EntityFrameworkCore.Database.Command", DefaultLogLevel.Coerce(LogEventLevel.Warning))
 		       .Filter.ByExcluding(static e => e.Exception is OperationCanceledException)
 		       .Enrich.FromLogContext()
-		       .WriteTo.Console(outputTemplate: template, formatProvider: CultureInfo.InvariantCulture, theme: AnsiConsoleTheme.Literate)
+		       .WriteTo.Async(c => c.Console(outputTemplate: template, formatProvider: CultureInfo.InvariantCulture, theme: AnsiConsoleTheme.Literate))
 		       .CreateLogger();
 	}
 

Packages.props

@@ -20,6 +20,7 @@
   <ItemGroup>
     <PackageReference Update="Serilog"               Version="2.12.0" />
     <PackageReference Update="Serilog.AspNetCore"    Version="6.1.0" />
+    <PackageReference Update="Serilog.Sinks.Async"   Version="1.5.0" />
     <PackageReference Update="Serilog.Sinks.Console" Version="4.1.0" />
   </ItemGroup>
   

Server/Phantom.Server.Services/Rpc/MessageToServerListener.cs

@@ -9,6 +9,7 @@ using Phantom.Server.Services.Agents;
 using Phantom.Server.Services.Events;
 using Phantom.Server.Services.Instances;
 using Phantom.Utils.Rpc.Message;
+using Phantom.Utils.Runtime;
 
 namespace Phantom.Server.Services.Rpc;
 
@@ -21,7 +22,7 @@ public sealed class MessageToServerListener : IMessageToServerListener {
 	private readonly InstanceLogManager instanceLogManager;
 	private readonly EventLog eventLog;
 
-	private readonly TaskCompletionSource<Guid> agentGuidWaiter = new ();
+	private readonly TaskCompletionSource<Guid> agentGuidWaiter = Tasks.CreateCompletionSource<Guid>();
 
 	public bool IsDisposed { get; private set; }
 

Utils/Phantom.Utils.Rpc/Message/MessageReplyTracker.cs

@@ -1,4 +1,5 @@
 using System.Collections.Concurrent;
+using Phantom.Utils.Runtime;
 using Serilog;
 
 namespace Phantom.Utils.Rpc.Message;
@@ -15,7 +16,7 @@ public sealed class MessageReplyTracker {
 
 	public uint RegisterReply() {
 		var sequenceId = Interlocked.Increment(ref lastSequenceId);
-		replyTasks[sequenceId] = new TaskCompletionSource<byte[]>(TaskCreationOptions.None);
+		replyTasks[sequenceId] = Tasks.CreateCompletionSource<byte[]>();
 		return sequenceId;
 	}
 

Utils/Phantom.Utils.Runtime/OneShotProcess.cs

@@ -1,30 +1,24 @@
-using System.Diagnostics;
-using Serilog;
+using Serilog;
 
 namespace Phantom.Utils.Runtime;
 
 public sealed class OneShotProcess {
 	private readonly ILogger logger;
-	private readonly ProcessStartInfo startInfo;
+	private readonly ProcessConfigurator configurator;
 	
-	public event DataReceivedEventHandler? Output;
+	public event EventHandler<Process.Output>? OutputReceived;
 	
-	public OneShotProcess(ILogger logger, ProcessStartInfo startInfo) {
+	public OneShotProcess(ILogger logger, ProcessConfigurator configurator) {
 		this.logger = logger;
-		this.startInfo = startInfo;
-		this.startInfo.RedirectStandardOutput = true;
-		this.startInfo.RedirectStandardError = true;
+		this.configurator = configurator;
 	}
 
 	public async Task<bool> Run(CancellationToken cancellationToken) {
-		using var process = new Process { StartInfo = startInfo };
-		process.OutputDataReceived += Output;
-		process.ErrorDataReceived += Output;
+		using var process = configurator.CreateProcess();
+		process.OutputReceived += OutputReceived;
 
 		try {
 			process.Start();
-			process.BeginOutputReadLine();
-			process.BeginErrorReadLine();
 		} catch (Exception e) {
 			logger.Error(e, "Caught exception launching process.");
 			return false;

Utils/Phantom.Utils.Runtime/Process.cs

@@ -0,0 +1,92 @@
+using System.Diagnostics;
+
+namespace Phantom.Utils.Runtime;
+
+public sealed class Process : IDisposable {
+	public readonly record struct Output(string Line, bool IsError);
+	
+	public event EventHandler<Output>? OutputReceived;
+	
+	public event EventHandler Exited {
+		add {
+			wrapped.EnableRaisingEvents = true;
+			wrapped.Exited += value;
+		}
+		remove {
+			wrapped.Exited -= value;
+		}
+	}
+
+	public bool HasExited => wrapped.HasExited;
+	public int ExitCode => wrapped.ExitCode;
+	public StreamWriter StandardInput => wrapped.StandardInput;
+
+	private readonly System.Diagnostics.Process wrapped;
+
+	internal Process(System.Diagnostics.Process wrapped) {
+		this.wrapped = wrapped;
+	}
+
+	public void Start() {
+		if (!OperatingSystem.IsWindows()) {
+			this.wrapped.OutputDataReceived += OnStandardOutputDataReceived;
+			this.wrapped.ErrorDataReceived += OnStandardErrorDataReceived;
+		}
+			
+		this.wrapped.Start();
+
+		// https://github.com/dotnet/runtime/issues/81896
+		if (OperatingSystem.IsWindows()) {
+			Task.Factory.StartNew(ReadStandardOutputSynchronously, TaskCreationOptions.LongRunning);
+			Task.Factory.StartNew(ReadStandardErrorSynchronously, TaskCreationOptions.LongRunning);
+		}
+		else {
+			this.wrapped.BeginOutputReadLine();
+			this.wrapped.BeginErrorReadLine();
+		}
+	}
+
+	private void OnStandardOutputDataReceived(object sender, DataReceivedEventArgs e) {
+		OnStandardStreamDataReceived(e.Data, isError: false);
+	}
+
+	private void OnStandardErrorDataReceived(object sender, DataReceivedEventArgs e) {
+		OnStandardStreamDataReceived(e.Data, isError: true);
+	}
+
+	private void OnStandardStreamDataReceived(string? line, bool isError) {
+		if (line != null) {
+			OutputReceived?.Invoke(this, new Output(line, isError));
+		}
+	}
+
+	private void ReadStandardOutputSynchronously() {
+		ReadStandardStreamSynchronously(wrapped.StandardOutput, isError: false);
+	}
+
+	private void ReadStandardErrorSynchronously() {
+		ReadStandardStreamSynchronously(wrapped.StandardError, isError: true);
+	}
+
+	private void ReadStandardStreamSynchronously(StreamReader reader, bool isError) {
+		try {
+			while (reader.ReadLine() is {} line) {
+				OutputReceived?.Invoke(this, new Output(line, isError));
+			}
+		} catch (ObjectDisposedException) {
+			// Ignore.
+		}
+	}
+
+	public Task WaitForExitAsync(CancellationToken cancellationToken) {
+		return wrapped.WaitForExitAsync(cancellationToken);
+	}
+
+	public void Kill(bool entireProcessTree = false) {
+		wrapped.Kill(entireProcessTree);
+	}
+
+	public void Dispose() {
+		wrapped.Dispose();
+	}
+}

Utils/Phantom.Utils.Runtime/ProcessConfigurator.cs

@@ -0,0 +1,37 @@
+using System.Collections.ObjectModel;
+using System.Diagnostics;
+
+namespace Phantom.Utils.Runtime; 
+
+public sealed class ProcessConfigurator {
+	private readonly ProcessStartInfo startInfo = new () {
+		RedirectStandardOutput = true,
+		RedirectStandardError = true
+	};
+	
+	public string FileName {
+		get => startInfo.FileName;
+		set => startInfo.FileName = value;
+	}
+
+	public Collection<string> ArgumentList => startInfo.ArgumentList;
+
+	public string WorkingDirectory {
+		get => startInfo.WorkingDirectory;
+		set => startInfo.WorkingDirectory = value;
+	}
+
+	public bool RedirectInput {
+		get => startInfo.RedirectStandardInput;
+		set => startInfo.RedirectStandardInput = value;
+	}
+	
+	public bool UseShellExecute {
+		get => startInfo.UseShellExecute;
+		set => startInfo.UseShellExecute = value;
+	}
+
+	public Process CreateProcess() {
+		return new Process(new System.Diagnostics.Process { StartInfo = startInfo });
+	}
+}

Utils/Phantom.Utils.Runtime/Tasks.cs

@@ -0,0 +1,11 @@
+namespace Phantom.Utils.Runtime; 
+
+public static class Tasks {
+	public static TaskCompletionSource CreateCompletionSource() {
+		return new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
+	}
+
+	public static TaskCompletionSource<T> CreateCompletionSource<T>() {
+		return new TaskCompletionSource<T>(TaskCreationOptions.RunContinuationsAsynchronously);
+	}
+}