FIX: Fix TrackedPoseDriver serialization migration (ISXB-512, ISXB-521) (#1705)

* Fixed serialization migration in TrackedPoseDriver when prefabs are used

- Removed the no longer necessary m_HasMigratedActions field since it only copies over from the old deprecated fields if the new property has not been initialized.
- This fix still does not fix the issue of nested prefabs where the parent prefab has an override to add a new input binding. The base prefab will already have the InputActionProperty upgraded, so the modified old deprecated field with the additional singleton bindings doesn't get copied over to the new property. There doesn't seem to be a way to reliably detect this situation.

* Fixed flags not being copied in Clone methods and fixed so a Guid is generated for actions in constructor

- When adding a serialized InputAction (or with an InputActionProperty), the ID Guid may not be generated, which could cause noise in prefab overrides. Having the constructor generate an ID initially instead of relying on the id property or property drawer generate one and write to the asset makes it more consistent. This specifically fixes the GameObject > XR > XR Origin (VR) creation shortcut not having IDs set since the Inspector is never visible before making a prefab.

* Fixed changelog after merge of 1.6.2 release

* Fixed changelog to put new stuff in Unreleased section, not 1.6.2

* Added property getter for the fields instead of making the fields internal

- We can potentially make the new properties public and even add setters along with a property for useReference, but this way of keeping them internal will avoid having to bump minor version to fix this bug.

Author: chris-massie

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -10,12 +10,16 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased]
 
-### Fixed
-- Fixed missing prefab errors in InputDeviceTester project (case ISXB-420).
-
 ### Added
 - Preliminary support for visionOS.
 
+### Changed
+- Changed the `InputAction` constructors so it generates an ID for the action and the optional binding parameter. This is intended to improve the serialization of input actions on behaviors when created through API when the property drawer in the Inspector window does not have a chance to generate an ID.
+
+### Fixed
+- Fixed missing prefab errors in InputDeviceTester project ([case ISXB-420](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-420)).
+- Fixed serialization migration in the Tracked Pose Driver component causing bindings to clear when prefabs are used in some cases ([case ISXB-512](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-512), [case ISXB-521](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-521)).
+- Fixed the `Clone` methods of `InputAction` and `InputActionMap` so it copies the Initial State Check flag (`InputAction.wantsInitialStateCheck`) of input actions.
 
 ## [1.6.3] - 2023-07-11
 

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

@@ -669,6 +669,7 @@ public bool wantsInitialStateCheck
         /// </remarks>
         public InputAction()
         {
+            m_Id = Guid.NewGuid().ToString();
         }
 
         /// <summary>
@@ -724,8 +725,9 @@ public InputAction(string name = null, InputActionType type = default, string bi
                         path = binding,
                         interactions = interactions,
                         processors = processors,
-                        action = m_Name
-                    }
+                        action = m_Name,
+                        id = Guid.NewGuid(),
+                    },
                 };
                 m_BindingsStartIndex = 0;
                 m_BindingsCount = 1;
@@ -737,6 +739,7 @@ public InputAction(string name = null, InputActionType type = default, string bi
             }
 
             m_ExpectedControlType = expectedControlType;
+            m_Id = Guid.NewGuid().ToString();
         }
 
         /// <summary>
@@ -913,6 +916,7 @@ public InputAction Clone()
                 m_ExpectedControlType = m_ExpectedControlType,
                 m_Interactions = m_Interactions,
                 m_Processors = m_Processors,
+                m_Flags = m_Flags,
             };
             return clone;
         }

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

@@ -596,6 +596,7 @@ public InputActionMap Clone()
                         m_Interactions = original.m_Interactions,
                         m_Processors = original.m_Processors,
                         m_ExpectedControlType = original.m_ExpectedControlType,
+                        m_Flags = original.m_Flags,
                     };
                 }
                 clone.m_Actions = actions;

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

@@ -29,9 +29,9 @@ namespace UnityEngine.InputSystem
     public struct InputActionProperty : IEquatable<InputActionProperty>, IEquatable<InputAction>, IEquatable<InputActionReference>
     {
         /// <summary>
-        /// The action held on to by the property.
+        /// The effective action held on to by the property.
         /// </summary>
-        /// <value>The action object contained in the property.</value>
+        /// <value>The effective action object contained in the property.</value>
         /// <remarks>
         /// This property will return <c>null</c> if the property is using a <see cref="reference"/> and
         /// the referenced action cannot be found. Also, it will be <c>null</c> if the property
@@ -41,12 +41,24 @@ public struct InputActionProperty : IEquatable<InputActionProperty>, IEquatable<
         public InputAction action => m_UseReference ? m_Reference != null ? m_Reference.action : null : m_Action;
 
         /// <summary>
-        /// If the property contains a reference to the action, this property returns
+        /// If the property is set to use a reference to the action, this property returns
         /// the reference. Otherwise it returns <c>null</c>.
         /// </summary>
         /// <value>Reference to external input action, if defined.</value>
         public InputActionReference reference => m_UseReference ? m_Reference : null;
 
+        /// <summary>
+        /// The serialized loose action created in code serialized with this property.
+        /// </summary>
+        /// <value>The serialized action field.</value>
+        internal InputAction serializedAction => m_Action;
+
+        /// <summary>
+        /// The serialized reference to an external action.
+        /// </summary>
+        /// <value>The serialized reference field.</value>
+        internal InputActionReference serializedReference => m_Reference;
+
         /// <summary>
         /// Initialize the property to contain the given action.
         /// </summary>

Packages/com.unity.inputsystem/InputSystem/Editor/PropertyDrawers/InputActionDrawer.cs

@@ -1,4 +1,5 @@
 #if UNITY_EDITOR
+using System;
 using UnityEditor;
 using UnityEditor.IMGUI.Controls;
 
@@ -52,7 +53,7 @@ protected override void ResetProperty(SerializedProperty property)
         {
             if (property == null) return;
 
-            property.SetStringValue(nameof(InputAction.m_Id), "");
+            property.SetStringValue(nameof(InputAction.m_Id), Guid.NewGuid().ToString());
             property.SetStringValue(nameof(InputAction.m_Name), "Input Action");
             property.FindPropertyRelative(nameof(InputAction.m_SingletonActionBindings))?.ClearArray();
             property.serializedObject?.ApplyModifiedPropertiesWithoutUndo();

Packages/com.unity.inputsystem/InputSystem/Editor/PropertyDrawers/InputActionMapDrawer.cs

@@ -1,4 +1,5 @@
 #if UNITY_EDITOR
+using System;
 using UnityEditor;
 using UnityEditor.IMGUI.Controls;
 
@@ -52,7 +53,7 @@ protected override void ResetProperty(SerializedProperty property)
         {
             if (property == null) return;
 
-            property.SetStringValue(nameof(InputActionMap.m_Id), "");
+            property.SetStringValue(nameof(InputActionMap.m_Id), Guid.NewGuid().ToString());
             property.SetStringValue(nameof(InputActionMap.m_Name), "Input Action Map");
             property.FindPropertyRelative(nameof(InputActionMap.m_Actions))?.ClearArray();
             property.FindPropertyRelative(nameof(InputActionMap.m_Bindings))?.ClearArray();

Packages/com.unity.inputsystem/InputSystem/Plugins/XR/TrackedPoseDriver.cs

@@ -397,8 +397,6 @@ void OnTrackingStateCanceled(InputAction.CallbackContext context)
         /// </summary>
         protected void Reset()
         {
-            m_HasMigratedActions = true;
-
             m_PositionInput = new InputActionProperty(new InputAction("Position", expectedControlType: "Vector3"));
             m_RotationInput = new InputActionProperty(new InputAction("Rotation", expectedControlType: "Quaternion"));
             m_TrackingStateInput = new InputActionProperty(new InputAction("Tracking State", expectedControlType: "Integer"));
@@ -636,12 +634,6 @@ public InputAction rotationAction
 #pragma warning restore 0649
         // ReSharper restore UnassignedField.Local
 
-        /// <summary>
-        /// Stores whether the fields of type <see cref="InputAction"/> have been migrated to fields of type <see cref="InputActionProperty"/>.
-        /// </summary>
-        [SerializeField, HideInInspector]
-        bool m_HasMigratedActions;
-
         /// <inheritdoc />
         void ISerializationCallbackReceiver.OnBeforeSerialize()
         {
@@ -650,13 +642,16 @@ void ISerializationCallbackReceiver.OnBeforeSerialize()
         /// <inheritdoc />
         void ISerializationCallbackReceiver.OnAfterDeserialize()
         {
-            if (m_HasMigratedActions)
-                return;
+#pragma warning disable 0612 // Type or member is obsolete -- Deprecated fields are migrated to new properties.
+#pragma warning disable UNT0029 // Pattern matching with null on Unity objects -- Using true null is intentional, not operator== evaluation.
+            // We're checking for true null here since we don't want to migrate if the new field is already being used, even if the reference is missing.
+            // Migrate the old fields to the new properties added in Input System 1.1.0-pre.6.
+            if (m_PositionInput.serializedReference is null && m_PositionInput.serializedAction is null && !(m_PositionAction is null))
+                m_PositionInput = new InputActionProperty(m_PositionAction);
 
-#pragma warning disable 0612
-            m_PositionInput = new InputActionProperty(m_PositionAction);
-            m_RotationInput = new InputActionProperty(m_RotationAction);
-            m_HasMigratedActions = true;
+            if (m_RotationInput.serializedReference is null && m_RotationInput.serializedAction is null && !(m_RotationAction is null))
+                m_RotationInput = new InputActionProperty(m_RotationAction);
+#pragma warning restore UNT0029
 #pragma warning restore 0612
         }