Added settings instance cache and cache invalidation

Using net6-windows target for the UI project because of windows forms
Aragas · Mar 2, 2024 · 20bbbfe · 20bbbfe
1 parent 7cce3dc
commit 20bbbfe
Show file tree

Hide file tree

Showing 18 changed files with 189 additions and 51 deletions.
diff --git a/build/common.props b/build/common.props
@@ -4,7 +4,7 @@
   <PropertyGroup>
     <GameVersion>1.0.0</GameVersion>
     <GameVersionWithPrefix>v$(GameVersion)</GameVersionWithPrefix>
-    <Version>5.9.2</Version>
+    <Version>5.10.0</Version>
     <HarmonyVersion>2.2.2</HarmonyVersion>
     <ButterLibVersion>2.8.15</ButterLibVersion>
     <UIExtenderExVersion>2.8.1</UIExtenderExVersion>

diff --git a/changelog.txt b/changelog.txt
@@ -1,4 +1,8 @@
 ---------------------------------------------------------------------------------------------------
+Version: 5.10.0
+Game Versions: v1.0.0,v1.0.1,v1.0.2,v1.0.3,v1.1.0,v1.1.1,v1.1.2,v1.1.3,v1.1.4,v1.1.5,v1.1.6,v1.2.x
+* Added Settings instance cache and cache invalidation
+---------------------------------------------------------------------------------------------------
 Version: 5.9.2
 Game Versions: v1.0.0,v1.0.1,v1.0.2,v1.0.3,v1.1.0,v1.1.1,v1.1.2,v1.1.3,v1.1.4,v1.1.5,v1.1.6,v1.2.7
 * Switched to .NET 6 for Xbox

diff --git a/src/MCM.Abstractions/Base/Global/GlobalSettings.cs b/src/MCM.Abstractions/Base/Global/GlobalSettings.cs
@@ -15,16 +15,20 @@ namespace MCM.Abstractions.Base.Global
     {
         /// <summary>
         /// A modder flriendly way to get settings from any place
+        /// We now cache it. Cache is invalidated on game start/end.
         /// </summary>
-        public static T? Instance
+        public static T? Instance => (T?) CacheInstance.GetOrAdd(Cache.GetOrAdd(typeof(T), static _ => new T().Id), static id =>
         {
-            get
-            {
-                if (!Cache.ContainsKey(typeof(T)))
-                    Cache.TryAdd(typeof(T), new T().Id);
-                return BaseSettingsProvider.Instance?.GetSettings(Cache[typeof(T)]) as T;
-            }
-        }
+            return BaseSettingsProvider.Instance?.GetSettings(id!);
+        });
+
+        /// <summary>
+        /// A slower way to get settings from any place.
+        /// </summary>
+        public static T? InstanceNotCached => (T?) BaseSettingsProvider.Instance?.GetSettings(Cache.GetOrAdd(typeof(T), static _ =>
+        {
+            return new T().Id;
+        })!);
     }
 
 #if !BANNERLORDMCM_INCLUDE_IN_CODE_COVERAGE
@@ -38,5 +42,14 @@ public static T? Instance
     abstract class GlobalSettings : BaseSettings
     {
         protected static readonly ConcurrentDictionary<Type, string> Cache = new();
+        // We don't need to clear it since the only case when the settings instance can change is when
+        // we add a new settings cotainer, which is not possible at runtime
+        protected static readonly ConcurrentDictionary<string, BaseSettings?> CacheInstance = new();
+
+        internal static void InvalidateCache()
+        {
+            Cache.Clear();
+            CacheInstance.Clear();
+        }
     }
 }
diff --git a/src/MCM.Abstractions/Base/PerCampaign/PerCampaignSettings.cs b/src/MCM.Abstractions/Base/PerCampaign/PerCampaignSettings.cs
@@ -15,16 +15,20 @@ namespace MCM.Abstractions.Base.PerCampaign
     {
         /// <summary>
         /// A modder flriendly way to get settings from any place
+        /// We now cache it. Cache is invalidated on game start/end.
         /// </summary>
-        public static T? Instance
+        public static T? Instance => (T?) CacheInstance.GetOrAdd(Cache.GetOrAdd(typeof(T), static _ => new T().Id), static id =>
         {
-            get
-            {
-                if (!Cache.ContainsKey(typeof(T)))
-                    Cache.TryAdd(typeof(T), new T().Id);
-                return BaseSettingsProvider.Instance?.GetSettings(Cache[typeof(T)]) as T;
-            }
-        }
+            return BaseSettingsProvider.Instance?.GetSettings(id!);
+        });
+
+        /// <summary>
+        /// A slower way to get settings from any place.
+        /// </summary>
+        public static T? InstanceNotCached => (T?) BaseSettingsProvider.Instance?.GetSettings(Cache.GetOrAdd(typeof(T), static _ =>
+        {
+            return new T().Id;
+        })!);
     }
 
 #if !BANNERLORDMCM_INCLUDE_IN_CODE_COVERAGE
@@ -38,7 +42,14 @@ public static T? Instance
     abstract class PerCampaignSettings : BaseSettings
     {
         protected static readonly ConcurrentDictionary<Type, string> Cache = new();
+        protected static readonly ConcurrentDictionary<string, BaseSettings?> CacheInstance = new();
 
+        internal static void InvalidateCache()
+        {
+            Cache.Clear();
+            CacheInstance.Clear();
+        }
+
         public sealed override string FormatType { get; } = "json2";
     }
 }
diff --git a/src/MCM.Abstractions/Base/PerSave/PerSaveSettings.cs b/src/MCM.Abstractions/Base/PerSave/PerSaveSettings.cs
@@ -15,16 +15,20 @@ namespace MCM.Abstractions.Base.PerSave
     {
         /// <summary>
         /// A modder flriendly way to get settings from any place
+        /// We now cache it. Cache is invalidated on game start/end.
         /// </summary>
-        public static T? Instance
+        public static T? Instance => (T?) CacheInstance.GetOrAdd(Cache.GetOrAdd(typeof(T), static _ => new T().Id), static id =>
         {
-            get
-            {
-                if (!Cache.ContainsKey(typeof(T)))
-                    Cache.TryAdd(typeof(T), new T().Id);
-                return BaseSettingsProvider.Instance?.GetSettings(Cache[typeof(T)]) as T;
-            }
-        }
+            return BaseSettingsProvider.Instance?.GetSettings(id!);
+        });
+
+        /// <summary>
+        /// A slower way to get settings from any place.
+        /// </summary>
+        public static T? InstanceNotCached => (T?) BaseSettingsProvider.Instance?.GetSettings(Cache.GetOrAdd(typeof(T), static _ =>
+        {
+            return new T().Id;
+        })!);
     }
 
 #if !BANNERLORDMCM_INCLUDE_IN_CODE_COVERAGE
@@ -38,7 +42,14 @@ public static T? Instance
     abstract class PerSaveSettings : BaseSettings
     {
         protected static readonly ConcurrentDictionary<Type, string> Cache = new();
+        protected static readonly ConcurrentDictionary<string, BaseSettings?> CacheInstance = new();
 
+        internal static void InvalidateCache()
+        {
+            Cache.Clear();
+            CacheInstance.Clear();
+        }
+
         public sealed override string FormatType { get; } = "json2";
     }
 }
diff --git a/src/MCM.Abstractions/Containers/ISettingsContainerCanInvalidateCache.cs b/src/MCM.Abstractions/Containers/ISettingsContainerCanInvalidateCache.cs
@@ -0,0 +1,14 @@
+using System;
+
+namespace MCM.Abstractions
+{
+#if !BANNERLORDMCM_PUBLIC
+    internal
+#else
+    public
+# endif
+    interface ISettingsContainerCanInvalidateCache
+    {
+        event Action InstanceCacheInvalidated;
+    }
+}
diff --git a/src/MCM.Abstractions/Containers/PerCampaign/IPerCampaignSettingsContainer.cs b/src/MCM.Abstractions/Containers/PerCampaign/IPerCampaignSettingsContainer.cs
@@ -12,6 +12,7 @@ interface IPerCampaignSettingsContainer :
         ISettingsContainerCanReset,
         ISettingsContainerPresets,
         ISettingsContainerHasUnavailable,
-        ISettingsContainerHasSettingsPack
+        ISettingsContainerHasSettingsPack,
+        ISettingsContainerCanInvalidateCache
     { }
 }
diff --git a/src/MCM.Abstractions/Containers/PerSave/IPerSaveSettingsContainer.cs b/src/MCM.Abstractions/Containers/PerSave/IPerSaveSettingsContainer.cs
@@ -12,7 +12,8 @@ interface IPerSaveSettingsContainer :
         ISettingsContainerCanReset,
         ISettingsContainerPresets,
         ISettingsContainerHasUnavailable,
-        ISettingsContainerHasSettingsPack
+        ISettingsContainerHasSettingsPack,
+        ISettingsContainerCanInvalidateCache
     {
         void LoadSettings();
     }

diff --git a/src/MCM.Abstractions/Providers/IExternalSettingsProviderCanInvalidateCache.cs b/src/MCM.Abstractions/Providers/IExternalSettingsProviderCanInvalidateCache.cs
@@ -0,0 +1,32 @@
+using System;
+
+namespace MCM.Abstractions
+{
+#if !BANNERLORDMCM_PUBLIC
+    internal
+#else
+    public
+# endif
+        enum ExternalSettingsProviderInvalidateCacheType
+    {
+        None,
+        Global,
+        PerCampaign,
+        PerSave,
+    }
+
+    /// <summary>
+    /// Used to add foreign Options API's that MCM will be able to use.
+    /// Most likely will be used to ease backwards compatibility ports of older MCM API's so we'll be able to reuse more code.
+    /// This is a higher level alternative to using <see cref="ISettingsContainer"/>.
+    /// </summary>
+#if !BANNERLORDMCM_PUBLIC
+    internal
+#else
+    public
+# endif
+    interface IExternalSettingsProviderCanInvalidateCache
+    {
+        event Action<ExternalSettingsProviderInvalidateCacheType> InstanceCacheInvalidated;
+    }
+}
diff --git a/src/MCM.Implementation/Containers/PerCampaign/FluentPerCampaignSettingsContainer.cs b/src/MCM.Implementation/Containers/PerCampaign/FluentPerCampaignSettingsContainer.cs
@@ -6,6 +6,7 @@
 using MCM.Abstractions.GameFeatures;
 using MCM.Abstractions.PerCampaign;
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -16,6 +17,9 @@ namespace MCM.Implementation.PerCampaign
 #endif
     internal sealed class FluentPerCampaignSettingsContainer : BaseSettingsContainer<FluentPerCampaignSettings>, IFluentPerCampaignSettingsContainer
     {
+        /// <inheritdoc/>
+        public event Action? InstanceCacheInvalidated;
+
         private readonly IGameEventListener _gameEventListener;
 
         public FluentPerCampaignSettingsContainer(IGameEventListener gameEventListener)

diff --git a/src/MCM.Implementation/Containers/PerCampaign/PerCampaignSettingsContainer.cs b/src/MCM.Implementation/Containers/PerCampaign/PerCampaignSettingsContainer.cs
@@ -21,6 +21,9 @@ namespace MCM.Implementation.PerCampaign
 #endif
     internal sealed class PerCampaignSettingsContainer : BaseSettingsContainer<PerCampaignSettings>, IPerCampaignSettingsContainer
     {
+        /// <inheritdoc/>
+        public event Action? InstanceCacheInvalidated;
+
         private readonly IBUTRLogger _logger;
         private readonly IGameEventListener _gameEventListener;
 
@@ -96,6 +99,7 @@ public override bool SaveSettings(BaseSettings settings)
         private void GameStarted()
         {
             _hasGameStarted = true;
+            InstanceCacheInvalidated?.Invoke();
             LoadedSettings.Clear();
         }
 
@@ -165,6 +169,7 @@ public IEnumerable<UnavailableSetting> GetUnavailableSettings() => !_hasGameStar
         private void GameEnded()
         {
             _hasGameStarted = false;
+            InstanceCacheInvalidated?.Invoke();
             LoadedSettings.Clear();
         }
     }

diff --git a/src/MCM.Implementation/Containers/PerSave/FluentPerSaveSettingsContainer.cs b/src/MCM.Implementation/Containers/PerSave/FluentPerSaveSettingsContainer.cs
@@ -6,6 +6,7 @@
 using MCM.Abstractions.GameFeatures;
 using MCM.Abstractions.PerSave;
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -16,6 +17,9 @@ namespace MCM.Implementation.PerSave
 #endif
     internal sealed class FluentPerSaveSettingsContainer : BaseSettingsContainer<FluentPerSaveSettings>, IFluentPerSaveSettingsContainer
     {
+        /// <inheritdoc/>
+        public event Action? InstanceCacheInvalidated;
+
         private readonly IGameEventListener _gameEventListener;
 
         public FluentPerSaveSettingsContainer(IGameEventListener gameEventListener)

diff --git a/src/MCM.Implementation/Containers/PerSave/PerSaveSettingsContainer.cs b/src/MCM.Implementation/Containers/PerSave/PerSaveSettingsContainer.cs
@@ -21,6 +21,9 @@ namespace MCM.Implementation.PerSave
 #endif
     internal sealed class PerSaveSettingsContainer : BaseSettingsContainer<PerSaveSettings>, IPerSaveSettingsContainer
     {
+        /// <inheritdoc/>
+        public event Action? InstanceCacheInvalidated;
+
         private readonly IBUTRLogger _logger;
         private readonly IGameEventListener _gameEventListener;
 
@@ -75,6 +78,7 @@ public override bool SaveSettings(BaseSettings settings)
         private void GameStarted()
         {
             _hasGameStarted = true;
+            InstanceCacheInvalidated?.Invoke();
             LoadedSettings.Clear();
         }
 
@@ -137,6 +141,7 @@ public IEnumerable<UnavailableSetting> GetUnavailableSettings() => !_hasGameStar
         private void GameEnded()
         {
             _hasGameStarted = false;
+            InstanceCacheInvalidated?.Invoke();
             LoadedSettings.Clear();
         }
     }

diff --git a/src/MCM.Implementation/Providers/DefaultSettingsProvider.cs b/src/MCM.Implementation/Providers/DefaultSettingsProvider.cs
@@ -3,6 +3,9 @@
 
 using MCM.Abstractions;
 using MCM.Abstractions.Base;
+using MCM.Abstractions.Base.Global;
+using MCM.Abstractions.Base.PerCampaign;
+using MCM.Abstractions.Base.PerSave;
 using MCM.Abstractions.Global;
 using MCM.Abstractions.PerCampaign;
 using MCM.Abstractions.PerSave;
@@ -40,18 +43,46 @@ public DefaultSettingsProvider(IBUTRLogger<DefaultSettingsProvider> logger)
 
             foreach (var globalSettingsContainer in globalSettingsContainers)
             {
+                if (globalSettingsContainer is ISettingsContainerCanInvalidateCache canInvalidateCache)
+                    canInvalidateCache.InstanceCacheInvalidated += GlobalSettings.InvalidateCache;
+
                 logger.LogInformation($"Found Global container {globalSettingsContainer.GetType()} ({globalSettingsContainer.SettingsDefinitions.Count()})");
             }
             foreach (var perSaveSettingsContainer in perSaveSettingsContainers)
             {
+                if (perSaveSettingsContainer is ISettingsContainerCanInvalidateCache canInvalidateCache)
+                    canInvalidateCache.InstanceCacheInvalidated += PerSaveSettings.InvalidateCache;
+
                 logger.LogInformation($"Found PerSave container {perSaveSettingsContainer.GetType()} ({perSaveSettingsContainer.SettingsDefinitions.Count()})");
             }
             foreach (var perCampaignSettingsContainer in perCampaignSettingsContainers)
             {
+                if (perCampaignSettingsContainer is ISettingsContainerCanInvalidateCache canInvalidateCache)
+                    canInvalidateCache.InstanceCacheInvalidated += PerCampaignSettings.InvalidateCache;
+
                 logger.LogInformation($"Found Campaign container {perCampaignSettingsContainer.GetType()} ({perCampaignSettingsContainer.SettingsDefinitions.Count()})");
             }
             foreach (var externalSettingsProvider in externalSettingsProviders)
             {
+                if (externalSettingsProvider is IExternalSettingsProviderCanInvalidateCache canInvalidateCache)
+                {
+                    canInvalidateCache.InstanceCacheInvalidated += (cacheType) =>
+                    {
+                        switch (cacheType)
+                        {
+                            case ExternalSettingsProviderInvalidateCacheType.Global:
+                                GlobalSettings.InvalidateCache();
+                                break;
+                            case ExternalSettingsProviderInvalidateCacheType.PerSave:
+                                PerSaveSettings.InvalidateCache();
+                                break;
+                            case ExternalSettingsProviderInvalidateCacheType.PerCampaign:
+                                PerCampaignSettings.InvalidateCache();
+                                break;
+                        }
+                    };
+                }
+
                 logger.LogInformation($"Found external provider {externalSettingsProvider.GetType()} ({externalSettingsProvider.SettingsDefinitions.Count()})");
             }
 
@@ -60,7 +91,7 @@ public DefaultSettingsProvider(IBUTRLogger<DefaultSettingsProvider> logger)
                 .Concat(perSaveSettingsContainers)
                 .Concat(perCampaignSettingsContainers)
                 .ToList();
-
+            
             _externalSettingsProviders = externalSettingsProviders.ToList();
         }
 

diff --git a/src/MCM.Publish/MCM.Publish.csproj b/src/MCM.Publish/MCM.Publish.csproj
@@ -2,7 +2,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net472;net6</TargetFrameworks>
+    <TargetFrameworks>net472;net6-windows</TargetFrameworks>
     <Authors>Aragas</Authors>
     <ModuleId>Bannerlord.MBOptionScreen</ModuleId>
     <ModuleName>Mod Configuration Menu v5</ModuleName>