Improve testing coverage and comments

Author: jfreire-unity

Assets/Tests/InputSystem/CoreTests_Editor.cs

@@ -2893,9 +2893,9 @@ public void Editor_WhenRunUpdatesInEditModeIsEnabled_InputActionsTriggerInEditMo
     private static void DisableProjectWideActions()
     {
 #if UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS
-        // If the system has project-wide input actions they will also trigger enable/disable via
-        // play mode change triggers above. Hence we adjust extra variable to compensate of
-        // state allocated by project-wide actions.
+        // If the system has project-wide input actions they will start enabled once InputSystem.Reset() is called and
+        // be disabled entering EditMode. Hence, we adjust extra variable to compensate ofstate allocated by
+        // project-wide actions.
         if (InputSystem.actions)
         {
             Assert.That(InputActionState.s_GlobalState.globalList.length, Is.EqualTo(1));
@@ -2918,6 +2918,14 @@ public void Editor_LeavingPlayMode_DestroysAllActionStates()
 
         // Enter play mode.
         InputSystem.OnPlayModeChange(PlayModeStateChange.ExitingEditMode);
+
+#if UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS
+        // This simulates enabling project-wide actions, which is done before just before entering play mode,
+        // called from InputSystem.InitializeInEditor().
+        if (InputSystem.actions)
+            InputSystem.actions.Enable();
+#endif
+
         InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredPlayMode);
 
         DisableProjectWideActions();
@@ -2934,7 +2942,8 @@ public void Editor_LeavingPlayMode_DestroysAllActionStates()
         InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredEditMode);
 
         Assert.That(InputActionState.s_GlobalState.globalList.length, Is.Zero);
-        Assert.That(InputSystem.s_Manager.m_StateChangeMonitors[0].listeners[0].control, Is.Null); // Won't get removed, just cleared.
+        // Won't get removed, just cleared.
+        Assert.That(InputSystem.s_Manager.m_StateChangeMonitors[0].listeners[0].control, Is.Null);
     }
 
     [Test]

Assets/Tests/InputSystem/CoreTests_ProjectWideActions.cs

@@ -196,6 +196,37 @@ public void ProjectWideActions_CanEnableCurrentActionMapOfPlayerInput(string act
         //NOTE: Asset actions are considered enabled even if a single action map is enabled
         Assert.That(playerInput.actions.enabled, Is.EqualTo(expectedResult));
     }
+
+    [Test]
+    [Category("Editor")]
+    public void ProjectWideActions_InitializeInEditorEnablesProjectWideActions()
+    {
+        if (InputSystem.actions != null)
+        {
+            // Asserts that project wide actions are enabled by default.
+            // Before the test is run, InputSystem.Reset() is called which will enable them.
+            // It can be interpreted as a mock of the behavior that happens when `InitializeInEditor()` is called.
+            Assert.That(InputSystem.actions.enabled, Is.True);
+
+            // Calling exit play mode callbacks will disable them
+            InputSystem.OnPlayModeChange(PlayModeStateChange.ExitingPlayMode);
+            InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredEditMode);
+
+            Assert.That(InputSystem.actions.enabled, Is.False);
+
+            // Calling enter play mode callbacks will not re-enable them per default. They are only
+            // enabled when `InputSystem.InitializeInEditor()` is called, which happens before these callbacks.
+            // Note: Project-wide actions are disabled at this point. These next lines are added to make sure we
+            // establish behavior that project-wide actions should be enabled only once
+            // `InputSystem.InitializeInEditor()` is called. Before this test was introduced, project-wide actions were
+            // enabled after entering play mode again which would lead to a different behavior than Player
+            // builds.
+            InputSystem.OnPlayModeChange(PlayModeStateChange.ExitingEditMode);
+            InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredPlayMode);
+
+            Assert.That(InputSystem.actions.enabled, Is.False);
+        }
+    }
 }
 
 #endif

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

@@ -3015,16 +3015,10 @@ internal static bool ShouldDrawWarningIconForBinding(string bindingPath)
         #region Actions
 
 #if UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS
-        // EnteredEditMode  Occurs during the next update of the Editor application if it is in edit mode and was previously in play mode.
-        // ExitingEditMode  Occurs when exiting edit mode, before the Editor is in play mode.
-        // EnteredPlayMode  Occurs during the next update of the Editor application if it is in play mode and was previously in edit mode.
-        // ExitingPlayMode  Occurs when exiting play mode, before the Editor is in edit mode.
-        //
-        // Using the EnteredEditMode / EnteredPlayMode states to transition the actions' enabled
-        // state ensures that the they are active in all of these MonoBehavior methods:
-        //
-        //      Awake() /  Start() / OnEnable() / OnDisable() / OnDestroy()
-        //
+
+        // This is called from InitializeInEditor() and InitializeInPlayer() to make sure
+        // project-wide actions are all active in they are active in all of these MonoBehavior methods:
+        // Awake() /  Start() / OnEnable() / OnDisable() / OnDestroy()
         private static void EnableActions()
         {
 #if UNITY_EDITOR
@@ -3908,8 +3902,7 @@ private static void Reset(bool enableRemoting = false, IInputRuntime runtime = n
             InputUser.ResetGlobals();
             EnhancedTouchSupport.Reset();
 
-            // // This is the point where we initialise project-wide actions for the Editor, Editor Tests and Player Tests.
-            // // Note this is too early for editor ! actions is not setup yet.
+            // This is the point where we initialise project-wide actions for the Editor Play-mode, Editor Tests and Player Tests.
             #if UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS
             EnableActions();
             #endif