Feature/custom snapshot launch (#1098)

* Custom snapshot launch added Allows user to set a custom snapshot for local launch. The snapshot can be selected at the GDK tools configuration window * Disabled the custom snapshot path text field * Changelog edit with the pull request # * Implemented changes suggested by Martijn Removed custom snapshot path from GdkToolsConfiguration class / Single local launch button that will load the selected snapshot * Added customSnapshotPath PlayerPref abstraction Added customSnapshotPath PlayerPref abstraction to the GdkToolsConfiguration class / When opening the snapshot selection window it now opens on the currently selected snapshot file folder. * Update workers/unity/Packages/io.improbable.gdk.tools/GdkToolsConfigurationWindow.cs Co-Authored-By: Jamie Brynes <[email protected]> * Update workers/unity/Packages/io.improbable.gdk.tools/LocalLaunch.cs Co-Authored-By: Jamie Brynes <[email protected]> * Update workers/unity/Packages/io.improbable.gdk.tools/LocalLaunch.cs Co-Authored-By: Jamie Brynes <[email protected]> * Suggested changes and fixed default folder * Fix for initial case * CHANGELOG.md conflict solved? * CHANGELOG conflict solved - take 2 * CHANGELOG conflict solved - take 3 * Fixed wording on the CHANGELOG * Update CHANGELOG.md Co-Authored-By: Paul Balaji <[email protected]> * Fixed minor issues Removed unused directive and extra newline
spatialos · Aug 14, 2019 · 3aa596c · 3aa596c
1 parent 1febf58
commit 3aa596c
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 - Added the ability to connect to an arbitrary host/port combo for the `AlphaLocatorFlow`. [#1105](https://github.com/spatialos/gdk-for-unity/pull/1105)
 - Added a `SpatialdManager` class for managing local deployments with `SpatialD` into `io.improbable.gdk.testutils`. [#1104](https://github.com/spatialos/gdk-for-unity/pull/1104)
+- Added the ability to specify a snapshot to be used when launching a deployment in the Editor. [#1098](https://github.com/spatialos/gdk-for-unity/pull/1098)
 
 ### Changed
 

diff --git a/workers/unity/Assets/Plugins/Editor.meta b/workers/unity/Assets/Plugins/Editor.meta
diff --git a/workers/unity/Packages/io.improbable.gdk.tools/GdkToolsConfiguration.cs b/workers/unity/Packages/io.improbable.gdk.tools/GdkToolsConfiguration.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using UnityEngine;
@@ -20,6 +20,14 @@ public class GdkToolsConfiguration
         public string DevAuthTokenFilepath => Path.Combine(DevAuthTokenFullDir, "DevAuthToken.txt");
         public int DevAuthTokenLifetimeHours => TimeSpan.FromDays(DevAuthTokenLifetimeDays).Hours;
 
+        private const string CustomSnapshotPathPrefKey = "CustomSnapshotPath";
+
+        public string CustomSnapshotPath
+        {
+            get => PlayerPrefs.GetString(CustomSnapshotPathPrefKey, Path.GetFullPath("../../snapshots/default.snapshot"));
+            set => PlayerPrefs.SetString(CustomSnapshotPathPrefKey, value);
+        }
+
         private static readonly string JsonFilePath = Path.GetFullPath("Assets/Config/GdkToolsConfiguration.json");
 
         private GdkToolsConfiguration()

diff --git a/workers/unity/Packages/io.improbable.gdk.tools/GdkToolsConfigurationWindow.cs b/workers/unity/Packages/io.improbable.gdk.tools/GdkToolsConfigurationWindow.cs
@@ -18,6 +18,7 @@ public class GdkToolsConfigurationWindow : EditorWindow
         private const string DevAuthTokenSectionLabel = "Dev Auth Token Settings";
         private const string DevAuthTokenLifetimeLabel = "Token lifetime (days)";
         private const string CodeGeneratorLabel = "Code generator";
+        private const string CustomSnapshotPathLabel = "Selected snapshot path";
         private const string ResetConfigurationButtonText = "Reset to default";
         private const string SaveConfigurationButtonText = "Save";
 
@@ -85,6 +86,8 @@ public void OnGUI()
 
                 DrawCodeGenerationOptions();
 
+                DrawCustomSnapshotDir();
+
                 if (check.changed)
                 {
                     configErrors = toolsConfig.Validate();
@@ -160,5 +163,28 @@ private void DrawCodeGenerationOptions()
 
             EditorGUIUtility.labelWidth = previousWidth;
         }
+
+        private void DrawCustomSnapshotDir()
+        {
+            GUILayout.Label(CustomSnapshotPathLabel, EditorStyles.boldLabel);
+            GUILayout.Space(EditorGUIUtility.standardVerticalSpacing);
+            using (new EditorGUILayout.HorizontalScope())
+            {
+                using (new EditorGUI.DisabledScope(true))
+                {
+                    EditorGUILayout.TextField(CustomSnapshotPathLabel, toolsConfig.CustomSnapshotPath);
+                }
+
+                if (GUILayout.Button("Open", EditorStyles.miniButtonRight, GUILayout.ExpandWidth(false)))
+                {
+                    var path = EditorUtility.OpenFilePanel("Select snapshot", toolsConfig.CustomSnapshotPath, "snapshot");
+
+                    if (!string.IsNullOrEmpty(path))
+                    {
+                        toolsConfig.CustomSnapshotPath = path;
+                    }
+                }
+            }
+        }
     }
 }
diff --git a/workers/unity/Packages/io.improbable.gdk.tools/LocalLaunch.cs b/workers/unity/Packages/io.improbable.gdk.tools/LocalLaunch.cs
@@ -37,7 +37,14 @@ private static void BuildConfigMenu()
         [MenuItem("SpatialOS/Local launch %l", false, MenuPriorities.LocalLaunch)]
         private static void LaunchMenu()
         {
-            Debug.Log("Launching SpatialOS locally...");
+            GdkToolsConfiguration toolsConfig = GdkToolsConfiguration.GetOrCreateInstance();
+            if (!File.Exists(toolsConfig.CustomSnapshotPath))
+            {
+                Debug.LogError($"Snapshot {toolsConfig.CustomSnapshotPath} not found. Make sure the file exists and it has not been moved or renamed");
+                return;
+            }
+
+            Debug.Log($"Launching SpatialOS locally with snapshot {toolsConfig.CustomSnapshotPath}.");
             EditorApplication.delayCall += LaunchLocalDeployment;
         }
 
@@ -202,9 +209,10 @@ private static string GetClientLogFileFullPath()
         public static void LaunchLocalDeployment()
         {
             BuildConfig();
+            GdkToolsConfiguration toolsConfig = GdkToolsConfiguration.GetOrCreateInstance();
 
             var command = Common.SpatialBinary;
-            var commandArgs = "local launch --enable_pre_run_check=false";
+            var commandArgs = $"local launch --enable_pre_run_check=false --snapshot \"{toolsConfig.CustomSnapshotPath}\"";
 
             var runtimeIp = EditorPrefs.GetString(Common.RuntimeIpEditorPrefKey);
             if (!string.IsNullOrEmpty(runtimeIp))