Add an option to disable compression for Geyser clients

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeeCompressionDisabler.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2019-2021 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.platform.bungeecord;
+
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.channel.ChannelOutboundHandlerAdapter;
+import io.netty.channel.ChannelPromise;
+import net.md_5.bungee.protocol.packet.LoginSuccess;
+import net.md_5.bungee.protocol.packet.SetCompression;
+
+public class GeyserBungeeCompressionDisabler extends ChannelOutboundHandlerAdapter {
+
+    @Override
+    public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
+        if (!(msg instanceof SetCompression)) {
+            if (msg instanceof LoginSuccess) {
+                // We're past the point that compression can be enabled
+                if (ctx.pipeline().get("compress") != null) {
+                    ctx.pipeline().remove("compress");
+                }
+                if (ctx.pipeline().get("decompress") != null) {
+                    ctx.pipeline().remove("decompress");
+                }
+                ctx.pipeline().remove(this);
+            }
+            super.write(ctx, msg, promise);
+        }
+    }
+}

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeeInjector.java

@@ -140,6 +140,11 @@ public class GeyserBungeeInjector extends GeyserInjector implements Listener {
                             channelInitializer = PipelineUtils.SERVER_CHILD;
                         }
                         initChannel.invoke(channelInitializer, ch);
+
+                        if (bootstrap.getGeyserConfig().isDisableCompression()) {
+                            ch.pipeline().addAfter(PipelineUtils.PACKET_ENCODER, "geyser-compression-disabler",
+                                    new GeyserBungeeCompressionDisabler());
+                        }
                     }
                 })
                 .childAttr(listener, listenerInfo)

bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotCompressionDisabler.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2019-2021 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.platform.spigot;
+
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.channel.ChannelOutboundHandlerAdapter;
+import io.netty.channel.ChannelPromise;
+import org.bukkit.Bukkit;
+import org.geysermc.connector.GeyserConnector;
+
+/**
+ * Disables the compression packet (and the compression handlers from being added to the pipeline) for Geyser clients
+ * that won't be receiving the data over the network.
+ *
+ * As of 1.8 - 1.17.1, compression is enabled in the Netty pipeline by adding a listener after a packet is written.
+ * If we simply "cancel" or don't forward the packet, then the listener is never called.
+ */
+public class GeyserSpigotCompressionDisabler extends ChannelOutboundHandlerAdapter {
+    public static final boolean ENABLED;
+
+    private static final Class<?> COMPRESSION_PACKET_CLASS;
+    private static final Class<?> LOGIN_SUCCESS_PACKET_CLASS;
+    private static final boolean PROTOCOL_SUPPORT_INSTALLED;
+
+    static {
+        PROTOCOL_SUPPORT_INSTALLED = Bukkit.getPluginManager().getPlugin("ProtocolSupport") != null;
+
+        Class<?> compressionPacketClass = null;
+        Class<?> loginSuccessPacketClass = null;
+        boolean enabled = false;
+        try {
+            compressionPacketClass = findCompressionPacket();
+            loginSuccessPacketClass = findLoginSuccessPacket();
+            enabled = true;
+        } catch (Exception e) {
+            GeyserConnector.getInstance().getLogger().error("Could not initialize compression disabler!", e);
+        }
+        COMPRESSION_PACKET_CLASS = compressionPacketClass;
+        LOGIN_SUCCESS_PACKET_CLASS = loginSuccessPacketClass;
+        ENABLED = enabled;
+    }
+
+    public GeyserSpigotCompressionDisabler() {
+        if (!ENABLED) {
+            throw new RuntimeException("Geyser compression disabler cannot be initialized in its current state!");
+        }
+    }
+
+    @Override
+    public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
+        Class<?> msgClass = msg.getClass();
+        // Don't let any compression packet get through
+        if (!COMPRESSION_PACKET_CLASS.isAssignableFrom(msgClass)) {
+            if (LOGIN_SUCCESS_PACKET_CLASS.isAssignableFrom(msgClass)) {
+                if (PROTOCOL_SUPPORT_INSTALLED) {
+                    // ProtocolSupport must send the compression packet, so let's remove what it did before it does damage
+                    if (ctx.pipeline().get("compress") != null) {
+                        ctx.pipeline().remove("compress");
+                    }
+                    if (ctx.pipeline().get("decompress") != null) {
+                        ctx.pipeline().remove("decompress");
+                    }
+                }
+                // We're past the point that a compression packet can be sent, so we can safely yeet ourselves away
+                ctx.channel().pipeline().remove(this);
+            }
+            super.write(ctx, msg, promise);
+        } else if (PROTOCOL_SUPPORT_INSTALLED) {
+            // We must indicate it "succeeded" or ProtocolSupport will time us out
+            promise.setSuccess();
+        }
+    }
+
+    private static Class<?> findCompressionPacket() throws ClassNotFoundException {
+        try {
+            return Class.forName("net.minecraft.network.protocol.login.PacketLoginOutSetCompression");
+        } catch (ClassNotFoundException e) {
+            String prefix = Bukkit.getServer().getClass().getPackage().getName().replace("org.bukkit.craftbukkit", "net.minecraft.server");
+            return Class.forName(prefix + ".PacketLoginOutSetCompression");
+        }
+    }
+
+    private static Class<?> findLoginSuccessPacket() throws ClassNotFoundException {
+        try {
+            return Class.forName("net.minecraft.network.protocol.login.PacketLoginOutSuccess");
+        } catch (ClassNotFoundException e) {
+            String prefix = Bukkit.getServer().getClass().getPackage().getName().replace("org.bukkit.craftbukkit", "net.minecraft.server");
+            return Class.forName(prefix + ".PacketLoginOutSuccess");
+        }
+    }
+}

bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotInjector.java

@@ -115,10 +115,14 @@ public class GeyserSpigotInjector extends GeyserInjector {
 
         ChannelFuture channelFuture = (new ServerBootstrap()
                 .channel(LocalServerChannelWrapper.class)
-                .childHandler(new ChannelInitializer<Channel>() {
+                .childHandler(new ChannelInitializer<>() {
                     @Override
                     protected void initChannel(Channel ch) throws Exception {
                         initChannel.invoke(childHandler, ch);
+
+                        if (bootstrap.getGeyserConfig().isDisableCompression() && GeyserSpigotCompressionDisabler.ENABLED) {
+                            ch.pipeline().addAfter("encoder", "geyser-compression-disabler", new GeyserSpigotCompressionDisabler());
+                        }
                     }
                 })
                 // Set to MAX_PRIORITY as MultithreadEventLoopGroup#newDefaultThreadFactory which DefaultEventLoopGroup implements does by default

bootstrap/velocity/src/main/java/org/geysermc/geyser/platform/velocity/GeyserVelocityCompressionDisabler.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2019-2021 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.platform.velocity;
+
+import io.netty.channel.ChannelHandlerContext;
+import io.netty.channel.ChannelOutboundHandlerAdapter;
+import io.netty.channel.ChannelPromise;
+import org.geysermc.connector.GeyserConnector;
+
+import java.lang.reflect.Method;
+
+public class GeyserVelocityCompressionDisabler extends ChannelOutboundHandlerAdapter {
+    public static final boolean ENABLED;
+    private static final Class<?> COMPRESSION_PACKET_CLASS;
+    private static final Class<?> LOGIN_SUCCESS_PACKET_CLASS;
+    private static final Method SET_COMPRESSION_METHOD;
+
+    static {
+        boolean enabled = false;
+        Class<?> compressionPacketClass = null;
+        Class<?> loginSuccessPacketClass = null;
+        Method setCompressionMethod = null;
+
+        try {
+            compressionPacketClass = Class.forName("com.velocitypowered.proxy.protocol.packet.SetCompression");
+            loginSuccessPacketClass = Class.forName("com.velocitypowered.proxy.protocol.packet.ServerLoginSuccess");
+            setCompressionMethod = Class.forName("com.velocitypowered.proxy.connection.MinecraftConnection")
+                    .getMethod("setCompressionThreshold", int.class);
+            enabled = true;
+        } catch (Exception e) {
+            GeyserConnector.getInstance().getLogger().error("Could not initialize compression disabler!", e);
+        }
+
+        ENABLED = enabled;
+        COMPRESSION_PACKET_CLASS = compressionPacketClass;
+        LOGIN_SUCCESS_PACKET_CLASS = loginSuccessPacketClass;
+        SET_COMPRESSION_METHOD = setCompressionMethod;
+    }
+
+    public GeyserVelocityCompressionDisabler() {
+        if (!ENABLED) {
+            throw new RuntimeException("Geyser compression disabler cannot be initialized in its current state!");
+        }
+    }
+
+    @Override
+    public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
+        Class<?> msgClass = msg.getClass();
+        // instanceOf doesn't work. Unsure why.
+        if (COMPRESSION_PACKET_CLASS != msgClass) {
+            if (LOGIN_SUCCESS_PACKET_CLASS == msgClass) {
+                // We're past the point that compression can be enabled
+                // Invoke the method as it calls a Netty event and handles removing cleaner than we could
+                Object minecraftConnection = ctx.pipeline().get("handler");
+                SET_COMPRESSION_METHOD.invoke(minecraftConnection, -1);
+
+                ctx.pipeline().remove(this);
+            }
+            super.write(ctx, msg, promise);
+        }
+    }
+}

bootstrap/velocity/src/main/java/org/geysermc/geyser/platform/velocity/GeyserVelocityInjector.java

@@ -34,6 +34,7 @@ import org.geysermc.geyser.network.netty.GeyserInjector;
 import org.geysermc.geyser.network.netty.LocalServerChannelWrapper;
 
 import java.lang.reflect.Field;
+import java.lang.reflect.Method;
 import java.util.function.Supplier;
 
 public class GeyserVelocityInjector extends GeyserInjector {
@@ -67,9 +68,23 @@ public class GeyserVelocityInjector extends GeyserInjector {
         workerGroupField.setAccessible(true);
         EventLoopGroup workerGroup = (EventLoopGroup) workerGroupField.get(connectionManager);
 
+        // This method is what initializes the connection in Java Edition, after Netty is all set.
+        Method initChannel = ChannelInitializer.class.getDeclaredMethod("initChannel", Channel.class);
+        initChannel.setAccessible(true);
+
         ChannelFuture channelFuture = (new ServerBootstrap()
                 .channel(LocalServerChannelWrapper.class)
-                .childHandler(channelInitializer)
+                .childHandler(new ChannelInitializer<>() {
+                    @Override
+                    protected void initChannel(Channel ch) throws Exception {
+                        initChannel.invoke(channelInitializer, ch);
+
+                        if (bootstrap.getGeyserConfig().isDisableCompression() && GeyserVelocityCompressionDisabler.ENABLED) {
+                            ch.pipeline().addAfter("minecraft-encoder", "geyser-compression-disabler",
+                                    new GeyserVelocityCompressionDisabler());
+                        }
+                    }
+                })
                 .group(bossGroup, workerGroup) // Cannot be DefaultEventLoopGroup
                 .childOption(ChannelOption.WRITE_BUFFER_WATER_MARK, serverWriteMark) // Required or else rare network freezes can occur
                 .localAddress(LocalAddress.ANY))

core/src/main/java/org/geysermc/geyser/configuration/GeyserConfiguration.java

@@ -182,6 +182,8 @@ public interface GeyserConfiguration {
 
     boolean isUseDirectConnection();
 
+    boolean isDisableCompression();
+
     int getConfigVersion();
 
     static void checkGeyserConfiguration(GeyserConfiguration geyserConfig, GeyserLogger geyserLogger) {

core/src/main/java/org/geysermc/geyser/configuration/GeyserJacksonConfiguration.java

@@ -275,6 +275,9 @@ public abstract class GeyserJacksonConfiguration implements GeyserConfiguration
     @JsonProperty("use-direct-connection")
     private boolean useDirectConnection = true;
 
+    @JsonProperty("disable-compression")
+    private boolean isDisableCompression = true;
+
     @JsonProperty("config-version")
     private int configVersion = 0;
 

core/src/main/resources/config.yml

@@ -207,4 +207,9 @@ mtu: 1400
 # If disabled on plugin versions, expect performance decrease and latency increase
 use-direct-connection: true
 
+# Whether Geyser should attempt to disable compression for Bedrock players. This should be a benefit as there is no need to compress data
+# when Java packets aren't being handled over the network.
+# This requires use-direct-connection to be true.
+disable-compression: true
+
 config-version: 4