Fix incorrect channel factory selection for custom EventLoopGroups

j-bahr · j-bahr · commit e4fc1a11e49a · 2026-01-25T12:34:56.000-08:00
`LoopResources.onChannel()` and `onChannelClass()` incorrectly selected channel factories when users provided custom `EventLoopGroups` via `runOn()`. The previous logic only checked if `DefaultLoopNativeDetector.INSTANCE` (the highest-priority available transport) supported the group, falling back to `NIO` otherwise.

This caused issues when, for example, `io_uring` was the default transport but a user explicitly provided an `Epoll` `EventLoopGroup` - the code would incorrectly return `NIO` channel factories instead of `Epoll` ones.

Changes:
  - Add forGroup(EventLoopGroup) method to `DefaultLoopNativeDetector` that checks all available transports (`io_uring`, `epoll`, `kqueue`, `nio`) to find the correct channel factory for any given `EventLoopGroup`
  - Fix `DefaultLoopNIO.supportGroup()` to properly detect `NIO` event loops using `isCompatible(NioIoHandle.class)`, matching the pattern used by other transports
  - Update `onChannel()` and `onChannelClass()` to use `forGroup()` instead of the previous INSTANCE-or-NIO logic

Signed-off-by: Jeff Bahr &lt;jbahr@meta.com&gt;
diff --git a/reactor-netty-core/build.gradle b/reactor-netty-core/build.gradle
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2025 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2026 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -202,12 +202,39 @@ jar {
 	}
 }
 
+// Use the shadow JAR for java11Test and java17Test to ensure multi-release class loading works correctly.
+// The JVM's multi-release feature (selecting classes from META-INF/versions/N/) only works with JAR files,
+// not class directories. Without this, both the Java 8 and Java 11+ versions of DefaultLoopIOUring would
+// be on the classpath as separate directories, causing unpredictable class loading. By using the shadow JAR,
+// the JVM correctly selects the appropriate class version (e.g., Java 11+ io_uring vs Java 8 incubator io_uring).
 java17Test {
-	classpath = sourceSets.main.output + sourceSets.test.runtimeClasspath
+	Set<? super File> mainOutputs = [
+		project.sourceSets.main.output.resourcesDir,
+		project.sourceSets.main.java.classesDirectory,
+	]
+	classpath = shadowJar.outputs.files
+	classpath += sourceSets.test.runtimeClasspath.filter { !(it in mainOutputs) }
 	jvmArgs = ["-XX:+AllowRedefinitionToAddDeleteMethods"]
+	//The imports are not relocated, we do relocation only for the main sources not the tests
+	exclude '**/*PooledConnectionProviderTest*.*'
+	//NativeConfigTest uses Reflections to scan for ChannelHandler implementations and compares
+	//against a static config; shaded classes cause a mismatch
+	exclude '**/*NativeConfigTest*.*'
+	dependsOn(shadowJar)
 }
 java11Test {
-	classpath = sourceSets.main.output + sourceSets.test.runtimeClasspath
+	Set<? super File> mainOutputs = [
+		project.sourceSets.main.output.resourcesDir,
+		project.sourceSets.main.java.classesDirectory,
+	]
+	classpath = shadowJar.outputs.files
+	classpath += sourceSets.test.runtimeClasspath.filter { !(it in mainOutputs) }
+	//The imports are not relocated, we do relocation only for the main sources not the tests
+	exclude '**/*PooledConnectionProviderTest*.*'
+	//NativeConfigTest uses Reflections to scan for ChannelHandler implementations and compares
+	//against a static config; shaded classes cause a mismatch
+	exclude '**/*NativeConfigTest*.*'
+	dependsOn(shadowJar)
 }
 
 components.java.withVariantsFromConfiguration(configurations.testFixturesApiElements) { skip() }
@@ -389,6 +416,9 @@ task shadedJarTest(type: Test) {
 
 	//The imports are not relocated, we do relocation only for the main sources not the tests
 	exclude '**/*PooledConnectionProviderTest*.*'
+	//NativeConfigTest uses Reflections to scan for ChannelHandler implementations and compares
+	//against a static config; shaded classes cause a mismatch
+	exclude '**/*NativeConfigTest*.*'
 
 	dependsOn(shadowJar)
 }
diff --git a/reactor-netty-core/src/main/java/reactor/netty/resources/DefaultLoopNIO.java b/reactor-netty-core/src/main/java/reactor/netty/resources/DefaultLoopNIO.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2025 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2026 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,8 @@
 
 import io.netty.channel.Channel;
 import io.netty.channel.EventLoopGroup;
+import io.netty.channel.IoEventLoopGroup;
+import io.netty.channel.nio.NioIoHandle;
 import io.netty.channel.socket.DatagramChannel;
 import io.netty.channel.socket.ServerSocketChannel;
 import io.netty.channel.socket.SocketChannel;
@@ -77,6 +79,9 @@ public EventLoopGroup newEventLoopGroup(int threads, ThreadFactory factory) {
 
 	@Override
 	public boolean supportGroup(EventLoopGroup group) {
-		return false;
+		if (group instanceof ColocatedEventLoopGroup) {
+			group = ((ColocatedEventLoopGroup) group).get();
+		}
+		return group instanceof IoEventLoopGroup && ((IoEventLoopGroup) group).isCompatible(NioIoHandle.class);
 	}
 }
diff --git a/reactor-netty-core/src/main/java/reactor/netty/resources/DefaultLoopNativeDetector.java b/reactor-netty-core/src/main/java/reactor/netty/resources/DefaultLoopNativeDetector.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2022 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2018-2026 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,6 +15,9 @@
  */
 package reactor.netty.resources;
 
+import io.netty.channel.EventLoopGroup;
+import org.jspecify.annotations.Nullable;
+
 /**
  * Provides an {@link DefaultLoop} instance based on the available transport.
  *
@@ -26,20 +29,58 @@ final class DefaultLoopNativeDetector {
 
 	static final DefaultLoop NIO;
 
+	@Nullable
+	static final DefaultLoop IO_URING;
+
+	@Nullable
+	static final DefaultLoop EPOLL;
+
+	@Nullable
+	static final DefaultLoop KQUEUE;
+
 	static {
 		NIO = new DefaultLoopNIO();
+		IO_URING = DefaultLoopIOUring.isIoUringAvailable ? new DefaultLoopIOUring() : null;
+		EPOLL = DefaultLoopEpoll.isEpollAvailable ? new DefaultLoopEpoll() : null;
+		KQUEUE = DefaultLoopKQueue.isKqueueAvailable ? new DefaultLoopKQueue() : null;
 
-		if (DefaultLoopIOUring.isIoUringAvailable) {
-			INSTANCE = new DefaultLoopIOUring();
+		if (IO_URING != null) {
+			INSTANCE = IO_URING;
 		}
-		else if (DefaultLoopEpoll.isEpollAvailable) {
-			INSTANCE = new DefaultLoopEpoll();
+		else if (EPOLL != null) {
+			INSTANCE = EPOLL;
 		}
-		else if (DefaultLoopKQueue.isKqueueAvailable) {
-			INSTANCE = new DefaultLoopKQueue();
+		else if (KQUEUE != null) {
+			INSTANCE = KQUEUE;
 		}
 		else {
 			INSTANCE = NIO;
 		}
 	}
+
+	/**
+	 * Finds the correct {@link DefaultLoop} for the given {@link EventLoopGroup}.
+	 * This method checks all available native transports to find one that supports
+	 * the provided group, falling back to NIO if none match.
+	 *
+	 * @param group the event loop group to find a matching channel factory for
+	 * @return the appropriate {@link DefaultLoop} for the group
+	 */
+	static DefaultLoop forGroup(EventLoopGroup group) {
+		// Check each available native transport in priority order
+		if (IO_URING != null && IO_URING.supportGroup(group)) {
+			return IO_URING;
+		}
+		if (EPOLL != null && EPOLL.supportGroup(group)) {
+			return EPOLL;
+		}
+		if (KQUEUE != null && KQUEUE.supportGroup(group)) {
+			return KQUEUE;
+		}
+		if (NIO.supportGroup(group)) {
+			return NIO;
+		}
+		// Fallback to NIO for unknown group types
+		return NIO;
+	}
 }
diff --git a/reactor-netty-core/src/main/java/reactor/netty/resources/LoopResources.java b/reactor-netty-core/src/main/java/reactor/netty/resources/LoopResources.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2025 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2011-2026 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -235,12 +235,7 @@ default Mono<Void> disposeLater(Duration quietPeriod, Duration timeout) {
 	 * @return a {@link Channel} instance
 	 */
 	default <CHANNEL extends Channel> CHANNEL onChannel(Class<CHANNEL> channelType, EventLoopGroup group) {
-		DefaultLoop channelFactory =
-				DefaultLoopNativeDetector.INSTANCE.supportGroup(group) ?
-						DefaultLoopNativeDetector.INSTANCE :
-						DefaultLoopNativeDetector.NIO;
-
-		return channelFactory.getChannel(channelType);
+		return DefaultLoopNativeDetector.forGroup(group).getChannel(channelType);
 	}
 
 	/**
@@ -252,12 +247,7 @@ default <CHANNEL extends Channel> CHANNEL onChannel(Class<CHANNEL> channelType,
 	 * @return a {@link Channel} class
 	 */
 	default <CHANNEL extends Channel> Class<? extends CHANNEL> onChannelClass(Class<CHANNEL> channelType, EventLoopGroup group) {
-		DefaultLoop channelFactory =
-				DefaultLoopNativeDetector.INSTANCE.supportGroup(group) ?
-						DefaultLoopNativeDetector.INSTANCE :
-						DefaultLoopNativeDetector.NIO;
-
-		return channelFactory.getChannelClass(channelType);
+		return DefaultLoopNativeDetector.forGroup(group).getChannelClass(channelType);
 	}
 
 	/**
diff --git a/reactor-netty-core/src/main/java17/reactor/netty/resources/DefaultLoopNIO.java b/reactor-netty-core/src/main/java17/reactor/netty/resources/DefaultLoopNIO.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2025 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2026 VMware, Inc. or its affiliates, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,8 @@
 
 import io.netty.channel.Channel;
 import io.netty.channel.EventLoopGroup;
+import io.netty.channel.IoEventLoopGroup;
+import io.netty.channel.nio.NioIoHandle;
 import io.netty.channel.socket.DatagramChannel;
 import io.netty.channel.socket.ServerSocketChannel;
 import io.netty.channel.socket.SocketChannel;
@@ -87,6 +89,9 @@ public EventLoopGroup newEventLoopGroup(int threads, ThreadFactory factory) {
 
 	@Override
 	public boolean supportGroup(EventLoopGroup group) {
-		return false;
+		if (group instanceof ColocatedEventLoopGroup) {
+			group = ((ColocatedEventLoopGroup) group).get();
+		}
+		return group instanceof IoEventLoopGroup && ((IoEventLoopGroup) group).isCompatible(NioIoHandle.class);
 	}
 }
diff --git a/reactor-netty-core/src/test/java/reactor/netty/resources/DefaultLoopResourcesTest.java b/reactor-netty-core/src/test/java/reactor/netty/resources/DefaultLoopResourcesTest.java
