Merge pull request #1085 from PlayEveryWare/fix/populate-platform-deployment-from-product

fix: Set default deployment and sandbox values for platforms for first-time user scenarios

Author: paulhazen

Assets/Plugins/Source/Editor/ConfigEditors/IPlatformConfigEditor.cs

@@ -36,6 +36,10 @@ public interface IPlatformConfigEditor : IConfigEditor
         /// </returns>
         bool IsPlatformAvailable();
 
+        void SetDeployment(Deployment deployment);
+
+        PlatformManager.Platform GetPlatform();
+
         Texture GetPlatformIconTexture();
     }
 }

Assets/Plugins/Source/Editor/ConfigEditors/PlatformConfigEditor.cs

@@ -54,6 +54,16 @@ public Texture GetPlatformIconTexture()
             return PlatformManager.GetPlatformIcon(config.Platform);
         }
 
+        public void SetDeployment(Deployment deployment)
+        {
+            config.deployment = deployment;
+        }
+
+        public PlatformManager.Platform GetPlatform()
+        {
+            return config.Platform;
+        }
+
         public override sealed void RenderContents()
         {
             GUIEditorUtility.RenderInputs(ref config);

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

@@ -122,7 +122,7 @@ protected EOSEditorWindow(string windowTitle, float minimumHeight = 50f, float m
         /// </summary>
         public string WindowTitle { get; }
 
-        private void OnEnable()
+        protected virtual void OnEnable()
         {
             _initializeTask = Initialize();
             EditorApplication.update += CheckForInitialized;
@@ -288,7 +288,7 @@ public void OnGUI()
             }
         }
 
-        public void OnDestroy()
+        protected virtual void OnDestroy()
         {
             Teardown();
         }

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 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)))
@@ -178,6 +216,9 @@ private void Save()
             // Save the product config editor
             _productConfigEditor.Save();
 
+            // reload the product config editor
+            _productConfigEditor.Load();
+
             // Save each of the platform config editors.
             foreach (IConfigEditor editor in _platformConfigEditors)
             {

Assets/Plugins/Source/Editor/Utility/GUIEditorUtility.cs

@@ -975,9 +975,9 @@ private static void RenderSandboxInputs(ref ProductionEnvironments value)
                     }
 
                     item.Value.Value = RenderFieldWithHint(
-                        EditorGUI.TextField,
+                        EditorGUI.DelayedTextField,
                         new Rect(currentX, rect.y, remainingWidth - 10f, rect.height),
-                        string.IsNullOrEmpty,
+                        SandboxId.IsNullOrEmpty,
                         item.Value.Value,
                         "Sandbox Id");
                 },
@@ -1079,6 +1079,13 @@ public static EOSClientCredentials RenderInput(ConfigFieldAttribute configFieldA
                 int currentIndex = 0;
                 foreach (Named<EOSClientCredentials> cred in credentials)
                 {
+                    // Do not display incomplete client credentials as options
+                    // for selection
+                    if (!cred.Value.IsComplete)
+                    {
+                        continue;
+                    }
+
                     if (cred.Value.Equals(value))
                     {
                         selectedIndex = currentIndex;
@@ -1089,11 +1096,22 @@ public static EOSClientCredentials RenderInput(ConfigFieldAttribute configFieldA
                     currentIndex++;
                 }
 
+                string additionalTooltip = "";
+                // If there are no credentials to select, then disable the popup.
+                if (credentialsLabels.Count == 0)
+                {
+                    additionalTooltip =
+                        "\nTo select a client credential for this platform, you must first add a valid one above.";
+                    GUI.enabled = false;
+                }
+
                 int newIndex = EditorGUILayout.Popup(
-                    CreateGUIContent(configFieldAttribute.Label, configFieldAttribute.ToolTip),
+                    CreateGUIContent(configFieldAttribute.Label, configFieldAttribute.ToolTip + additionalTooltip),
                     selectedIndex,
                     credentialsLabels.ToArray());
 
+                GUI.enabled = true;
+
                 return (newIndex >= 0 && newIndex < credentials.Count) ? credentials[newIndex].Value : value;
             });
         }
@@ -1155,6 +1173,13 @@ public static Deployment RenderInput(ConfigFieldAttribute configFieldAttribute,
                 int currentIndex = 0;
                 foreach (Named<Deployment> deployment in deployments)
                 {
+                    // Do not display incomplete deployments as options for
+                    // selection.
+                    if (!deployment.Value.IsComplete)
+                    {
+                        continue;
+                    }
+
                     if (value.DeploymentId == deployment.Value.DeploymentId)
                         selectedIndex = currentIndex;
 
@@ -1163,11 +1188,23 @@ public static Deployment RenderInput(ConfigFieldAttribute configFieldAttribute,
                     currentIndex++;
                 }
 
+                // If there are no deployments to select, don't enable the 
+                // popup.
+                string additionalTooltip = "";
+                if (deploymentLabels.Count == 0)
+                {
+                    additionalTooltip = "\nTo select a deployment, you must define a valid one above.";
+                    GUI.enabled = false;
+                }
+
                 int newIndex = EditorGUILayout.Popup(
-                    CreateGUIContent(configFieldAttribute.Label, configFieldAttribute.ToolTip),
+                    CreateGUIContent(configFieldAttribute.Label, configFieldAttribute.ToolTip + additionalTooltip),
                     selectedIndex,
                     deploymentLabels.ToArray());
 
+                // Re-enable the GUI
+                GUI.enabled = true;
+
                 return (newIndex >= 0 && newIndex < deployments.Count) ? deployments[newIndex].Value : value;
             });
         }

com.playeveryware.eos/Runtime/Core/Common/Named.cs

@@ -130,7 +130,7 @@ public override int GetHashCode()
 
         public override string ToString()
         {
-            return $"{Name} : {Value}";
+            return $"\"{Name}\" : ({Value})";
         }
     }
 }

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

@@ -409,6 +409,8 @@ public string FilePath
             }
         }
 
+        #region Reading
+
         // NOTE: This compile conditional is here because Async IO does not work
         //       well on Android.
 #if !UNITY_ANDROID || UNITY_EDITOR
@@ -425,6 +427,7 @@ protected virtual async Task ReadAsync()
             {
                 _lastReadJsonString = await FileSystemUtility.ReadAllTextAsync(FilePath);
                 JsonUtility.FromJsonOverwrite(_lastReadJsonString, this);
+                OnReadCompleted();
             }
         }
 #endif
@@ -442,11 +445,24 @@ protected virtual void Read()
 
             _lastReadJsonString = FileSystemUtility.ReadAllText(FilePath);
             JsonUtility.FromJsonOverwrite(_lastReadJsonString, this);
+            OnReadCompleted();
+        }
+
+        protected virtual void OnReadCompleted()
+        {
+            // Optionally override for deriving classes. Default behavior is to 
+            // take no action.
         }
 
+        #endregion
+
         /// <summary>
         /// Determines if the config file exists, and if it does not, and the
         /// editor is running, then create the file.
+        /// TODO: Consider whether this function should be removed - there is
+        ///       no equivalent function for non-async contexts - and the
+        ///       difference in implementation between async and non-async could
+        ///       lead to confusion later on.
         /// </summary>
         /// <returns>Task.</returns>
         protected virtual async Task EnsureConfigFileExistsAsync()
@@ -468,6 +484,8 @@ protected virtual async Task EnsureConfigFileExistsAsync()
             }
         }
 
+        #region Writing
+
         // Functions declared below should only ever be utilized in the editor.
         // They are so divided to guarantee separation of concerns.
 #if UNITY_EDITOR
@@ -481,6 +499,8 @@ protected virtual async Task EnsureConfigFileExistsAsync()
         /// <returns>Task</returns>
         public virtual async Task WriteAsync(bool prettyPrint = true)
         {
+            BeforeWrite();
+
             // Set the schema version to the current before writing.
             schemaVersion = CURRENT_SCHEMA_VERSION;
 
@@ -492,6 +512,7 @@ public virtual async Task WriteAsync(bool prettyPrint = true)
                 return;
 
             await FileSystemUtility.WriteFileAsync(FilePath, json);
+            OnWriteCompleted();
         }
 
         /// <summary>
@@ -502,6 +523,8 @@ public virtual async Task WriteAsync(bool prettyPrint = true)
         /// </param>
         public virtual void Write(bool prettyPrint = true)
         {
+            BeforeWrite();
+
             // Set the schema version to the current before writing.
             schemaVersion = CURRENT_SCHEMA_VERSION;
 
@@ -513,8 +536,25 @@ public virtual void Write(bool prettyPrint = true)
                 return;
 
             FileSystemUtility.WriteFile(FilePath, json);
+            OnWriteCompleted();
+        }
+
+        protected virtual void BeforeWrite()
+        {
+            // Optionally override this function in a deriving class. Default
+            // behavior is to take no action.
+        }
+
+        protected virtual void OnWriteCompleted()
+        {
+            // Optionally override for deriving classes. Default behavior is to 
+            // take no action.
         }
 
+#endif
+
+        #endregion
+
         /// <summary>
         /// Determines whether the values in the Config have their
         /// default values
@@ -527,7 +567,6 @@ public bool IsDefault()
             return IsDefault(this);
         }
 
-
         /// <summary>
         /// Returns member-wise clone of configuration data
         /// (copies the values).
@@ -783,6 +822,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/Deployment.cs

@@ -22,15 +22,36 @@
 
 namespace PlayEveryWare.EpicOnlineServices
 {
-    using PlayEveryWare.EpicOnlineServices.Utility;
+    using Newtonsoft.Json;
+    using Utility;
     using System;
 
     public struct Deployment : IEquatable<Deployment>
     {
+        /// <summary>
+        /// The SandboxId for the deployment.
+        /// </summary>
         public SandboxId SandboxId;
 
+        /// <summary>
+        /// The DeploymentId.
+        /// </summary>
         public Guid DeploymentId;
 
+        /// <summary>
+        /// Indicates whether a deployment is completely defined or not. A
+        /// deployment is completely defined if neither the sandbox id nor the
+        /// deployment id are empty.
+        /// </summary>
+        [JsonIgnore]
+        public readonly bool IsComplete
+        {
+            get
+            {
+                return !DeploymentId.Equals(Guid.Empty) && !SandboxId.IsEmpty;
+            }
+        }
+
         public bool Equals(Deployment other)
         {
             return SandboxId.Equals(other.SandboxId) && DeploymentId.Equals(other.DeploymentId);
@@ -45,6 +66,11 @@ public override int GetHashCode()
         {
             return HashUtility.Combine(SandboxId, DeploymentId);
         }
+
+        public override string ToString()
+        {
+            return $"DeploymentId: {DeploymentId.ToString("N").ToLower()}, SandboxId: {SandboxId}";
+        }
     }
 
 }