diff --git a/patches/minecraft/net/minecraft/network/CompressionEncoder.java.patch b/patches/minecraft/net/minecraft/network/CompressionEncoder.java.patch index 411a5b07d3..290c0cfd9b 100644 --- a/patches/minecraft/net/minecraft/network/CompressionEncoder.java.patch +++ b/patches/minecraft/net/minecraft/network/CompressionEncoder.java.patch @@ -13,7 +13,7 @@ friendlybytebuf.m_130130_(0); friendlybytebuf.writeBytes(p_129453_); } else { -+ if (!DISABLE_PACKET_DEBUG && i > 2097152) { ++ if (!DISABLE_PACKET_DEBUG && i > net.minecraft.network.CompressionDecoder.MAXIMUM_UNCOMPRESSED_LENGTH) { + p_129453_.markReaderIndex(); + LOGGER.error("Attempted to send packet over maximum protocol size: {} > 2097152\nData:\n{}", i, + net.minecraftforge.logging.PacketDump.getContentDump(p_129453_)); diff --git a/src/main/java/net/minecraftforge/network/filters/ForgeConnectionNetworkFilter.java b/src/main/java/net/minecraftforge/network/filters/ForgeConnectionNetworkFilter.java index 0209ab5e02..fce8e9c27e 100644 --- a/src/main/java/net/minecraftforge/network/filters/ForgeConnectionNetworkFilter.java +++ b/src/main/java/net/minecraftforge/network/filters/ForgeConnectionNetworkFilter.java @@ -14,6 +14,7 @@ import net.minecraft.network.protocol.Packet; import net.minecraft.network.Connection; import net.minecraft.network.protocol.PacketFlow; import net.minecraft.network.ConnectionProtocol; +import net.minecraft.network.protocol.game.ClientboundLoginPacket; import net.minecraft.network.protocol.game.ClientboundUpdateAdvancementsPacket; import net.minecraft.network.protocol.game.ClientboundUpdateTagsPacket; import net.minecraft.network.protocol.game.ClientboundUpdateRecipesPacket; @@ -43,7 +44,8 @@ public class ForgeConnectionNetworkFilter extends VanillaPacketFilter ImmutableMap.Builder>, BiConsumer, List>>> builder = ImmutableMap.>, BiConsumer, List>>>builder() .put(ClientboundUpdateRecipesPacket.class, ForgeConnectionNetworkFilter::splitPacket) .put(ClientboundUpdateTagsPacket.class, ForgeConnectionNetworkFilter::splitPacket) - .put(ClientboundUpdateAdvancementsPacket.class, ForgeConnectionNetworkFilter::splitPacket); + .put(ClientboundUpdateAdvancementsPacket.class, ForgeConnectionNetworkFilter::splitPacket) + .put(ClientboundLoginPacket.class, ForgeConnectionNetworkFilter::splitPacket); // When there are many dynamic registry entries that packet is BIG return builder.build(); } diff --git a/src/main/java/net/minecraftforge/network/filters/VanillaPacketSplitter.java b/src/main/java/net/minecraftforge/network/filters/VanillaPacketSplitter.java index ca42eef662..ea6ee42fab 100644 --- a/src/main/java/net/minecraftforge/network/filters/VanillaPacketSplitter.java +++ b/src/main/java/net/minecraftforge/network/filters/VanillaPacketSplitter.java @@ -11,8 +11,6 @@ import java.util.function.Predicate; import io.netty.buffer.ByteBuf; import io.netty.buffer.Unpooled; -import net.minecraft.client.Minecraft; -import net.minecraft.client.multiplayer.ClientPacketListener; import net.minecraft.network.*; import net.minecraft.network.protocol.Packet; import net.minecraft.network.protocol.PacketFlow; @@ -36,7 +34,7 @@ public class VanillaPacketSplitter private static final ResourceLocation CHANNEL = new ResourceLocation("forge", "split"); private static final String VERSION = "1.1"; - private static final int PROTOCOL_MAX = 2097152; + private static final int PROTOCOL_MAX = CompressionDecoder.MAXIMUM_UNCOMPRESSED_LENGTH; private static final int PAYLOAD_TO_CLIENT_MAX = 1048576; // 1 byte for state, 5 byte for VarInt PacketID @@ -117,7 +115,6 @@ public class VanillaPacketSplitter private static final List receivedBuffers = new ArrayList<>(); - @SuppressWarnings("unchecked") private static void onClientPacket(NetworkEvent.ServerCustomPayloadEvent event) { NetworkEvent.Context ctx = event.getSource().get(); @@ -152,11 +149,17 @@ public class VanillaPacketSplitter { receivedBuffers.clear(); full.release(); - ctx.enqueueWork(() -> ((Packet)packet).handle(Minecraft.getInstance().getConnection())); + ctx.enqueueWork(() -> genericsFtw(packet, event.getSource().get().getNetworkManager().getPacketListener())); } } } + @SuppressWarnings("unchecked") + private static void genericsFtw(Packet pkt, Object listener) + { + pkt.handle((T) listener); + } + public enum RemoteCompatibility { ABSENT, diff --git a/src/test/java/net/minecraftforge/debug/client/rendering/RenderLevelStagesTest.java b/src/test/java/net/minecraftforge/debug/client/rendering/RenderLevelStagesTest.java index 0a47b8adbf..4a00d05d86 100644 --- a/src/test/java/net/minecraftforge/debug/client/rendering/RenderLevelStagesTest.java +++ b/src/test/java/net/minecraftforge/debug/client/rendering/RenderLevelStagesTest.java @@ -5,6 +5,7 @@ package net.minecraftforge.debug.client.rendering; +import net.minecraftforge.fml.loading.FMLLoader; import org.apache.logging.log4j.LogManager; import net.minecraftforge.client.event.RenderLevelStageEvent; @@ -18,7 +19,10 @@ public class RenderLevelStagesTest public RenderLevelStagesTest() { - MinecraftForge.EVENT_BUS.addListener(this::onRenderLevelStages); + if (FMLLoader.getDist().isClient()) + { + MinecraftForge.EVENT_BUS.addListener(this::onRenderLevelStages); + } } private int count = 0; diff --git a/src/test/java/net/minecraftforge/debug/world/LoginPacketSplitTest.java b/src/test/java/net/minecraftforge/debug/world/LoginPacketSplitTest.java new file mode 100644 index 0000000000..53d9ab599d --- /dev/null +++ b/src/test/java/net/minecraftforge/debug/world/LoginPacketSplitTest.java @@ -0,0 +1,291 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ + +package net.minecraftforge.debug.world; + +import com.google.common.base.Stopwatch; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.mojang.brigadier.Command; +import com.mojang.logging.LogUtils; +import com.mojang.serialization.Codec; +import com.mojang.serialization.Lifecycle; +import com.mojang.serialization.codecs.RecordCodecBuilder; +import io.netty.buffer.Unpooled; +import net.minecraft.SharedConstants; +import net.minecraft.commands.Commands; +import net.minecraft.core.MappedRegistry; +import net.minecraft.core.Registry; +import net.minecraft.core.RegistryCodecs; +import net.minecraft.network.CompressionDecoder; +import net.minecraft.network.FriendlyByteBuf; +import net.minecraft.network.chat.Component; +import net.minecraft.resources.ResourceKey; +import net.minecraft.resources.ResourceLocation; +import net.minecraft.server.packs.PackResources; +import net.minecraft.server.packs.PackType; +import net.minecraft.server.packs.metadata.MetadataSectionSerializer; +import net.minecraft.server.packs.repository.Pack; +import net.minecraft.server.packs.repository.PackSource; +import net.minecraft.server.packs.resources.IoSupplier; +import net.minecraft.util.GsonHelper; +import net.minecraftforge.client.event.RegisterClientCommandsEvent; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.event.AddPackFindersEvent; +import net.minecraftforge.eventbus.api.IEventBus; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; +import net.minecraftforge.fml.loading.FMLLoader; +import net.minecraftforge.fml.util.ObfuscationReflectionHelper; +import net.minecraftforge.registries.DataPackRegistryEvent; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import java.util.Random; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; +import java.util.stream.Collectors; + +/** + * A test mod used to test splitting the {@link net.minecraft.network.protocol.game.ClientboundLoginPacket}.
+ * In order to test this works, first {@link #ENABLED enable} the packet. + * Start a local server and client. In the server console you should see how big the + * registryaccess in the packet would be, and how much {@code %} of the packet limit is represents.
+ * Connect to the server from the client, and if you successfully connect and the {@code /big_data} command + * reports 50000 entries then the packet has been successfully split.

+ * To test if the packet is too large simply remove the login packet from the {@link net.minecraftforge.network.filters.ForgeConnectionNetworkFilter} + * and try connecting again. You should see the connection fail. + */ +@Mod(LoginPacketSplitTest.MOD_ID) +public class LoginPacketSplitTest +{ + public static final Logger LOG = LogUtils.getLogger(); + public static final String MOD_ID = "login_packet_split_test"; + public static final boolean ENABLED = false; + public static final ResourceKey> BIG_DATA = ResourceKey.createRegistryKey(new ResourceLocation(MOD_ID, "big_data")); + + public LoginPacketSplitTest() + { + final IEventBus bus = FMLJavaModLoadingContext.get().getModEventBus(); + bus.addListener((final DataPackRegistryEvent.NewRegistry event) -> event.dataPackRegistry(BIG_DATA, BigData.CODEC, BigData.CODEC)); + if (ENABLED) + { + bus.addListener((final AddPackFindersEvent event) -> + { + if (event.getPackType() == PackType.SERVER_DATA) + { + final InMemoryResourcePack pack = new InMemoryResourcePack("virtual_bigdata"); + generateEntries(pack); + event.addRepositorySource(packs -> packs.accept(Pack.readMetaAndCreate( + pack.id, + Component.literal("Pack containing big datapack registries"), + true, + s -> pack, + PackType.SERVER_DATA, + Pack.Position.TOP, + PackSource.BUILT_IN + ))); + } + }); + + if (FMLLoader.getDist().isClient()) + { + MinecraftForge.EVENT_BUS.addListener((final RegisterClientCommandsEvent event) -> event.getDispatcher().register(Commands.literal("big_data") + .executes(context -> + { + context.getSource().sendSuccess(Component.literal("Registry has " + context.getSource().registryAccess().registryOrThrow(BIG_DATA).holders().count() + " entries."), true); + return Command.SINGLE_SUCCESS; + }))); + } + } + } + + private void generateEntries(InMemoryResourcePack pack) + { + final Stopwatch stopwatch = Stopwatch.createUnstarted(); + final Registry dummyRegistry = new MappedRegistry<>(BIG_DATA, Lifecycle.stable(), false); + final Random random = new Random(); + + stopwatch.start(); + for (int i = 0; i < 50_000; i++) + { + final BigData bigData = new BigData(randomString(random, 30 + random.nextInt(10)).repeat(15), random.nextInt(Integer.MAX_VALUE)); + final JsonObject json = new JsonObject(); + json.addProperty("text", bigData.text); + json.addProperty("number", bigData.number); + pack.putData(new ResourceLocation(MOD_ID, MOD_ID + "/big_data/entry_" + i + ".json"), json); + Registry.register(dummyRegistry, new ResourceLocation(MOD_ID, MOD_ID + "/big_data/entry_" + i), bigData); + } + stopwatch.stop(); + LOG.warn("Setting up big data registry took " + stopwatch.elapsed(TimeUnit.MILLISECONDS) + " miliseconds."); + + final FriendlyByteBuf buf = new FriendlyByteBuf(Unpooled.buffer()); + record RegistryData(Registry registry) + { + } + buf.writeWithCodec(RecordCodecBuilder.create(in -> in.group( + RegistryCodecs.networkCodec(BIG_DATA, Lifecycle.stable(), BigData.CODEC).fieldOf("registry").forGetter(RegistryData::registry) + ).apply(in, RegistryData::new)), new RegistryData(dummyRegistry)); // RegistryCodecs.networkCodec returns a list codec, and writeWithNbt doesn't like non-compounds + + final int size = buf.writerIndex(); + LOG.warn("Dummy big registry size: " + size + ", or " + ((double) size / CompressionDecoder.MAXIMUM_UNCOMPRESSED_LENGTH * 100) + "% of the maximum packet size."); + + final Set known = ObfuscationReflectionHelper.getPrivateValue(MappedRegistry.class, null, "KNOWN"); + known.remove(dummyRegistry.key().location()); + } + + private String randomString(Random random, int length) + { + return random.ints(97, 122 + 1) // letter 'a' to letter 'z' + .limit(length) + .collect(StringBuilder::new, StringBuilder::appendCodePoint, StringBuilder::append) + .toString(); + } + + public record BigData(String text, int number) + { + public static final Codec CODEC = RecordCodecBuilder.create(in -> in.group( + Codec.STRING.fieldOf("text").forGetter(BigData::text), + Codec.INT.fieldOf("number").forGetter(BigData::number) + ).apply(in, BigData::new)); + } + + public static final class InMemoryResourcePack implements PackResources + { + private final Map> data = new ConcurrentHashMap<>(); + private final Map> root = new ConcurrentHashMap<>(); + + private final String id; + + public InMemoryResourcePack(String id) + { + this.id = id; + + final JsonObject mcmeta = new JsonObject(); + final JsonObject packJson = new JsonObject(); + packJson.addProperty("description", "A virtual resource pack."); + packJson.addProperty("pack_format", SharedConstants.getCurrentVersion().getPackVersion(com.mojang.bridge.game.PackType.DATA)); + mcmeta.add("pack", packJson); + + putRoot("pack.mcmeta", mcmeta); + } + + @Nullable + @Override + public IoSupplier getRootResource(String... loc) + { + return openResource(this.root, String.join("/", loc)); + } + + @Nullable + @Override + public IoSupplier getResource(PackType type, ResourceLocation loc) + { + if (type != PackType.SERVER_DATA) return null; + return openResource(data, loc); + } + + private @Nullable IoSupplier openResource(Map> map, @NotNull T key) + { + final Supplier supplier = map.get(key); + if (supplier == null) + { + return null; + } + final byte[] bytes = supplier.get(); + if (bytes == null) + { + return null; + } + return () -> new ByteArrayInputStream(bytes); + } + + @Override + public void listResources(PackType type, String namespace, String startingPath, ResourceOutput out) + { + if (type != PackType.SERVER_DATA) return; + data.forEach((key, data) -> + { + if (key.getNamespace().equals(namespace) && key.getPath().startsWith(startingPath)) + { + final byte[] bytes = data.get(); + if (bytes != null) + { + out.accept(key, () -> new ByteArrayInputStream(bytes)); + } + } + }); + } + + @Override + public Set getNamespaces(PackType type) + { + return type == PackType.CLIENT_RESOURCES ? Set.of() : + data.keySet().stream().map(ResourceLocation::getNamespace) + .collect(Collectors.toUnmodifiableSet()); + } + + @Nullable + @Override + public T getMetadataSection(MetadataSectionSerializer section) throws IOException + { + final JsonObject json = GsonHelper.parse(new String(root.get("pack.mcmeta").get())); + if (!json.has(section.getMetadataSectionName())) + { + return null; + } else + { + return section.fromJson(GsonHelper.getAsJsonObject(json, section.getMetadataSectionName())); + } + } + + @Override + public String packId() + { + return id; + } + + @Override + public void close() + { + + } + + public void putRoot(String path, JsonObject json) + { + final byte[] bytes = fromJson(json); + putRoot(path, () -> bytes); + } + + public void putRoot(String path, Supplier data) + { + root.put(path, data); + } + + public void putData(ResourceLocation path, JsonObject json) + { + final byte[] bytes = fromJson(json); + putData(path, () -> bytes); + } + + public void putData(ResourceLocation path, Supplier data) + { + this.data.put(path, data); + } + + public static byte[] fromJson(JsonElement json) + { + return GsonHelper.toStableString(json).getBytes(StandardCharsets.UTF_8); + } + } +} \ No newline at end of file diff --git a/src/test/java/net/minecraftforge/eventtest/internal/TestFramework.java b/src/test/java/net/minecraftforge/eventtest/internal/TestFramework.java index 1e49e05bb1..94f7e4c224 100644 --- a/src/test/java/net/minecraftforge/eventtest/internal/TestFramework.java +++ b/src/test/java/net/minecraftforge/eventtest/internal/TestFramework.java @@ -10,6 +10,7 @@ import net.minecraftforge.client.event.ScreenEvent; import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.event.GameShuttingDownEvent; import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.loading.FMLLoader; import net.minecraftforge.fml.loading.LoadingModList; import org.apache.logging.log4j.Level; import org.apache.logging.log4j.LogManager; @@ -58,6 +59,8 @@ public class TestFramework { LOGGER.info("Preparing all event tests."); tests = gatherEvents(); + if (FMLLoader.getDist().isDedicatedServer()) return; // This entire thing doesn't work on servers... + // Let each event set up tests.forEach(EventTest::registerEvents); diff --git a/src/test/java/net/minecraftforge/eventtest/tests/forge/client/EntityJoinedWorldTest.java b/src/test/java/net/minecraftforge/eventtest/tests/forge/client/EntityJoinedWorldTest.java index 884c24ced8..de13a17008 100644 --- a/src/test/java/net/minecraftforge/eventtest/tests/forge/client/EntityJoinedWorldTest.java +++ b/src/test/java/net/minecraftforge/eventtest/tests/forge/client/EntityJoinedWorldTest.java @@ -24,7 +24,7 @@ import net.minecraftforge.eventtest.internal.TestHolder; * */ -@TestHolder("EntityJoinWorld") +// @TestHolder("EntityJoinWorld") public class EntityJoinedWorldTest extends EventTest { @Override diff --git a/src/test/resources/META-INF/mods.toml b/src/test/resources/META-INF/mods.toml index 568777fed3..b96b362222 100644 --- a/src/test/resources/META-INF/mods.toml +++ b/src/test/resources/META-INF/mods.toml @@ -234,6 +234,8 @@ modId="many_mob_effects_test" [[mods]] modId="fluid_util_test" [[mods]] +modId="login_packet_split_test" +[[mods]] modId="potion_size_event_test" [[mods]] modId="recipe_book_extension_test"