tgstation-server 6.14.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>(),
297 var eventConsumer = new EventConsumer(configuration);
298 var repoManager = repositoryManagerFactory.CreateRepositoryManager(repoIoManager, eventConsumer);
299 try
300 {
301 var engineManager = new EngineManager(
302 byondIOManager,
304 eventConsumer,
305 loggerFactory.CreateLogger<EngineManager>());
306
307 var dmbFactory = new DmbFactory(
309 gameIoManager,
311 eventConsumer,
313 loggerFactory.CreateLogger<DmbFactory>(),
314 metadata);
315 try
316 {
317 var commandFactory = new CommandFactory(assemblyInformationProvider, engineManager, repoManager, databaseContextFactory, dmbFactory, metadata);
318
319 var chatManager = chatFactory.CreateChatManager(commandFactory, metadata.ChatSettings);
320 try
321 {
322 var reattachInfoHandler = new SessionPersistor(
324 dmbFactory,
326 loggerFactory.CreateLogger<SessionPersistor>(),
327 metadata);
328
329 var sessionControllerFactory = new SessionControllerFactory(
331 engineManager,
335 gameIoManager,
336 diagnosticsIOManager,
337 chatManager,
340 bridgeRegistrar,
342 eventConsumer,
349 metadata);
350
351 var watchdog = watchdogFactory.CreateWatchdog(
352 chatManager,
353 dmbFactory,
354 reattachInfoHandler,
355 sessionControllerFactory,
356 gameIoManager,
357 diagnosticsIOManager,
358 configuration, // watchdog doesn't need itself as an event consumer
361 metadata,
362 metadata.DreamDaemonSettings!);
363 try
364 {
365 eventConsumer.SetWatchdog(watchdog);
366 commandFactory.SetWatchdog(watchdog);
367
368 Instance? instance = null;
369 var dreamMaker = new DreamMaker(
370 engineManager,
371 gameIoManager,
372 configuration,
373 sessionControllerFactory,
374 eventConsumer,
375 chatManager,
377 dmbFactory,
378 repoManager,
382 loggerFactory.CreateLogger<DreamMaker>(),
384 metadata);
385
386 instance = new Instance(
387 metadata,
388 repoManager,
389 engineManager,
390 dreamMaker,
391 watchdog,
392 chatManager,
393 configuration,
394 dmbFactory,
396 eventConsumer,
399 loggerFactory.CreateLogger<Instance>());
400
401 return instance;
402 }
403 catch
404 {
405 await watchdog.DisposeAsync();
406 throw;
407 }
408 }
409 catch
410 {
411 await chatManager.DisposeAsync();
412 throw;
413 }
414 }
415 catch
416 {
417 dmbFactory.Dispose();
418 throw;
419 }
420 }
421 catch
422 {
423 repoManager.Dispose();
424 throw;
425 }
426 }
427#pragma warning restore CA1506
428
430 public Task StartAsync(CancellationToken cancellationToken)
431 => Task.WhenAll(
432 repositoryManagerFactory.StartAsync(cancellationToken),
433 engineInstaller.CleanCache(cancellationToken));
434
436 public Task StopAsync(CancellationToken cancellationToken) => repositoryManagerFactory.StopAsync(cancellationToken);
437
443 ResolvingIOManager CreateInstanceIOManager(Models.Instance metadata) => new(ioManager, metadata.Path!);
444 }
445}
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.