improve logging when data packet has data left

Author: ghzdude

src/main/java/gregtech/api/capability/GregtechDataCodes.java

@@ -1,5 +1,10 @@
 package gregtech.api.capability;
 
+import it.unimi.dsi.fastutil.ints.Int2ObjectArrayMap;
+import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
+
+import java.lang.reflect.Field;
+
 public class GregtechDataCodes {
 
     private static int nextId = 0;
@@ -180,4 +185,20 @@ public static int assignId() {
     // ME Parts
     public static final int UPDATE_AUTO_PULL = assignId();
     public static final int UPDATE_ONLINE_STATUS = assignId();
+
+    // Everything below MUST be last in the class!
+    public static final Int2ObjectMap<String> NAMES = new Int2ObjectArrayMap<>();
+
+    static {
+        try {
+            for (Field field : GregtechDataCodes.class.getFields()) {
+                if (field.getType() != Integer.TYPE) continue;
+                NAMES.put(field.getInt(null), field.getName());
+            }
+        } catch (IllegalAccessException ignored) {}
+    }
+
+    public static String getNameFor(int id) {
+        return NAMES.getOrDefault(id, "Unknown DataCode: " + id);
+    }
 }

src/main/java/gregtech/api/metatileentity/MetaTileEntity.java

@@ -1096,6 +1096,9 @@ public void receiveCustomData(int dataId, @NotNull PacketBuffer buf) {
             if (cover != null) {
                 cover.readCustomData(internalId, buf);
             }
+            if (buf.readableBytes() != 0)
+                ISyncedTileEntity.handleUnreadPacket(internalId, buf, this);
+            buf.clear(); // clear data so holder doesn't log error
         } else if (dataId == UPDATE_SOUND_MUFFLED) {
             this.muffled = buf.readBoolean();
             if (muffled) {

src/main/java/gregtech/api/metatileentity/SyncedTileEntityBase.java

@@ -80,19 +80,10 @@ public final void onDataPacket(@NotNull NetworkManager net, @NotNull SPacketUpda
             NBTTagCompound entryTag = (NBTTagCompound) entryBase;
             for (String discriminatorKey : entryTag.getKeySet()) {
                 ByteBuf backedBuffer = Unpooled.copiedBuffer(entryTag.getByteArray(discriminatorKey));
-                receiveCustomData(Integer.parseInt(discriminatorKey), new PacketBuffer(backedBuffer));
+                int dataId = Integer.parseInt(discriminatorKey);
+                receiveCustomData(dataId, new PacketBuffer(backedBuffer));
                 if (backedBuffer.readableBytes() != 0) {
-                    String className = null;
-                    if (this instanceof IGregTechTileEntity gtte) {
-                        MetaTileEntity mte = gtte.getMetaTileEntity();
-                        if (mte != null) className = mte.getClass().getName();
-                    }
-                    if (className == null) {
-                        className = this.getClass().getName();
-                    }
-                    GTLog.logger.error(
-                            "Class {} failed to finish reading receiveCustomData with discriminator {} and {} bytes remaining",
-                            className, discriminatorKey, backedBuffer.readableBytes());
+                    ISyncedTileEntity.handleUnreadPacket(dataId, backedBuffer, this);
                 }
             }
         }

src/main/java/gregtech/api/metatileentity/interfaces/ISyncedTileEntity.java

@@ -1,7 +1,13 @@
 package gregtech.api.metatileentity.interfaces;
 
+import gregtech.api.capability.GregtechDataCodes;
+import gregtech.api.metatileentity.MetaTileEntity;
+import gregtech.api.util.GTLog;
+
 import net.minecraft.network.PacketBuffer;
+import net.minecraft.tileentity.TileEntity;
 
+import io.netty.buffer.ByteBuf;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.function.Consumer;
@@ -25,7 +31,7 @@ public interface ISyncedTileEntity {
      * <p>
      * This method is called <strong>Server-Side</strong>.
      * <p>
-     * Equivalent to {@link net.minecraft.tileentity.TileEntity#getUpdateTag}.
+     * Equivalent to {@link TileEntity#getUpdateTag}.
      *
      * @param buf the buffer to write data to
      */
@@ -43,7 +49,7 @@ public interface ISyncedTileEntity {
      * <p>
      * This method is called <strong>Client-Side</strong>.
      * <p>
-     * Equivalent to {@link net.minecraft.tileentity.TileEntity#handleUpdateTag}.
+     * Equivalent to {@link TileEntity#handleUpdateTag}.
      *
      * @param buf the buffer to read data from
      */
@@ -62,11 +68,11 @@ public interface ISyncedTileEntity {
      * <p>
      * This method is called <strong>Server-Side</strong>.
      * <p>
-     * Equivalent to {@link net.minecraft.tileentity.TileEntity#getUpdatePacket}
+     * Equivalent to {@link TileEntity#getUpdatePacket}
      *
      * @param discriminator the discriminator determining the packet sent.
      * @param dataWriter    a consumer which writes packet data to a buffer.
-     * @see gregtech.api.capability.GregtechDataCodes
+     * @see GregtechDataCodes
      */
     void writeCustomData(int discriminator, @NotNull Consumer<@NotNull PacketBuffer> dataWriter);
 
@@ -82,10 +88,10 @@ public interface ISyncedTileEntity {
      * <p>
      * This method is called <strong>Server-Side</strong>.
      * <p>
-     * Equivalent to {@link net.minecraft.tileentity.TileEntity#getUpdatePacket}
+     * Equivalent to {@link TileEntity#getUpdatePacket}
      *
      * @param discriminator the discriminator determining the packet sent.
-     * @see gregtech.api.capability.GregtechDataCodes
+     * @see GregtechDataCodes
      */
     default void writeCustomData(int discriminator) {
         writeCustomData(discriminator, NO_OP);
@@ -103,11 +109,24 @@ default void writeCustomData(int discriminator) {
      * <p>
      * This method is called <strong>Client-Side</strong>.
      * <p>
-     * Equivalent to {@link net.minecraft.tileentity.TileEntity#onDataPacket}
+     * Equivalent to {@link TileEntity#onDataPacket}
      *
      * @param discriminator the discriminator determining the packet sent.
      * @param buf           the buffer containing the packet data.
-     * @see gregtech.api.capability.GregtechDataCodes
+     * @see GregtechDataCodes
      */
     void receiveCustomData(int discriminator, @NotNull PacketBuffer buf);
+
+    static void handleUnreadPacket(int discriminator, @NotNull ByteBuf buf, ISyncedTileEntity syncedTile) {
+        String className = null;
+        if (syncedTile instanceof IGregTechTileEntity gtte) {
+            MetaTileEntity mte = gtte.getMetaTileEntity();
+            if (mte != null) className = mte.getClass().getSimpleName();
+        } else {
+            className = syncedTile.getClass().getSimpleName();
+        }
+        GTLog.logger.error(
+                "Class {} failed to finish reading receiveCustomData with discriminator {} and {} bytes remaining",
+                className, GregtechDataCodes.getNameFor(discriminator), buf.readableBytes());
+    }
 }