Report issues with null settings/duplicate ids

SecretAPI/Features/UserSettings/CustomSetting.cs

@@ -2,10 +2,12 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using global::UserSettings.ServerSpecific;
 using LabApi.Events.Handlers;
+using LabApi.Features.Console;
 using LabApi.Features.Enums;
 using LabApi.Features.Wrappers;
 using Mirror;
@@ -155,13 +157,22 @@ public bool IsShared
     /// Registers a collection of settings.
     /// </summary>
     /// <param name="settings">The settings to register.</param>
-    public static void Register(params CustomSetting[] settings) => CustomSettings.AddRange(settings);
+    public static void Register(params CustomSetting[] settings)
+    {
+        settings.ForEach(setting => ReportSettingIssue(setting, null));
+        CustomSettings.AddRange(settings);
+    }
 
     /// <summary>
     /// Registers a collection of settings.
     /// </summary>
     /// <param name="settings">The settings to register.</param>
-    public static void Register(IEnumerable<CustomSetting> settings) => CustomSettings.AddRange(settings);
+    public static void Register(IEnumerable<CustomSetting> settings)
+    {
+        foreach (CustomSetting? setting in settings)
+            ReportSettingIssue(setting, null);
+        CustomSettings.AddRange(settings);
+    }
 
     /// <summary>
     /// Unregisters collection of settings.
@@ -322,6 +333,28 @@ public static void SendSettingsToPlayer(Player player, int? version = null)
         ListPool<CustomSetting>.Shared.Return(playerSettings);
     }
 
+    /// <summary>
+    /// Reports issues with settings being registered.
+    /// </summary>
+    /// <param name="setting">The <see cref="CustomSetting"/> to validate.</param>
+    /// <param name="settingBase">The <see cref="ServerSpecificSettingBase"/> to validate.</param>
+    internal static void ReportSettingIssue(CustomSetting? setting, ServerSpecificSettingBase? settingBase)
+    {
+        if (settingBase == null && setting == null)
+        {
+            Logger.Error("[CustomSetting.TryValidateSetting] Failed to validate null setting! " + new StackTrace());
+            return;
+        }
+
+        int id = setting?.Id ?? settingBase!.SettingId;
+        string? sharedIdInfo = CustomSettings.FirstOrDefault(s => s.Id == id)?.GetType().FullName ?? ServerSpecificSettingsSync.DefinedSettings.FirstOrDefault(s => s.SettingId == id)?.Label;
+        if (sharedIdInfo != null)
+        {
+            Logger.Error($"[CustomSetting.TryValidateSetting] {setting?.GetType().FullName ?? settingBase?.Label ?? "UNKNOWN"} is being registered with a duplicate ID ({id}) shared by {sharedIdInfo} {new StackTrace()}");
+            return;
+        }
+    }
+
     /// <summary>
     /// Checks whether a <see cref="ReferenceHub"/> is equal to <see cref="KnownOwner"/>.
     /// </summary>

SecretAPI/Patches/Features/ReportDefinedSettingPatch.cs

@@ -0,0 +1,19 @@
+namespace SecretAPI.Patches.Features;
+
+using HarmonyLib;
+using SecretAPI.Attributes;
+using SecretAPI.Features.UserSettings;
+using UserSettings.ServerSpecific;
+
+/// <summary>
+/// Logs issues with <see cref="ServerSpecificSettingsSync.DefinedSettings"/>.
+/// </summary>
+[HarmonyPatchCategory(nameof(CustomSetting))]
+[HarmonyPatch(typeof(ServerSpecificSettingsSync), nameof(ServerSpecificSettingsSync.DefinedSettings), MethodType.Setter)]
+internal static class ReportDefinedSettingPatch
+{
+    private static void Postfix(ref ServerSpecificSettingBase[] value)
+    {
+        value.ForEach(setting => CustomSetting.ReportSettingIssue(null, setting));
+    }
+}