Skip to content

Issue 5676: Introduced the option to fall back to TCP when DNS resolv… #5692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cgm-aw wants to merge 1 commit into
base: 4.x
Choose a base branch
from
Open

Issue 5676: Introduced the option to fall back to TCP when DNS resolv… #5692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/main/generated/io/vertx/core/dns/AddressResolverOptionsConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ static void fromJson(Iterable<java.util.Map.Entry<String, Object>> json, Address
obj.setServers(list);
}
break;
case "useTcpForFallbackDnsResolving":
if (member.getValue() instanceof Boolean) {
obj.setUseTcpForFallbackDnsResolving((Boolean)member.getValue());
}
break;
}
}
}
Expand Down Expand Up @@ -141,5 +146,6 @@ static void toJson(AddressResolverOptions obj, java.util.Map<String, Object> jso
obj.getServers().forEach(item -> array.add(item));
json.put("servers", array);
}
json.put("useTcpForFallbackDnsResolving", obj.isUseTcpForFallbackDnsResolving());
}
}
26 changes: 26 additions & 0 deletions src/main/java/io/vertx/core/dns/AddressResolverOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ public class AddressResolverOptions {
*/
public static final boolean DEFAULT_ROUND_ROBIN_INET_ADDRESS = false;

/**
* The default whether to use TCP for DNS resolving if resolving via UDP times out = false
*/
public static final boolean DEFAULT_USE_TCP_FOR_FALLBACK_DNS_RESOLVING = false;

private String hostsPath;
private Buffer hostsValue;
private int hostsRefreshPeriod;
Expand All @@ -118,6 +123,7 @@ public class AddressResolverOptions {
private int ndots;
private boolean rotateServers;
private boolean roundRobinInetAddress;
private boolean useTcpForFallbackDnsResolving;

public AddressResolverOptions() {
servers = DEFAULT_SERVERS;
Expand All @@ -133,6 +139,7 @@ public AddressResolverOptions() {
rotateServers = DEFAULT_ROTATE_SERVERS;
roundRobinInetAddress = DEFAULT_ROUND_ROBIN_INET_ADDRESS;
hostsRefreshPeriod = DEFAULT_HOSTS_REFRESH_PERIOD;
useTcpForFallbackDnsResolving = DEFAULT_USE_TCP_FOR_FALLBACK_DNS_RESOLVING;
}

public AddressResolverOptions(AddressResolverOptions other) {
Expand All @@ -151,6 +158,7 @@ public AddressResolverOptions(AddressResolverOptions other) {
this.ndots = other.ndots;
this.rotateServers = other.rotateServers;
this.roundRobinInetAddress = other.roundRobinInetAddress;
this.useTcpForFallbackDnsResolving = other.useTcpForFallbackDnsResolving;
}

public AddressResolverOptions(JsonObject json) {
Expand Down Expand Up @@ -496,6 +504,24 @@ public AddressResolverOptions setRoundRobinInetAddress(boolean roundRobinInetAdd
return this;
}

/**
* @return the value {@code true} when using TCP for DNS resolving as a fallback is enabled when resolving via
* UDP times out.
*/
public boolean isUseTcpForFallbackDnsResolving() {
return useTcpForFallbackDnsResolving;
}

/**
* Set to {@code true} to enable using TCP as a fallback for DNS resolving when using UDP times out.
*
* @return a reference to this, so the API can be used fluently
*/
public AddressResolverOptions setUseTcpForFallbackDnsResolving(boolean useTcpForFallbackDnsResolving) {
this.useTcpForFallbackDnsResolving = useTcpForFallbackDnsResolving;
return this;
}

public JsonObject toJson() {
JsonObject json = new JsonObject();
AddressResolverOptionsConverter.toJson(this, json);
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/io/vertx/core/impl/resolver/DnsResolverProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ private DnsResolverProvider(VertxInternal vertx, AddressResolverOptions options)
DnsNameResolverBuilder builder = new DnsNameResolverBuilder();
builder.hostsFileEntriesResolver(this);
builder.channelFactory(() -> vertx.transport().datagramChannel());
builder.socketChannelFactory(() -> (SocketChannel) vertx.transport().channelFactory(false).newChannel());
builder.socketChannelFactory(() -> (SocketChannel) vertx.transport().channelFactory(false).newChannel(),
options.isUseTcpForFallbackDnsResolving());
builder.nameServerProvider(nameServerAddressProvider);
builder.optResourceEnabled(options.isOptResourceEnabled());
builder.resolveCache(resolveCache);
Expand Down
6 changes: 6 additions & 0 deletions src/test/java/io/vertx/core/dns/HostnameResolutionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ public void testOptions() {
assertEquals(AddressResolverOptions.DEFAULT_RD_FLAG, options.getRdFlag());
assertEquals(AddressResolverOptions.DEFAULT_NDOTS, options.getNdots());
assertEquals(AddressResolverOptions.DEFAULT_SEARCH_DOMAINS, options.getSearchDomains());
assertEquals(AddressResolverOptions.DEFAULT_USE_TCP_FOR_FALLBACK_DNS_RESOLVING, options.isUseTcpForFallbackDnsResolving());

boolean optResourceEnabled = TestUtils.randomBoolean();
List<String> servers = Arrays.asList("1.2.3.4", "5.6.7.8");
Expand All @@ -205,11 +206,13 @@ public void testOptions() {
for (int i = 0; i < 2; i++) {
searchDomains.add(TestUtils.randomAlphaString(15));
}
boolean useTcpForFallbackDnsResolving = true;

assertSame(options, options.setOptResourceEnabled(optResourceEnabled));
assertSame(options, options.setServers(new ArrayList<>(servers)));
assertSame(options, options.setCacheMinTimeToLive(0));
assertSame(options, options.setCacheMinTimeToLive(minTTL));
assertSame(options, options.setUseTcpForFallbackDnsResolving(useTcpForFallbackDnsResolving));
try {
options.setCacheMinTimeToLive(-1);
fail("Should throw exception");
Expand Down Expand Up @@ -266,6 +269,7 @@ public void testOptions() {
assertEquals(rdFlag, options.getRdFlag());
assertEquals(ndots, options.getNdots());
assertEquals(searchDomains, options.getSearchDomains());
assertEquals(useTcpForFallbackDnsResolving, options.isUseTcpForFallbackDnsResolving());

// Test copy and json copy
AddressResolverOptions copy = new AddressResolverOptions(options);
Expand Down Expand Up @@ -303,6 +307,7 @@ public void testOptions() {
assertEquals(rdFlag, jsonCopy.getRdFlag());
assertEquals(ndots, jsonCopy.getNdots());
assertEquals(searchDomains, jsonCopy.getSearchDomains());
assertEquals(useTcpForFallbackDnsResolving, jsonCopy.isUseTcpForFallbackDnsResolving());
}

@Test
Expand All @@ -318,6 +323,7 @@ public void testDefaultJsonOptions() {
assertEquals(AddressResolverOptions.DEFAULT_RD_FLAG, options.getRdFlag());
assertEquals(AddressResolverOptions.DEFAULT_SEARCH_DOMAINS, options.getSearchDomains());
assertEquals(AddressResolverOptions.DEFAULT_NDOTS, options.getNdots());
assertEquals(AddressResolverOptions.DEFAULT_USE_TCP_FOR_FALLBACK_DNS_RESOLVING, options.isUseTcpForFallbackDnsResolving());
}

@Test
Expand Down