Merge pull request #257 from KyoriPowered/fix/gson-ordering

KyoriPowered · Jan 11, 2021 · 9e959f0 · 9e959f0
2 parents b7c62e8 + 5d8c8ac
commit 9e959f0
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 33 deletions.
diff --git a/...e3/src/test/java/net/kyori/adventure/serializer/configurate3/ComponentSerializerTest.java b/...e3/src/test/java/net/kyori/adventure/serializer/configurate3/ComponentSerializerTest.java
@@ -43,7 +43,7 @@ void testSerializeToString() {
       .build()
       .serialize(Component.text("Hello", Style.style(TextDecoration.BOLD)));
 
-    assertEquals("{\"text\":\"Hello\",\"bold\":true}", serialized.getString());
+    assertEquals("{\"bold\":true,\"text\":\"Hello\"}", serialized.getString());
   }
 
   @Test

diff --git a/...e4/src/test/java/net/kyori/adventure/serializer/configurate4/ComponentSerializerTest.java b/...e4/src/test/java/net/kyori/adventure/serializer/configurate4/ComponentSerializerTest.java
@@ -43,7 +43,7 @@ void testSerializeToString() {
       .build()
       .serialize(Component.text("Hello", Style.style(TextDecoration.BOLD)));
 
-    assertEquals("{\"text\":\"Hello\",\"bold\":true}", serialized.getString());
+    assertEquals("{\"bold\":true,\"text\":\"Hello\"}", serialized.getString());
   }
 
   @Test

diff --git a/...-gson/src/main/java/net/kyori/adventure/text/serializer/gson/ComponentSerializerImpl.java b/...-gson/src/main/java/net/kyori/adventure/text/serializer/gson/ComponentSerializerImpl.java
@@ -172,6 +172,25 @@ private static <C extends NBTComponent<C, B>, B extends NBTComponentBuilder<C, B
   @Override
   public JsonElement serialize(final Component src, final Type typeOfSrc, final JsonSerializationContext context) {
     final JsonObject object = new JsonObject();
+
+    if(src.hasStyling()) {
+      final JsonElement style = context.serialize(src.style());
+      if(style.isJsonObject()) {
+        for(final Map.Entry<String, JsonElement> entry : ((JsonObject) style).entrySet()) {
+          object.add(entry.getKey(), entry.getValue());
+        }
+      }
+    }
+
+    final List<Component> children = src.children();
+    if(!children.isEmpty()) {
+      final JsonArray extra = new JsonArray();
+      for(final Component child : children) {
+        extra.add(context.serialize(child));
+      }
+      object.add(EXTRA, extra);
+    }
+
     if(src instanceof TextComponent) {
       object.addProperty(TEXT, ((TextComponent) src).content());
     } else if(src instanceof TranslatableComponent) {
@@ -215,24 +234,6 @@ public JsonElement serialize(final Component src, final Type typeOfSrc, final Js
       throw notSureHowToSerialize(src);
     }
 
-    final List<Component> children = src.children();
-    if(!children.isEmpty()) {
-      final JsonArray extra = new JsonArray();
-      for(final Component child : children) {
-        extra.add(context.serialize(child));
-      }
-      object.add(EXTRA, extra);
-    }
-
-    if(src.hasStyling()) {
-      final JsonElement style = context.serialize(src.style());
-      if(style.isJsonObject()) {
-        for(final Map.Entry<String, JsonElement> entry : ((JsonObject) style).entrySet()) {
-          object.add(entry.getKey(), entry.getValue());
-        }
-      }
-    }
-
     return object;
   }
 

diff --git a/...rializer-gson/src/main/java/net/kyori/adventure/text/serializer/gson/StyleSerializer.java b/...rializer-gson/src/main/java/net/kyori/adventure/text/serializer/gson/StyleSerializer.java
@@ -38,6 +38,8 @@
 import java.io.IOException;
 import java.io.StringReader;
 import java.lang.reflect.Type;
+import java.util.EnumSet;
+import java.util.Set;
 import net.kyori.adventure.key.Key;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.event.ClickEvent;
@@ -49,7 +51,27 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 final class StyleSerializer implements JsonDeserializer<Style>, JsonSerializer<Style> {
-  private static final TextDecoration[] DECORATIONS = TextDecoration.values();
+  @SuppressWarnings("checkstyle:NoWhitespaceAfter")
+  private static final TextDecoration[] DECORATIONS = {
+    // The order here is important -- Minecraft does string comparisons of some
+    // serialized components so we have to make sure our order matches Vanilla
+    TextDecoration.BOLD,
+    TextDecoration.ITALIC,
+    TextDecoration.UNDERLINED,
+    TextDecoration.STRIKETHROUGH,
+    TextDecoration.OBFUSCATED
+  };
+
+  static {
+    // Ensure coverage of decorations
+    final Set<TextDecoration> knownDecorations = EnumSet.allOf(TextDecoration.class);
+    for(final TextDecoration decoration : DECORATIONS) {
+      knownDecorations.remove(decoration);
+    }
+    if(!knownDecorations.isEmpty()) {
+      throw new IllegalStateException("GSON serializer is missing some text decorations: " + knownDecorations);
+    }
+  }
 
   static final String FONT = "font";
   static final String COLOR = "color";
@@ -183,16 +205,6 @@ private Codec.Decoder<Component, String, JsonParseException> decoder(final JsonD
   public JsonElement serialize(final Style src, final Type typeOfSrc, final JsonSerializationContext context) {
     final JsonObject json = new JsonObject();
 
-    final @Nullable Key font = src.font();
-    if(font != null) {
-      json.add(FONT, context.serialize(font));
-    }
-
-    final @Nullable TextColor color = src.color();
-    if(color != null) {
-      json.add(COLOR, context.serialize(color));
-    }
-
     for(int i = 0, length = DECORATIONS.length; i < length; i++) {
       final TextDecoration decoration = DECORATIONS[i];
       final TextDecoration.State state = src.decoration(decoration);
@@ -203,6 +215,11 @@ public JsonElement serialize(final Style src, final Type typeOfSrc, final JsonSe
       }
     }
 
+    final @Nullable TextColor color = src.color();
+    if(color != null) {
+      json.add(COLOR, context.serialize(color));
+    }
+
     final @Nullable String insertion = src.insertion();
     if(insertion != null) {
       json.addProperty(INSERTION, insertion);
@@ -228,6 +245,11 @@ public JsonElement serialize(final Style src, final Type typeOfSrc, final JsonSe
       json.add(HOVER_EVENT, eventJson);
     }
 
+    final @Nullable Key font = src.font();
+    if(font != null) {
+      json.add(FONT, context.serialize(font));
+    }
+
     return json;
   }
 

diff --git a/...n/src/test/java/net/kyori/adventure/text/serializer/gson/GsonComponentSerializerTest.java b/...n/src/test/java/net/kyori/adventure/text/serializer/gson/GsonComponentSerializerTest.java
@@ -67,7 +67,7 @@ public void testPre116Downsamples() {
     final TextColor original = TextColor.color(0xAB2211);
     final NamedTextColor downsampled = NamedTextColor.nearestTo(original);
     final Component test = Component.text("meow", original);
-    assertEquals("{\"text\":\"meow\",\"color\":\"" + name(downsampled) + "\"}", GsonComponentSerializer.colorDownsamplingGson().serializer().toJson(test));
+    assertEquals("{\"color\":\"" + name(downsampled) + "\",\"text\":\"meow\"}", GsonComponentSerializer.colorDownsamplingGson().serializer().toJson(test));
   }
 
   @Test
@@ -76,7 +76,7 @@ public void testPre116DownsamplesInChildren() {
     final NamedTextColor downsampled = NamedTextColor.nearestTo(original);
     final Component test = Component.text(builder -> builder.content("hey").append(Component.text("there", original)));
 
-    assertEquals("{\"text\":\"hey\",\"extra\":[{\"text\":\"there\",\"color\":\"" + name(downsampled) + "\"}]}", GsonComponentSerializer.colorDownsamplingGson().serializer().toJson(test));
+    assertEquals("{\"extra\":[{\"color\":\"" + name(downsampled) + "\",\"text\":\"there\"}],\"text\":\"hey\"}", GsonComponentSerializer.colorDownsamplingGson().serializer().toJson(test));
   }
 
   private static String name(final NamedTextColor color) {