FIX: Properly reset ActionMap state in OnAfterDeserialize (ISXB-737) (#1832)

* FIX: Properly reset ActionMap state in OnAfterDeserialize (ISXB-737)

* The m_EnabledActionsCount field reports "enabled" state and must be reset for ActionMap to be re-enabled

* Add regression test cases

* Actions_ActionMapDisabledDuringOnAfterSerialization covers the specific scenario

* ProjectWideActions_ThrowsWhenAddingOrRemovingWhileEnabled validates Setup cannot change while ActionMap is enabled

Author: timkeo

Assets/Tests/InputSystem/CoreTests_Actions.cs

@@ -11923,4 +11923,36 @@ public void TODO_Actions_ReResolvingBindings_DoesNotAllocate_IfXXX()
     {
         Assert.Fail();
     }
+
+    // Validate OnAfterDeserialize() completely disables ActionMap
+    // https://jira.unity3d.com/browse/ISXB-737
+    [Test]
+    [Category("Actions")]
+    public void Actions_ActionMapDisabledDuringOnAfterSerialization()
+    {
+        var map = new InputActionMap("MyMap");
+        var action = map.AddAction("MyAction");
+        action.AddCompositeBinding("2DVector")
+            .With("Up", "<Keyboard>/w")
+            .With("Down", "<Keyboard>/s")
+            .With("Left", "<Keyboard>/a")
+            .With("Right", "<Keyboard>/d");
+
+        map.Enable();
+
+        Assert.That(map.enabled, Is.True);
+        Assert.That(map.FindAction("MyAction", true).enabled, Is.True);
+        Assert.Throws<System.InvalidOperationException>(() => map.AddAction("Something"));
+
+        // Calling this directly is contrived (and not supported usage) but it should
+        // effectively cover this regression scenario.
+        map.OnAfterDeserialize();
+
+        Assert.That(map.enabled, Is.False);
+
+        map.Enable();
+
+        Assert.That(map.enabled, Is.True);
+        Assert.That(map.FindAction("MyAction", true).enabled, Is.True);
+    }
 }

Assets/Tests/InputSystem/CoreTests_ProjectWideActions.cs

@@ -253,6 +253,48 @@ public void ProjectWideActions_CanReplaceExistingActions()
         Assert.That(InputSystem.actions.actionMaps[1].actions.Count, Is.EqualTo(1));
         Assert.That(InputSystem.actions.actionMaps[1].actions[0].name, Is.EqualTo("replacedAction4"));
     }
-}
 
+#if UNITY_EDITOR
+    [Test]
+    [Category(TestCategory)]
+    public void ProjectWideActions_ThrowsWhenAddingOrRemovingWhileEnabled()
+    {
+        var asset = ProjectWideActionsAsset.GetOrCreate();
+
+        // Verify adding ActionMap while enabled throws an exception
+        Assert.Throws<InvalidOperationException>(() => asset.AddActionMap("AnotherMap").AddAction("AnotherAction"));
+
+        asset.Disable();
+        asset.AddActionMap("AnotherMap").AddAction("AnotherAction");
+
+        // Verify enabled state reported correctly
+        Assert.That(asset.enabled, Is.False);
+        Assert.That(asset.FindActionMap("AnotherMap", true).enabled, Is.False);
+        Assert.That(asset.FindAction("AnotherAction", true).enabled, Is.False);
+
+        asset.Enable();
+
+        Assert.That(asset.enabled, Is.True);
+        Assert.That(asset.FindActionMap("AnotherMap", true).enabled, Is.True);
+        Assert.That(asset.FindAction("AnotherAction", true).enabled, Is.True);
+
+        // Verify adding/removing actions throws when ActionMap is enabled
+        Assert.Throws<System.InvalidOperationException>(() => asset.FindActionMap("AnotherMap", true).AddAction("YetAnotherAction"));
+        Assert.Throws<System.InvalidOperationException>(() => asset.RemoveAction("AnotherAction"));
+        Assert.Throws<InvalidOperationException>(() => asset.RemoveActionMap("AnotherMap"));
+
+        // Verify enabled state when enabling Action directly
+        asset.Disable();
+        asset.FindAction("AnotherAction", true).Enable();
+
+        Assert.That(asset.FindActionMap("InitialActionMapOne", true).enabled, Is.False);
+        Assert.That(asset.FindActionMap("AnotherMap", true).enabled, Is.True);
+        Assert.That(asset.FindAction("AnotherAction", true).enabled, Is.True);
+
+        // Verify removing any ActionMap throws if another one is enabled
+        Assert.Throws<System.InvalidOperationException>(() => asset.RemoveActionMap("InitialActionMapOne"));
+    }
+
+#endif // UNITY_EDITOR
+}
 #endif

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -39,6 +39,7 @@ however, it has to be formatted properly to pass verification tests.
 - Fixed "Listen" functionality for selecting an input sometimes expecting the wrong input type.
 - Fixed console errors that can be produced when opening input package settings from the Inspector.
 - Fixed InputManager.asset file growing in size on each Reset call.
+- Fixed Opening InputDebugger throws 'Action map must have state at this point' error
 
 ## [1.8.0-pre.2] - 2023-11-09
 

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

@@ -1984,6 +1984,7 @@ public void OnAfterDeserialize()
         {
             m_State = null;
             m_MapIndexInState = InputActionState.kInvalidIndex;
+            m_EnabledActionsCount = 0;
 
             // Restore references of actions linking back to us.
             if (m_Actions != null)