Move runtime IP to EditorPref / DevAuthToken to PlayerPref (#961)

Paul Balaji · web-flow · commit 6ff6038dd17a · 2019-06-03T13:44:38.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,10 @@
 ### Changed
 
 - Upgraded the project to be compatible with `2019.1.3f1`.
+- Moved Runtime IP from the `GdkToolsConfiguration.json` to the Editor Preferences.
+- Moved Dev Auth Token to the Player Preferences.
+    - Added a setting in `GdkToolsConfiguration` to let users configure whether a `DevAuthToken.txt` should be generated or not.
+    - When launching Android cloud clients from the Editor, the DevAuthToken is now passed in as a command line argument.
 
 ### Fixed
 
diff --git a/workers/unity/Assets/Config/GdkToolsConfiguration.json b/workers/unity/Assets/Config/GdkToolsConfiguration.json
@@ -5,7 +5,7 @@
     ],
     "CodegenOutputDir": "Assets/Generated/Source",
     "DescriptorOutputDir": "../../build/assembly/schema",
-    "RuntimeIp": "",
     "DevAuthTokenDir": "Resources",
-    "DevAuthTokenLifetimeDays": 30
+    "DevAuthTokenLifetimeDays": 30,
+    "SaveDevAuthTokenToFile": false
 }
diff --git a/workers/unity/Assets/Plugins.meta b/workers/unity/Assets/Plugins.meta
diff --git a/workers/unity/Packages/com.improbable.gdk.core/Config/RuntimeConfig.cs b/workers/unity/Packages/com.improbable.gdk.core/Config/RuntimeConfig.cs
@@ -25,6 +25,7 @@ public static class RuntimeConfigNames
         public const string LinkProtocol = "linkProtocol";
         public const string LocatorHost = "locatorHost";
         public const string LoginToken = "loginToken";
+        public const string DevAuthTokenKey = "devAuthTokenSecret";
         public const string PlayerIdentityToken = "playerIdentityToken";
         public const string ProjectName = "projectName";
         public const string ReceptionistHost = "receptionistHost";
@@ -36,7 +37,7 @@ public static class RuntimeConfigNames
     }
 
     /// <summary>
-    ///     Stores the configuration needed to connect via the Lcoator.
+    ///     Stores the configuration needed to connect via the Locator.
     /// </summary>
     public struct LocatorConfig
     {
diff --git a/workers/unity/Packages/com.improbable.gdk.core/Worker/WorkerConnector.cs b/workers/unity/Packages/com.improbable.gdk.core/Worker/WorkerConnector.cs
@@ -254,16 +254,23 @@ protected virtual string SelectDeploymentName(DeploymentList deployments)
         /// </summary>
         protected virtual string GetDevAuthToken()
         {
+            if (PlayerPrefs.HasKey(RuntimeConfigNames.DevAuthTokenKey))
+            {
+                return PlayerPrefs.GetString(RuntimeConfigNames.DevAuthTokenKey);
+            }
+
             var textAsset = Resources.Load<TextAsset>("DevAuthToken");
             if (textAsset != null)
             {
-                return textAsset.text.Trim();
+                PlayerPrefs.SetString(RuntimeConfigNames.DevAuthTokenKey, textAsset.text.Trim());
             }
             else
             {
                 throw new MissingReferenceException("Unable to find DevAuthToken.txt in the Resources folder. " +
                     "You can generate one via SpatialOS > Generate Dev Authentication Token.");
             }
+
+            return PlayerPrefs.GetString(RuntimeConfigNames.DevAuthTokenKey);
         }
 
         /// <summary>
diff --git a/workers/unity/Packages/com.improbable.gdk.mobile/Editor/LaunchMenu.cs b/workers/unity/Packages/com.improbable.gdk.mobile/Editor/LaunchMenu.cs
@@ -16,7 +16,6 @@ public static class LaunchMenu
         private const string MenuLaunchAndroidLocal = "/Android for local";
         private const string MenuLaunchAndroidCloud = "/Android for cloud";
 
-
         [MenuItem(MenuLaunchMobile + MenuLaunchAndroidLocal, false, 73)]
         private static void LaunchAndroidLocal()
         {
@@ -90,6 +89,17 @@ private static void LaunchAndroid(bool shouldConnectLocally)
                 else
                 {
                     arguments.Append($"+{RuntimeConfigNames.Environment} {RuntimeConfigDefaults.CloudEnvironment} ");
+
+                    var gdkToolsConfig = GdkToolsConfiguration.GetOrCreateInstance();
+
+                    // Return error if no DevAuthToken is set AND fails to generate new DevAuthToken.
+                    if (!PlayerPrefs.HasKey(RuntimeConfigNames.DevAuthTokenKey) && !DevAuthTokenUtils.TryGenerate())
+                    {
+                        Debug.LogError("Failed to generate a Dev Auth Token to launch mobile client.");
+                        return;
+                    }
+
+                    arguments.Append($"+{RuntimeConfigNames.DevAuthTokenKey} {DevAuthTokenUtils.DevAuthToken} ");
                 }
 
                 // Get chosen android package id and launch
diff --git a/workers/unity/Packages/com.improbable.gdk.mobile/Improbable.Gdk.Mobile.asmdef b/workers/unity/Packages/com.improbable.gdk.mobile/Improbable.Gdk.Mobile.asmdef
@@ -6,5 +6,10 @@
     "optionalUnityReferences": [],
     "includePlatforms": [],
     "excludePlatforms": [],
-    "allowUnsafeCode": false
-}
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": []
+}
diff --git a/workers/unity/Packages/com.improbable.gdk.mobile/Worker/DefaultMobileWorkerConnector.cs b/workers/unity/Packages/com.improbable.gdk.mobile/Worker/DefaultMobileWorkerConnector.cs
@@ -47,6 +47,12 @@ protected virtual void InitializeClient()
                 PlayerPrefs.DeleteKey(HostIpPlayerPrefsKey);
             }
 
+            var devAuthToken = CommandLineUtility.GetCommandLineValue(arguments, RuntimeConfigNames.DevAuthTokenKey, string.Empty);
+            if (!string.IsNullOrEmpty(devAuthToken))
+            {
+                PlayerPrefs.SetString(RuntimeConfigNames.DevAuthTokenKey, devAuthToken);
+            }
+
             PlayerPrefs.Save();
         }
 
diff --git a/workers/unity/Packages/com.improbable.gdk.tools/DevAuthTokenUtils.cs b/workers/unity/Packages/com.improbable.gdk.tools/DevAuthTokenUtils.cs
@@ -9,16 +9,26 @@ namespace Improbable.Gdk.Tools
 {
     public static class DevAuthTokenUtils
     {
+        public static string DevAuthToken => PlayerPrefs.GetString(PlayerPrefDevAuthTokenKey);
+
+        private static string DevAuthTokenAssetPath =>
+            Path.Combine("Assets", GdkToolsConfiguration.GetOrCreateInstance().DevAuthTokenDir, "DevAuthToken.txt");
+
         private static readonly string JsonDataKey = "json_data";
-        private static readonly string TokenSecretKey = "token_secret";
+        private static readonly string JsonErrorKey = "error";
+        private static readonly string JsonTokenSecretKey = "token_secret";
+        private static readonly string PlayerPrefDevAuthTokenKey = "devAuthTokenSecret";
 
-        [MenuItem("SpatialOS/Generate Dev Authentication Token", false, MenuPriorities.GenerateDevAuthToken)]
-        private static void Generate()
+        private const string DevAuthMenuPrefix = "SpatialOS/Dev Authentication Token";
+        private const string DevAuthMenuGenerateToken = "/Generate Token";
+        private const string DevAuthMenuClearToken = "/Clear Token";
+
+        [MenuItem(DevAuthMenuPrefix + DevAuthMenuGenerateToken, false, MenuPriorities.GenerateDevAuthToken)]
+        public static bool TryGenerate()
         {
             var devAuthToken = string.Empty;
             var gdkToolsConfiguration = GdkToolsConfiguration.GetOrCreateInstance();
-            var devAuthTokenFullDir = gdkToolsConfiguration.DevAuthTokenFullDir;
-            var devAuthTokenFilePath = gdkToolsConfiguration.DevAuthTokenFilepath;
+
             var devAuthTokenLifetimeHours = $"{gdkToolsConfiguration.DevAuthTokenLifetimeHours}h";
 
             var receivedMessage = string.Empty;
@@ -33,18 +43,55 @@ private static void Generate()
 
             try
             {
-                if (Json.Deserialize(receivedMessage).TryGetValue(JsonDataKey, out var jsonData) &&
-                    ((Dictionary<string, object>) jsonData).TryGetValue(TokenSecretKey, out var tokenSecret))
+                var deserializedMessage = Json.Deserialize(receivedMessage);
+                if (deserializedMessage.TryGetValue(JsonDataKey, out var jsonData) &&
+                    ((Dictionary<string, object>) jsonData).TryGetValue(JsonTokenSecretKey, out var tokenSecret))
                 {
                     devAuthToken = (string) tokenSecret;
                 }
+                else
+                {
+                    if (deserializedMessage.TryGetValue(JsonErrorKey, out var errorMessage))
+                    {
+                        throw new Exception(errorMessage.ToString());
+                    }
+
+                    throw new Exception(string.Empty);
+                }
             }
             catch (Exception e)
             {
                 Debug.LogError($"Unable to generate Dev Auth Token. {e.Message}");
-                return;
+                return false;
             }
 
+            Debug.Log($"Saving token to Player Preferences.");
+            PlayerPrefs.SetString(PlayerPrefDevAuthTokenKey, devAuthToken);
+
+            if (gdkToolsConfiguration.SaveDevAuthTokenToFile)
+            {
+                return SaveTokenToFile();
+            }
+
+            return true;
+        }
+
+        private static bool SaveTokenToFile()
+        {
+            var gdkToolsConfiguration = GdkToolsConfiguration.GetOrCreateInstance();
+            var devAuthTokenFullDir = gdkToolsConfiguration.DevAuthTokenFullDir;
+            var devAuthTokenFilePath = gdkToolsConfiguration.DevAuthTokenFilepath;
+
+            if (!PlayerPrefs.HasKey(PlayerPrefDevAuthTokenKey))
+            {
+                // Given we call SaveTokenToFile after successfully generating a Dev Auth Token,
+                // we should never see the following error.
+                Debug.LogError("Cannot save Development Authentication Token, as it has not been generated.");
+                return false;
+            }
+
+            var devAuthToken = PlayerPrefs.GetString(PlayerPrefDevAuthTokenKey);
+
             if (!Directory.Exists(devAuthTokenFullDir))
             {
                 Directory.CreateDirectory(devAuthTokenFullDir);
@@ -57,13 +104,21 @@ private static void Generate()
             catch (Exception e)
             {
                 Debug.LogError($"Unable to save Dev Auth Token asset. {e.Message}");
-                return;
+                return false;
             }
 
-            Debug.Log($"Saving token {devAuthToken} to {devAuthTokenFilePath}.");
-            AssetDatabase.ImportAsset(
-                Path.Combine("Assets", gdkToolsConfiguration.DevAuthTokenDir, "DevAuthToken.txt"),
-                ImportAssetOptions.ForceUpdate);
+            Debug.Log($"Saving token to {devAuthTokenFilePath}.");
+            AssetDatabase.ImportAsset(DevAuthTokenAssetPath, ImportAssetOptions.ForceUpdate);
+            AssetDatabase.Refresh();
+
+            return true;
+        }
+
+        [MenuItem(DevAuthMenuPrefix + DevAuthMenuClearToken, false, MenuPriorities.ClearDevAuthToken)]
+        private static void ClearToken()
+        {
+            PlayerPrefs.DeleteKey(PlayerPrefDevAuthTokenKey);
+            AssetDatabase.DeleteAsset(DevAuthTokenAssetPath);
             AssetDatabase.Refresh();
         }
     }
diff --git a/workers/unity/Packages/com.improbable.gdk.tools/GdkToolsConfiguration.cs b/workers/unity/Packages/com.improbable.gdk.tools/GdkToolsConfiguration.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Net;
+using UnityEditor;
 using UnityEngine;
 
 namespace Improbable.Gdk.Tools
@@ -13,18 +14,19 @@ public class GdkToolsConfiguration
         public List<string> SchemaSourceDirs = new List<string>();
         public string CodegenOutputDir;
         public string DescriptorOutputDir;
-        public string RuntimeIp;
         public string DevAuthTokenDir;
         public int DevAuthTokenLifetimeDays;
+        public bool SaveDevAuthTokenToFile;
+
+        internal string RuntimeIpEditorPrefKey = "RuntimeIp";
+        public string RuntimeIp => EditorPrefs.GetString(RuntimeIpEditorPrefKey);
 
         public string DevAuthTokenFullDir => Path.Combine(Application.dataPath, DevAuthTokenDir);
         public string DevAuthTokenFilepath => Path.Combine(DevAuthTokenFullDir, "DevAuthToken.txt");
         public int DevAuthTokenLifetimeHours => TimeSpan.FromDays(DevAuthTokenLifetimeDays).Hours;
 
         private static readonly string JsonFilePath = Path.GetFullPath("Assets/Config/GdkToolsConfiguration.json");
 
-        private static readonly string UnityProjectRoot = Path.Combine(Application.dataPath, "..");
-
         private GdkToolsConfiguration()
         {
             ResetToDefault();
@@ -66,7 +68,7 @@ internal List<string> Validate()
 
                 try
                 {
-                    var fullSchemaSourceDirPath = Path.Combine(UnityProjectRoot, schemaSourceDir);
+                    var fullSchemaSourceDirPath = Path.Combine(Application.dataPath, "..", schemaSourceDir);
                     if (!Directory.Exists(fullSchemaSourceDirPath))
                     {
                         errors.Add($"{fullSchemaSourceDirPath} cannot be found.");
@@ -83,6 +85,11 @@ internal List<string> Validate()
                 errors.Add($"Runtime IP \"{RuntimeIp}\" is not a valid IP address.");
             }
 
+            if (!SaveDevAuthTokenToFile)
+            {
+                return errors;
+            }
+
             if (string.IsNullOrEmpty(DevAuthTokenDir))
             {
                 errors.Add($"{GdkToolsConfigurationWindow.DevAuthTokenDirLabel} cannot be empty.");
@@ -101,7 +108,6 @@ internal void ResetToDefault()
             SchemaStdLibDir = DefaultValues.SchemaStdLibDir;
             CodegenOutputDir = DefaultValues.CodegenOutputDir;
             DescriptorOutputDir = DefaultValues.DescriptorOutputDir;
-            RuntimeIp = DefaultValues.RuntimeIp;
             DevAuthTokenDir = DefaultValues.DevAuthTokenDir;
             DevAuthTokenLifetimeDays = DefaultValues.DevAuthTokenLifetimeDays;
 
@@ -134,7 +140,6 @@ private static class DefaultValues
             public const string CodegenOutputDir = "Assets/Generated/Source";
             public const string DescriptorOutputDir = "../../build/assembly/schema";
             public const string SchemaSourceDir = "../../schema";
-            public const string RuntimeIp = null;
             public const string DevAuthTokenDir = "Resources";
             public const int DevAuthTokenLifetimeDays = 30;
         }
diff --git a/workers/unity/Packages/com.improbable.gdk.tools/GdkToolsConfigurationWindow.cs b/workers/unity/Packages/com.improbable.gdk.tools/GdkToolsConfigurationWindow.cs
@@ -154,7 +154,9 @@ private void DrawCodeGenerationOptions()
             GUILayout.Label(MobileSectionLabel, EditorStyles.boldLabel);
             using (new EditorGUI.IndentLevelScope())
             {
-                toolsConfig.RuntimeIp = EditorGUILayout.TextField(RuntimeIpLabel, toolsConfig.RuntimeIp);
+                EditorPrefs.SetString(
+                    toolsConfig.RuntimeIpEditorPrefKey,
+                    EditorGUILayout.TextField(RuntimeIpLabel, toolsConfig.RuntimeIp));
             }
 
             GUILayout.Label(DevAuthTokenSectionLabel, EditorStyles.boldLabel);
@@ -163,9 +165,12 @@ private void DrawCodeGenerationOptions()
                 toolsConfig.DevAuthTokenLifetimeDays =
                     EditorGUILayout.IntSlider(DevAuthTokenLifetimeLabel, toolsConfig.DevAuthTokenLifetimeDays, 1, 90);
 
-                toolsConfig.DevAuthTokenDir = EditorGUILayout.TextField(DevAuthTokenDirLabel, toolsConfig.DevAuthTokenDir);
-
-                GUILayout.Label($"Token filepath: {toolsConfig.DevAuthTokenFilepath}", EditorStyles.helpBox);
+                toolsConfig.SaveDevAuthTokenToFile = EditorGUILayout.Toggle("Save token to file", toolsConfig.SaveDevAuthTokenToFile);
+                using (new EditorGUI.DisabledScope(!toolsConfig.SaveDevAuthTokenToFile))
+                {
+                    toolsConfig.DevAuthTokenDir = EditorGUILayout.TextField(DevAuthTokenDirLabel, toolsConfig.DevAuthTokenDir);
+                    GUILayout.Label($"Token filepath: {toolsConfig.DevAuthTokenFilepath}", EditorStyles.helpBox);
+                }
             }
 
             EditorGUIUtility.labelWidth = previousWidth;
diff --git a/workers/unity/Packages/com.improbable.gdk.tools/MenuPriorities.cs b/workers/unity/Packages/com.improbable.gdk.tools/MenuPriorities.cs
@@ -12,5 +12,6 @@ internal static class MenuPriorities
 
         internal const int GdkToolsConfiguration = 201;
         internal const int GenerateDevAuthToken = 202;
+        internal const int ClearDevAuthToken = 203;
     }
 }
diff --git a/workers/unity/ProjectSettings/EditorBuildSettings.asset b/workers/unity/ProjectSettings/EditorBuildSettings.asset
@@ -14,7 +14,4 @@ EditorBuildSettings:
   - enabled: 1
     path: Assets/Playground/Scenes/MobileClientScene.unity
     guid: 82ccd0fd96a2ba24f88d0c7d01592f2e
-  - enabled: 1
-    path: Assets/Playground/Scenes/iOSClientScene.unity
-    guid: 424c4b2c090874512badc5e7ee757d5f
   m_configObjects: {}
diff --git a/workers/unity/ProjectSettings/GraphicsSettings.asset b/workers/unity/ProjectSettings/GraphicsSettings.asset
@@ -37,6 +37,7 @@ GraphicsSettings:
   - {fileID: 10770, guid: 0000000000000000f000000000000000, type: 0}
   - {fileID: 17000, guid: 0000000000000000f000000000000000, type: 0}
   - {fileID: 16000, guid: 0000000000000000f000000000000000, type: 0}
+  - {fileID: 16001, guid: 0000000000000000f000000000000000, type: 0}
   m_PreloadedShaders: []
   m_SpritesDefaultMaterial: {fileID: 10754, guid: 0000000000000000f000000000000000,
     type: 0}
diff --git a/workers/unity/ProjectSettings/ProjectSettings.asset b/workers/unity/ProjectSettings/ProjectSettings.asset

Original file line number	Diff line number	Diff line change
`@@ -254,16 +254,23 @@ protected virtual string SelectDeploymentName(DeploymentList deployments)`
`254`	`254`	`/// </summary>`
`255`	`255`	`protected virtual string GetDevAuthToken()`
`256`	`256`	`{`
	`257`	`+ if (PlayerPrefs.HasKey(RuntimeConfigNames.DevAuthTokenKey))`
	`258`	`+ {`
	`259`	`+ return PlayerPrefs.GetString(RuntimeConfigNames.DevAuthTokenKey);`
	`260`	`+ }`
	`261`	`+`
`257`	`262`	`var textAsset = Resources.Load<TextAsset>("DevAuthToken");`
`258`	`263`	`if (textAsset != null)`
`259`	`264`	`{`
`260`		`- return textAsset.text.Trim();`
	`265`	`+ PlayerPrefs.SetString(RuntimeConfigNames.DevAuthTokenKey, textAsset.text.Trim());`
`261`	`266`	`}`
`262`	`267`	`else`
`263`	`268`	`{`
`264`	`269`	`throw new MissingReferenceException("Unable to find DevAuthToken.txt in the Resources folder. " +`
`265`	`270`	`"You can generate one via SpatialOS > Generate Dev Authentication Token.");`
`266`	`271`	`}`
	`272`	`+`
	`273`	`+ return PlayerPrefs.GetString(RuntimeConfigNames.DevAuthTokenKey);`
`267`	`274`	`}`
`268`	`275`
`269`	`276`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,12 @@ protected virtual void InitializeClient()`
`47`	`47`	`PlayerPrefs.DeleteKey(HostIpPlayerPrefsKey);`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ var devAuthToken = CommandLineUtility.GetCommandLineValue(arguments, RuntimeConfigNames.DevAuthTokenKey, string.Empty);`
	`51`	`+ if (!string.IsNullOrEmpty(devAuthToken))`
	`52`	`+ {`
	`53`	`+ PlayerPrefs.SetString(RuntimeConfigNames.DevAuthTokenKey, devAuthToken);`
	`54`	`+ }`
	`55`	`+`
`50`	`56`	`PlayerPrefs.Save();`
`51`	`57`	`}`
`52`	`58`