feat: Add functionality to catch when editing productconfig results in edits being made to platformconfigs - and properly update the user interface to reflect the changes.

Author: paulhazen

Assets/Plugins/Source/Editor/EditorWindows/EOSSettingsWindow.cs

@@ -34,7 +34,8 @@ namespace PlayEveryWare.EpicOnlineServices.Editor.Windows
     using PlayEveryWare.EpicOnlineServices.Utility;
     using System;
 	using System.Collections.Generic;
-	using System.Threading.Tasks;
+    using System.Linq;
+    using System.Threading.Tasks;
 	using UnityEditor;
     using UnityEngine;
 
@@ -54,7 +55,7 @@ public class NEW_EOSSettingsWindow : EOSEditorWindow
         /// <summary>
         /// Stores the config editors for each of the platforms.
         /// </summary>
-        private readonly IList<IConfigEditor> _platformConfigEditors = new List<IConfigEditor>();
+        private readonly IList<IPlatformConfigEditor> _platformConfigEditors = new List<IPlatformConfigEditor>();
 
         /// <summary>
         /// Contains the GUIContent that represents the set of tabs that contain
@@ -92,10 +93,47 @@ public static void ShowWindow()
             window.SetIsEmbedded(false);
         }
 
+        protected override void OnEnable()
+        {
+            base.OnEnable();
+            ProductConfig.PlatformConfigsDeploymentUpdatedEvent += ReloadDeploymentSettingsForPlatformConfigEditors;
+        }
+
+        protected override void OnDestroy()
+        {
+            ProductConfig.PlatformConfigsDeploymentUpdatedEvent -= ReloadDeploymentSettingsForPlatformConfigEditors;
+            base.OnDestroy();
+        }
+
+        private void ReloadDeploymentSettingsForPlatformConfigEditors(object sender, ProductConfig.PlatformConfigsDeploymentUpdatedEventArgs e)
+        {
+            // For each of the platform config editors
+            foreach (IPlatformConfigEditor platformConfigEditor in _platformConfigEditors)
+            {
+                // If the platform config was not one of the ones updated, then skip it.
+                if (!e.PlatformConfigsUpdated.Contains(platformConfigEditor.GetPlatform()))
+                {
+                    continue;
+                }
+
+                // If the platform config could not be read from disk
+                if (!PlatformManager.TryGetConfig(platformConfigEditor.GetPlatform(),
+                        out PlatformConfig platformConfigFromDisk))
+                {
+                    // TODO: Log warning?
+                    continue;
+                }
+
+                // Update the deployment for the cached instance of the config
+                // within the PlatformConfigEditor.
+                platformConfigEditor.SetDeployment(platformConfigFromDisk.deployment);
+            }
+        }
+
         protected override async Task AsyncSetup()
         {
             await _productConfigEditor.LoadAsync();
-
+            
             List<GUIContent> tabContents = new();
             int tabIndex = 0;
             foreach (PlatformManager.Platform platform in Enum.GetValues(typeof(PlatformManager.Platform)))

com.playeveryware.eos/Runtime/Core/Config/Config.cs

@@ -541,7 +541,9 @@ protected virtual void OnWriteCompleted()
             // take no action.
         }
 
-#endregion
+#endif
+
+        #endregion
 
         /// <summary>
         /// Determines whether the values in the Config have their
@@ -555,7 +557,6 @@ public bool IsDefault()
             return IsDefault(this);
         }
 
-
         /// <summary>
         /// Returns member-wise clone of configuration data
         /// (copies the values).
@@ -811,6 +812,4 @@ private static IEnumerable<MemberInfo> IteratePropertiesAndFields<T>(
 #pragma warning restore CS0414
 // Field is never assigned to, and will always have its default value.
 #pragma warning restore CS0649
-#endif
-
 #endif

com.playeveryware.eos/Runtime/Core/Config/ProductConfig.cs

@@ -110,6 +110,25 @@ public class ProductConfig : Config
         [JsonIgnore]
         private bool _deploymentDefined;
 
+        /// <summary>
+        /// Used to store information about what platform configs have been
+        /// updated.
+        /// </summary>
+        public sealed class PlatformConfigsDeploymentUpdatedEventArgs : EventArgs
+        {
+            /// <summary>
+            /// A list of all the platform configs that have been updated.
+            /// </summary>
+            public readonly IEnumerable<PlatformManager.Platform> PlatformConfigsUpdated;
+
+            public PlatformConfigsDeploymentUpdatedEventArgs(IEnumerable<PlatformManager.Platform> platformConfigsUpdated)
+            {
+                PlatformConfigsUpdated = platformConfigsUpdated;
+            }
+        }
+
+        public static event EventHandler<PlatformConfigsDeploymentUpdatedEventArgs> PlatformConfigsDeploymentUpdatedEvent;
+
         static ProductConfig()
         {
             RegisterFactory(() => new ProductConfig());
@@ -147,6 +166,8 @@ protected override void OnWriteCompleted()
             // platform configs to use.
             Named<Deployment> deploymentToSetPlatformsTo = Environments.Deployments[0];
 
+            List<PlatformManager.Platform> platformConfigsUpdated = new();
+
             // For each platform for which configuration can be done
             foreach (var platform in PlatformManager.ConfigurablePlatforms)
             {
@@ -157,6 +178,16 @@ protected override void OnWriteCompleted()
                     continue;
                 }
 
+                // If the config already has a completely defined deployment,
+                // then do not override, and move to the next platform config
+                if (config.deployment.IsComplete)
+                {
+                    continue;
+                }
+
+                // Add to the list of platform configs that have been updated
+                platformConfigsUpdated.Add(platform);
+
                 // Set the deployment.
                 config.deployment = deploymentToSetPlatformsTo.Value;
 
@@ -168,6 +199,13 @@ protected override void OnWriteCompleted()
                 // Save the config
                 config.Write();
             }
+
+            // If at least one platform config was updated as a result, trigger
+            // the event that indicates as much
+            if (platformConfigsUpdated.Count > 0)
+            {
+                PlatformConfigsDeploymentUpdatedEvent?.Invoke(this, new PlatformConfigsDeploymentUpdatedEventArgs(platformConfigsUpdated));
+            }
         }
 
 #endif