FIX: Allow default UI actions to work without setting up a project-wide actions file (ISXB-811). (#1899)

* FIX: Allow default UI actions to work without setting up a project-wide actions file (ISXB-833).

Also, fix newlines not functioning correctly in uxml file.

* Evaluate InputSystemProvider has an asset

This makes sure that InputForUI input will not break during tests.

* Add tests which use and remove project-wide actions

Evaluates that there is an action asset fallback in case there are no project-wide actions.

* Fix formatting issues

* Don't need to pass around a member variable.

* Restrict visibility of private member variable to only share what's required.

* Update CHANGELOG.md

* Move assertion to separate test.

---------

Co-authored-by: João Freire <[email protected]>

Author: graham-huws

Assets/Tests/InputSystem/Plugins/InputForUITests.cs

@@ -31,13 +31,9 @@ public override void Setup()
     {
         base.Setup();
 
-        // Test assumes a compatible project-wide action configuration exist for UI
-        // See CoreTests_ProjectWideActions for how its setup via build plugins.
-        Assert.That(InputSystem.actions, Is.Not.Null,
-            "Test is invalid since Project-wide Input System actions have not been setup for play-mode test environment");
-
         m_InputSystemProvider = new InputSystemProvider();
         EventProvider.SetMockProvider(m_InputSystemProvider);
+
         // Register at least one consumer so the mock update gets invoked
         EventProvider.Subscribe(InputForUIOnEvent);
     }
@@ -58,6 +54,15 @@ private bool InputForUIOnEvent(in Event ev)
         return true;
     }
 
+    [Test]
+    [Category("InputForUI")]
+    public void InputSystemActionAssetIsNotNull()
+    {
+        // Test assumes a compatible action asset configuration exists for UI
+        Assert.IsTrue(m_InputSystemProvider.ActionAssetIsNotNull(),
+            "Test is invalid since InputSystemProvider actions are not available");
+    }
+
     [Test]
     [Category("InputForUI")]
     public void PointerEventsAreDispatchedFromMouse()
@@ -109,12 +114,7 @@ public void TouchIsPressedAndMouseEventsAreIgnored()
     // Presses a gamepad left stick left and verifies that a navigation move event is dispatched
     public void NavigationMoveWorks()
     {
-        var gamepad = InputSystem.AddDevice<Gamepad>();
-        Update();
-        Press(gamepad.leftStick.left);
-        Update();
-        Release(gamepad.leftStick.left);
-        Update();
+        MoveWithGamepad();
 
         Assert.IsTrue(m_InputForUIEvents.Count == 1);
         Assert.That(m_InputForUIEvents[0] is Event
@@ -126,6 +126,16 @@ public void NavigationMoveWorks()
         });
     }
 
+    void MoveWithGamepad()
+    {
+        var gamepad = InputSystem.AddDevice<Gamepad>();
+        Update();
+        Press(gamepad.leftStick.left);
+        Update();
+        Release(gamepad.leftStick.left);
+        Update();
+    }
+
     [Test]
     [Category("InputForUI")]
     public void SendWheelEvent()
@@ -140,6 +150,37 @@ public void SendWheelEvent()
         Assert.That(m_InputForUIEvents[0].asPointerEvent.scroll, Is.EqualTo(new Vector2(0, 1)));
     }
 
+    [Test]
+    [Category("InputForUI")]
+    [TestCase(true)]
+    [TestCase(false)]
+    // The goal of this test is to make sure that InputSystemProvider works with and without project-wide actions asset
+    // so that there is no impact in receiving the necessary input events for UI.
+    // When there are no project-wide actions asset, the InputSystemProvider should still work as it currently gets
+    // the actions from DefaultActionsAsset().asset.
+    public void EventProviderWorksWithAndWithoutProjectWideActionsSet(bool useProjectWideActionsAsset)
+    {
+        Update();
+        if (!useProjectWideActionsAsset)
+        {
+            // Remove the project-wide actions asset in play mode and player.
+            // It will call InputSystem.onActionChange and re-set InputSystemProvider.actionAsset
+            // This the case where no project-wide actions asset is available in the project.
+            InputSystem.s_Manager.actions = null;
+        }
+        Update();
+        MoveWithGamepad();
+
+        Assert.IsTrue(m_InputForUIEvents.Count == 1);
+        Assert.That(m_InputForUIEvents[0] is Event
+        {
+            type: Event.Type.NavigationEvent,
+            asNavigationEvent: { type: NavigationEvent.Type.Move,
+                                 direction: NavigationEvent.Direction.Left,
+                                 eventSource: EventSource.Gamepad}
+        });
+    }
+
     static void Update()
     {
         EventProvider.NotifyUpdate();

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -11,6 +11,7 @@ however, it has to be formatted properly to pass verification tests.
 ## [Unreleased] - YYYY-MM-DD
 
 ### Fixed
+- Fixed an issue where UI interactions would not function without setting up a project-wide actions asset in Project Settings. Default UI actions are now created on the fly, if no asset for project-wide actions has been set. [ISXB-811](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-811).
 - Physical keyboards used on Android/ChromeOS could have keys "stuck" reporting as pressed after a long press and release [ISXB-475](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-475).
 - NullReferenceException thrown when right-clicking an empty Action Map list in Input Actions Editor windows [ISXB-833](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-833).
 - Fixed an issue where `System.ObjectDisposedException` would be thrown when deleting the last ActionMap item in the Input Actions Asset editor.

Packages/com.unity.inputsystem/InputSystem/Editor/UITKAssetEditor/Resources/InputActionsProjectSettings.uxml

@@ -8,7 +8,7 @@
         <uie:ObjectField name="current-asset" type="UnityEngine.InputSystem.InputActionAsset, Unity.InputSystem" label="Project-wide Actions" />
     </ui:VisualElement>
     <ui:VisualElement name="missing-asset-section">
-        <ui:HelpBox text="Actions for the Input System are stored in an Action Asset. You can assign an Action Asset as project-wide in the field above to make them accessible directly through the InputSystem.actions API.\n\nClick the button below to create a new Action Asset containing default actions, which will be assigned as project-wide." message-type="Info"/>
+        <ui:HelpBox text="Actions for the Input System are stored in an Action Asset. You can assign an Action Asset as project-wide in the field above to make them accessible directly through the InputSystem.actions API.&#10;&#10;Click the button below to create a new Action Asset containing default actions, which will be assigned as project-wide." message-type="Info"/>
         <ui:Button text="Create and assign a default project-wide Action Asset" name="create-asset"/>
     </ui:VisualElement>
 </ui:UXML>

Packages/com.unity.inputsystem/InputSystem/Plugins/InputForUI/InputSystemProvider.cs

@@ -17,6 +17,7 @@ internal class InputSystemProvider : IEventProviderImpl
         Configuration m_Cfg;
 
         InputActionAsset m_InputActionAsset;
+
         InputActionReference m_PointAction;
         InputActionReference m_MoveAction;
         InputActionReference m_SubmitAction;
@@ -79,14 +80,14 @@ public void Initialize()
             m_SeenTouchEvents = false;
 
             m_Cfg = Configuration.GetDefaultConfiguration();
-            RegisterActions(m_Cfg);
+            RegisterActions();
 
             InputSystem.onActionsChange += OnActionsChange;
         }
 
         public void Shutdown()
         {
-            UnregisterActions(m_Cfg);
+            UnregisterActions();
 
             m_InputEventPartialProvider.Shutdown();
             m_InputEventPartialProvider = null;
@@ -96,10 +97,10 @@ public void Shutdown()
 
         public void OnActionsChange()
         {
-            UnregisterActions(m_Cfg);
+            UnregisterActions();
 
             m_Cfg = Configuration.GetDefaultConfiguration();
-            RegisterActions(m_Cfg);
+            RegisterActions();
         }
 
         public void Update()
@@ -156,6 +157,11 @@ void ResetSeenEvents()
             m_SeenPenEvents = false;
         }
 
+        public bool ActionAssetIsNotNull()
+        {
+            return m_InputActionAsset != null;
+        }
+
         //TODO: Refactor as there is no need for having almost the same implementation in the IM and ISX?
         void DirectionNavigation(DiscreteTime currentTime)
         {
@@ -573,21 +579,18 @@ void UnregisterNextPreviousAction()
             }
         }
 
-        void RegisterActions(Configuration cfg)
+        void RegisterActions()
         {
-            m_InputActionAsset = cfg.ActionAsset;
+            m_InputActionAsset = m_Cfg.ActionAsset;
 
-            if (m_InputActionAsset != null)
-            {
-                m_PointAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.PointAction));
-                m_MoveAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.MoveAction));
-                m_SubmitAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.SubmitAction));
-                m_CancelAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.CancelAction));
-                m_LeftClickAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.LeftClickAction));
-                m_MiddleClickAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.MiddleClickAction));
-                m_RightClickAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.RightClickAction));
-                m_ScrollWheelAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.ScrollWheelAction));
-            }
+            m_PointAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.PointAction));
+            m_MoveAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.MoveAction));
+            m_SubmitAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.SubmitAction));
+            m_CancelAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.CancelAction));
+            m_LeftClickAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.LeftClickAction));
+            m_MiddleClickAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.MiddleClickAction));
+            m_RightClickAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.RightClickAction));
+            m_ScrollWheelAction = InputActionReference.Create(m_InputActionAsset.FindAction(m_Cfg.ScrollWheelAction));
 
             if (m_PointAction != null && m_PointAction.action != null)
                 m_PointAction.action.performed += OnPointerPerformed;
@@ -610,17 +613,22 @@ void RegisterActions(Configuration cfg)
             if (m_ScrollWheelAction != null && m_ScrollWheelAction.action != null)
                 m_ScrollWheelAction.action.performed += OnScrollWheelPerformed;
 
-            // When adding new one's don't forget to add them to UnregisterActions
+            // When adding new actions, don't forget to add them to UnregisterActions
 
-            if (m_InputActionAsset != null)
+            if (InputSystem.actions == null)
+            {
+                // If we've not loaded a user-created set of actions, just enable the UI actions from our defaults.
+                m_InputActionAsset.FindActionMap("UI", true).Enable();
+            }
+            else
                 m_InputActionAsset.Enable();
 
             // TODO make it configurable as it is not part of default config
             // The Next/Previous action is not part of the input actions asset
             RegisterNextPreviousAction();
         }
 
-        void UnregisterActions(Configuration cfg)
+        void UnregisterActions()
         {
             if (m_PointAction != null && m_PointAction.action != null)
                 m_PointAction.action.performed -= OnPointerPerformed;
@@ -673,7 +681,7 @@ public struct Configuration
 
             public static Configuration GetDefaultConfiguration()
             {
-                return new Configuration
+                var config = new Configuration
                 {
                     ActionAsset = InputSystem.actions,
                     PointAction = "UI/Point",
@@ -685,6 +693,14 @@ public static Configuration GetDefaultConfiguration()
                     RightClickAction = "UI/RightClick",
                     ScrollWheelAction = "UI/ScrollWheel",
                 };
+
+                if (config.ActionAsset == null)
+                {
+                    // Use default asset if user didn't specifically set one, so that UI functions still work (ISXB-811)
+                    config.ActionAsset = new DefaultInputActions().asset;
+                }
+
+                return config;
             }
         }
     }