Skip to content

Harden config loading against exceptions #636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 18, 2025
Merged

Harden config loading against exceptions #636

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a6f560
Harden config loading against exceptions
DrakiaXYZ Oct 18, 2025
a5fe584
- Pass through main exception on json deserialization failure
DrakiaXYZ Oct 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 27 additions & 4 deletions Libraries/SPTarkov.Server.Core/Servers/ConfigServer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Collections.Frozen;
using System.Text.Json;
using SPTarkov.DI.Annotations;
using SPTarkov.Server.Core.Models.Enums;
using SPTarkov.Server.Core.Models.Spt.Config;
Expand Down Expand Up @@ -75,22 +76,44 @@ public void Initialize()
if (acceptableFileExtensions.Contains(FileUtil.GetFileExtension(file)))
{
var type = GetConfigTypeByFilename(file);
var deserializedContent = JsonUtil.DeserializeFromFile(file, type);
if (type == null)
{
Logger.Error($"Config file: {file} has no associated ConfigTypes entry. Skipping");
continue;
}

object? deserializedContent = null;
try
{
deserializedContent = JsonUtil.DeserializeFromFile(file, type);
}
catch (JsonException ex)
{
Logger.Error($"Config file: {file} failed to deserialize");
throw new Exception($"Server will not run until the: {file} config error mentioned above is fixed", ex);
}

if (deserializedContent == null)
{
Logger.Error($"Config file: {file} is corrupt. Use a site like: https://jsonlint.com to find the issue.");
throw new Exception($"Server will not run until the: {file} config error mentioned above is fixed");
throw new Exception($"Server will not run until the: {file} config error mentioned above is fixed");
}

_configs[$"spt-{FileUtil.StripExtension(file)}"] = deserializedContent;
}
}
}

private Type GetConfigTypeByFilename(string filename)
private Type? GetConfigTypeByFilename(string filename)
{
var type = Enum.GetValues<ConfigTypes>().First(en => en.GetValue().Contains(FileUtil.StripExtension(filename)));
Func<ConfigTypes, bool> filterMethod = (entry => entry.GetValue().Contains(FileUtil.StripExtension(filename)));

if (!Enum.GetValues<ConfigTypes>().Any(filterMethod))
{
return null;
}

var type = Enum.GetValues<ConfigTypes>().First(filterMethod);
return type.GetConfigType();
}
}
Loading