Enable DNS retryOnTimeout with TCP (#3063)

Add an API for configuring the resolver to fallback to TCP if a timeout is detected.
By default, the resolver will only try to use TCP if the response is marked as truncated.

Fixes #3059

docs/asciidoc/http-client.adoc

@@ -564,6 +564,8 @@ Default: -1 (to determine the value from the OS on Unix or use a value of 1 othe
 | `queryTimeout` | Sets the timeout of each DNS query performed by this resolver (resolution: milliseconds). Default: 5000.
 | `resolveCache` | The cache to use to store resolved DNS entries.
 | `resolvedAddressTypes` | The list of the protocol families of the resolved address.
+| `retryTcpOnTimeout` | Specifies whether this resolver will also fallback to TCP if a timeout is detected.
+By default, the resolver will only try to use TCP if the response is marked as truncated.
 | `roundRobinSelection` | Enables an
 {nettyjavadoc}/io/netty/resolver/AddressResolverGroup.html[`AddressResolverGroup`] of
 {nettyjavadoc}/io/netty/resolver/dns/DnsNameResolver.html[`DnsNameResolver`] that supports random selection

docs/asciidoc/tcp-client.adoc

@@ -418,6 +418,8 @@ Default: {nettyjavadoc}/io/netty/resolver/DefaultHostsFileEntriesResolver.html[`
 | `queryTimeout` | Sets the timeout of each DNS query performed by this resolver (resolution: milliseconds). Default: 5000.
 | `resolveCache` | The cache to use to store resolved DNS entries.
 | `resolvedAddressTypes` | The list of the protocol families of the resolved address.
+| `retryTcpOnTimeout` | Specifies whether this resolver will also fallback to TCP if a timeout is detected.
+By default, the resolver will only try to use TCP if the response is marked as truncated.
 | `roundRobinSelection` | Enables an
  {nettyjavadoc}/io/netty/resolver/AddressResolverGroup.html[`AddressResolverGroup`] of
  {nettyjavadoc}/io/netty/resolver/dns/DnsNameResolver.html[`DnsNameResolver`] that supports random selection

reactor-netty-core/build.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2020-2024 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.
@@ -240,6 +240,8 @@ task japicmp(type: JapicmpTask) {
 	compatibilityChangeExcludes = [ "METHOD_NEW_DEFAULT" ]
 
 	methodExcludes = [
+			'reactor.netty.transport.NameResolverProvider#retryTcpOnTimeout()',
+			'reactor.netty.transport.NameResolverProvider$NameResolverSpec#retryTcpOnTimeout(boolean)'
 	]
 }
 

reactor-netty-core/src/main/java/reactor/netty/transport/NameResolverProvider.java

@@ -210,6 +210,17 @@ NameResolverSpec dnsAddressResolverGroupProvider(
 		 */
 		NameResolverSpec resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes);
 
+		/**
+		 * Specifies whether this resolver will also fallback to TCP if a timeout is detected.
+		 * By default, the resolver will only try to use TCP if the response is marked as truncated.
+		 *
+		 * @param enable if true this resolver will also fallback to TCP if a timeout is detected,
+		 * if false the resolver will only try to use TCP if the response is marked as truncated.
+		 * @return {@code this}
+		 * @since 1.1.17
+		 */
+		NameResolverSpec retryTcpOnTimeout(boolean enable);
+
 		/**
 		 * Enables an {@link AddressResolverGroup} of {@link DnsNameResolver}s that supports random selection
 		 * of destination addresses if multiple are provided by the nameserver.
@@ -378,6 +389,16 @@ public boolean isPreferNative() {
 		return preferNative;
 	}
 
+	/**
+	 * Returns {@code true} if the resolver will also fallback to TCP if a timeout is detected.
+	 *
+	 * @return {@code true} if the resolver will also fallback to TCP if a timeout is detected
+	 * @since 1.1.17
+	 */
+	public boolean isRetryTcpOnTimeout() {
+		return retryTcpOnTimeout;
+	}
+
 	/**
 	 * Returns true if {@link RoundRobinDnsAddressResolverGroup} is in use.
 	 *
@@ -491,6 +512,7 @@ public boolean equals(Object o) {
 				queryTimeout.equals(that.queryTimeout) &&
 				Objects.equals(resolveCache, that.resolveCache) &&
 				resolvedAddressTypes == that.resolvedAddressTypes &&
+				retryTcpOnTimeout == that.retryTcpOnTimeout &&
 				roundRobinSelection == that.roundRobinSelection &&
 				// searchDomains is List so Objects.equals is OK
 				Objects.equals(searchDomains, that.searchDomains);
@@ -516,6 +538,7 @@ public int hashCode() {
 		result = 31 * result + Objects.hashCode(queryTimeout);
 		result = 31 * result + Objects.hashCode(resolveCache);
 		result = 31 * result + Objects.hashCode(resolvedAddressTypes);
+		result = 31 * result + Boolean.hashCode(retryTcpOnTimeout);
 		result = 31 * result + Boolean.hashCode(roundRobinSelection);
 		result = 31 * result + Objects.hashCode(searchDomains);
 		return result;
@@ -551,7 +574,7 @@ public DnsAddressResolverGroup newNameResolverGroup(LoopResources defaultLoopRes
 				.queryTimeoutMillis(queryTimeout.toMillis())
 				.eventLoop(group.next())
 				.channelFactory(() -> loop.onChannel(DatagramChannel.class, group))
-				.socketChannelFactory(() -> loop.onChannel(SocketChannel.class, group));
+				.socketChannelFactory(() -> loop.onChannel(SocketChannel.class, group), retryTcpOnTimeout);
 		if (bindAddressSupplier != null) {
 			// There is no check for bindAddressSupplier.get() == null
 			// This is deliberate, when null value is provided Netty will use the default behaviour
@@ -596,6 +619,7 @@ public DnsAddressResolverGroup newNameResolverGroup(LoopResources defaultLoopRes
 	final Duration queryTimeout;
 	final DnsCache resolveCache;
 	final ResolvedAddressTypes resolvedAddressTypes;
+	final boolean retryTcpOnTimeout;
 	final boolean roundRobinSelection;
 	final Iterable<String> searchDomains;
 
@@ -618,6 +642,7 @@ public DnsAddressResolverGroup newNameResolverGroup(LoopResources defaultLoopRes
 		this.queryTimeout = build.queryTimeout;
 		this.resolveCache = build.resolveCache;
 		this.resolvedAddressTypes = build.resolvedAddressTypes;
+		this.retryTcpOnTimeout = build.retryTcpOnTimeout;
 		this.roundRobinSelection = build.roundRobinSelection;
 		this.searchDomains = build.searchDomains;
 	}
@@ -650,6 +675,7 @@ static final class Build implements NameResolverSpec {
 		Duration queryTimeout = DEFAULT_QUERY_TIMEOUT;
 		DnsCache resolveCache;
 		ResolvedAddressTypes resolvedAddressTypes;
+		boolean retryTcpOnTimeout;
 		boolean roundRobinSelection;
 		Iterable<String> searchDomains;
 
@@ -755,6 +781,12 @@ public NameResolverSpec resolvedAddressTypes(ResolvedAddressTypes resolvedAddres
 			return this;
 		}
 
+		@Override
+		public NameResolverSpec retryTcpOnTimeout(boolean enable) {
+			this.retryTcpOnTimeout = enable;
+			return this;
+		}
+
 		@Override
 		public NameResolverSpec roundRobinSelection(boolean enable) {
 			this.roundRobinSelection = enable;

reactor-netty-core/src/test/java/reactor/netty/transport/NameResolverProviderTest.java

@@ -273,6 +273,14 @@ void resolvedAddressTypesBadValues() {
 				.isThrownBy(() -> builder.resolvedAddressTypes(null));
 	}
 
+	@Test
+	void retryTcpOnTimeout() {
+		assertThat(builder.build().isRetryTcpOnTimeout()).isFalse();
+
+		builder.retryTcpOnTimeout(true);
+		assertThat(builder.build().isRetryTcpOnTimeout()).isTrue();
+	}
+
 	@Test
 	void roundRobinSelection() {
 		assertThat(builder.build().isRoundRobinSelection()).isFalse();