feat: MA Parameters auto-rename now uses stable names (#1529)

Closes: #1527, #1430

CHANGELOG-PRERELEASE-jp.md

@@ -15,6 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#1528] `Merge Animator` が `アバターのWrite Defaults設定に合わせる` 設定を無視し、常に合わせてしまう問題を修正
 
 ### Changed
+- [#1529] `MA Parameters` の自動リネームは、オブジェクトのパスに基づいて新しい名前を割り当てるように変更されました。これにより、
+  `MA Sync Parameter Sequence` との互換性が向上します。
+  - `MA Sync Parameter Sequence` を使用している場合は、このバージョンに更新した後、SyncedParamsアセットを空にして、
+    すべてのプラットフォームを再アップロードすることをお勧めします。
 
 ### Removed
 

CHANGELOG-PRERELEASE.md

@@ -15,6 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#1528] `Merge Animator` ignored the `Match Avatar Write Defaults` setting and always matched
 
 ### Changed
+- [#1529] `MA Parameters` auto-rename now assigns new names based on the path of the object. This should improve
+  compatibility with `MA Sync Parameter Sequence`
+  - If you are using `MA Sync Parameter Sequence`, it's a good idea to empty your SyncedParams asset and reupload all
+    platforms after updating to this version.
 
 ### Removed
 

CHANGELOG-jp.md

@@ -27,6 +27,10 @@ Modular Avatarの主な変更点をこのファイルで記録しています。
 - [#1513] iOSビルドでエクスプレッションメニューアイコンの圧縮処理が壊れる問題を修正
 
 ### Changed
+- [#1529] `MA Parameters` の自動リネームは、オブジェクトのパスに基づいて新しい名前を割り当てるように変更されました。これにより、
+  `MA Sync Parameter Sequence` との互換性が向上します。
+  - `MA Sync Parameter Sequence` を使用している場合は、このバージョンに更新した後、SyncedParamsアセットを空にして、
+    すべてのプラットフォームを再アップロードすることをお勧めします。
 - [#1514] `Merge Blend Tree` は `Merge Motion (Blend Tree)` に改名され、アニメーションクリップにも対応するようになりました
 - [#1476] ModularAvatarMergeAnimator と ModularAvatarMergeParameter を新しい NDMF API (`IVirtualizeMotion` と `IVirtualizeAnimatorController`) を使用するように変更
 - [#1483] Merge Animator の 「アバターの Write Defaults 設定に合わせる」設定では、Additiveなレイヤー、および単一Stateかつ遷移のないレイヤー

CHANGELOG.md

@@ -31,6 +31,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#1513] Expression menu icon compression broke on iOS builds
 
 ### Changed
+- [#1529] `MA Parameters` auto-rename now assigns new names based on the path of the object. This should improve
+  compatibility with `MA Sync Parameter Sequence`
+  - If you are using `MA Sync Parameter Sequence`, it's a good idea to empty your SyncedParams asset and reupload all
+    platforms after updating to this version.
 - [#1514] `Merge Blend Tree` is now `Merge Motion (Blend Tree)` and supports merging animation clips as well as blend trees
 - [#1476] Switch ModularAvatarMergeAnimator and ModularAvatarMergeParameter to use new NDMF APIs (`IVirtualizeMotion` and `IVirtualizeAnimatorController`)
 - [#1483] The Merge Animator "Match Avatar Write Defaults" option will no longer adjust write defaults on states in

Editor/RenameParametersHook.cs

@@ -6,6 +6,8 @@ using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
+using System.Security.Cryptography;
+using System.Text;
 using nadena.dev.modular_avatar.editor.ErrorReporting;
 using nadena.dev.ndmf;
 using nadena.dev.ndmf.animator;
@@ -30,8 +32,8 @@ namespace nadena.dev.modular_avatar.core.editor
             return ctx.GetState<ParameterRenameMappings>();
         }
 
-        public Dictionary<(ModularAvatarParameters, ParameterNamespace, string), string> Remappings =
-            new Dictionary<(ModularAvatarParameters, ParameterNamespace, string), string>();
+        private readonly HashSet<string> usedNames = new();
+        public Dictionary<(ModularAvatarParameters, ParameterNamespace, string), string> Remappings = new();
 
         private int internalParamIndex;
 
@@ -41,7 +43,28 @@ namespace nadena.dev.modular_avatar.core.editor
 
             if (Remappings.TryGetValue(tuple, out var mapping)) return mapping;
 
-            mapping = s + "$$Internal_" + internalParamIndex++;
+            var path = RuntimeUtil.AvatarRootPath(p.gameObject)!;
+            string pathHash;
+            using (var sha = SHA256.Create())
+            {
+                var hashBytes = sha.ComputeHash(Encoding.UTF8.GetBytes(path));
+
+                StringBuilder sb = new();
+                for (var i = 0; i < 6; i++)
+                {
+                    sb.AppendFormat("{0:x2}", hashBytes[i]);
+                }
+
+                pathHash = sb.ToString();
+            }
+
+            mapping = s + "$" + pathHash;
+
+            for (var i = 0; !usedNames.Add(mapping); i++)
+            {
+                mapping = s + "$" + mapping + "." + i;
+            }
+            
             Remappings[tuple] = mapping;
             
             return mapping;

UnitTests~/RenameParametersTests/RenameParametersTests.cs

@@ -63,8 +63,8 @@ namespace modular_avatar_tests.RenameParametersTests
             AvatarProcessor.ProcessAvatar(prefab);
 
             var menu = prefab.GetComponent<VRCAvatarDescriptor>().expressionsMenu;
-            Assert.AreEqual("test$$Internal_0", menu.controls[0].parameter.name);
-            Assert.AreEqual("test$$Internal_0", menu.controls[1].subMenu.controls[0].parameter.name);
+            Assert.AreEqual("test$33bf6fbd7cd8", menu.controls[0].parameter.name);
+            Assert.AreEqual("test$33bf6fbd7cd8", menu.controls[1].subMenu.controls[0].parameter.name);
         }
 
         [Test]
@@ -107,7 +107,7 @@ namespace modular_avatar_tests.RenameParametersTests
                 .Select(e => e.TheError)
                 .Cast<SimpleError>()
                 .First(e => e.TitleKey == "error.rename_params.default_value_conflict");
-            Assert.AreEqual("a$$Internal_1", valueConflict.DetailsSubst[0]);
+            Assert.AreEqual("a$014659ab9d98", valueConflict.DetailsSubst[0]);
             Assert.AreEqual("0", valueConflict.DetailsSubst[1]);
             Assert.AreEqual("1", valueConflict.DetailsSubst[2]);
             
@@ -119,7 +119,7 @@ namespace modular_avatar_tests.RenameParametersTests
                 .Cast<SimpleError>()
                 .First(e => e.TitleKey == "error.rename_params.type_conflict");
             
-            Assert.AreEqual("a$$Internal_2", typeConflict.DetailsSubst[0]);
+            Assert.AreEqual("a$88c01afc056a", typeConflict.DetailsSubst[0]);
             Assert.AreEqual("Int", typeConflict.DetailsSubst[1]);
             Assert.AreEqual("Float", typeConflict.DetailsSubst[2]);