splitting worker connector into default and mobile (#588)

Author: jessicafalk

CHANGELOG.md

@@ -16,6 +16,7 @@
 - Changed the allocation type used internally for Unity ECS chunk iteration from `Temp` to `TempJob`
 - Running a build in the Editor no longer automatically selects all scenes in the Unity build configuration
 - `Improbable.Gdk.Core.Snapshot.AddEntity` now returns the `EntityId` assigned in the snapshot.
+- Changed the `WorkerConnector` to be more generic and have an explicit `StandaloneWorkerConnector` for any workers running on OSX/Linux/Windows.
 
 ### Fixed
 

workers/unity/Assets/Playground/Scripts/Worker/ClientWorkerConnector.cs

@@ -4,7 +4,7 @@
 
 namespace Playground
 {
-    public class ClientWorkerConnector : WorkerConnector
+    public class ClientWorkerConnector : DefaultWorkerConnector
     {
         [SerializeField] private GameObject level;
 

workers/unity/Assets/Playground/Scripts/Worker/GameLogicWorkerConnector.cs

@@ -3,7 +3,7 @@
 
 namespace Playground
 {
-    public class GameLogicWorkerConnector : WorkerConnector
+    public class GameLogicWorkerConnector : DefaultWorkerConnector
     {
         [SerializeField] private GameObject level;
 

workers/unity/Packages/com.improbable.gdk.core/Worker/DefaultWorkerConnector.cs

@@ -0,0 +1,71 @@
+using System;
+using UnityEngine;
+
+namespace Improbable.Gdk.Core
+{
+    public abstract class DefaultWorkerConnector : WorkerConnector
+    {
+        /// <summary>
+        ///     Denotes whether to connect using an external IP address.
+        /// </summary>
+        public bool UseExternalIp;
+
+        /// <summary>
+        ///     Determines whether to connect via the locator.
+        /// </summary>
+        /// <returns>True, if should connect via the Locator, false otherwise.</returns>
+        protected override bool ShouldUseLocator()
+        {
+            if (Application.isEditor)
+            {
+                return false;
+            }
+
+            var commandLineArguments = Environment.GetCommandLineArgs();
+            var commandLineArgs = CommandLineUtility.ParseCommandLineArgs(commandLineArguments);
+            var shouldUseLocator = commandLineArgs.ContainsKey(RuntimeConfigNames.LoginToken) ||
+                commandLineArgs.ContainsKey(RuntimeConfigNames.SteamDeploymentTag) ||
+                commandLineArgs.ContainsKey(RuntimeConfigNames.SteamTicket);
+            return shouldUseLocator;
+        }
+
+        protected override ReceptionistConfig GetReceptionistConfig(string workerType)
+        {
+            ReceptionistConfig config;
+
+            if (Application.isEditor)
+            {
+                config = new ReceptionistConfig
+                {
+                    WorkerType = workerType,
+                    WorkerId = CreateNewWorkerId(workerType),
+                    UseExternalIp = UseExternalIp
+                };
+            }
+            else
+            {
+                var commandLineArguments = Environment.GetCommandLineArgs();
+                var commandLineArgs = CommandLineUtility.ParseCommandLineArgs(commandLineArguments);
+                config = ReceptionistConfig.CreateConnectionConfigFromCommandLine(commandLineArgs);
+                config.WorkerType = workerType;
+                config.UseExternalIp = UseExternalIp;
+                if (!commandLineArgs.ContainsKey(RuntimeConfigNames.WorkerId))
+                {
+                    config.WorkerId = CreateNewWorkerId(workerType);
+                }
+            }
+
+            return config;
+        }
+
+        protected override LocatorConfig GetLocatorConfig(string workerType)
+        {
+            var commandLineArguments = Environment.GetCommandLineArgs();
+            var commandLineArgs = CommandLineUtility.ParseCommandLineArgs(commandLineArguments);
+            var config = LocatorConfig.CreateConnectionConfigFromCommandLine(commandLineArgs);
+            config.WorkerType = workerType;
+            config.WorkerId = CreateNewWorkerId(workerType);
+            return config;
+        }
+    }
+}

workers/unity/Packages/com.improbable.gdk.core/Worker/DefaultWorkerConnector.cs.meta

@@ -13,7 +13,7 @@ namespace Improbable.Gdk.Core
     /// <summary>
     ///     Connect workers via Monobehaviours.
     /// </summary>
-    public class WorkerConnector : MonoBehaviour, IDisposable
+    public abstract class WorkerConnector : MonoBehaviour, IDisposable
     {
         private delegate Task<Worker> ConnectionDelegate();
 
@@ -22,11 +22,6 @@ public class WorkerConnector : MonoBehaviour, IDisposable
         /// </summary>
         public int MaxConnectionAttempts = 3;
 
-        /// <summary>
-        ///     Denotes whether to connect using an external IP address.
-        /// </summary>
-        public bool UseExternalIp;
-
         /// <summary>
         ///     Represents a SpatialOS worker.
         /// </summary>
@@ -149,30 +144,7 @@ await Worker.CreateWorkerAsync(GetReceptionistConfig(workerType), logger, origin
         ///     Determines whether to connect via the locator.
         /// </summary>
         /// <returns>True, if should connect via the Locator, false otherwise.</returns>
-        protected virtual bool ShouldUseLocator()
-        {
-            if (Application.isEditor)
-            {
-                return false;
-            }
-
-            var commandLineArguments = Environment.GetCommandLineArgs();
-            var commandLineArgs = CommandLineUtility.ParseCommandLineArgs(commandLineArguments);
-            var shouldUseLocator = commandLineArgs.ContainsKey(RuntimeConfigNames.LoginToken) ||
-                commandLineArgs.ContainsKey(RuntimeConfigNames.SteamDeploymentTag) ||
-                commandLineArgs.ContainsKey(RuntimeConfigNames.SteamTicket);
-            return shouldUseLocator;
-        }
-
-        /// <summary>
-        ///     Selects which deployment to connect to.
-        /// </summary>
-        /// <param name="deployments">The list of deployments.</param>
-        /// <returns>The name of the deployment to connect to.</returns>
-        protected virtual string SelectDeploymentName(DeploymentList deployments)
-        {
-            return null;
-        }
+        protected abstract bool ShouldUseLocator();
 
         /// <summary>
         ///     Creates a Receptionist configuration.
@@ -185,34 +157,7 @@ protected virtual string SelectDeploymentName(DeploymentList deployments)
         /// </remarks>
         /// <param name="workerType">The type of the worker to create.</param>
         /// <returns>The Receptionist connection configuration</returns>
-        protected virtual ReceptionistConfig GetReceptionistConfig(string workerType)
-        {
-            ReceptionistConfig config;
-
-            if (Application.isEditor)
-            {
-                config = new ReceptionistConfig
-                {
-                    WorkerType = workerType,
-                    WorkerId = CreateNewWorkerId(workerType),
-                    UseExternalIp = UseExternalIp
-                };
-            }
-            else
-            {
-                var commandLineArguments = Environment.GetCommandLineArgs();
-                var commandLineArgs = CommandLineUtility.ParseCommandLineArgs(commandLineArguments);
-                config = ReceptionistConfig.CreateConnectionConfigFromCommandLine(commandLineArgs);
-                config.WorkerType = workerType;
-                config.UseExternalIp = UseExternalIp;
-                if (!commandLineArgs.ContainsKey(RuntimeConfigNames.WorkerId))
-                {
-                    config.WorkerId = CreateNewWorkerId(workerType);
-                }
-            }
-
-            return config;
-        }
+        protected abstract ReceptionistConfig GetReceptionistConfig(string workerType);
 
         /// <summary>
         ///     Creates the Locator configuration.
@@ -222,14 +167,16 @@ protected virtual ReceptionistConfig GetReceptionistConfig(string workerType)
         /// </remarks>
         /// <param name="workerType">The type of the worker to create.</param>
         /// <returns>The Locator connection configuration</returns>
-        protected virtual LocatorConfig GetLocatorConfig(string workerType)
+        protected abstract LocatorConfig GetLocatorConfig(string workerType);
+
+        /// <summary>
+        ///     Selects which deployment to connect to.
+        /// </summary>
+        /// <param name="deployments">The list of deployments.</param>
+        /// <returns>The name of the deployment to connect to.</returns>
+        protected virtual string SelectDeploymentName(DeploymentList deployments)
         {
-            var commandLineArguments = Environment.GetCommandLineArgs();
-            var commandLineArgs = CommandLineUtility.ParseCommandLineArgs(commandLineArguments);
-            var config = LocatorConfig.CreateConnectionConfigFromCommandLine(commandLineArgs);
-            config.WorkerType = workerType;
-            config.WorkerId = CreateNewWorkerId(workerType);
-            return config;
+            return null;
         }
 
         protected virtual void HandleWorkerConnectionEstablished()

workers/unity/Packages/com.improbable.gdk.core/Worker/WorkerConnector.cs

@@ -1,8 +1,5 @@
 using Improbable.Gdk.Core;
 using Improbable.Worker;
-#if UNITY_EDITOR
-using UnityEditor;
-#endif
 
 namespace Improbable.Gdk.Mobile
 {
@@ -17,26 +14,19 @@ protected override ReceptionistConfig GetReceptionistConfig(string workerType)
                 ReceptionistHost = GetHostIp(),
                 WorkerType = workerType,
                 WorkerId = CreateNewWorkerId(workerType),
-                UseExternalIp = UseExternalIp,
+                UseExternalIp = true,
                 LinkProtocol = NetworkConnectionType.Tcp,
             };
         }
 
-        protected override bool ShouldUseLocator()
+        protected override LocatorConfig GetLocatorConfig(string workerType)
         {
-            // We currently only support local deployments for Mobile
-            return false;
+            throw new System.NotImplementedException("The locator flow is currently not available for mobile workers.");
         }
 
-        private void OnValidate()
+        protected override bool ShouldUseLocator()
         {
-            if (UseExternalIp == false)
-            {
-                UseExternalIp = true;
-#if UNITY_EDITOR
-                EditorUtility.DisplayDialog("Invalid configuration", "Use External Ip needs to be set to true for mobile client workers.", "Ok");
-#endif
-            }
+            return false;
         }
     }
 }