Redis Client: add support for the Proxy Registry

Author: Ladicek

extensions/redis-client/deployment/pom.xml

@@ -31,6 +31,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-tls-registry-deployment</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-proxy-registry-deployment</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-redis-client</artifactId>

extensions/redis-client/deployment/src/main/java/io/quarkus/redis/deployment/client/RedisClientProcessor.java

@@ -43,6 +43,7 @@
 import io.quarkus.deployment.builditem.ShutdownContextBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
+import io.quarkus.proxy.deployment.ProxyRegistryBuildItem;
 import io.quarkus.redis.client.RedisClient;
 import io.quarkus.redis.client.RedisClientName;
 import io.quarkus.redis.client.RedisHostsProvider;
@@ -128,7 +129,8 @@ public void init(
             ApplicationArchivesBuildItem applicationArchivesBuildItem, LaunchModeBuildItem launchMode,
             BuildProducer<NativeImageResourceBuildItem> nativeImageResources,
             BuildProducer<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFiles,
-            TlsRegistryBuildItem tlsRegistryBuildItem) {
+            TlsRegistryBuildItem tlsRegistryBuildItem,
+            ProxyRegistryBuildItem proxyRegistryBuildItem) {
 
         // Collect the used redis clients, the unused clients will not be instantiated.
         Set<String> names = new HashSet<>();
@@ -157,7 +159,8 @@ public void init(
                 .ifPresent(x -> names.addAll(configuredClientNames(buildTimeConfig, ConfigProvider.getConfig())));
 
         // Inject the creation of the client when the application starts.
-        recorder.initialize(vertxBuildItem.getVertx(), names, tlsRegistryBuildItem.registry());
+        recorder.initialize(vertxBuildItem.getVertx(), names, tlsRegistryBuildItem.registry(),
+                proxyRegistryBuildItem.registry());
 
         // Create the supplier and define the beans.
         for (String name : names) {

extensions/redis-client/deployment/src/main/java/io/quarkus/redis/deployment/client/RedisDatasourceProcessor.java

@@ -27,6 +27,7 @@
 import io.quarkus.deployment.annotations.Record;
 import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
 import io.quarkus.deployment.builditem.ShutdownContextBuildItem;
+import io.quarkus.proxy.deployment.ProxyRegistryBuildItem;
 import io.quarkus.redis.datasource.ReactiveRedisDataSource;
 import io.quarkus.redis.datasource.RedisDataSource;
 import io.quarkus.redis.datasource.codecs.Codec;
@@ -86,7 +87,8 @@ public void init(RedisClientRecorder recorder,
             ShutdownContextBuildItem shutdown,
             BuildProducer<SyntheticBeanBuildItem> syntheticBeans,
             VertxBuildItem vertxBuildItem,
-            TlsRegistryBuildItem tlsRegistryBuildItem) {
+            TlsRegistryBuildItem tlsRegistryBuildItem,
+            ProxyRegistryBuildItem proxyRegistryBuildItem) {
 
         if (clients.isEmpty()) {
             return;
@@ -96,7 +98,8 @@ public void init(RedisClientRecorder recorder,
             names.add(client.name);
         }
         // Inject the creation of the client when the application starts.
-        recorder.initialize(vertxBuildItem.getVertx(), names, tlsRegistryBuildItem.registry());
+        recorder.initialize(vertxBuildItem.getVertx(), names, tlsRegistryBuildItem.registry(),
+                proxyRegistryBuildItem.registry());
 
         // Create the supplier and define the beans.
         for (String name : names) {

extensions/redis-client/runtime/pom.xml

@@ -27,6 +27,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-tls-registry</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-proxy-registry</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.smallrye.reactive</groupId>
             <artifactId>smallrye-mutiny-vertx-redis-client</artifactId>

extensions/redis-client/runtime/src/main/java/io/quarkus/redis/runtime/client/RedisClientRecorder.java

@@ -13,6 +13,7 @@
 import jakarta.enterprise.inject.Instance;
 import jakarta.enterprise.inject.spi.CDI;
 
+import io.quarkus.proxy.ProxyConfigurationRegistry;
 import io.quarkus.redis.client.RedisClient;
 import io.quarkus.redis.client.reactive.ReactiveRedisClient;
 import io.quarkus.redis.datasource.ReactiveRedisDataSource;
@@ -49,7 +50,8 @@ public RedisClientRecorder(RuntimeValue<RedisConfig> rc) {
     }
 
     public void initialize(RuntimeValue<io.vertx.core.Vertx> vertx, Set<String> names,
-            Supplier<TlsConfigurationRegistry> registry) {
+            Supplier<TlsConfigurationRegistry> tlsRegistrySupplier,
+            Supplier<ProxyConfigurationRegistry> proxyRegistrySupplier) {
         Instance<ObservableRedisMetrics> instance = CDI.current().select(ObservableRedisMetrics.class);
         if (instance.isResolvable()) {
             this.metrics = instance.get();
@@ -59,11 +61,12 @@ public void initialize(RuntimeValue<io.vertx.core.Vertx> vertx, Set<String> name
 
         this.vertx = Vertx.newInstance(vertx.getValue());
 
-        TlsConfigurationRegistry tlsRegistry = registry.get();
+        TlsConfigurationRegistry tlsRegistry = tlsRegistrySupplier.get();
+        ProxyConfigurationRegistry proxyRegistry = proxyRegistrySupplier.get();
 
         _registerCodecs();
 
-        _initialize(vertx.getValue(), names, tlsRegistry);
+        _initialize(vertx.getValue(), names, tlsRegistry, proxyRegistry);
     }
 
     private static void _registerCodecs() {
@@ -72,7 +75,8 @@ private static void _registerCodecs() {
         Codecs.register(codecs.stream());
     }
 
-    public void _initialize(io.vertx.core.Vertx vertx, Set<String> names, TlsConfigurationRegistry tlsRegistry) {
+    public void _initialize(io.vertx.core.Vertx vertx, Set<String> names, TlsConfigurationRegistry tlsRegistry,
+            ProxyConfigurationRegistry proxyRegistry) {
         for (String name : names) {
             // Search if we have an associated config:
             // - if default -> Default
@@ -91,13 +95,13 @@ public ConfigurationException get() {
                                         "You must at least configure `quarkus.redis." + name + ".hosts`.");
                             }
                         });
-                clients.computeIfAbsent(name,
-                        x -> new RedisClientAndApi(name, VertxRedisClientFactory.create(name, vertx, actualConfig, tlsRegistry),
-                                metrics));
+                clients.computeIfAbsent(name, x -> new RedisClientAndApi(name,
+                        VertxRedisClientFactory.create(name, vertx, actualConfig, tlsRegistry, proxyRegistry),
+                        metrics));
             } else if (DEFAULT_CLIENT_NAME.equalsIgnoreCase(name) && maybe.isPresent()) {
-                clients.computeIfAbsent(name,
-                        x -> new RedisClientAndApi(name,
-                                VertxRedisClientFactory.create(DEFAULT_CLIENT_NAME, vertx, maybe.get(), tlsRegistry), metrics));
+                clients.computeIfAbsent(name, x -> new RedisClientAndApi(name,
+                        VertxRedisClientFactory.create(DEFAULT_CLIENT_NAME, vertx, maybe.get(), tlsRegistry, proxyRegistry),
+                        metrics));
             }
             // Do not throw an error. We would need to check if the default redis client is used.
         }

extensions/redis-client/runtime/src/main/java/io/quarkus/redis/runtime/client/VertxRedisClientFactory.java

@@ -21,6 +21,8 @@
 import io.quarkus.arc.ArcContainer;
 import io.quarkus.arc.InjectableInstance;
 import io.quarkus.arc.InstanceHandle;
+import io.quarkus.proxy.ProxyConfiguration;
+import io.quarkus.proxy.ProxyConfigurationRegistry;
 import io.quarkus.redis.client.RedisHostsProvider;
 import io.quarkus.redis.client.RedisOptionsCustomizer;
 import io.quarkus.redis.runtime.client.config.NetConfig;
@@ -33,6 +35,7 @@
 import io.vertx.core.Vertx;
 import io.vertx.core.net.NetClientOptions;
 import io.vertx.core.net.ProxyOptions;
+import io.vertx.core.net.ProxyType;
 import io.vertx.redis.client.Redis;
 import io.vertx.redis.client.RedisClientType;
 import io.vertx.redis.client.RedisOptions;
@@ -51,7 +54,8 @@ private VertxRedisClientFactory() {
         // Avoid direct instantiation.
     }
 
-    public static Redis create(String name, Vertx vertx, RedisClientConfig config, TlsConfigurationRegistry tlsRegistry) {
+    public static Redis create(String name, Vertx vertx, RedisClientConfig config, TlsConfigurationRegistry tlsRegistry,
+            ProxyConfigurationRegistry proxyRegistry) {
         RedisOptions options = new RedisOptions();
 
         Consumer<Set<URI>> configureOptions = new Consumer<Set<URI>>() {
@@ -113,7 +117,7 @@ public void accept(Set<URI> uris) {
         config.topology().ifPresent(options::setTopology);
         config.clusterTransactions().ifPresent(options::setClusterTransactions);
 
-        options.setNetClientOptions(toNetClientOptions(config));
+        options.setNetClientOptions(toNetClientOptions(config, proxyRegistry));
         configureTLS(name, config, tlsRegistry, options.getNetClientOptions(), hosts);
 
         options.setPoolName(name);
@@ -179,7 +183,7 @@ private static void customize(String name, RedisOptions options) {
         }
     }
 
-    private static NetClientOptions toNetClientOptions(RedisClientConfig config) {
+    private static NetClientOptions toNetClientOptions(RedisClientConfig config, ProxyConfigurationRegistry proxyRegistry) {
         NetConfig tcp = config.tcp();
         NetClientOptions net = new NetClientOptions();
 
@@ -193,7 +197,6 @@ private static NetClientOptions toNetClientOptions(RedisClientConfig config) {
         net.setReconnectInterval(config.reconnectInterval().toMillis());
 
         tcp.localAddress().ifPresent(net::setLocalAddress);
-        tcp.nonProxyHosts().ifPresent(net::setNonProxyHosts);
         if (tcp.proxyOptions().host().isPresent()) {
             ProxyOptions po = new ProxyOptions();
             po.setHost(tcp.proxyOptions().host().get());
@@ -202,6 +205,24 @@ private static NetClientOptions toNetClientOptions(RedisClientConfig config) {
             tcp.proxyOptions().username().ifPresent(po::setUsername);
             tcp.proxyOptions().password().ifPresent(po::setPassword);
             net.setProxyOptions(po);
+            tcp.nonProxyHosts().ifPresent(net::setNonProxyHosts);
+        } else {
+            Optional<ProxyConfiguration> proxyConfig = proxyRegistry.get(tcp.proxyConfigurationName());
+            proxyConfig.ifPresent(proxy -> {
+                ProxyOptions po = new ProxyOptions();
+                po.setHost(proxy.host());
+                po.setPort(proxy.port());
+                po.setUsername(proxy.username().orElse(null));
+                po.setPassword(proxy.password().orElse(null));
+                po.setConnectTimeout(proxy.proxyConnectTimeout().orElse(null));
+                po.setType(switch (proxy.type()) {
+                    case HTTP -> ProxyType.HTTP;
+                    case SOCKS4 -> ProxyType.SOCKS4;
+                    case SOCKS5 -> ProxyType.SOCKS5;
+                });
+                net.setProxyOptions(po);
+                proxy.nonProxyHosts().ifPresent(net::setNonProxyHosts);
+            });
         }
         tcp.readIdleTimeout().ifPresent(d -> net.setReadIdleTimeout((int) d.toSeconds()));
         tcp.reconnectAttempts().ifPresent(net::setReconnectAttempts);

extensions/redis-client/runtime/src/main/java/io/quarkus/redis/runtime/client/config/NetConfig.java

@@ -37,14 +37,34 @@ public interface NetConfig {
      */
     Optional<Duration> connectionTimeout();
 
+    /**
+     * The name of the proxy configuration to use.
+     * <p>
+     * If {@code quarkus.redis.tcp.proxy-options.host} is set, the {@code quarkus.redis.tcp.proxy-options.*}
+     * (and {@code quarkus.redis.tcp.non-proxy-hosts}) configuration is used and the {@code quarkus.proxy.*}
+     * configuration is ignored.
+     * <p>
+     * Otherwise, if not set and the default proxy configuration is configured ({@code quarkus.proxy.*}), it is used.
+     * If set to {@code none}, no proxy configuration is used.
+     * If set to some other value, the configuration from {@code quarkus.proxy.<name>.*} is used.
+     * If set but no proxy configuration with that name is found, an exception is thrown at runtime.
+     */
+    Optional<String> proxyConfigurationName();
+
     /**
      * Set a list of remote hosts that are not proxied when the client is configured to use a proxy.
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
+    @Deprecated
     Optional<List<String>> nonProxyHosts();
 
     /**
      * Set proxy options for connections via CONNECT proxy
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
+    @Deprecated
     ProxyConfig proxyOptions();
 
     /**

extensions/redis-client/runtime/src/main/java/io/quarkus/redis/runtime/client/config/ProxyConfig.java

@@ -11,30 +11,49 @@ public interface ProxyConfig {
 
     /**
      * Set proxy username.
+     * Honored only when {@code quarkus.redis.tcp.proxy-options.host} is set.
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
+    @Deprecated
     Optional<String> username();
 
     /**
      * Set proxy password.
+     * Honored only when {@code quarkus.redis.tcp.proxy-options.host} is set.
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
+    @Deprecated
     Optional<String> password();
 
     /**
      * Set proxy port. Defaults to 3128.
+     * Honored only when {@code quarkus.redis.tcp.proxy-options.host} is set.
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
     @WithDefault("3128")
+    @Deprecated
     int port();
 
     /**
      * Set proxy host.
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
+    @Deprecated
     Optional<String> host();
 
     /**
      * Set proxy type.
      * Accepted values are: {@code HTTP} (default), {@code SOCKS4} and {@code SOCKS5}.
+     * Honored only when {@code quarkus.redis.tcp.proxy-options.host} is set.
+     *
+     * @deprecated use {@code quarkus.redis.tcp.proxy-configuration-name} and {@code quarkus.proxy.*}
      */
     @WithDefault("http")
+    @Deprecated
     ProxyType type();
 
 }