Use built-in ResourceLocation type (#811)

* Use built-in ResourceLocation type

* Use kyori Key instead of built-in type

* Fix missing keys

* Fix packets with incorrect resource location types

* Fix more packets with invalid resource locations

* Update jigsaw packet to use ResourceLocation

* Fix test compilation

* Fully use Key for ResourceProperties

* Fix all Key.key() warnings

* Fix HolderSet revert

* Address review

Author: AlexProgrammerDE

example/src/main/java/org/geysermc/mcprotocollib/protocol/example/MinecraftProtocolTest.java

@@ -5,6 +5,7 @@
 import com.github.steveice10.mc.auth.service.AuthenticationService;
 import com.github.steveice10.mc.auth.service.MojangAuthenticationService;
 import com.github.steveice10.mc.auth.service.SessionService;
+import net.kyori.adventure.key.Key;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.format.NamedTextColor;
 import net.kyori.adventure.text.format.TextDecoration;
@@ -76,7 +77,7 @@ public static void main(String[] args) {
                     session.send(new ClientboundLoginPacket(
                             0,
                             false,
-                            new String[]{"minecraft:world"},
+                            new Key[]{Key.key("minecraft:world")},
                             0,
                             16,
                             16,
@@ -85,7 +86,7 @@ public static void main(String[] args) {
                             false,
                             new PlayerSpawnInfo(
                                     0,
-                                    "minecraft:world",
+                                    Key.key("minecraft:world"),
                                     100,
                                     GameMode.SURVIVAL,
                                     GameMode.SURVIVAL,

protocol/src/main/java/org/geysermc/mcprotocollib/network/codec/BasePacketCodecHelper.java

@@ -140,6 +140,7 @@ public long readVarLong(ByteBuf buf) {
         return value | ((b & 0x7FL) << (size * 7));
     }
 
+    @Override
     public String readString(ByteBuf buf) {
         return this.readString(buf, Short.MAX_VALUE);
     }

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/ServerListener.java

@@ -4,6 +4,7 @@
 import com.github.steveice10.mc.auth.exception.request.RequestException;
 import com.github.steveice10.mc.auth.service.SessionService;
 import lombok.RequiredArgsConstructor;
+import net.kyori.adventure.key.Key;
 import net.kyori.adventure.text.Component;
 import org.cloudburstmc.nbt.NbtMap;
 import org.cloudburstmc.nbt.NbtType;
@@ -136,12 +137,15 @@ public void packetReceived(Session session, Packet packet) {
 
                 // Credit ViaVersion: https://github.com/ViaVersion/ViaVersion/blob/dev/common/src/main/java/com/viaversion/viaversion/protocols/protocol1_20_5to1_20_3/rewriter/EntityPacketRewriter1_20_5.java
                 for (Map.Entry<String, Object> entry : networkCodec.entrySet()) {
+                    @SuppressWarnings("PatternValidation")
                     NbtMap entryTag = (NbtMap) entry.getValue();
-                    String typeTag = entryTag.getString("type");
+                    @SuppressWarnings("PatternValidation")
+                    Key typeTag = Key.key(entryTag.getString("type"));
                     List<NbtMap> valueTag = entryTag.getList("value", NbtType.COMPOUND);
                     List<RegistryEntry> entries = new ArrayList<>();
                     for (NbtMap compoundTag : valueTag) {
-                        String nameTag = compoundTag.getString("name");
+                        @SuppressWarnings("PatternValidation")
+                        Key nameTag = Key.key(compoundTag.getString("name"));
                         int id = compoundTag.getInt("id");
                         entries.add(id, new RegistryEntry(nameTag, compoundTag.getCompound("element")));
                     }

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/codec/MinecraftCodecHelper.java

@@ -7,6 +7,7 @@
 import io.netty.buffer.ByteBufOutputStream;
 import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
 import lombok.RequiredArgsConstructor;
+import net.kyori.adventure.key.Key;
 import net.kyori.adventure.text.Component;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
@@ -20,7 +21,6 @@
 import org.geysermc.mcprotocollib.network.codec.BasePacketCodecHelper;
 import org.geysermc.mcprotocollib.protocol.data.DefaultComponentSerializer;
 import org.geysermc.mcprotocollib.protocol.data.game.Holder;
-import org.geysermc.mcprotocollib.protocol.data.game.Identifier;
 import org.geysermc.mcprotocollib.protocol.data.game.chat.numbers.BlankFormat;
 import org.geysermc.mcprotocollib.protocol.data.game.chat.numbers.FixedFormat;
 import org.geysermc.mcprotocollib.protocol.data.game.chat.numbers.NumberFormat;
@@ -161,12 +161,13 @@ public <T> void writeHolder(ByteBuf buf, Holder<T> holder, BiConsumer<ByteBuf, T
         }
     }
 
-    public String readResourceLocation(ByteBuf buf) {
-        return Identifier.formalize(this.readString(buf));
+    @SuppressWarnings("PatternValidation")
+    public Key readResourceLocation(ByteBuf buf) {
+        return Key.key(this.readString(buf));
     }
 
-    public void writeResourceLocation(ByteBuf buf, String location) {
-        this.writeString(buf, location);
+    public void writeResourceLocation(ByteBuf buf, Key location) {
+        this.writeString(buf, location.asString());
     }
 
     public UUID readUUID(ByteBuf buf) {
@@ -563,19 +564,19 @@ public void writeMetadataType(ByteBuf buf, MetadataType<?> type) {
     }
 
     public GlobalPos readGlobalPos(ByteBuf buf) {
-        String dimension = Identifier.formalize(this.readString(buf));
+        Key dimension = readResourceLocation(buf);
         Vector3i pos = this.readPosition(buf);
         return new GlobalPos(dimension, pos);
     }
 
     public void writeGlobalPos(ByteBuf buf, GlobalPos pos) {
-        this.writeString(buf, pos.getDimension());
+        this.writeResourceLocation(buf, pos.getDimension());
         this.writePosition(buf, pos.getPosition());
     }
 
     public PlayerSpawnInfo readPlayerSpawnInfo(ByteBuf buf) {
         int dimension = this.readVarInt(buf);
-        String worldName = this.readString(buf);
+        Key worldName = this.readResourceLocation(buf);
         long hashedSeed = buf.readLong();
         GameMode gameMode = GameMode.byId(buf.readByte());
         GameMode previousGamemode = GameMode.byNullableId(buf.readByte());
@@ -588,7 +589,7 @@ public PlayerSpawnInfo readPlayerSpawnInfo(ByteBuf buf) {
 
     public void writePlayerSpawnInfo(ByteBuf buf, PlayerSpawnInfo info) {
         this.writeVarInt(buf, info.getDimension());
-        this.writeString(buf, info.getWorldName());
+        this.writeResourceLocation(buf, info.getWorldName());
         buf.writeLong(info.getHashedSeed());
         buf.writeByte(info.getGameMode().ordinal());
         buf.writeByte(GameMode.toNullableId(info.getPreviousGamemode()));

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/data/game/Identifier.java

@@ -2,12 +2,13 @@
 
 import lombok.AllArgsConstructor;
 import lombok.Data;
+import net.kyori.adventure.key.Key;
 import org.cloudburstmc.nbt.NbtMap;
 import org.jetbrains.annotations.Nullable;
 
 @Data
 @AllArgsConstructor
 public class RegistryEntry {
-    private final String id;
+    private final Key id;
     private final @Nullable NbtMap data;
 }

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/data/game/RegistryEntry.java

@@ -1,6 +1,7 @@
 package org.geysermc.mcprotocollib.protocol.data.game.chat;
 
-import org.geysermc.mcprotocollib.protocol.data.game.Identifier;
+import net.kyori.adventure.key.Key;
+import org.intellij.lang.annotations.Subst;
 
 import java.util.HashMap;
 import java.util.Locale;
@@ -15,19 +16,20 @@ public enum BuiltinChatType {
     TEAM_MSG_COMMAND_OUTGOING,
     EMOTE_COMMAND;
 
-    private final String resourceLocation;
+    private final Key resourceLocation;
 
     BuiltinChatType() {
-        this.resourceLocation = Identifier.formalize(name().toLowerCase(Locale.ROOT));
+        @Subst("empty") String lowerCase = name().toLowerCase(Locale.ROOT);
+        this.resourceLocation = Key.key(lowerCase);
     }
 
-    public String getResourceLocation() {
+    public Key getResourceLocation() {
         return resourceLocation;
     }
 
-    private static final Map<String, BuiltinChatType> VALUES = new HashMap<>();
+    private static final Map<Key, BuiltinChatType> VALUES = new HashMap<>();
 
-    public static BuiltinChatType from(String resourceLocation) {
+    public static BuiltinChatType from(Key resourceLocation) {
         return VALUES.get(resourceLocation);
     }
 

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/data/game/chat/BuiltinChatType.java

@@ -3,6 +3,7 @@
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NonNull;
+import net.kyori.adventure.key.Key;
 import org.geysermc.mcprotocollib.protocol.data.game.command.properties.CommandProperties;
 
 import java.util.OptionalInt;
@@ -49,5 +50,5 @@ public class CommandNode {
      * Suggestions type, if present.
      * See {@link SuggestionType} for vanilla defaults.
      */
-    private final String suggestionType;
+    private final Key suggestionType;
 }

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/data/game/command/CommandNode.java

@@ -1,7 +1,8 @@
 package org.geysermc.mcprotocollib.protocol.data.game.command;
 
+import net.kyori.adventure.key.Key;
 import org.checkerframework.checker.nullness.qual.NonNull;
-import org.geysermc.mcprotocollib.protocol.data.game.Identifier;
+import org.intellij.lang.annotations.Subst;
 
 import java.util.HashMap;
 import java.util.Locale;
@@ -13,20 +14,21 @@ public enum SuggestionType {
     AVAILABLE_SOUNDS,
     SUMMONABLE_ENTITIES;
 
-    private final String resourceLocation;
+    private final Key resourceLocation;
 
     SuggestionType() {
-        this.resourceLocation = Identifier.formalize(name().toLowerCase(Locale.ROOT));
+        @Subst("empty") String lowerCase = name().toLowerCase(Locale.ROOT);
+        this.resourceLocation = Key.key(lowerCase);
     }
 
-    public String getResourceLocation() {
+    public Key getResourceLocation() {
         return resourceLocation;
     }
 
-    private static final Map<String, SuggestionType> VALUES = new HashMap<>();
+    private static final Map<Key, SuggestionType> VALUES = new HashMap<>();
 
     @NonNull
-    public static SuggestionType from(String resourceLocation) {
+    public static SuggestionType from(Key resourceLocation) {
         // Vanilla behavior as of 1.19.3
         // 1.16.5 still has AVAILABLE_BIOMES and vanilla doesn't care
         return VALUES.getOrDefault(resourceLocation, ASK_SERVER);

protocol/src/main/java/org/geysermc/mcprotocollib/protocol/data/game/command/SuggestionType.java

@@ -1,13 +1,13 @@
 package org.geysermc.mcprotocollib.protocol.data.game.command.properties;
 
 import lombok.Data;
-import org.geysermc.mcprotocollib.protocol.data.game.Identifier;
+import net.kyori.adventure.key.Key;
 
 @Data
 public class ResourceProperties implements CommandProperties {
-    private final String registryKey;
+    private final Key registryKey;
 
-    public ResourceProperties(String registryKey) {
-        this.registryKey = Identifier.formalize(registryKey);
+    public ResourceProperties(Key registryKey) {
+        this.registryKey = registryKey;
     }
 }