Deployment Launcher editor performance improvement (#1219)

Author: Paul Balaji

CHANGELOG.md

@@ -6,6 +6,11 @@
 
 - A `WorkerSystem` now exposes the underlying Worker's `IsConnected` property. [#1217](https://github.com/spatialos/gdk-for-unity/pull/1217)
 
+### Fixed
+
+- Fixed an issue where the Deployment Launcher window would feel unresponsive due to saving changes after every input. [#1219](https://github.com/spatialos/gdk-for-unity/pull/1219)
+    - It will now wait for at least 1 second to elapse after the last change before writing the configuration back to disk.
+
 ## `0.3.0` - 2019-11-11
 
 ### Breaking Changes

workers/unity/Packages/io.improbable.gdk.deploymentlauncher/DeploymentLauncherWindow.cs

@@ -39,6 +39,10 @@ internal class DeploymentLauncherWindow : EditorWindow
         private List<DeploymentInfo> listedDeployments = new List<DeploymentInfo>();
         private int selectedListedDeploymentIndex;
 
+        // Minimum time required from last config change before saving to file
+        private static readonly TimeSpan FileSavingInterval = TimeSpan.FromSeconds(1);
+        private DateTime lastEditTime;
+
         [MenuItem("SpatialOS/Deployment Launcher", false, 51)]
         private static void LaunchDeploymentMenu()
         {
@@ -57,8 +61,7 @@ private void OnEnable()
             if (launcherConfig != null && projectName != null)
             {
                 launcherConfig.SetProjectName(projectName);
-                EditorUtility.SetDirty(launcherConfig);
-                AssetDatabase.SaveAssets();
+                MarkConfigAsDirty();
             }
 
             spinnerMaterial = new Material(Shader.Find("UI/Default"));
@@ -75,11 +78,15 @@ private void OnDestroy()
 
         private void OnExit()
         {
+            AssetDatabase.SaveAssets();
+
             manager.Cancel();
         }
 
         private void Update()
         {
+            TrySaveChanges();
+
             manager.Update();
 
             foreach (var wrappedTask in manager.CompletedTasks.OfType<UploadTask>())
@@ -223,8 +230,7 @@ private void OnGUI()
                         {
                             projectName = GetProjectName();
                             launcherConfig.SetProjectName(projectName);
-                            EditorUtility.SetDirty(launcherConfig);
-                            AssetDatabase.SaveAssets();
+                            MarkConfigAsDirty();
                         }
                     }
 
@@ -307,8 +313,7 @@ private void OnGUI()
 
                 if (check.changed)
                 {
-                    EditorUtility.SetDirty(launcherConfig);
-                    AssetDatabase.SaveAssets();
+                    MarkConfigAsDirty();
                 }
 
                 if (manager.IsActive)
@@ -882,6 +887,23 @@ private string GetStatusMessage()
             return sb.ToString();
         }
 
+        private void MarkConfigAsDirty()
+        {
+            EditorUtility.SetDirty(launcherConfig);
+            lastEditTime = DateTime.Now;
+        }
+
+        private void TrySaveChanges()
+        {
+            var timeSinceLastEdit = DateTime.Now - lastEditTime;
+            if (EditorUtility.GetDirtyCount(launcherConfig) <= 0 || timeSinceLastEdit <= FileSavingInterval)
+            {
+                return;
+            }
+
+            AssetDatabase.SaveAssets();
+        }
+
         private bool IsSelectedValid<T>(List<T> list, int index)
         {
             return index >= 0 && index < list.Count;