[SDK-454] feature/settings-handler-refactor (#124)

- refactored settings handler and separated classes
readyplayerme · Sep 21, 2023 · 25f78e0 · 25f78e0
1 parent eef533e
commit 25f78e0
Show file tree

Hide file tree

Showing 13 changed files with 110 additions and 59 deletions.
diff --git a/Editor/Analytics/AnalyticsEditorLogger.cs b/Editor/Analytics/AnalyticsEditorLogger.cs
@@ -1,4 +1,6 @@
-namespace ReadyPlayerMe.Core.Analytics
+using ReadyPlayerMe.Core.Editor;
+
+namespace ReadyPlayerMe.Core.Analytics
 {
     public static class AnalyticsEditorLogger
     {
@@ -16,16 +18,14 @@ public static void Enable()
         {
             IsEnabled = true;
             EventLogger.Enable();
-            CoreSettingsHandler.CoreSettings.EnableAnalytics = true;
-            CoreSettingsHandler.Save();
+            CoreSettingsSetter.SetEnableAnalytics(true);
         }
 
         public static void Disable()
         {
             EventLogger.Disable();
             IsEnabled = false;
-            CoreSettingsHandler.CoreSettings.EnableAnalytics = false;
-            CoreSettingsHandler.Save();
+            CoreSettingsSetter.SetEnableAnalytics(false);
         }
     }
 }
diff --git a/Editor/BuildPostProcessor.cs b/Editor/BuildPostProcessor.cs
@@ -11,7 +11,7 @@ public static class BuildPostProcessor
         public static void OnPostprocessBuild(BuildTarget target, string pathToBuiltProject)
         {
             // create asset if it has been deleted
-            CoreSettingsHandler.EnsureSettingsExist();
+            CoreSettingsLoader.EnsureSettingsExist();
             AppData appData = ApplicationData.GetData();
             AnalyticsEditorLogger.EventLogger.LogBuildApplication(appData.BuildTarget, PlayerSettings.productName, !Debug.isDebugBuild);
         }

diff --git a/Editor/Module Management/ModuleInstaller.cs b/Editor/Module Management/ModuleInstaller.cs
@@ -62,7 +62,7 @@ static ModuleInstaller()
         private static void DelayCreateCoreSettings()
         {
             EditorApplication.delayCall -= DelayCreateCoreSettings;
-            CoreSettingsHandler.EnsureSettingsExist();
+            CoreSettingsLoader.EnsureSettingsExist();
         }
 
         /// <summary>

diff --git a/Editor/UI/EditorWindows/SettingsWindow/SettingsEditor.cs b/Editor/UI/EditorWindows/SettingsWindow/SettingsEditor.cs
@@ -113,6 +113,7 @@ private void OnLoggingToggle(ChangeEvent<bool> evt)
         {
             AnalyticsEditorLogger.EventLogger.LogSetLoggingEnabled(evt.newValue);
             SDKLogger.EnableLogging(evt.newValue);
+            CoreSettingsSetter.SetEnableLogging(evt.newValue);
         }
 
         private void OnPrivacyPolicyClicked(MouseUpEvent evt)

diff --git a/Editor/UI/EditorWindows/Templates/AppIdTemplate.cs b/Editor/UI/EditorWindows/Templates/AppIdTemplate.cs
@@ -60,7 +60,7 @@ private void SaveAppId()
                 AnalyticsEditorLogger.EventLogger.LogUpdatePartnerURL(id, appIdField.value);
             }
 
-            CoreSettingsHandler.SaveAppId(appIdField.value);
+            CoreSettingsSetter.SaveAppId(appIdField.value);
         }
     }
 }
diff --git a/Editor/UI/EditorWindows/Templates/SubdomainTemplate.cs b/Editor/UI/EditorWindows/Templates/SubdomainTemplate.cs
@@ -116,7 +116,7 @@ private void SaveSubdomain()
             var subDomain = CoreSettingsHandler.CoreSettings.Subdomain;
             if (subDomain == partnerSubdomain || !IsValidSubdomain()) return;
             AnalyticsEditorLogger.EventLogger.LogUpdatePartnerURL(subDomain, partnerSubdomain);
-            CoreSettingsHandler.SaveSubDomain(partnerSubdomain);
+            CoreSettingsSetter.SaveSubDomain(partnerSubdomain);
         }
     }
 }
diff --git a/Editor/UI/Obsolete/Components/SubdomainField.cs b/Editor/UI/Obsolete/Components/SubdomainField.cs
@@ -141,7 +141,7 @@ public void SaveSubdomain()
             var subDomain = CoreSettingsHandler.CoreSettings.Subdomain;
             if (subDomain == partnerSubdomain || !IsValidSubdomain()) return;
             AnalyticsEditorLogger.EventLogger.LogUpdatePartnerURL(subDomain, partnerSubdomain);
-            CoreSettingsHandler.SaveSubDomain(partnerSubdomain);
+            CoreSettingsSetter.SaveSubDomain(partnerSubdomain);
         }
     }
 }
diff --git a/Editor/Utils/CoreSettingsLoader.cs b/Editor/Utils/CoreSettingsLoader.cs
@@ -0,0 +1,35 @@
+using ReadyPlayerMe.Core.Data;
+using UnityEditor;
+using UnityEngine;
+
+namespace ReadyPlayerMe.Core.Editor
+{
+    [InitializeOnLoad]
+    public static class CoreSettingsLoader
+    {
+        private const string PROJECT_RELATIVE_ASSET_PATH = "Assets/Ready Player Me/Resources/Settings/CoreSettings.asset";
+        private const string SETTINGS_SAVE_FOLDER = "Ready Player Me/Resources/Settings";
+
+        static CoreSettingsLoader()
+        {
+            EnsureSettingsExist();
+        }
+
+        public static void EnsureSettingsExist()
+        {
+            if (CoreSettingsHandler.CoreSettings == null)
+            {
+                CreateSettings();
+            }
+        }
+
+        private static void CreateSettings()
+        {
+            DirectoryUtility.ValidateDirectory($"{Application.dataPath}/{SETTINGS_SAVE_FOLDER}");
+            var newSettings = ScriptableObject.CreateInstance<CoreSettings>();
+            AssetDatabase.CreateAsset(newSettings, PROJECT_RELATIVE_ASSET_PATH);
+            AssetDatabase.SaveAssets();
+            AssetDatabase.Refresh();
+        }
+    }
+}
diff --git a/Editor/Utils/CoreSettingsLoader.cs.meta b/Editor/Utils/CoreSettingsLoader.cs.meta
diff --git a/Editor/Utils/CoreSettingsSetter.cs b/Editor/Utils/CoreSettingsSetter.cs
@@ -0,0 +1,38 @@
+using UnityEditor;
+
+namespace ReadyPlayerMe.Core.Editor
+{
+    public static class CoreSettingsSetter
+    {
+        public static void SetEnableAnalytics(bool isEnabled)
+        {
+            CoreSettingsHandler.CoreSettings.EnableAnalytics = isEnabled;
+            Save();
+        }
+
+        public static void SetEnableLogging(bool isEnabled)
+        {
+            CoreSettingsHandler.CoreSettings.EnableLogging = isEnabled;
+            Save();
+        }
+
+        public static void SaveSubDomain(string subDomain)
+        {
+            if (string.IsNullOrEmpty(subDomain) || CoreSettingsHandler.CoreSettings.Subdomain == subDomain) return;
+            CoreSettingsHandler.CoreSettings.Subdomain = subDomain;
+            Save();
+        }
+
+        public static void SaveAppId(string appId)
+        {
+            CoreSettingsHandler.CoreSettings.AppId = appId;
+            Save();
+        }
+
+        public static void Save()
+        {
+            EditorUtility.SetDirty(CoreSettingsHandler.CoreSettings);
+            AssetDatabase.SaveAssets();
+        }
+    }
+}
diff --git a/Editor/Utils/CoreSettingsSetter.cs.meta b/Editor/Utils/CoreSettingsSetter.cs.meta
diff --git a/Runtime/CoreSettingsHandler.cs b/Runtime/CoreSettingsHandler.cs
@@ -1,71 +1,30 @@
 using ReadyPlayerMe.Core.Data;
-using UnityEditor;
 using UnityEngine;
 
 namespace ReadyPlayerMe.Core
 {
     public static class CoreSettingsHandler
     {
         private const string RESOURCE_PATH = "Settings/CoreSettings";
-        public const string PROJECT_RELATIVE_ASSET_PATH = "Assets/Ready Player Me/Resources/Settings/CoreSettings.asset";
-        private const string SETTINGS_SAVE_FOLDER = "Ready Player Me/Resources/Settings";
-
         public static CoreSettings CoreSettings
         {
             get
             {
                 if (coreSettings != null) return coreSettings;
-                coreSettings = Resources.Load<CoreSettings>(RESOURCE_PATH);
-#if UNITY_EDITOR
+                coreSettings = Load();
                 if (coreSettings == null)
                 {
-                    coreSettings = CreateSettings();
+                    Debug.LogError("CoreSettings could not be loaded.");
                 }
-#endif
                 return coreSettings;
             }
         }
 
         private static CoreSettings coreSettings;
 
-#if UNITY_EDITOR
-        public static void SaveSubDomain(string subDomain)
-        {
-            if (string.IsNullOrEmpty(subDomain) || coreSettings.Subdomain == subDomain) return;
-            coreSettings.Subdomain = subDomain;
-            Save();
-        }
-
-        public static void SaveAppId(string appId)
-        {
-            coreSettings.AppId = appId;
-            Save();
-        }
-
-        public static void Save()
-        {
-            EditorUtility.SetDirty(coreSettings);
-            AssetDatabase.SaveAssets();
-        }
-
-        public static void EnsureSettingsExist()
-        {
-            coreSettings = Resources.Load<CoreSettings>(RESOURCE_PATH);
-            if (coreSettings == null)
-            {
-                coreSettings = CreateSettings();
-            }
-        }
-
-        private static CoreSettings CreateSettings()
+        public static CoreSettings Load()
         {
-            DirectoryUtility.ValidateDirectory($"{Application.dataPath}/{SETTINGS_SAVE_FOLDER}");
-            var newSettings = ScriptableObject.CreateInstance<CoreSettings>();
-            AssetDatabase.CreateAsset(newSettings, PROJECT_RELATIVE_ASSET_PATH);
-            AssetDatabase.SaveAssets();
-            AssetDatabase.Refresh();
-            return newSettings;
+            return Resources.Load<CoreSettings>(RESOURCE_PATH);
         }
-#endif
     }
 }
diff --git a/Runtime/Logger/SDKLogger.cs b/Runtime/Logger/SDKLogger.cs
@@ -25,14 +25,10 @@ public static bool IsLoggingEnabled()
             return CoreSettingsHandler.CoreSettings.EnableLogging;
         }
 
-#if UNITY_EDITOR
         public static void EnableLogging(bool enabled)
         {
             loggingEnabled = enabled;
-            CoreSettingsHandler.CoreSettings.EnableLogging = loggingEnabled;
-            CoreSettingsHandler.Save();
         }
-#endif
 
         public static void Log(string tag, object message)
         {