From e72ebb95c53016249846f7d05aec71924e100069 Mon Sep 17 00:00:00 2001
From: Dominion <Cyberboss@users.noreply.github.com>
Date: Sat, 22 Apr 2023 10:59:39 -0400
Subject: [PATCH] Split the start/stop functionality of ISwarmService into its
 own interface

---
 .../Components/InstanceManager.cs             | 14 +++++------
 src/Tgstation.Server.Host/Core/Application.cs |  1 +
 .../Swarm/ISwarmService.cs                    | 14 -----------
 .../Swarm/ISwarmServiceController.cs          | 25 +++++++++++++++++++
 .../Swarm/SwarmService.cs                     |  2 +-
 5 files changed, 34 insertions(+), 22 deletions(-)
 create mode 100644 src/Tgstation.Server.Host/Swarm/ISwarmServiceController.cs

diff --git a/src/Tgstation.Server.Host/Components/InstanceManager.cs b/src/Tgstation.Server.Host/Components/InstanceManager.cs
index 44d112ca94..699aef0c47 100644
--- a/src/Tgstation.Server.Host/Components/InstanceManager.cs
+++ b/src/Tgstation.Server.Host/Components/InstanceManager.cs
@@ -82,9 +82,9 @@ namespace Tgstation.Server.Host.Components
 		readonly IServerPortProvider serverPortProvider;
 
 		/// <summary>
-		/// The <see cref="ISwarmService"/> for the <see cref="InstanceManager"/>.
+		/// The <see cref="ISwarmServiceController"/> for the <see cref="InstanceManager"/>.
 		/// </summary>
-		readonly ISwarmService swarmService;
+		readonly ISwarmServiceController swarmServiceController;
 
 		/// <summary>
 		/// The <see cref="ILogger"/> for the <see cref="InstanceManager"/>.
@@ -138,7 +138,7 @@ namespace Tgstation.Server.Host.Components
 		/// <param name="systemIdentityFactory">The value of <see cref="systemIdentityFactory"/>.</param>
 		/// <param name="asyncDelayer">The value of <see cref="asyncDelayer"/>.</param>
 		/// <param name="serverPortProvider">The value of <see cref="serverPortProvider"/>.</param>
-		/// <param name="swarmService">The value of <see cref="swarmService"/>.</param>
+		/// <param name="swarmServiceController">The value of <see cref="swarmServiceController"/>.</param>
 		/// <param name="generalConfigurationOptions">The <see cref="IOptions{TOptions}"/> containing the value of <see cref="generalConfiguration"/>.</param>
 		/// <param name="swarmConfigurationOptions">The <see cref="IOptions{TOptions}"/> containing the value of <see cref="swarmConfiguration"/>.</param>
 		/// <param name="logger">The value of <see cref="logger"/>.</param>
@@ -152,7 +152,7 @@ namespace Tgstation.Server.Host.Components
 			ISystemIdentityFactory systemIdentityFactory,
 			IAsyncDelayer asyncDelayer,
 			IServerPortProvider serverPortProvider,
-			ISwarmService swarmService,
+			ISwarmServiceController swarmServiceController,
 			IOptions<GeneralConfiguration> generalConfigurationOptions,
 			IOptions<SwarmConfiguration> swarmConfigurationOptions,
 			ILogger<InstanceManager> logger)
@@ -166,7 +166,7 @@ namespace Tgstation.Server.Host.Components
 			this.systemIdentityFactory = systemIdentityFactory ?? throw new ArgumentNullException(nameof(systemIdentityFactory));
 			this.asyncDelayer = asyncDelayer ?? throw new ArgumentNullException(nameof(asyncDelayer));
 			this.serverPortProvider = serverPortProvider ?? throw new ArgumentNullException(nameof(serverPortProvider));
-			this.swarmService = swarmService ?? throw new ArgumentNullException(nameof(swarmService));
+			this.swarmServiceController = swarmServiceController ?? throw new ArgumentNullException(nameof(swarmServiceController));
 			generalConfiguration = generalConfigurationOptions?.Value ?? throw new ArgumentNullException(nameof(generalConfigurationOptions));
 			swarmConfiguration = swarmConfigurationOptions?.Value ?? throw new ArgumentNullException(nameof(swarmConfigurationOptions));
 			this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
@@ -481,7 +481,7 @@ namespace Tgstation.Server.Host.Components
 				await Task.WhenAll(instances.Select(x => OfflineInstanceImmediate(x.Value.Instance, cancellationToken)));
 				await instanceFactoryStopTask;
 
-				await swarmService.Shutdown(cancellationToken);
+				await swarmServiceController.Shutdown(cancellationToken);
 			}
 			catch (Exception ex)
 			{
@@ -578,7 +578,7 @@ namespace Tgstation.Server.Host.Components
 			SwarmRegistrationResult registrationResult;
 			do
 			{
-				registrationResult = await swarmService.Initialize(cancellationToken);
+				registrationResult = await swarmServiceController.Initialize(cancellationToken);
 
 				if (registrationResult == SwarmRegistrationResult.Unauthorized)
 					throw new InvalidOperationException("Swarm private key does not match the swarm controller's!");
diff --git a/src/Tgstation.Server.Host/Core/Application.cs b/src/Tgstation.Server.Host/Core/Application.cs
index be4b8e1a83..7dc98d518d 100644
--- a/src/Tgstation.Server.Host/Core/Application.cs
+++ b/src/Tgstation.Server.Host/Core/Application.cs
@@ -358,6 +358,7 @@ namespace Tgstation.Server.Host.Core
 			services.AddSingleton<SwarmService>();
 			services.AddSingleton<ISwarmService>(x => x.GetRequiredService<SwarmService>());
 			services.AddSingleton<ISwarmOperations>(x => x.GetRequiredService<SwarmService>());
+			services.AddSingleton<ISwarmServiceController>(x => x.GetRequiredService<SwarmService>());
 			services.AddSingleton<IServerUpdater, ServerUpdater>();
 			services.AddSingleton<IServerUpdateInitiator, ServerUpdateInitiator>();
 			services.AddSingleton<IRequestSwarmRegistrationParser, RequestSwarmRegistrationParser>();
diff --git a/src/Tgstation.Server.Host/Swarm/ISwarmService.cs b/src/Tgstation.Server.Host/Swarm/ISwarmService.cs
index b0bb3c69b7..a498374195 100644
--- a/src/Tgstation.Server.Host/Swarm/ISwarmService.cs
+++ b/src/Tgstation.Server.Host/Swarm/ISwarmService.cs
@@ -12,20 +12,6 @@ namespace Tgstation.Server.Host.Swarm
 	/// </summary>
 	public interface ISwarmService
 	{
-		/// <summary>
-		/// Attempt to register with the swarm controller if not one, sets up the database otherwise.
-		/// </summary>
-		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
-		/// <returns>A <see cref="Task{TResult}"/> resulting in the <see cref="SwarmRegistrationResult"/>.</returns>
-		Task<SwarmRegistrationResult> Initialize(CancellationToken cancellationToken);
-
-		/// <summary>
-		/// Deregister with the swarm controller or put clients into querying state.
-		/// </summary>
-		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
-		/// <returns>A <see cref="Task"/> representing the running operation.</returns>
-		Task Shutdown(CancellationToken cancellationToken);
-
 		/// <summary>
 		/// Signal to the swarm that an update is requested.
 		/// </summary>
diff --git a/src/Tgstation.Server.Host/Swarm/ISwarmServiceController.cs b/src/Tgstation.Server.Host/Swarm/ISwarmServiceController.cs
new file mode 100644
index 0000000000..5912232e04
--- /dev/null
+++ b/src/Tgstation.Server.Host/Swarm/ISwarmServiceController.cs
@@ -0,0 +1,25 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Tgstation.Server.Host.Swarm
+{
+	/// <summary>
+	/// Start and stop controllers for a swarm service.
+	/// </summary>
+	interface ISwarmServiceController
+	{
+		/// <summary>
+		/// Attempt to register with the swarm controller if not one, sets up the database otherwise.
+		/// </summary>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
+		/// <returns>A <see cref="Task{TResult}"/> resulting in the <see cref="SwarmRegistrationResult"/>.</returns>
+		Task<SwarmRegistrationResult> Initialize(CancellationToken cancellationToken);
+
+		/// <summary>
+		/// Deregister with the swarm controller or put clients into querying state.
+		/// </summary>
+		/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
+		/// <returns>A <see cref="Task"/> representing the running operation.</returns>
+		Task Shutdown(CancellationToken cancellationToken);
+	}
+}
diff --git a/src/Tgstation.Server.Host/Swarm/SwarmService.cs b/src/Tgstation.Server.Host/Swarm/SwarmService.cs
index 282a95df32..d67c6b854e 100644
--- a/src/Tgstation.Server.Host/Swarm/SwarmService.cs
+++ b/src/Tgstation.Server.Host/Swarm/SwarmService.cs
@@ -27,7 +27,7 @@ namespace Tgstation.Server.Host.Swarm
 	/// <summary>
 	/// Helps keep servers connected to the same database in sync by coordinating updates.
 	/// </summary>
-	sealed class SwarmService : ISwarmService, ISwarmOperations, IDisposable
+	sealed class SwarmService : ISwarmService, ISwarmServiceController, ISwarmOperations, IDisposable
 	{
 		/// <summary>
 		/// Interval at which the swarm controller makes health checks on nodes.