Skip to content

spring.data.redis.cluster.nodes and spring.data.redis.sentinel.nodes do not handle IPv6 addresses correctly #39819

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

Closed
wants to merge 2 commits into from
Closed

spring.data.redis.cluster.nodes and spring.data.redis.sentinel.nodes do not handle IPv6 addresses correctly #39819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e705def
Fix handling of nodes with IPv6 addresses for Redis sentinel and clus…
tobi-laa Mar 1, 2024
0b809bc
Keep surrounding brackets and replace var with full type name in Redi…
tobi-laa Mar 19, 2024
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: 4 additions & 2 deletions ...a/org/springframework/boot/autoconfigure/data/redis/PropertiesRedisConnectionDetails.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@ public Cluster getCluster() {
}

private Node asNode(String node) {
String[] components = node.split(":");
return new Node(components[0], Integer.parseInt(components[1]));
int portSeparatorIndex = node.lastIndexOf(':');
String host = node.substring(0, portSeparatorIndex);
int port = Integer.parseInt(node.substring(portSeparatorIndex + 1));
return new Node(host, port);
}

}
4 changes: 2 additions & 2 deletions .../java/org/springframework/boot/autoconfigure/data/redis/RedisConnectionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ protected final RedisClusterConfiguration getClusterConfiguration() {
}

private List<String> getNodes(Cluster cluster) {
return cluster.getNodes().stream().map((node) -> "%s:%d".formatted(node.host(), node.port())).toList();
return cluster.getNodes().stream().map(Node::asString).toList();
}

protected final RedisProperties getProperties() {
Expand All @@ -162,7 +162,7 @@ protected boolean isPoolEnabled(Pool pool) {
private List<RedisNode> createSentinels(Sentinel sentinel) {
List<RedisNode> nodes = new ArrayList<>();
for (Node node : sentinel.getNodes()) {
nodes.add(new RedisNode(node.host(), node.port()));
nodes.add(RedisNode.fromString(node.asString()));
}
return nodes;
}
Expand Down
3 changes: 3 additions & 0 deletions ...c/main/java/org/springframework/boot/autoconfigure/data/redis/RedisConnectionDetails.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ interface Cluster {
*/
record Node(String host, int port) {

String asString() {
return this.host + ":" + this.port;
}
}

}
17 changes: 14 additions & 3 deletions .../springframework/boot/autoconfigure/data/redis/PropertiesRedisConnectionDetailsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,23 @@ void standaloneIsConfiguredFromProperties() {
@Test
void clusterIsConfigured() {
RedisProperties.Cluster cluster = new RedisProperties.Cluster();
cluster.setNodes(List.of("first:1111", "second:2222", "third:3333"));
cluster.setNodes(List.of("localhost:1111", "127.0.0.1:2222", "[::1]:3333"));
this.properties.setCluster(cluster);
PropertiesRedisConnectionDetails connectionDetails = new PropertiesRedisConnectionDetails(this.properties);
assertThat(connectionDetails.getCluster().getNodes()).containsExactly(
new RedisConnectionDetails.Node("first", 1111), new RedisConnectionDetails.Node("second", 2222),
new RedisConnectionDetails.Node("third", 3333));
new RedisConnectionDetails.Node("localhost", 1111), new RedisConnectionDetails.Node("127.0.0.1", 2222),
new RedisConnectionDetails.Node("[::1]", 3333));
}

@Test
void sentinelIsConfigured() {
RedisProperties.Sentinel sentinel = new RedisProperties.Sentinel();
sentinel.setNodes(List.of("localhost:1111", "127.0.0.1:2222", "[::1]:3333"));
this.properties.setSentinel(sentinel);
PropertiesRedisConnectionDetails connectionDetails = new PropertiesRedisConnectionDetails(this.properties);
assertThat(connectionDetails.getSentinel().getNodes()).containsExactly(
new RedisConnectionDetails.Node("localhost", 1111), new RedisConnectionDetails.Node("127.0.0.1", 2222),
new RedisConnectionDetails.Node("[::1]", 3333));
}

}
22 changes: 14 additions & 8 deletions ...t/java/org/springframework/boot/autoconfigure/data/redis/RedisAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,8 +312,14 @@ void testRedisConfigurationWithIpv6Sentinel() {
this.contextRunner
.withPropertyValues("spring.data.redis.sentinel.master:mymaster",
"spring.data.redis.sentinel.nodes:" + StringUtils.collectionToCommaDelimitedString(sentinels))
.run((context) -> assertThat(context.getBean(LettuceConnectionFactory.class).isRedisSentinelAware())
.isTrue());
.run((context) -> {
assertThat(context.getBean(LettuceConnectionFactory.class).isRedisSentinelAware()).isTrue();
assertThat(context.getBean(LettuceConnectionFactory.class).getSentinelConfiguration()).isNotNull();
assertThat(context.getBean(LettuceConnectionFactory.class).getSentinelConfiguration().getSentinels())
.isNotNull()
.extracting(RedisNode::toString)
.containsExactlyInAnyOrder("[0:0:0:0:0:0:0:1]:26379", "[0:0:0:0:0:0:0:1]:26380");
});
}

@Test
Expand Down Expand Up @@ -398,17 +404,17 @@ void testRedisSentinelUrlConfiguration() {

@Test
void testRedisConfigurationWithCluster() {
List<String> clusterNodes = Arrays.asList("127.0.0.1:27379", "127.0.0.1:27380");
List<String> clusterNodes = Arrays.asList("127.0.0.1:27379", "127.0.0.1:27380", "[::1]:27381");
this.contextRunner
.withPropertyValues("spring.data.redis.cluster.nodes[0]:" + clusterNodes.get(0),
"spring.data.redis.cluster.nodes[1]:" + clusterNodes.get(1))
"spring.data.redis.cluster.nodes[1]:" + clusterNodes.get(1),
"spring.data.redis.cluster.nodes[2]:" + clusterNodes.get(2))
.run((context) -> {
RedisClusterConfiguration clusterConfiguration = context.getBean(LettuceConnectionFactory.class)
.getClusterConfiguration();
assertThat(clusterConfiguration.getClusterNodes()).hasSize(2);
assertThat(clusterConfiguration.getClusterNodes())
.extracting((node) -> node.getHost() + ":" + node.getPort())
.containsExactlyInAnyOrder("127.0.0.1:27379", "127.0.0.1:27380");
assertThat(clusterConfiguration.getClusterNodes()).hasSize(3);
assertThat(clusterConfiguration.getClusterNodes()).extracting(RedisNode::asString)
.containsExactlyInAnyOrder("127.0.0.1:27379", "127.0.0.1:27380", "[::1]:27381");
});

}
Expand Down