Decouple Unity Remote from IInputRuntime

Author: jfreire-unity

Assets/Tests/InputSystem/Plugins/UnityRemoteTests.cs

@@ -13,7 +13,7 @@ internal class UnityRemoteTests : CoreTestsFixture
     public override void Setup()
     {
         base.Setup();
-        runtime.onUnityRemoteMessage = UnityRemoteSupport.GetMessageHandlerForTesting();
+        UnityRemoteSupport.s_TestMessageDispatch = UnityRemoteSupport.GetMessageHandlerForTesting();
     }
 
     public override void TearDown()
@@ -125,7 +125,7 @@ public void Remote_CanReceiveGyroscopeInputFromUnityRemote()
         // Now the app enables the gyro.
         InputSystem.EnableDevice(Gyroscope.current);
 
-        Assert.That(runtime.unityRemoteGyroEnabled, Is.True);
+        Assert.That(UnityRemoteSupport.unityRemoteGyroEnabled, Is.True);
         Assert.That(Gyroscope.current.enabled, Is.True);
         Assert.That(AttitudeSensor.current.enabled, Is.False);
         Assert.That(GravitySensor.current.enabled, Is.False);
@@ -160,7 +160,7 @@ public void Remote_CanReceiveGyroscopeInputFromUnityRemote()
         InputSystem.EnableDevice(GravitySensor.current);
         InputSystem.EnableDevice(LinearAccelerationSensor.current);
 
-        Assert.That(runtime.unityRemoteGyroEnabled, Is.True);
+        Assert.That(UnityRemoteSupport.unityRemoteGyroEnabled, Is.True);
         Assert.That(AttitudeSensor.current.enabled, Is.True);
         Assert.That(GravitySensor.current.enabled, Is.True);
         Assert.That(LinearAccelerationSensor.current.enabled, Is.True);
@@ -200,7 +200,7 @@ public void Remote_CanReceiveGyroscopeInputFromUnityRemote()
         // Set update interval.
         Gyroscope.current.samplingFrequency = 123.456f;
 
-        Assert.That(runtime.unityRemoteGyroUpdateInterval, Is.EqualTo(123.456f));
+        Assert.That(UnityRemoteSupport.unityRemoteGyroUpdateInterval, Is.EqualTo(123.456f));
         Assert.That(Gyroscope.current.samplingFrequency, Is.EqualTo(123.456f));
 
         SendUnityRemoteMessage(new UnityRemoteSupport.GoodbyeMessage());
@@ -281,14 +281,14 @@ public void TODO_Remote_CanReceiveJoystickInputFromUnityRemote()
     private unsafe void SendUnityRemoteMessage<TMessage>(TMessage message)
         where TMessage : unmanaged, UnityRemoteSupport.IUnityRemoteMessage
     {
-        if (runtime.onUnityRemoteMessage == null)
+        if (UnityRemoteSupport.s_TestMessageDispatch == null)
             return;
 
         var ptr = UnsafeUtility.AddressOf(ref message);
         *(byte*)ptr = message.staticType;
         *(int*)((byte*)ptr + 1) = UnsafeUtility.SizeOf<TMessage>();
 
-        runtime.onUnityRemoteMessage(new IntPtr(ptr));
+        UnityRemoteSupport.s_TestMessageDispatch(new IntPtr(ptr));
     }
 }
 #endif // UNITY_EDITOR

Packages/com.unity.inputsystem/InputSystem/Editor/InputSystemEditorInitializer.cs

@@ -62,48 +62,6 @@ private static void UnregisterWantsToQuit(Func<bool> handler)
             EditorApplication.wantsToQuit -= handler;
         }
 
-        // Unity Remote support
-        private static Func<IntPtr, bool> s_CurrentUnityRemoteMessageHandler;
-
-        private static void SetUnityRemoteMessageHandler(Func<IntPtr, bool> handler)
-        {
-            if (s_CurrentUnityRemoteMessageHandler != null)
-            {
-                var removeMethod = GetUnityRemoteAPIMethod("RemoveMessageHandler");
-                removeMethod?.Invoke(null, new object[] { s_CurrentUnityRemoteMessageHandler });
-            }
-
-            s_CurrentUnityRemoteMessageHandler = handler;
-
-            if (handler != null)
-            {
-                var addMethod = GetUnityRemoteAPIMethod("AddMessageHandler");
-                addMethod?.Invoke(null, new object[] { handler });
-            }
-        }
-
-        private static void SetUnityRemoteGyroEnabled(bool value)
-        {
-            var setMethod = GetUnityRemoteAPIMethod("SetGyroEnabled");
-            setMethod?.Invoke(null, new object[] { value });
-        }
-
-        private static void SetUnityRemoteGyroUpdateInterval(float interval)
-        {
-            var setMethod = GetUnityRemoteAPIMethod("SetGyroUpdateInterval");
-            setMethod?.Invoke(null, new object[] { interval });
-        }
-
-        private static System.Reflection.MethodInfo GetUnityRemoteAPIMethod(string methodName)
-        {
-            var editorAssembly = typeof(EditorApplication).Assembly;
-            var genericRemoteClass = editorAssembly.GetType("UnityEditor.Remote.GenericRemote");
-            if (genericRemoteClass == null)
-                return null;
-
-            return genericRemoteClass.GetMethod(methodName);
-        }
-
         private static void SendEditorAnalytic(InputAnalytics.IInputAnalytic analytic)
         {
             #if ENABLE_CLOUD_SERVICES_ANALYTICS
@@ -343,10 +301,6 @@ private static void RegisterNativeInputRuntimeHooks()
             nativeRuntime.m_RegisterWantsToQuit = RegisterWantsToQuit;
             nativeRuntime.m_UnregisterWantsToQuit = UnregisterWantsToQuit;
 
-            nativeRuntime.m_SetUnityRemoteMessageHandler = SetUnityRemoteMessageHandler;
-            nativeRuntime.m_SetUnityRemoteGyroEnabledCallback = SetUnityRemoteGyroEnabled;
-            nativeRuntime.m_SetUnityRemoteGyroUpdateIntervalCallback = SetUnityRemoteGyroUpdateInterval;
-
             nativeRuntime.m_SendEditorAnalytic = SendEditorAnalytic;
         }
 

Packages/com.unity.inputsystem/InputSystem/Editor/Plugins/UnityRemote/UnityRemoteSupport.cs

@@ -1,5 +1,6 @@
 #if UNITY_EDITOR
 using System;
+using System.Reflection;
 using System.Runtime.InteropServices;
 using UnityEditor;
 using UnityEngine.InputSystem.LowLevel;
@@ -18,27 +19,87 @@ internal static class UnityRemoteSupport
     {
         public static bool isConnected => s_State.connected;
 
+        private static Func<IntPtr, bool> s_RegisteredNativeHandler;
+
+        /// <summary>
+        /// When set (by tests), this delegate receives messages instead of the native path.
+        /// Cleared in <see cref="ResetGlobalState"/>.
+        /// </summary>
+        internal static Func<IntPtr, bool> s_TestMessageDispatch;
+
+        /// <summary>
+        /// Set whenever gyro commands are forwarded to the editor native API (for test observability).
+        /// </summary>
+        internal static bool? unityRemoteGyroEnabled;
+        /// <summary>
+        /// Set whenever the gyro update interval is forwarded to the editor native API (for test observability).
+        /// </summary>
+        internal static float? unityRemoteGyroUpdateInterval;
+
         /// <summary>
-        /// Used by tests that run with a test runtime; the editor sets the handler on the native runtime
-        /// at init, but the test runtime needs it installed explicitly.
+        /// Used by tests that run with a test runtime; the test fixture installs
+        /// <see cref="s_TestMessageDispatch"/> to deliver messages into <see cref="ProcessMessageFromUnityRemote"/>.
         /// </summary>
         internal static Func<IntPtr, bool> GetMessageHandlerForTesting() => ProcessMessageFromUnityRemote;
 
         public static void Initialize()
         {
-            InputRuntime.s_Instance.onUnityRemoteMessage = ProcessMessageFromUnityRemote;
+            SetNativeMessageHandler(ProcessMessageFromUnityRemote);
 
-            InputSystem.onSettingsChange += () =>
+            InputSystem.onSettingsChange += OnSettingsChanged;
+        }
+
+        private static void OnSettingsChanged()
+        {
+            if (InputSystem.settings.IsFeatureEnabled(InputFeatureNames.kDisableUnityRemoteSupport))
             {
-                if (InputSystem.settings.IsFeatureEnabled(InputFeatureNames.kDisableUnityRemoteSupport))
-                {
-                    InputRuntime.s_Instance.onUnityRemoteMessage = null;
-                    if (s_State.connected)
-                        Disconnect();
-                }
-                else
-                    InputRuntime.s_Instance.onUnityRemoteMessage = ProcessMessageFromUnityRemote;
-            };
+                SetNativeMessageHandler(null);
+                if (s_State.connected)
+                    Disconnect();
+            }
+            else
+                SetNativeMessageHandler(ProcessMessageFromUnityRemote);
+        }
+
+        private static MethodInfo GetUnityRemoteAPIMethod(string methodName)
+        {
+            var editorAssembly = typeof(EditorApplication).Assembly;
+            var genericRemoteClass = editorAssembly.GetType("UnityEditor.Remote.GenericRemote");
+            if (genericRemoteClass == null)
+                return null;
+
+            return genericRemoteClass.GetMethod(methodName);
+        }
+
+        private static void SetNativeMessageHandler(Func<IntPtr, bool> handler)
+        {
+            if (s_RegisteredNativeHandler != null)
+            {
+                var removeMethod = GetUnityRemoteAPIMethod("RemoveMessageHandler");
+                removeMethod?.Invoke(null, new object[] { s_RegisteredNativeHandler });
+            }
+
+            s_RegisteredNativeHandler = handler;
+
+            if (handler != null)
+            {
+                var addMethod = GetUnityRemoteAPIMethod("AddMessageHandler");
+                addMethod?.Invoke(null, new object[] { handler });
+            }
+        }
+
+        private static void SetNativeGyroEnabled(bool value)
+        {
+            unityRemoteGyroEnabled = value;
+            var setMethod = GetUnityRemoteAPIMethod("SetGyroEnabled");
+            setMethod?.Invoke(null, new object[] { value });
+        }
+
+        private static void SetNativeGyroUpdateInterval(float interval)
+        {
+            unityRemoteGyroUpdateInterval = interval;
+            var setMethod = GetUnityRemoteAPIMethod("SetGyroUpdateInterval");
+            setMethod?.Invoke(null, new object[] { interval });
         }
 
         private static unsafe bool ProcessMessageFromUnityRemote(IntPtr messageData)
@@ -250,7 +311,7 @@ private static void OnDeviceChange(InputDevice device, InputDeviceChange change)
             if (command->type == SetSamplingFrequencyCommand.Type)
             {
                 s_State.gyroUpdateInterval = ((SetSamplingFrequencyCommand*)command)->frequency;
-                InputRuntime.s_Instance.SetUnityRemoteGyroUpdateInterval(s_State.gyroUpdateInterval);
+                SetNativeGyroUpdateInterval(s_State.gyroUpdateInterval);
                 return InputDeviceCommand.GenericSuccess;
             }
 
@@ -270,7 +331,7 @@ private static void SyncGyroEnabledInRemote()
             if (enabled != s_State.gyroEnabled)
             {
                 s_State.gyroEnabled = enabled;
-                InputRuntime.s_Instance.SetUnityRemoteGyroEnabled(enabled);
+                SetNativeGyroEnabled(enabled);
             }
         }
 
@@ -503,6 +564,9 @@ internal static void ResetGlobalState()
             if (s_State.deviceCommandHandler != null)
                 InputSystem.onDeviceCommand -= s_State.deviceCommandHandler;
             s_State = default;
+            s_TestMessageDispatch = null;
+            unityRemoteGyroEnabled = null;
+            unityRemoteGyroUpdateInterval = null;
         }
     }
 }

Packages/com.unity.inputsystem/InputSystem/Runtime/IInputRuntime.cs

@@ -199,11 +199,6 @@ internal unsafe interface IInputRuntime
         bool isInPlayMode { get;  }
         bool isEditorActive { get; }
         bool isEditorPaused { get; }
-
-        // Functionality related to the Unity Remote.
-        Func<IntPtr, bool> onUnityRemoteMessage { set; }
-        void SetUnityRemoteGyroEnabled(bool value);
-        void SetUnityRemoteGyroUpdateInterval(float interval);
 #endif
     }
 

Packages/com.unity.inputsystem/InputSystem/Runtime/NativeInputRuntime.cs

@@ -354,35 +354,6 @@ public float scrollWheelDeltaPerTick
         public bool isEditorActive => m_IsEditorActive?.Invoke() ?? true;
         public bool isEditorPaused => m_IsEditorPaused?.Invoke() ?? false;
 
-        // Unity Remote callbacks - set by Editor
-        internal Action<Func<IntPtr, bool>> m_SetUnityRemoteMessageHandler;
-        internal Action<bool> m_SetUnityRemoteGyroEnabledCallback;
-        internal Action<float> m_SetUnityRemoteGyroUpdateIntervalCallback;
-
-        private Func<IntPtr, bool> m_UnityRemoteMessageHandler;
-
-        public Func<IntPtr, bool> onUnityRemoteMessage
-        {
-            set
-            {
-                if (m_UnityRemoteMessageHandler == value)
-                    return;
-
-                m_UnityRemoteMessageHandler = value;
-                m_SetUnityRemoteMessageHandler?.Invoke(value);
-            }
-        }
-
-        public void SetUnityRemoteGyroEnabled(bool value)
-        {
-            m_SetUnityRemoteGyroEnabledCallback?.Invoke(value);
-        }
-
-        public void SetUnityRemoteGyroUpdateInterval(float interval)
-        {
-            m_SetUnityRemoteGyroUpdateIntervalCallback?.Invoke(interval);
-        }
-
         private Action<InputPlayModeChange> m_OnPlayModeChanged;
         private Action m_OnProjectChanged;
         /// <summary>

Packages/com.unity.inputsystem/Tests/TestFixture/InputTestRuntime.cs

@@ -400,25 +400,6 @@ public double currentTimeOffsetToRealtimeSinceStartup
         public bool isInPlayMode { get; set; } = true;
         public bool isEditorActive { get; set; } = true;
         public bool isEditorPaused { get; set; }
-        public Func<IntPtr, bool> onUnityRemoteMessage
-        {
-            get => m_UnityRemoteMessageHandler;
-            set => m_UnityRemoteMessageHandler = value;
-        }
-
-        public bool? unityRemoteGyroEnabled;
-        public float? unityRemoteGyroUpdateInterval;
-
-        public void SetUnityRemoteGyroEnabled(bool value)
-        {
-            unityRemoteGyroEnabled = value;
-        }
-
-        public void SetUnityRemoteGyroUpdateInterval(float interval)
-        {
-            unityRemoteGyroUpdateInterval = interval;
-        }
-
         public Action<InputPlayModeChange> onPlayModeChanged { get; set; }
         public Action onProjectChange { get; set; }
         #endif
@@ -438,7 +419,6 @@ public void SetUnityRemoteGyroUpdateInterval(float interval)
         private List<KeyValuePair<int, DeviceCommandCallback>> m_DeviceCommandCallbacks;
         private object m_Lock = new object();
         private double m_CurrentTimeOffsetToRealtimeSinceStartup;
-        private Func<IntPtr, bool> m_UnityRemoteMessageHandler;
 
         #if UNITY_ANALYTICS || UNITY_EDITOR