Tgstation.Server.Host.ServerFactory Class Reference

Implementation of IServerFactory. More...

Inheritance diagram for Tgstation.Server.Host.ServerFactory:

Collaboration diagram for Tgstation.Server.Host.ServerFactory:

Public Member Functions
async ValueTask< IServer?>	CreateServer (string[] args, string? updatePath, CancellationToken cancellationToken)
	Create a IServer. Parameters args The arguments for the IServer. updatePath The directory in which to install server updates. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in a new IServer if it should be run, null otherwise.

Static Public Attributes
const string	AppSettings = "appsettings"
	Name of the appsettings file.

Properties
IIOManager	IOManager [get]
	The IIOManager for the IServerFactory.
Properties inherited from Tgstation.Server.Host.IServerFactory

Private Attributes
readonly IAssemblyInformationProvider	assemblyInformationProvider
	The IAssemblyInformationProvider for the ServerFactory.

Detailed Description

Implementation of IServerFactory.

Definition at line 25 of file ServerFactory.cs.

Member Function Documentation

CreateServer()

async ValueTask< IServer?> Tgstation.Server.Host.ServerFactory.CreateServer	(	string[]	args,
		string?	updatePath,
		CancellationToken	cancellationToken
	)

Create a IServer.

Parameters

args	The arguments for the IServer.
updatePath	The directory in which to install server updates.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in a new IServer if it should be run, null otherwise.

Implements Tgstation.Server.Host.IServerFactory.

Definition at line 54 of file ServerFactory.cs.

        {
            ArgumentNullException.ThrowIfNull(args);
 
            // need to shove this arg in to disable config reloading unless a user specifically overrides it
            if (!args.Any(arg => arg.Contains("hostBuilder:reloadConfigOnChange", StringComparison.OrdinalIgnoreCase))
                && String.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("hostBuilder__reloadConfigOnChange")))
            {
                var oldArgs = args;
                args = new string[oldArgs.Length + 1];
                Array.Copy(oldArgs, args, oldArgs.Length);
                args[oldArgs.Length] = "--hostBuilder:reloadConfigOnChange=false";
            }
 
            const string AppSettingsRelocationKey = $"--{AppSettings}-base-path=";
 
            var appsettingsRelativeBasePathArgument = args.FirstOrDefault(arg => arg.StartsWith(AppSettingsRelocationKey, StringComparison.Ordinal));
            string basePath;
            if (appsettingsRelativeBasePathArgument != null)
                basePath = IOManager.ResolvePath(appsettingsRelativeBasePathArgument[AppSettingsRelocationKey.Length..]);
            else
                basePath = IOManager.ResolvePath();
 
            // this is a massive bloody hack but I don't know a better way to do it
            // It's needed for the setup wizard
            Environment.SetEnvironmentVariable($"{InternalConfiguration.Section}__{nameof(InternalConfiguration.AppSettingsBasePath)}", basePath);
 
            IHostBuilder CreateDefaultBuilder() => Microsoft.Extensions.Hosting.Host.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((context, builder) =>
                {
                    builder.SetBasePath(basePath);
 
                    builder.AddYamlFile($"{AppSettings}.yml", optional: true, reloadOnChange: false)
                        .AddYamlFile($"{AppSettings}.{context.HostingEnvironment.EnvironmentName}.yml", optional: true, reloadOnChange: false);
 
                    // reorganize the builder so our yaml configs don't override the env/cmdline configs
                    // values obtained via debugger
                    var environmentJsonConfig = builder.Sources[2];
                    var envConfig = builder.Sources[3];
 
                    // CURSED
                    // https://github.com/dotnet/runtime/blob/30dc7e7aedb7aab085c7d9702afeae5bc5a43133/src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs#L246-L249
#if !NET8_0
#error Validate this monstrosity works on current .NET
#endif
                    IConfigurationSource? cmdLineConfig;
                    IConfigurationSource baseYmlConfig, environmentYmlConfig;
                    if (args.Length == 0)
                    {
                        cmdLineConfig = null;
                        baseYmlConfig = builder.Sources[4];
                        environmentYmlConfig = builder.Sources[5];
                    }
                    else
                    {
                        cmdLineConfig = builder.Sources[4];
                        baseYmlConfig = builder.Sources[5];
                        environmentYmlConfig = builder.Sources[6];
                    }
 
                    builder.Sources[2] = baseYmlConfig;
                    builder.Sources[3] = environmentJsonConfig;
                    builder.Sources[4] = environmentYmlConfig;
                    builder.Sources[5] = envConfig;
 
                    if (cmdLineConfig != null)
                    {
                        builder.Sources[6] = cmdLineConfig;
                    }
                });
 
            var setupWizardHostBuilder = CreateDefaultBuilder()
                .UseSetupApplication(assemblyInformationProvider, IOManager);
 
            IPostSetupServices postSetupServices;
            using (var setupHost = setupWizardHostBuilder.Build())
            {
                ILogger<ServerFactory> logger = setupHost.Services.GetRequiredService<ILogger<ServerFactory>>();
                postSetupServices = setupHost.Services.GetRequiredService<IPostSetupServices>();
                await setupHost.RunAsync(cancellationToken);
 
                if (postSetupServices.GeneralConfiguration.SetupWizardMode == SetupWizardMode.Only)
                {
                    logger.LogInformation("Shutting down due to only running setup wizard.");
                    return null;
                }
 
                if (postSetupServices.ReloadRequired)
                {
                    logger.LogInformation("TGS must restart to reload the updated configuration.");
                    return null;
                }
            }
 
            var hostBuilder = CreateDefaultBuilder()
                .ConfigureWebHost(webHostBuilder =>
                    webHostBuilder
                        .UseKestrel(kestrelOptions =>
                        {
                            var serverPortProvider = kestrelOptions.ApplicationServices.GetRequiredService<IServerPortProvider>();
                            kestrelOptions.ListenAnyIP(
                                serverPortProvider.HttpApiPort,
                                listenOptions => listenOptions.Protocols = HttpProtocols.Http1); // Can't use Http1And2 without TLS. Let the reverse proxy handle it
 
                            // with 515 we lost the ability to test this effectively. Just bump it slightly above the default and let the existing limit hold us back
                            kestrelOptions.Limits.MaxRequestLineSize = 8400;
                        })
                        .UseIIS()
                        .UseIISIntegration()
                        .UseApplication(assemblyInformationProvider, IOManager, postSetupServices)
                        .SuppressStatusMessages(true)
                        .UseShutdownTimeout(
                            TimeSpan.FromMinutes(
                                postSetupServices.GeneralConfiguration.RestartTimeoutMinutes)));
 
            if (updatePath != null)
                hostBuilder.UseContentRoot(
                    IOManager.ResolvePath(
                        IOManager.GetDirectoryName(assemblyInformationProvider.Path)));
 
            return new Server(hostBuilder, updatePath);
        }

References Tgstation.Server.Host.ServerFactory.assemblyInformationProvider, Tgstation.Server.Host.Setup.IPostSetupServices.GeneralConfiguration, Tgstation.Server.Host.IO.IIOManager.GetDirectoryName(), Tgstation.Server.Host.ServerFactory.IOManager, Tgstation.Server.Host.System.IAssemblyInformationProvider.Path, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), and Tgstation.Server.Host.Configuration.GeneralConfiguration.RestartTimeoutMinutes.

Here is the call graph for this function:

Member Data Documentation

AppSettings

const string Tgstation.Server.Host.ServerFactory.AppSettings = "appsettings"

static

Name of the appsettings file.

Definition at line 30 of file ServerFactory.cs.

assemblyInformationProvider

readonly IAssemblyInformationProvider Tgstation.Server.Host.ServerFactory.assemblyInformationProvider

private

The IAssemblyInformationProvider for the ServerFactory.

Definition at line 35 of file ServerFactory.cs.

Referenced by Tgstation.Server.Host.ServerFactory.CreateServer().

Property Documentation

IOManager

IIOManager Tgstation.Server.Host.ServerFactory.IOManager

get

The IIOManager for the IServerFactory.

Implements Tgstation.Server.Host.IServerFactory.

Definition at line 38 of file ServerFactory.cs.

{ get; }

Referenced by Tgstation.Server.Host.ServerFactory.CreateServer().

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Host/ServerFactory.cs