Staticify all serialization helpers (#878)

* Staticify all serialization helpers

First of all, why am I changing the whole API so that MinecraftCodecHelper is now static instead of an instance? The reason is that these methods are better used statically. Right now the biggest issue with MCPL I see is its reliance on "serialization instances" that are being passed around everywhere. Why were those even made in the first place? Because there was a belief a few years ago that MCPL could somehow ever support multiple versions of Minecraft. The idea is good however it is unrealistic. Packets change heavily between versions and rarely do serialization types. Serialization instances were made with the idea somehow you could implement multiple codechelpers for each version and "downgrade" packets and bind them together using UnsupportedOperationException. In my opinion this is not a route MCPL should be taking. Instead my plan is to add a module that allows ViaVersion to be used with MCPL to allow the desired multi-version support.
Without having to pass serialization instances around, the API becomes a lot simpler. Especially with the removal of the parent class of ItemCodecHelper. (Which previously extended MinecraftCodecHelper for some reason)
Now it is clear what you're calling and there are way more lambda/inlining opportunities around the codebase.
This makes the API more similar to the approach Velocity and ViaVersion are also taking with their static serialization methods.
Classes renamed:
- MinecraftCodecHelper -> MinecraftTypes
- ItemCodecHelper -> ItemTypes
Classes removed:
- PacketCodecHelper interface (not needed anymore)
- BasePacketCodec (merged into MinecraftTypes)

Why was BasePacketCodec not renamed to BaseTypes? Because this library is slowly going to more and more specialize on only minecraft, not needing to retain a special implementation for developers who use it just for PacketLib.

* Update comments

Author: AlexProgrammerDE

example/src/main/java/org/geysermc/mcprotocollib/network/example/PingPacket.java

@@ -1,14 +1,14 @@
 package org.geysermc.mcprotocollib.network.example;
 
 import io.netty.buffer.ByteBuf;
-import org.geysermc.mcprotocollib.network.codec.PacketCodecHelper;
 import org.geysermc.mcprotocollib.network.packet.Packet;
+import org.geysermc.mcprotocollib.protocol.codec.MinecraftTypes;
 
 public class PingPacket implements Packet {
     private final String id;
 
-    public PingPacket(ByteBuf buf, PacketCodecHelper codecHelper) {
-        this.id = codecHelper.readString(buf);
+    public PingPacket(ByteBuf buf) {
+        this.id = MinecraftTypes.readString(buf);
     }
 
     public PingPacket(String id) {

example/src/main/java/org/geysermc/mcprotocollib/network/example/TestProtocol.java

@@ -3,8 +3,6 @@
 import io.netty.buffer.ByteBuf;
 import org.geysermc.mcprotocollib.network.Server;
 import org.geysermc.mcprotocollib.network.Session;
-import org.geysermc.mcprotocollib.network.codec.BasePacketCodecHelper;
-import org.geysermc.mcprotocollib.network.codec.PacketCodecHelper;
 import org.geysermc.mcprotocollib.network.codec.PacketDefinition;
 import org.geysermc.mcprotocollib.network.codec.PacketSerializer;
 import org.geysermc.mcprotocollib.network.crypt.AESEncryption;
@@ -13,6 +11,7 @@
 import org.geysermc.mcprotocollib.network.packet.PacketHeader;
 import org.geysermc.mcprotocollib.network.packet.PacketProtocol;
 import org.geysermc.mcprotocollib.network.packet.PacketRegistry;
+import org.geysermc.mcprotocollib.protocol.codec.MinecraftTypes;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -33,20 +32,16 @@ public TestProtocol(SecretKey key) {
         this.setSecretKey(key);
     }
 
-    public PacketCodecHelper createHelper() {
-        return new BasePacketCodecHelper();
-    }
-
     public void setSecretKey(SecretKey key) {
         registry.register(0, PingPacket.class, new PacketSerializer<>() {
             @Override
-            public void serialize(ByteBuf buf, PacketCodecHelper helper, PingPacket packet) {
-                helper.writeString(buf, packet.getPingId());
+            public void serialize(ByteBuf buf, PingPacket packet) {
+                MinecraftTypes.writeString(buf, packet.getPingId());
             }
 
             @Override
-            public PingPacket deserialize(ByteBuf buf, PacketCodecHelper helper, PacketDefinition<PingPacket, PacketCodecHelper> definition) {
-                return new PingPacket(buf, helper);
+            public PingPacket deserialize(ByteBuf buf, PacketDefinition<PingPacket> definition) {
+                return new PingPacket(buf);
             }
         });
 

protocol/src/main/java/org/geysermc/mcprotocollib/network/Session.java

@@ -4,7 +4,6 @@
 import net.kyori.adventure.text.Component;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
-import org.geysermc.mcprotocollib.network.codec.PacketCodecHelper;
 import org.geysermc.mcprotocollib.network.compression.CompressionConfig;
 import org.geysermc.mcprotocollib.network.crypt.EncryptionConfig;
 import org.geysermc.mcprotocollib.network.event.session.SessionEvent;
@@ -45,13 +44,6 @@ public interface Session {
      */
     PacketProtocol getPacketProtocol();
 
-    /**
-     * Gets the session's {@link PacketCodecHelper}.
-     *
-     * @return The session's packet codec helper.
-     */
-    PacketCodecHelper getCodecHelper();
-
     /**
      * Gets this session's set flags. If this session belongs to a server, the server's
      * flags will be included in the results.

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

@@ -10,12 +10,12 @@
  *
  * @param <T> the packet type
  */
-public class PacketDefinition<T extends Packet, H extends PacketCodecHelper> {
+public class PacketDefinition<T extends Packet> {
     private final int id;
     private final Class<T> packetClass;
-    private final PacketSerializer<T, H> serializer;
+    private final PacketSerializer<T> serializer;
 
-    public PacketDefinition(final int id, final Class<T> packetClass, final PacketSerializer<T, H> serializer) {
+    public PacketDefinition(final int id, final Class<T> packetClass, final PacketSerializer<T> serializer) {
         this.id = id;
         this.packetClass = packetClass;
         this.serializer = serializer;
@@ -44,11 +44,11 @@ public Class<T> getPacketClass() {
      *
      * @return the packet serializer of the packet
      */
-    public PacketSerializer<T, H> getSerializer() {
+    public PacketSerializer<T> getSerializer() {
         return this.serializer;
     }
 
-    public T newInstance(ByteBuf buf, H helper) {
-        return this.serializer.deserialize(buf, helper, this);
+    public T newInstance(ByteBuf buf) {
+        return this.serializer.deserialize(buf, this);
     }
 }

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

@@ -3,9 +3,9 @@
 import io.netty.buffer.ByteBuf;
 import org.geysermc.mcprotocollib.network.packet.Packet;
 
-public interface PacketSerializer<T extends Packet, H extends PacketCodecHelper> {
+public interface PacketSerializer<T extends Packet> {
 
-    void serialize(ByteBuf buf, H helper, T packet);
+    void serialize(ByteBuf buf, T packet);
 
-    T deserialize(ByteBuf buf, H helper, PacketDefinition<T, H> definition);
+    T deserialize(ByteBuf buf, PacketDefinition<T> definition);
 }

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

@@ -37,8 +37,8 @@ protected void addHandlers(S session, Channel ch) {
         pipeline.addLast("write-timeout", new WriteTimeoutHandler(session.getFlag(BuiltinFlags.WRITE_TIMEOUT, 0)));
 
         pipeline.addLast("encryption", new PacketEncryptorCodec());
-        pipeline.addLast("sizer", new PacketSizerCodec(protocol.getPacketHeader(), session.getCodecHelper()));
-        pipeline.addLast("compression", new PacketCompressionCodec(session.getCodecHelper()));
+        pipeline.addLast("sizer", new PacketSizerCodec(protocol.getPacketHeader()));
+        pipeline.addLast("compression", new PacketCompressionCodec());
 
         pipeline.addLast("flow-control", new AutoReadFlowControlHandler());
         pipeline.addLast("codec", new PacketCodec(session, client));

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

@@ -6,7 +6,6 @@
 import io.netty.handler.codec.EncoderException;
 import io.netty.handler.codec.MessageToMessageCodec;
 import org.geysermc.mcprotocollib.network.Session;
-import org.geysermc.mcprotocollib.network.codec.PacketCodecHelper;
 import org.geysermc.mcprotocollib.network.codec.PacketDefinition;
 import org.geysermc.mcprotocollib.network.event.session.PacketErrorEvent;
 import org.geysermc.mcprotocollib.network.packet.Packet;
@@ -40,14 +39,13 @@ public void encode(ChannelHandlerContext ctx, Packet packet, List<Object> out) {
 
         PacketProtocol packetProtocol = this.session.getPacketProtocol();
         PacketRegistry packetRegistry = packetProtocol.getOutboundPacketRegistry();
-        PacketCodecHelper codecHelper = this.session.getCodecHelper();
         try {
             int packetId = this.client ? packetRegistry.getServerboundId(packet) : packetRegistry.getClientboundId(packet);
             PacketDefinition definition = this.client ? packetRegistry.getServerboundDefinition(packetId) : packetRegistry.getClientboundDefinition(packetId);
 
             ByteBuf buf = ctx.alloc().buffer();
-            packetProtocol.getPacketHeader().writePacketId(buf, codecHelper, packetId);
-            definition.getSerializer().serialize(buf, codecHelper, packet);
+            packetProtocol.getPacketHeader().writePacketId(buf, packetId);
+            definition.getSerializer().serialize(buf, packet);
 
             out.add(buf);
 
@@ -76,18 +74,17 @@ protected void decode(ChannelHandlerContext ctx, ByteBuf buf, List<Object> out)
 
         PacketProtocol packetProtocol = this.session.getPacketProtocol();
         PacketRegistry packetRegistry = packetProtocol.getInboundPacketRegistry();
-        PacketCodecHelper codecHelper = this.session.getCodecHelper();
         Packet packet = null;
         try {
-            int id = packetProtocol.getPacketHeader().readPacketId(buf, codecHelper);
+            int id = packetProtocol.getPacketHeader().readPacketId(buf);
             if (id == -1) {
                 buf.readerIndex(initial);
                 return;
             }
 
             log.trace(marker, "Decoding packet with id: {}", id);
 
-            packet = this.client ? packetRegistry.createClientboundPacket(id, buf, codecHelper) : packetRegistry.createServerboundPacket(id, buf, codecHelper);
+            packet = this.client ? packetRegistry.createClientboundPacket(id, buf) : packetRegistry.createServerboundPacket(id, buf);
 
             if (buf.readableBytes() > 0) {
                 throw new IllegalStateException("Packet \"" + packet.getClass().getSimpleName() + "\" not fully read.");

protocol/src/main/java/org/geysermc/mcprotocollib/network/netty/MinecraftChannelInitializer.java

@@ -6,15 +6,14 @@
 import io.netty.handler.codec.MessageToMessageCodec;
 import lombok.RequiredArgsConstructor;
 import org.geysermc.mcprotocollib.network.NetworkConstants;
-import org.geysermc.mcprotocollib.network.codec.PacketCodecHelper;
 import org.geysermc.mcprotocollib.network.compression.CompressionConfig;
+import org.geysermc.mcprotocollib.protocol.codec.MinecraftTypes;
 
 import java.util.List;
 
 @RequiredArgsConstructor
 public class PacketCompressionCodec extends MessageToMessageCodec<ByteBuf, ByteBuf> {
     private static final int MAX_UNCOMPRESSED_SIZE = 8 * 1024 * 1024; // 8MiB
-    private final PacketCodecHelper helper;
 
     @Override
     public void handlerRemoved(ChannelHandlerContext ctx) {
@@ -42,10 +41,10 @@ public void encode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) {
         ByteBuf outBuf = ctx.alloc().directBuffer(uncompressed);
         if (uncompressed < config.threshold()) {
             // Under the threshold, there is nothing to do.
-            this.helper.writeVarInt(outBuf, 0);
+            MinecraftTypes.writeVarInt(outBuf, 0);
             outBuf.writeBytes(msg);
         } else {
-            this.helper.writeVarInt(outBuf, uncompressed);
+            MinecraftTypes.writeVarInt(outBuf, uncompressed);
             config.compression().deflate(msg, outBuf);
         }
 
@@ -60,7 +59,7 @@ protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) {
             return;
         }
 
-        int claimedUncompressedSize = this.helper.readVarInt(in);
+        int claimedUncompressedSize = MinecraftTypes.readVarInt(in);
         if (claimedUncompressedSize == 0) {
             out.add(in.retain());
             return;