refactor: rename commonpath to commonDirectory and implement migration logic

Author: Glavo

HMCL/src/main/java/org/jackhuang/hmcl/setting/LauncherSettings.java

@@ -159,7 +159,7 @@ public ObjectProperty<EnumCommonDirectory> commonDirTypeProperty() {
     }
 
     /// The custom common Minecraft directory path.
-    @SerializedName("commonpath")
+    @SerializedName("commonDirectory")
     private final StringProperty commonDirectory = new SimpleStringProperty();
 
     /// Returns the custom common Minecraft directory property.

HMCL/src/main/java/org/jackhuang/hmcl/setting/LegacyConfigMigrator.java

@@ -108,6 +108,7 @@ public static GUID getLegacyProfileId(String profileName) {
                     AccountStorages::new);
             JsonElement legacyAllowAutoAgent = jsonObject.remove("allowAutoAgent");
             JsonElement legacyDisableAutoGameOptions = jsonObject.remove("disableAutoGameOptions");
+            migrateLegacyCommonDirectory(jsonObject);
             migrateLegacyLanguage(jsonObject);
             migrateLegacySelectedVersions(jsonObject);
             @Nullable GameDirectories migratedGameDirectories = extractGameDirectoriesFromConfigJson(jsonObject);
@@ -220,6 +221,20 @@ static void migrateLegacyLanguage(JsonObject json) {
         });
     }
 
+    /// Migrates the legacy `commonpath` field into the current `commonDirectory` field.
+    static void migrateLegacyCommonDirectory(JsonObject json) {
+        Objects.requireNonNull(json);
+
+        JsonElement legacyCommonDirectory = json.remove("commonpath");
+        if (json.has("commonDirectory")
+                || !(legacyCommonDirectory instanceof JsonPrimitive primitive)
+                || !primitive.isString()) {
+            return;
+        }
+
+        json.addProperty("commonDirectory", primitive.getAsString());
+    }
+
     /// Migrates the legacy workspace-wide automatic Java agent permission into game setting presets.
     static void migrateLegacyAllowAutoAgent(
             LauncherSettings launcherSettings,

HMCL/src/test/java/org/jackhuang/hmcl/setting/LauncherSettingsMigrationTest.java

@@ -67,6 +67,26 @@ public void migratesLegacyTraditionalChineseLanguage() {
         assertEquals("zh-Hant", launcherSettings.languageProperty().get().getName());
     }
 
+    /// Tests migrating the legacy common directory field into the current launcher settings field.
+    @Test
+    public void migratesLegacyCommonPathToCommonDirectory() {
+        JsonObject settings = JsonParser.parseString("""
+                {
+                  "commonpath": "/home/user/.minecraft"
+                }
+                """).getAsJsonObject();
+
+        LegacyConfigMigrator.migrateLegacyCommonDirectory(settings);
+        LauncherSettings launcherSettings = Objects.requireNonNull(LauncherSettings.fromJson(settings));
+        JsonObject serialized = JsonParser.parseString(launcherSettings.toJson()).getAsJsonObject();
+
+        assertFalse(settings.has("commonpath"));
+        assertEquals("/home/user/.minecraft", settings.get("commonDirectory").getAsString());
+        assertEquals("/home/user/.minecraft", launcherSettings.commonDirectoryProperty().get());
+        assertFalse(serialized.has("commonpath"));
+        assertEquals("/home/user/.minecraft", serialized.get("commonDirectory").getAsString());
+    }
+
     /// Tests that launcher settings serialization preserves a patch-version schema and unknown fields.
     @Test
     public void preservesPatchSchemaAndUnknownFields() {