feat: verify and migrate config version in DTCabinetApplier

poi-vrc · Aug 17, 2023 · 464a69d · 464a69d
1 parent d3cb029
commit 464a69d
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 11 deletions.
diff --git a/Packages/com.chocopoi.vrc.dressingtools/Runtime/Cabinet/DTCabinetApplier.cs b/Packages/com.chocopoi.vrc.dressingtools/Runtime/Cabinet/DTCabinetApplier.cs
@@ -41,6 +41,8 @@ public static class MessageCode
             public const string UnableToDeserializeConfig = "appliers.default.msgCode.error.unableToDeserializeConfig";
             public const string ApplyingModuleHasErrors = "appliers.default.msgCode.error.applyingModuleHasErrors";
             public const string ApplyingWearableHasErrors = "appliers.default.msgCode.error.applyingWearableHasErrors";
+            public const string IncompatibleConfigVersion = "appliers.default.msgCode.error.incompatibleConfigVersion";
+            public const string ConfigMigrationFailed = "appliers.default.msgCode.error.configMigrationFailed";
         }
 
         private DTReport _report;
@@ -116,20 +118,9 @@ private void RollbackTransform(Transform lastAvatarParent, Vector3 lastAvatarSca
 
         private bool ApplyWearable(DTWearableConfig config, GameObject wearableGameObject)
         {
-            // TODO: check config version and do migration here
-
-            // TODO: do avatar GUID check?
-
-            // TODO: is this check still necessary now?
             GameObject wearableObj;
             if (DTRuntimeUtils.IsGrandParent(_cabinet.avatarGameObject.transform, wearableGameObject.transform))
             {
-                //// check if it's a prefab
-                //if (PrefabUtility.IsPartOfAnyPrefab(wearable.wearableGameObject))
-                //{
-                //    // unpack completely the prefab
-                //    PrefabUtility.UnpackPrefabInstance(wearable.wearableGameObject, PrefabUnpackMode.Completely, InteractionMode.AutomatedAction);
-                //}
                 wearableObj = wearableGameObject;
             }
             else
@@ -174,6 +165,24 @@ public void Execute()
                 // deserialize the config
                 var config = JsonConvert.DeserializeObject<DTWearableConfig>(wearable.configJson);
 
+                // Migration
+                if (config.configVersion > DTWearableConfig.CurrentConfigVersion)
+                {
+                    _report.LogErrorLocalized(LogLabel, MessageCode.IncompatibleConfigVersion);
+                    break;
+                }
+                else if (config.configVersion < DTWearableConfig.CurrentConfigVersion)
+                {
+                    var result = DTWearableConfigMigrator.Migrate(wearable.configJson, out var migratedJson);
+                    if (!result)
+                    {
+                        _report.LogErrorLocalized(LogLabel, MessageCode.ConfigMigrationFailed);
+                        break;
+                    }
+                    wearable.configJson = migratedJson;
+                    config = JsonConvert.DeserializeObject<DTWearableConfig>(migratedJson);
+                }
+
                 if (config == null)
                 {
                     _report.LogErrorLocalized(LogLabel, MessageCode.UnableToDeserializeConfig);

diff --git a/Packages/com.chocopoi.vrc.dressingtools/Runtime/Wearable/DTWearableConfig.cs b/Packages/com.chocopoi.vrc.dressingtools/Runtime/Wearable/DTWearableConfig.cs
@@ -23,6 +23,16 @@
 
 namespace Chocopoi.DressingTools.Wearable
 {
+    public class DTWearableConfigMigrator
+    {
+        public static bool Migrate(string inputJson, out string outputJson)
+        {
+            // TODO: do migration if necessary
+            outputJson = inputJson;
+            return false;
+        }
+    }
+
     // serialization is handled by newtonsoft json
     public class DTWearableConfig
     {