FIX: Device lost to InputUser after layout changes (case 1347320, #1468).

Author: ekcoh

Assets/Tests/InputSystem/Plugins/PlayerInputTests.cs

@@ -2142,6 +2142,39 @@ public void PlayerInput_WhenJoinActionIsAReference_JoiningIsStillPossibleAfterDe
         Assert.That(playerJoined, Is.True);
     }
 
+    [Test] // Mimics what is reported in https://issuetracker.unity3d.com/product/unity/issues/guid/1347320
+    [Category("PlayerInput")]
+    public void PlayerInput_WhenOverridingDeviceLayout_LostDeviceShouldBeResolvedAndRepaired()
+    {
+        var go = new GameObject();
+        var playerInput = go.AddComponent<PlayerInput>();
+        playerInput.actions = InputActionAsset.FromJson(kActions);
+        var gamepad = InputSystem.AddDevice<Gamepad>();
+        go.SetActive(true);
+
+        // Actuate gamepad to pair with user (other option would be initially paired)
+        Press(gamepad.buttonSouth);
+        Assert.That(playerInput.devices[0], Is.SameAs(gamepad));
+
+        // Register a layout override (this will recreate device)
+        InputSystem.RegisterLayoutOverride(@"
+            {
+                ""name"" : ""GamepadPlayerUsageTags"",
+                ""extend"" : ""Gamepad"",
+                ""commonUsages"" : [
+                    ""Player1"", ""Player2""
+                ]
+            }
+        ");
+
+        // As reported in https://issuetracker.unity3d.com/product/unity/issues/guid/1347320
+        // there would be no device assigned after registered layout override since this
+        // would recreate the device with the same device id (but a new instance).
+        Assert.That(playerInput.devices.Count, Is.EqualTo(1));
+        Assert.That(playerInput.devices[0], !Is.SameAs(gamepad)); // expected replacement (by design, not a requirement)
+        Assert.That(playerInput.devices[0].name, Is.EqualTo(gamepad.name));
+    }
+
     // An action is either
     //   (a) button-like, or
     //   (b) axis-like, or

Assets/Tests/InputSystem/Utilities/ArrayHelperTests.cs

@@ -117,4 +117,17 @@ public void Utilities_IndexOfReference__IsUsingReferenceEqualsAndConstrainedBySt
         Assert.AreEqual(1, arr.IndexOfReference(arr[1], 1, 3));
         Assert.AreEqual(2, arr.IndexOfReference(arr[2], 1, 3));
     }
+
+    [Test]
+    [Category("Utilities")]
+    public void Utilities_IndexOfPredicate__IsUsingPredicateForEqualityAndConstraintedByStartIndexAndCount()
+    {
+        var arr = new int[] { 0, 1, 2, 3, 4, 5 };
+
+        Assert.That(arr.IndexOf(x => x >= 3, 0, arr.Length), Is.EqualTo(3));
+        Assert.That(arr.IndexOf(x => x >= 3, 0, 3), Is.EqualTo(-1));
+        Assert.That(arr.IndexOf(x => x >= 3, 1, 3), Is.EqualTo(3));
+        Assert.That(arr.IndexOf(x => x >= 3, 4, 0), Is.EqualTo(-1));
+        Assert.That(arr.IndexOf(x => x < 0, 3, 3), Is.EqualTo(-1));
+    }
 }

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -30,6 +30,7 @@ however, it has to be formatted properly to pass verification tests.
 - Fixed an issue with `InputSystemUIInputModule` that would cause UI to stop responding during play mode after changing a script file while Recompile and Continue mode is active, or by forcing a script recompile using `RequestScriptCompilation`([case 1324215](https://issuetracker.unity3d.com/product/unity/issues/guid/1324215/)).
 - Fixed `InputSystemUIInputModule` inspector showing all action bindings as "None" when assigned a runtime created actions asset ([case 1304943](https://issuetracker.unity3d.com/issues/input-system-ui-input-module-loses-prefab-action-mapping-in-local-co-op)).
 - Fixed a problem with UI Toolkit buttons remaining active when multiple fingers are used on a touchscreen, using `InputSystemUIInputModule` with pointerBehavior set to `UIPointerBehavior.SingleUnifiedPointer`. UI Toolkit will now always receive the same pointerId when that option is in use, regardless of the hardware component that produced the pointer event. ([case 1369081](https://issuetracker.unity3d.com/issues/transitions-get-stuck-when-pointer-behavior-is-set-to-single-unified-pointer-and-multiple-touches-are-made)).
+- Fixed a problem with `InputUser` where devices would be removed and not added again after layout overrides preventing certain devices, e.g. gamepads to not work correctly when associated with action map bindings tied to `PlayerInput` ([case 1347320](https://issuetracker.unity3d.com/product/unity/issues/guid/1347320)).
 - Fixed DualSense on iOS not inheriting from `DualShockGamepad` ([case 1378308](https://issuetracker.unity3d.com/issues/input-dualsense-detection-ios)).
 - Fixed a device becoming `.current` (e.g. `Gamepad.current`, etc) when sending a new state event that contains no control changes (case 1377952).
 - Fixed calling `IsPressed` on an entire device returning `true` ([case 1374024](https://issuetracker.unity3d.com/issues/inputcontrol-dot-ispressed-always-returns-true-when-using-new-input-system)).

Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs

@@ -1506,10 +1506,10 @@ private static void OnDeviceChange(InputDevice device, InputDeviceChange change)
                 // New device was added. See if it was a device we previously lost on a user.
                 case InputDeviceChange.Added:
                 {
-                    // Could be a previously lost device. Could affect multiple users. Repeatedly search in
-                    // s_AllLostDevices until we can't find the device anymore.
-                    var deviceIndex = s_GlobalState.allLostDevices.IndexOfReference(device, s_GlobalState.allLostDeviceCount);
-                    while (deviceIndex != -1)
+                    // Search all lost devices. Could affect multiple users.
+                    // Note that RemoveDeviceFromUser removes one element, hence no advancement of deviceIndex.
+                    for (var deviceIndex = FindLostDevice(device); deviceIndex != -1;
+                         deviceIndex = FindLostDevice(device, deviceIndex))
                     {
                         // Find user. Must be there as we found the device in s_AllLostDevices.
                         var userIndex = -1;
@@ -1523,20 +1523,15 @@ private static void OnDeviceChange(InputDevice device, InputDeviceChange change)
                             }
                         }
 
-                        // Remove from list of lost devices. No notification.
-                        RemoveDeviceFromUser(userIndex, device, asLostDevice: true);
+                        // Remove from list of lost devices. No notification. Notice that we need to use device
+                        // from lost device list even if its another instance.
+                        RemoveDeviceFromUser(userIndex, s_GlobalState.allLostDevices[deviceIndex], asLostDevice: true);
 
                         // Notify.
                         Notify(userIndex, InputUserChange.DeviceRegained, device);
 
                         // Add back as normally paired device.
                         AddDeviceToUser(userIndex, device);
-
-                        // Search for another user who had lost the same device.
-                        // Note: s_AllLostDevices is modified (element erased) from within RemoveDeviceFromUser,
-                        //       hence, deviceIndex is not advanced and s_AllLostDeviceCount is one less than
-                        //       previous linear search iteration.
-                        deviceIndex = s_GlobalState.allLostDevices.IndexOfReference(device, deviceIndex, s_GlobalState.allLostDeviceCount);
                     }
                     break;
                 }
@@ -1603,6 +1598,22 @@ private static void OnDeviceChange(InputDevice device, InputDeviceChange change)
             }
         }
 
+        private static int FindLostDevice(InputDevice device, int startIndex = 0)
+        {
+            // Compare both by device ID and by reference. We may be looking at a device that was recreated
+            // due to layout changes (new InputDevice instance, same ID) or a device that was reconnected
+            // and thus fetched out of `disconnectedDevices` (same InputDevice instance, new ID).
+
+            var newDeviceId = device.deviceId;
+            for (var i = startIndex; i < s_GlobalState.allLostDeviceCount; ++i)
+            {
+                var lostDevice = s_GlobalState.allLostDevices[i];
+                if (device == lostDevice || lostDevice.deviceId == newDeviceId) return i;
+            }
+
+            return -1;
+        }
+
         // We hook this into InputSystem.onEvent when listening for activity on unpaired devices.
         // What this means is that we get to run *before* state reaches the device. This in turn
         // means that should the device get paired as a result, actions that are enabled as part

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

@@ -176,6 +176,21 @@ public static int IndexOf<TValue>(this TValue[] array, Predicate<TValue> predica
             return -1;
         }
 
+        public static int IndexOf<TValue>(this TValue[] array, Predicate<TValue> predicate, int startIndex = 0, int count = -1)
+        {
+            if (array == null)
+                return -1;
+
+            var end = startIndex + (count < 0 ? array.Length - startIndex : count);
+            for (var i = startIndex; i < end; ++i)
+            {
+                if (predicate(array[i]))
+                    return i;
+            }
+
+            return -1;
+        }
+
         public static int IndexOfReference<TFirst, TSecond>(this TFirst[] array, TSecond value, int count = -1)
             where TSecond : class
             where TFirst : TSecond