Merge branch 'develop' into DOC-5361

Author: ekcoh

Assets/Samples/InGameHints/InGameHintsActions.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from Assets/Samples/InGameHints/InGameHintsActions.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Assets/Samples/SimpleDemo/SimpleControls.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from Assets/Samples/SimpleDemo/SimpleControls.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Assets/Tests/InputSystem/CoreTests_Analytics.cs

@@ -663,6 +663,55 @@ public void Analytics_ShouldReportPlayerInputManagerData()
         }
     }
 
+    [Test]
+    [Category("Analytics")]
+    public void Analytics_ShouldReportCodeAuthoringAnalytic()
+    {
+        CollectAnalytics(InputExitPlayModeAnalytic.kEventName);
+
+        // NOTE: We do not want to trigger entering/exiting play-mode for this small data-sanity check
+        //       so just stick to triggering it explicitly. A better test would have been an editor test
+        //       going in and out of play-mode for real but not clear if this is really possible.
+
+        // Pretend we are entering play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingEditMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredPlayMode);
+
+        // Assert no data received
+        Assert.That(sentAnalyticsEvents.Count, Is.EqualTo(0));
+
+        // Pretend we are exiting play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingPlayMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredEditMode);
+
+        // Assert: Data received
+        Assert.That(sentAnalyticsEvents.Count, Is.EqualTo(1));
+        Assert.That(sentAnalyticsEvents[0].name, Is.EqualTo(InputExitPlayModeAnalytic.kEventName));
+        Assert.That(sentAnalyticsEvents[0].data, Is.TypeOf<InputExitPlayModeAnalytic.Data>());
+
+        var data0 = (InputExitPlayModeAnalytic.Data)sentAnalyticsEvents[0].data;
+        Assert.That(data0.uses_code_authoring, Is.False);
+
+        // Pretend we are entering play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingEditMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredPlayMode);
+
+        var action = new InputAction("Dance");
+        action.AddBinding("<Keyboard>/Space");
+
+        // Pretend we are exiting play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingPlayMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredEditMode);
+
+        // Assert: Data received
+        Assert.That(sentAnalyticsEvents.Count, Is.EqualTo(2));
+        Assert.That(sentAnalyticsEvents[1].name, Is.EqualTo(InputExitPlayModeAnalytic.kEventName));
+        Assert.That(sentAnalyticsEvents[1].data, Is.TypeOf<InputExitPlayModeAnalytic.Data>());
+
+        var data1 = (InputExitPlayModeAnalytic.Data)sentAnalyticsEvents[1].data;
+        Assert.That(data1.uses_code_authoring, Is.True);
+    }
+
 #if UNITY_INPUT_SYSTEM_ENABLE_UI
     [Test]
     [Category("Analytics")]

Assets/Tests/InputSystem/CoreTests_Devices.cs

@@ -4162,13 +4162,40 @@ public void Devices_RemovingAndReaddingDevice_DoesNotAllocateMemory()
         recorder.CollectFromAllThreads();
 #endif
 
-        // We expect a single allocation for each call to ReportNewInputDevice when there is one disconnected device
-        //
-        int numberOfRepeats = 2;
-        int numberOfDisconnectedDevices = 1;
-        int numberOfCallsToReportNewInputDevicePerRun = 2;
-        int expectedAllocations = numberOfRepeats * numberOfDisconnectedDevices * numberOfCallsToReportNewInputDevicePerRun;
-        Assert.AreEqual(expectedAllocations, recorder.sampleBlockCount);
+        // No allocations are expected.
+        Assert.AreEqual(0, recorder.sampleBlockCount);
+    }
+
+    // Regression test to cover having null descriptor fields for a device. Some non-desktop gamepad device types do this.
+    [Test]
+    [Category("Devices")]
+    public void Devices_RemovingAndReaddingDeviceWithNullDescriptorFields_DoesNotThrow()
+    {
+        // InputDeviceDescription.ToJson writes empty string fields and not null values, whereas reporting a device via an incomplete description string will fully omit the fields.
+        string description = @"{
+            ""type"": ""Gamepad"",
+            ""product"": ""TestProduct""
+        }";
+
+        var deviceId = runtime.ReportNewInputDevice(description);
+        InputSystem.Update();
+
+        // "Unplug" device.
+        var removeEvent1 = DeviceRemoveEvent.Create(deviceId);
+        InputSystem.QueueEvent(ref removeEvent1);
+        InputSystem.Update();
+
+        // "Plug" it back in.
+        deviceId = runtime.ReportNewInputDevice(description);
+        InputSystem.Update();
+
+        // Repeat that sequence.
+        var removeEvent2 = DeviceRemoveEvent.Create(deviceId);
+        InputSystem.QueueEvent(ref removeEvent2);
+        InputSystem.Update();
+
+        runtime.ReportNewInputDevice(description);
+        InputSystem.Update();
     }
 
     [Test]

Assets/Tests/InputSystem/InputActionCodeGeneratorActions.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from Assets/Tests/InputSystem/InputActionCodeGeneratorActions.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -10,13 +10,28 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased] - yyyy-mm-dd
 
+### Fixed
+- Fixed touch pointers being released twice causing an index out of bounds error. [ISXB-687](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-687)
+- Fixed `NullReferenceException` from disconnecting and reconnecting a GXDKGamepad.
+- Fixed "AnalyticsResult" errors on consoles [ISXB-1107]
+
+### Added
+- Added the display of the device flag `CanRunInBackground` in device debug view.
+- Added analytics for programmatic `InputAction` setup via `InputActionSetupExtensions` when exiting play-mode.
+
+### Fixed
+- Fixed wrong mapping of Xbox Series S|X and Xbox One wireless controllers "View" button on macOS.[ISXB-385](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-385)
+
+## [1.11.1] - 2024-09-26
+
 ### Fixed
 - Fixed Multiple interactions could breaks on Composite Binding. [ISXB-619](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-619)
 - Fixed memory leak when the OnScreenStick component was destroyed [ISXB-1070](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-1070). Contribution by [LukeUnityDev](https://github.com/LukeUnityDev).
 - Fixed Action Maps contextual menu in Action Editor UI that occasionally displays unrelated items.
 - Fixed "MissingReferenceException" errors when closing an in-game dropdown field [ISXB-1081](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-1081).
 - Fixed potential crash on Mac when using stale references to deleted InputDevice objects [ISXB-606](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-606).
 - Fixed conditional compilation for non-editor analytics on platforms not enabling analytics.
+- Fixed simulated touch input not working with PlayerInput component [ISXB-483](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-483).
 
 ### Changed
 - Renamed editor Resources directories to PackageResources to fix package validation warnings.

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

@@ -306,6 +306,23 @@ public static BindingSyntax AddBinding(this InputAction action, string path, str
             });
         }
 
+        /// <summary>
+        /// Conditionally compiled helper for logging API usage of code-authored actions.
+        /// </summary>
+        /// <param name="api">The associated API function.</param>
+        /// <remarks>
+        /// Be extremely carefully to review for indirect calls and overloads to not register analytics twice.
+        /// Be extremely careful in enabling/disabling tracking before internal calls since those may otherwise
+        /// be incorrectly registered.
+        /// </remarks>
+        #if UNITY_EDITOR
+        private static void RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api api)
+        {
+            UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Register(api);
+        }
+
+        #endif
+
         /// <summary>
         /// Add a binding that references the given <paramref name="control"/> and triggers
         /// the given <paramref cref="action"/>.
@@ -349,6 +366,10 @@ public static BindingSyntax AddBinding(this InputAction action, InputControl con
         /// </remarks>
         public static BindingSyntax AddBinding(this InputAction action, InputBinding binding = default)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
 
@@ -478,6 +499,10 @@ public static BindingSyntax AddBinding(this InputActionMap actionMap, string pat
         /// <seealso cref="InputActionMap.bindings"/>
         public static BindingSyntax AddBinding(this InputActionMap actionMap, InputBinding binding)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddBinding);
+            #endif
+
             if (actionMap == null)
                 throw new ArgumentNullException(nameof(actionMap));
             if (binding.path == null)
@@ -501,6 +526,10 @@ public static BindingSyntax AddBinding(this InputActionMap actionMap, InputBindi
         public static CompositeSyntax AddCompositeBinding(this InputAction action, string composite,
             string interactions = null, string processors = null)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddCompositeBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
             if (string.IsNullOrEmpty(composite))
@@ -580,6 +609,10 @@ private static int AddBindingInternal(InputActionMap map, InputBinding binding,
         /// of <paramref name="action"/>).</exception>
         public static BindingSyntax ChangeBinding(this InputAction action, int index)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ChangeBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
 
@@ -638,6 +671,10 @@ public static BindingSyntax ChangeBinding(this InputAction action, string name)
         /// of <paramref name="actionMap"/>).</exception>
         public static BindingSyntax ChangeBinding(this InputActionMap actionMap, int index)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ChangeBinding);
+            #endif
+
             if (actionMap == null)
                 throw new ArgumentNullException(nameof(actionMap));
             if (index < 0 || index >= actionMap.m_Bindings.LengthSafe())
@@ -836,6 +873,10 @@ public static BindingSyntax ChangeBinding(this InputAction action, InputBinding
         /// <seealso cref="InputBindingComposite"/>
         public static BindingSyntax ChangeCompositeBinding(this InputAction action, string compositeName)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ChangeCompositeBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
             if (string.IsNullOrEmpty(compositeName))
@@ -877,6 +918,10 @@ public static BindingSyntax ChangeCompositeBinding(this InputAction action, stri
         /// </remarks>
         public static void Rename(this InputAction action, string newName)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.Rename);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
             if (string.IsNullOrEmpty(newName))
@@ -919,6 +964,10 @@ public static void Rename(this InputAction action, string newName)
         /// </remarks>
         public static void AddControlScheme(this InputActionAsset asset, InputControlScheme controlScheme)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddControlScheme);
+            #endif
+
             if (asset == null)
                 throw new ArgumentNullException(nameof(asset));
             if (string.IsNullOrEmpty(controlScheme.name))
@@ -987,6 +1036,10 @@ public static ControlSchemeSyntax AddControlScheme(this InputActionAsset asset,
         /// </remarks>
         public static void RemoveControlScheme(this InputActionAsset asset, string name)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.RemoveControlScheme);
+            #endif
+
             if (asset == null)
                 throw new ArgumentNullException(nameof(asset));
             if (string.IsNullOrEmpty(name))
@@ -1007,33 +1060,57 @@ public static void RemoveControlScheme(this InputActionAsset asset, string name)
         /// <returns><paramref name="scheme"/></returns>
         public static InputControlScheme WithBindingGroup(this InputControlScheme scheme, string bindingGroup)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithBindingGroup);
+            #endif
+
             return new ControlSchemeSyntax(scheme).WithBindingGroup(bindingGroup).Done();
         }
 
         public static InputControlScheme WithDevice(this InputControlScheme scheme, string controlPath, bool required)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithDevice);
+            #endif
+
             if (required)
                 return new ControlSchemeSyntax(scheme).WithRequiredDevice(controlPath).Done();
             return new ControlSchemeSyntax(scheme).WithOptionalDevice(controlPath).Done();
         }
 
         public static InputControlScheme WithRequiredDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithRequiredDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).WithRequiredDevice(controlPath).Done();
         }
 
         public static InputControlScheme WithOptionalDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithOptionalDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).WithOptionalDevice(controlPath).Done();
         }
 
         public static InputControlScheme OrWithRequiredDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeOrWithRequiredDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).OrWithRequiredDevice(controlPath).Done();
         }
 
         public static InputControlScheme OrWithOptionalDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeOrWithOptionalDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).OrWithOptionalDevice(controlPath).Done();
         }