tgstation-server 6.17.0
The /tg/station 13 server suite
Loading...
Searching...
No Matches
InstanceFactory.cs
Go to the documentation of this file.
1using System;
2using System.Collections.Generic;
3using System.Globalization;
4using System.Threading;
5using System.Threading.Tasks;
6
7using Microsoft.Extensions.Logging;
8using Microsoft.Extensions.Options;
9
10using Prometheus;
11
31
33{
36 {
41
46
51
55 readonly ILoggerFactory loggerFactory;
56
61
66
71
76
81
86
91
96
101
106
111
116
121
126
131
136
141
146
150 readonly IMetricFactory metricFactory;
151
156
161
167 static ResolvingIOManager CreateGameIOManager(IIOManager instanceIOManager) => new(instanceIOManager, "Game");
168
169#pragma warning disable CA1502 // TODO: Decomplexify
198 public InstanceFactory(
202 ILoggerFactory loggerFactory,
221 IMetricFactory metricFactory,
222 IOptions<GeneralConfiguration> generalConfigurationOptions,
223 IOptions<SessionConfiguration> sessionConfigurationOptions)
224 {
225 this.ioManager = ioManager ?? throw new ArgumentNullException(nameof(ioManager));
226 this.databaseContextFactory = databaseContextFactory ?? throw new ArgumentNullException(nameof(databaseContextFactory));
227 this.assemblyInformationProvider = assemblyInformationProvider ?? throw new ArgumentNullException(nameof(assemblyInformationProvider));
228 this.loggerFactory = loggerFactory ?? throw new ArgumentNullException(nameof(loggerFactory));
229 this.topicClientFactory = topicClientFactory ?? throw new ArgumentNullException(nameof(topicClientFactory));
230 this.cryptographySuite = cryptographySuite ?? throw new ArgumentNullException(nameof(cryptographySuite));
231 this.synchronousIOManager = synchronousIOManager ?? throw new ArgumentNullException(nameof(synchronousIOManager));
232 this.linkFactory = linkFactory ?? throw new ArgumentNullException(nameof(linkFactory));
233 this.engineInstaller = engineInstaller ?? throw new ArgumentNullException(nameof(engineInstaller));
234 this.chatFactory = chatFactory ?? throw new ArgumentNullException(nameof(chatFactory));
235 this.processExecutor = processExecutor ?? throw new ArgumentNullException(nameof(processExecutor));
236 this.postWriteHandler = postWriteHandler ?? throw new ArgumentNullException(nameof(postWriteHandler));
237 this.watchdogFactory = watchdogFactory ?? throw new ArgumentNullException(nameof(watchdogFactory));
238 this.jobManager = jobManager ?? throw new ArgumentNullException(nameof(jobManager));
239 this.networkPromptReaper = networkPromptReaper ?? throw new ArgumentNullException(nameof(networkPromptReaper));
240 this.platformIdentifier = platformIdentifier ?? throw new ArgumentNullException(nameof(platformIdentifier));
241 this.repositoryManagerFactory = repositoryManagerFactory ?? throw new ArgumentNullException(nameof(repositoryManagerFactory));
242 this.serverPortProvider = serverPortProvider ?? throw new ArgumentNullException(nameof(serverPortProvider));
243 this.fileTransferService = fileTransferService ?? throw new ArgumentNullException(nameof(fileTransferService));
244 this.remoteDeploymentManagerFactory = remoteDeploymentManagerFactory ?? throw new ArgumentNullException(nameof(remoteDeploymentManagerFactory));
245 this.asyncDelayer = asyncDelayer ?? throw new ArgumentNullException(nameof(asyncDelayer));
246 this.dotnetDumpService = dotnetDumpService ?? throw new ArgumentNullException(nameof(dotnetDumpService));
247 this.metricFactory = metricFactory ?? throw new ArgumentNullException(nameof(metricFactory));
248 generalConfiguration = generalConfigurationOptions?.Value ?? throw new ArgumentNullException(nameof(generalConfigurationOptions));
249 sessionConfiguration = sessionConfigurationOptions?.Value ?? throw new ArgumentNullException(nameof(sessionConfigurationOptions));
250 }
251#pragma warning restore CA1502
252
254 public IIOManager CreateGameIOManager(Models.Instance metadata)
255 {
256 ArgumentNullException.ThrowIfNull(metadata);
257
258 var instanceIoManager = CreateInstanceIOManager(metadata);
259 return CreateGameIOManager(instanceIoManager);
260 }
261
263#pragma warning disable CA1506 // TODO: Decomplexify
264 public async ValueTask<IInstance> CreateInstance(IBridgeRegistrar bridgeRegistrar, Models.Instance metadata)
265 {
266 ArgumentNullException.ThrowIfNull(bridgeRegistrar);
267 ArgumentNullException.ThrowIfNull(metadata);
268
269 // Create the ioManager for the instance
270 var instanceIoManager = CreateInstanceIOManager(metadata);
271
272 // various other ioManagers
273 var repoIoManager = new ResolvingIOManager(instanceIoManager, "Repository");
274 var byondIOManager = new ResolvingIOManager(instanceIoManager, "Byond");
275 var gameIoManager = CreateGameIOManager(instanceIoManager);
276 var diagnosticsIOManager = new ResolvingIOManager(instanceIoManager, "Diagnostics");
277 var configurationIoManager = new ResolvingIOManager(instanceIoManager, "Configuration");
278
279 var metricFactory = this.metricFactory.WithLabels(
280 new Dictionary<string, string>
281 {
282 { "instance_name", metadata.Name! },
283 { "instance_id", metadata.Id!.Value.ToString(CultureInfo.InvariantCulture) },
284 });
285
286 var configuration = new StaticFiles.Configuration(
287 configurationIoManager,
294 loggerFactory.CreateLogger<StaticFiles.Configuration>(),
295 metadata,
298 var eventConsumer = new EventConsumer(configuration);
299 var repoManager = repositoryManagerFactory.CreateRepositoryManager(repoIoManager, eventConsumer);
300 try
301 {
302 var engineManager = new EngineManager(
303 byondIOManager,
305 eventConsumer,
306 loggerFactory.CreateLogger<EngineManager>());
307
308 var dmbFactory = new DmbFactory(
310 gameIoManager,
312 eventConsumer,
314 loggerFactory.CreateLogger<DmbFactory>(),
315 metadata);
316 try
317 {
318 var commandFactory = new CommandFactory(assemblyInformationProvider, engineManager, repoManager, databaseContextFactory, dmbFactory, metadata);
319
320 var chatManager = chatFactory.CreateChatManager(commandFactory, metadata.ChatSettings);
321 try
322 {
323 var reattachInfoHandler = new SessionPersistor(
325 dmbFactory,
327 loggerFactory.CreateLogger<SessionPersistor>(),
328 metadata);
329
330 var sessionControllerFactory = new SessionControllerFactory(
332 engineManager,
336 gameIoManager,
337 diagnosticsIOManager,
338 chatManager,
341 bridgeRegistrar,
343 eventConsumer,
350 metadata);
351
352 var watchdog = watchdogFactory.CreateWatchdog(
353 chatManager,
354 dmbFactory,
355 reattachInfoHandler,
356 sessionControllerFactory,
357 gameIoManager,
358 diagnosticsIOManager,
359 configuration, // watchdog doesn't need itself as an event consumer
362 metadata,
363 metadata.DreamDaemonSettings!);
364 try
365 {
366 eventConsumer.SetWatchdog(watchdog);
367 commandFactory.SetWatchdog(watchdog);
368
369 Instance? instance = null;
370 var dreamMaker = new DreamMaker(
371 engineManager,
372 gameIoManager,
373 configuration,
374 sessionControllerFactory,
375 eventConsumer,
376 chatManager,
378 dmbFactory,
379 repoManager,
383 loggerFactory.CreateLogger<DreamMaker>(),
385 metadata);
386
387 instance = new Instance(
388 metadata,
389 repoManager,
390 engineManager,
391 dreamMaker,
392 watchdog,
393 chatManager,
394 configuration,
395 dmbFactory,
397 eventConsumer,
400 loggerFactory.CreateLogger<Instance>());
401
402 return instance;
403 }
404 catch
405 {
406 await watchdog.DisposeAsync();
407 throw;
408 }
409 }
410 catch
411 {
412 await chatManager.DisposeAsync();
413 throw;
414 }
415 }
416 catch
417 {
418 dmbFactory.Dispose();
419 throw;
420 }
421 }
422 catch
423 {
424 repoManager.Dispose();
425 throw;
426 }
427 }
428#pragma warning restore CA1506
429
431 public Task StartAsync(CancellationToken cancellationToken)
432 => Task.WhenAll(
433 repositoryManagerFactory.StartAsync(cancellationToken),
434 engineInstaller.CleanCache(cancellationToken));
435
437 public Task StopAsync(CancellationToken cancellationToken) => repositoryManagerFactory.StopAsync(cancellationToken);
438
444 ResolvingIOManager CreateInstanceIOManager(Models.Instance metadata) => new(ioManager, metadata.Path!);
445 }
446}
readonly IDatabaseContextFactory databaseContextFactory
The IDatabaseContextFactory for the InstanceFactory.
readonly ITopicClientFactory topicClientFactory
The ITopicClientFactory for the InstanceFactory.
readonly ISynchronousIOManager synchronousIOManager
The ISynchronousIOManager for the InstanceFactory.
readonly IPlatformIdentifier platformIdentifier
The IPlatformIdentifier for the InstanceFactory.
readonly SessionConfiguration sessionConfiguration
The SessionConfiguration for the InstanceFactory.
readonly IEngineInstaller engineInstaller
The IEngineInstaller for the InstanceFactory.
readonly IIOManager ioManager
The IIOManager for the InstanceFactory.
readonly IAsyncDelayer asyncDelayer
The IAsyncDelayer for the InstanceFactory.
readonly IMetricFactory metricFactory
The IMetricFactory for the InstanceFactory.
readonly IProcessExecutor processExecutor
The IProcessExecutor for the InstanceFactory.
readonly IJobManager jobManager
The IJobManager for the InstanceFactory.
readonly IChatManagerFactory chatFactory
The IChatManagerFactory for the InstanceFactory.
readonly IRepositoryManagerFactory repositoryManagerFactory
The IRepositoryManagerFactory for the InstanceFactory.
readonly IServerPortProvider serverPortProvider
The IServerPortProvider for the InstanceFactory.
readonly GeneralConfiguration generalConfiguration
The GeneralConfiguration for the InstanceFactory.
Task StartAsync(CancellationToken cancellationToken)
Task StopAsync(CancellationToken cancellationToken)
readonly IWatchdogFactory watchdogFactory
The IWatchdogFactory for the InstanceFactory.
static ResolvingIOManager CreateGameIOManager(IIOManager instanceIOManager)
Create the IIOManager pointing to the "Game" directory of a given instanceIOManager .
readonly IAssemblyInformationProvider assemblyInformationProvider
The IAssemblyInformationProvider for the InstanceFactory.
ResolvingIOManager CreateInstanceIOManager(Models.Instance metadata)
Create the IIOManager for a given set of instance metadata .
readonly IPostWriteHandler postWriteHandler
The IPostWriteHandler for the InstanceFactory.
IIOManager CreateGameIOManager(Models.Instance metadata)
Create an IIOManager that resolves to the "Game" directory of the Models.Instance defined by metadata...
readonly IDotnetDumpService dotnetDumpService
The IDotnetDumpService for the InstanceFactory.
readonly ICryptographySuite cryptographySuite
The ICryptographySuite for the InstanceFactory.
async ValueTask< IInstance > CreateInstance(IBridgeRegistrar bridgeRegistrar, Models.Instance metadata)
Create an IInstance.A ValueTask<TResult> resulting in a new IInstance.
readonly IFileTransferTicketProvider fileTransferService
The IFileTransferTicketProvider for the InstanceFactory.
readonly INetworkPromptReaper networkPromptReaper
The INetworkPromptReaper for the InstanceFactory.
readonly IFilesystemLinkFactory linkFactory
The IFilesystemLinkFactory for the InstanceFactory.
readonly IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory
The IRemoteDeploymentManagerFactory for the InstanceFactory.
readonly ILoggerFactory loggerFactory
The ILoggerFactory for the InstanceFactory.
Configuration options for the game sessions.
An IIOManager that resolve relative paths from another IIOManager to a subdirectory of that.
IChatManager CreateChatManager(ICommandFactory commandFactory, IEnumerable< Models.ChatBot > initialChatBots)
Create a IChatManager.
For downloading and installing game engines for a given system.
Task CleanCache(CancellationToken cancellationToken)
Attempts to cleans the engine's cache folder for the system.
IRepositoryManager CreateRepositoryManager(IIOManager ioManager, IEventConsumer eventConsumer)
Create a IRepositoryManager.
IWatchdog CreateWatchdog(IChatManager chat, IDmbFactory dmbFactory, ISessionPersistor sessionPersistor, ISessionControllerFactory sessionControllerFactory, IIOManager gameIOManager, IIOManager diagnosticsIOManager, IEventConsumer eventConsumer, IRemoteDeploymentManagerFactory remoteDeploymentManagerFactory, IMetricFactory metricFactory, Api.Models.Instance instance, DreamDaemonSettings settings)
Creates a IWatchdog.
Provides access to the server's HttpApiPort.
Factory for scoping usage of IDatabaseContexts. Meant for use by Components.
Interface for using filesystems.
Definition IIOManager.cs:13
Handles changing file modes/permissions after writing.
For accessing the disk in a synchronous manner.
Manages the runtime of Jobs.
Contains various cryptographic functions.
Service for managing the dotnet-dump installation.
On Windows, DreamDaemon will show an unskippable prompt when using /world/proc/OpenPort()....
For identifying the current platform.
Service for temporarily storing files to be downloaded or uploaded.