Streamline api (#832)

This basically makes MinecraftCodec stateless and removes unused APIs.
The MinecraftCodecHelper has a state for an unused registry API, which is not needed at all. Developers can just send their own registry as seen in ServerListener. These only exist because there was an attempt at allowing multi-version support inside MinecraftCodecHelper, but that's not gonna be necessary if ViaVersion support gets added to MCPL.
The option to add back logic for multi-version support is fully open for the future. I didn't remove MinecraftCodecHelper being instance-based, so it's fully possible to readd the multi-version logic back in the future. Just level events and sounds being dynamic is not enough for multi-version support and thus should be removed to streamline the API.
This also removes many workarounds from the code that cause possible inconsistency. Often the MinecraftCodecHelper gets initialized in the tests with empty parameters. This removes them as parameters and removes the need to provide them by moving them to the object itself.
PacketCodecs were also improved to decrease the inheritance issues and streamline the code flow and remove the UnsupportedOperationExceptions being needed.
BufferedPacket was also removed since it's useless for Minecraft.

Author: AlexProgrammerDE

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

@@ -12,6 +12,7 @@
 import org.geysermc.mcprotocollib.network.packet.DefaultPacketHeader;
 import org.geysermc.mcprotocollib.network.packet.PacketHeader;
 import org.geysermc.mcprotocollib.network.packet.PacketProtocol;
+import org.geysermc.mcprotocollib.network.packet.PacketRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -21,6 +22,7 @@
 public class TestProtocol extends PacketProtocol {
     private static final Logger log = LoggerFactory.getLogger(TestProtocol.class);
     private final PacketHeader header = new DefaultPacketHeader();
+    private final PacketRegistry registry = new PacketRegistry();
     private AESEncryption encrypt;
 
     @SuppressWarnings("unused")
@@ -36,7 +38,7 @@ public PacketCodecHelper createHelper() {
     }
 
     public void setSecretKey(SecretKey key) {
-        this.register(0, PingPacket.class, new PacketSerializer<>() {
+        registry.register(0, PingPacket.class, new PacketSerializer<>() {
             @Override
             public void serialize(ByteBuf buf, PacketCodecHelper helper, PingPacket packet) {
                 helper.writeString(buf, packet.getPingId());
@@ -78,4 +80,9 @@ public void newClientSession(Session session, boolean transferring) {
     public void newServerSession(Server server, Session session) {
         session.addListener(new ServerSessionListener());
     }
+
+    @Override
+    public PacketRegistry getPacketRegistry() {
+        return registry;
+    }
 }

protocol/src/main/java/org/geysermc/mcprotocollib/network/packet/BufferedPacket.java

@@ -1,28 +1,15 @@
 package org.geysermc.mcprotocollib.network.packet;
 
 import io.netty.buffer.ByteBuf;
-import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
-import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
 import org.geysermc.mcprotocollib.network.Server;
 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.codec.PacketSerializer;
-
-import java.util.IdentityHashMap;
-import java.util.Map;
 
 /**
  * A protocol for packet sending and receiving.
  * All implementations must have a constructor that takes in a {@link ByteBuf}.
  */
 public abstract class PacketProtocol {
-    private final Int2ObjectMap<PacketDefinition<? extends Packet, ?>> serverbound = new Int2ObjectOpenHashMap<>();
-    private final Int2ObjectMap<PacketDefinition<? extends Packet, ?>> clientbound = new Int2ObjectOpenHashMap<>();
-
-    private final Map<Class<? extends Packet>, Integer> clientboundIds = new IdentityHashMap<>();
-    private final Map<Class<? extends Packet>, Integer> serverboundIds = new IdentityHashMap<>();
-
     /**
      * Gets the prefix used when locating SRV records for this protocol.
      *
@@ -62,241 +49,9 @@ public abstract class PacketProtocol {
     public abstract void newServerSession(Server server, Session session);
 
     /**
-     * Clears all currently registered packets.
-     */
-    public final void clearPackets() {
-        this.serverbound.clear();
-        this.clientbound.clear();
-        this.clientboundIds.clear();
-        this.serverboundIds.clear();
-    }
-
-    /**
-     * Registers a packet to this protocol as both serverbound and clientbound.
-     *
-     * @param id Id to register the packet to.
-     * @param packet Packet to register.
-     * @param serializer The packet serializer.
-     * @throws IllegalArgumentException If the packet fails a test creation when being registered as serverbound.
-     */
-    public final <T extends Packet, H extends PacketCodecHelper> void register(int id, Class<T> packet, PacketSerializer<T, H> serializer) {
-        this.registerServerbound(id, packet, serializer);
-        this.registerClientbound(id, packet, serializer);
-    }
-
-    /**
-     * Registers a packet to this protocol as both serverbound and clientbound.
-     *
-     * @param definition The packet definition.
-     * @throws IllegalArgumentException If the packet fails a test creation when being registered as serverbound.
-     */
-    public final void register(PacketDefinition<? extends Packet, ?> definition) {
-        this.registerServerbound(definition);
-        this.registerClientbound(definition);
-    }
-
-    /**
-     * Registers a serverbound packet to this protocol.
-     *
-     * @param id Id to register the packet to.
-     * @param packet Packet to register.
-     * @param serializer The packet serializer.
-     * @throws IllegalArgumentException If the packet fails a test creation.
-     */
-    public final <T extends Packet, H extends PacketCodecHelper> void registerServerbound(int id, Class<T> packet, PacketSerializer<T, H> serializer) {
-        this.registerServerbound(new PacketDefinition<>(id, packet, serializer));
-    }
-
-    /**
-     * Registers a serverbound packet to this protocol.
-     *
-     * @param definition The packet definition.
-     */
-    public final void registerServerbound(PacketDefinition<? extends Packet, ?> definition) {
-        this.serverbound.put(definition.getId(), definition);
-        this.serverboundIds.put(definition.getPacketClass(), definition.getId());
-    }
-
-    /**
-     * Registers a clientbound packet to this protocol.
-     *
-     * @param id Id to register the packet to.
-     * @param packet Packet to register.
-     * @param serializer The packet serializer.
-     */
-    public final <T extends Packet, H extends PacketCodecHelper> void registerClientbound(int id, Class<T> packet, PacketSerializer<T, H> serializer) {
-        this.registerClientbound(new PacketDefinition<>(id, packet, serializer));
-    }
-
-    /**
-     * Registers a clientbound packet to this protocol.
-     *
-     * @param definition The packet definition.
-     */
-    public final void registerClientbound(PacketDefinition<? extends Packet, ?> definition) {
-        this.clientbound.put(definition.getId(), definition);
-        this.clientboundIds.put(definition.getPacketClass(), definition.getId());
-    }
-
-    /**
-     * Creates a new instance of a clientbound packet with the given id and read the clientbound input.
-     *
-     * @param id Id of the packet to create.
-     * @param buf The buffer to read the packet from.
-     * @param codecHelper The codec helper.
-     * @return The created packet.
-     * @throws IllegalArgumentException If the packet ID is not registered.
-     */
-    @SuppressWarnings("unchecked")
-    public <H extends PacketCodecHelper> Packet createClientboundPacket(int id, ByteBuf buf, H codecHelper) {
-        PacketDefinition<?, H> definition = (PacketDefinition<?, H>) this.clientbound.get(id);
-        if (definition == null) {
-            throw new IllegalArgumentException("Invalid packet id: " + id);
-        }
-
-        return definition.newInstance(buf, codecHelper);
-    }
-
-    /**
-     * Gets the registered id of a clientbound packet class.
-     *
-     * @param packetClass Class of the packet to get the id for.
-     * @return The packet's registered id.
-     * @throws IllegalArgumentException If the packet is not registered.
-     */
-    public int getClientboundId(Class<? extends Packet> packetClass) {
-        Integer packetId = this.clientboundIds.get(packetClass);
-        if (packetId == null) {
-            throw new IllegalArgumentException("Unregistered clientbound packet class: " + packetClass.getName());
-        }
-
-        return packetId;
-    }
-
-    /**
-     * Gets the registered id of a clientbound {@link Packet} instance.
-     *
-     * @param packet Instance of {@link Packet} to get the id for.
-     * @return The packet's registered id.
-     * @throws IllegalArgumentException If the packet is not registered.
-     */
-    public int getClientboundId(Packet packet) {
-        if (packet instanceof BufferedPacket bufferedPacket) {
-            return getClientboundId(bufferedPacket.getPacketClass());
-        }
-
-        return getClientboundId(packet.getClass());
-    }
-
-    /**
-     * Gets the packet class for a packet id.
-     *
-     * @param id The packet id.
-     * @return The registered packet's class
-     * @throws IllegalArgumentException If the packet ID is not registered.
-     */
-    public Class<? extends Packet> getClientboundClass(int id) {
-        PacketDefinition<?, ?> definition = this.clientbound.get(id);
-        if (definition == null) {
-            throw new IllegalArgumentException("Invalid packet id: " + id);
-        }
-
-        return definition.getPacketClass();
-    }
-
-    /**
-     * Creates a new instance of a serverbound packet with the given id and read the serverbound input.
-     *
-     * @param id Id of the packet to create.
-     * @param buf The buffer to read the packet from.
-     * @param codecHelper The codec helper.
-     * @return The created packet.
-     * @throws IllegalArgumentException If the packet ID is not registered.
-     */
-    @SuppressWarnings("unchecked")
-    public <H extends PacketCodecHelper> Packet createServerboundPacket(int id, ByteBuf buf, H codecHelper) {
-        PacketDefinition<?, H> definition = (PacketDefinition<?, H>) this.serverbound.get(id);
-        if (definition == null) {
-            throw new IllegalArgumentException("Invalid packet id: " + id);
-        }
-
-        return definition.newInstance(buf, codecHelper);
-    }
-
-    /**
-     * Gets the registered id of a serverbound packet class.
-     *
-     * @param packetClass Class of the packet to get the id for.
-     * @return The packet's registered id.
-     * @throws IllegalArgumentException If the packet is not registered.
-     */
-    public int getServerboundId(Class<? extends Packet> packetClass) {
-        Integer packetId = this.serverboundIds.get(packetClass);
-        if (packetId == null) {
-            throw new IllegalArgumentException("Unregistered serverbound packet class: " + packetClass.getName());
-        }
-
-        return packetId;
-    }
-
-    /**
-     * Gets the registered id of a serverbound {@link Packet} instance.
-     *
-     * @param packet Instance of {@link Packet} to get the id for.
-     * @return The packet's registered id.
-     * @throws IllegalArgumentException If the packet is not registered.
-     */
-    public int getServerboundId(Packet packet) {
-        if (packet instanceof BufferedPacket bufferedPacket) {
-            return getServerboundId(bufferedPacket.getPacketClass());
-        }
-
-        return getServerboundId(packet.getClass());
-    }
-
-    /**
-     * Gets the packet class for a packet id.
+     * Gets the packet registry for this protocol.
      *
-     * @param id The packet id.
-     * @return The registered packet's class
-     * @throws IllegalArgumentException If the packet ID is not registered.
+     * @return The protocol's packet registry.
      */
-    public Class<? extends Packet> getServerboundClass(int id) {
-        PacketDefinition<?, ?> definition = this.serverbound.get(id);
-        if (definition == null) {
-            throw new IllegalArgumentException("Invalid packet id: " + id);
-        }
-
-        return definition.getPacketClass();
-    }
-
-    /**
-     * Gets the serverbound packet definition for the given packet id.
-     *
-     * @param id The packet id.
-     * @return The registered packet's class
-     */
-    public PacketDefinition<?, ?> getServerboundDefinition(int id) {
-        PacketDefinition<?, ?> definition = this.serverbound.get(id);
-        if (definition == null) {
-            throw new IllegalArgumentException("Invalid packet id: " + id);
-        }
-
-        return definition;
-    }
-
-    /**
-     * Gets the clientbound packet definition for the given packet id.
-     *
-     * @param id The packet id.
-     * @return The registered packet's class
-     */
-    public PacketDefinition<?, ?> getClientboundDefinition(int id) {
-        PacketDefinition<?, ?> definition = this.clientbound.get(id);
-        if (definition == null) {
-            throw new IllegalArgumentException("Invalid packet id: " + id);
-        }
-
-        return definition;
-    }
+    public abstract PacketRegistry getPacketRegistry();
 }