Allow for the entire UDP pipeline to be disabled

Author: ryanhcode

common/src/main/java/dev/ryanhcode/sable/SableConfig.java

@@ -15,6 +15,7 @@ public final class SableConfig {
     public static final ModConfigSpec.DoubleValue SUB_LEVEL_PUNCH_STRENGTH_MULTIPLIER;
     public static final ModConfigSpec.DoubleValue SUB_LEVEL_PUNCH_DOWNWARD_STRENGTH_MULTIPLIER;
     public static final ModConfigSpec.IntValue SUB_LEVEL_PUNCH_COOLDOWN_TICKS;
+    public static final ModConfigSpec.BooleanValue DISABLE_UDP_PIPELINE;
     public static final ModConfigSpec.BooleanValue ATTEMPT_UDP_NETWORKING;
 
     static {
@@ -49,6 +50,9 @@ public final class SableConfig {
         SUB_LEVEL_PUNCH_COOLDOWN_TICKS = builder
                 .comment("The cooldown in ticks between sub-level punches")
                 .defineInRange("sub_level_punch_cooldown_ticks", 3, 0, Integer.MAX_VALUE);
+        DISABLE_UDP_PIPELINE = builder
+                .comment("If the entire Sable UDP Networking pipeline should be disabled. This can improve compatibility with certain mods like Replay mod and certain networking setups, but will have worse performance and latency for networking sub-levels.")
+                .define("disable_udp_pipeline", false);
         ATTEMPT_UDP_NETWORKING = builder
                 .comment("If Sable should attempt to authenticate with clients and send them sub-level data over UDP")
                 .define("attempt_udp_networking", true);

common/src/main/java/dev/ryanhcode/sable/command/SableCommand.java

@@ -52,7 +52,12 @@ public static void register(final CommandDispatcher<CommandSourceStack> dispatch
         sableBuilder
                 .then(debugBuilder
                         .then(Commands.literal("udp_test").executes(ctx -> {
-                            SableUDPServer.sendPacket(ctx.getSource().getPlayerOrException(), new SableUDPEchoPacket("Skibidi Toilet"), true);
+                            final SableUDPServer server = SableUDPServer.getServer(ctx.getSource().getServer());
+
+                            if (server != null) {
+                                server.sendUDPPacket(ctx.getSource().getPlayerOrException(), new SableUDPEchoPacket("Skibidi Toilet"), true);
+                            }
+
                             return 1;
                         }))
                 );

common/src/main/java/dev/ryanhcode/sable/mixin/udp/ClientCommonPacketListenerImplMixin.java

@@ -19,7 +19,9 @@ public class MinecraftServerMixin {
     @Inject(method = "tickServer", at = @At("TAIL"))
     private void sable$keepUdpSocketsAlive(final BooleanSupplier booleanSupplier, final CallbackInfo ci) {
         final SableUDPServer server = SableUDPServer.getServer((MinecraftServer) (Object) this);
-        if (server == null) return;
+        if (server == null) {
+            return;
+        }
 
         final long time = System.currentTimeMillis();
 

common/src/main/java/dev/ryanhcode/sable/mixin/udp/MinecraftServerMixin.java

@@ -19,8 +19,14 @@ public class PlayerListMixin {
 
     @Inject(method = "placeNewPlayer", at = @At(value = "INVOKE", target = "Lnet/minecraft/server/network/ServerGamePacketListenerImpl;send(Lnet/minecraft/network/protocol/Packet;)V", ordinal = 0, shift = At.Shift.AFTER))
     private void onPlayerJoin(final Connection connection, final ServerPlayer serverPlayer, final CommonListenerCookie commonListenerCookie, final CallbackInfo ci) {
+        final SableUDPServer server = SableUDPServer.getServer(serverPlayer.server);
+
+        if (server == null) {
+            return;
+        }
+
         Sable.LOGGER.info("Beginning attempted authentication with player {}", serverPlayer.getName().getString());
-        SableUDPServer.getServer(serverPlayer.server).beginAuthentication(serverPlayer);
+        server.beginAuthentication(serverPlayer);
     }
 
 }

common/src/main/java/dev/ryanhcode/sable/mixin/udp/PlayerListMixin.java

@@ -1,6 +1,7 @@
 package dev.ryanhcode.sable.mixin.udp;
 
 import dev.ryanhcode.sable.Sable;
+import dev.ryanhcode.sable.SableConfig;
 import dev.ryanhcode.sable.mixinterface.udp.ServerConnectionListenerExtension;
 import dev.ryanhcode.sable.network.udp.SableUDPPacket;
 import dev.ryanhcode.sable.network.udp.SableUDPServer;
@@ -15,6 +16,7 @@
 import net.minecraft.network.protocol.PacketFlow;
 import net.minecraft.server.MinecraftServer;
 import net.minecraft.server.network.ServerConnectionListener;
+import org.jetbrains.annotations.Nullable;
 import org.spongepowered.asm.mixin.Final;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
@@ -37,13 +39,17 @@ public class ServerConnectionListenerMixin implements ServerConnectionListenerEx
 
     @Shadow
     @Final
-    MinecraftServer server;
+    private MinecraftServer server;
 
     @Unique
     private SableUDPServer sable$server = null;
 
     @Inject(method = "startTcpServerListener", at = @At("HEAD"))
     private void sable$startTcpServerListener(final InetAddress inetAddress, final int port, final CallbackInfo ci) {
+        if (SableConfig.DISABLE_UDP_PIPELINE.get()) {
+            return;
+        }
+
         synchronized (this.channels) {
             final Class<? extends Channel> channelClass;
             final EventLoopGroup eventLoopGroup;
@@ -77,6 +83,10 @@ protected void initChannel(final Channel channel) {
 
     @Inject(method = "startMemoryChannel", at = @At("TAIL"))
     private void sable$startMemoryChannel(final CallbackInfoReturnable<SocketAddress> cir) {
+        if (SableConfig.DISABLE_UDP_PIPELINE.get()) {
+            return;
+        }
+
         synchronized (this.channels) {
             Sable.LOGGER.info("Adding local UDP server channel future");
 
@@ -115,6 +125,7 @@ protected void initChannel(final Channel channel) {
     }
 
     @Override
+    @Nullable
     public SableUDPServer sable$getServer() {
         return this.sable$server;
     }

common/src/main/java/dev/ryanhcode/sable/mixin/udp/ServerConnectionListenerMixin.java

@@ -2,9 +2,11 @@
 
 import dev.ryanhcode.sable.network.udp.SableUDPServer;
 import io.netty.channel.Channel;
+import org.jetbrains.annotations.Nullable;
 
 public interface ServerConnectionListenerExtension {
     void sable$setupUDPServer(Channel channel);
 
+    @Nullable
     SableUDPServer sable$getServer();
 }

common/src/main/java/dev/ryanhcode/sable/mixinterface/udp/ServerConnectionListenerExtension.java

@@ -20,6 +20,10 @@ public SableUDPPacketType getType() {
 
     @Override
     public void handleServer(final MinecraftServer server, final InetSocketAddress sender) {
-        SableUDPServer.getServer(server).receiveAuthenticationPacket(UUID.fromString(this.token), sender);
+        final SableUDPServer udpServer = SableUDPServer.getServer(server);
+
+        if (udpServer != null) {
+            udpServer.receiveAuthenticationPacket(UUID.fromString(this.token), sender);
+        }
     }
 }

common/src/main/java/dev/ryanhcode/sable/network/packets/udp/SableUDPAuthenticationPacket.java

@@ -19,6 +19,10 @@ public SableUDPPacketType getType() {
 
     @Override
     public void handleServer(final MinecraftServer server, final InetSocketAddress sender) {
-        SableUDPServer.getServer(server).receiveAlivePacket(sender);
+        final SableUDPServer udpServer = SableUDPServer.getServer(server);
+
+        if (udpServer != null) {
+            udpServer.receiveAlivePacket(sender);
+        }
     }
 }

common/src/main/java/dev/ryanhcode/sable/network/packets/udp/SableUDPServerboundAlivePacket.java

@@ -18,6 +18,7 @@
 import net.minecraft.server.MinecraftServer;
 import net.minecraft.server.level.ServerPlayer;
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Nullable;
 
 import java.net.InetSocketAddress;
 import java.util.*;
@@ -42,14 +43,11 @@ public SableUDPServer(final MinecraftServer server, final Channel channel) {
         this.udpAuthStates = new WeakHashMap<>();
     }
 
-    public static boolean sendPacket(final ServerPlayer player, final SableUDPPacket packet, final boolean flush) {
-        return getServer(player.server).sendUDPPacket(player, packet, flush);
-    }
-
     /**
      * Retrieves the current instance of the UDP server from a {@link MinecraftServer}
      */
     @ApiStatus.Internal
+    @Nullable
     public static SableUDPServer getServer(final MinecraftServer server) {
         return (((ServerConnectionListenerExtension) server.getConnection())).sable$getServer();
     }
@@ -93,7 +91,7 @@ public boolean isConnectedTo(final ServerPlayer player) {
      * @param flush  whether to flush the packet immediately
      * @return if the packet has been successfully sent
      */
-    private boolean sendUDPPacket(final ServerPlayer player, final SableUDPPacket packet, final boolean flush) {
+    public boolean sendUDPPacket(final ServerPlayer player, final SableUDPPacket packet, final boolean flush) {
         if (this.channel.eventLoop().inEventLoop())
             throw new IllegalStateException("Cannot send packet from event loop");