FMWK-566 Update configuration in the Starters project (#257)

* Fix initializing only client beans * Update the configuration to use IAerospikeCLient and IAerospikeReactorClient interfaces * Un-deprecate configuration properties
aerospike-community · Oct 8, 2024 · a38af1f · a38af1f
1 parent 05ded3b
commit a38af1f
Show file tree

Hide file tree

Showing 15 changed files with 81 additions and 67 deletions.
diff --git a/README.adoc b/README.adoc
@@ -9,7 +9,7 @@ image:https://github.com/aerospike-community/spring-data-aerospike-starters/work
 
 |===
 |`spring-data-aerospike-starters` |`spring-data-aerospike` |`aerospike-client` |`aerospike-reactor-client`
-|0.15.x
+|0.15.x, 0.16.x
 |4.8.x
 |7.2.x
 |7.1.x

diff --git a/pom.xml b/pom.xml
@@ -31,7 +31,7 @@
     </modules>
 
     <properties>
-        <revision>0.15.0</revision>
+        <revision>0.16.0</revision>
         <java.version>17</java.version>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>

diff --git a/...ain/java/org/springframework/boot/autoconfigure/aerospike/AerospikeAutoConfiguration.java b/...ain/java/org/springframework/boot/autoconfigure/aerospike/AerospikeAutoConfiguration.java
@@ -23,15 +23,14 @@
 import com.aerospike.client.async.NioEventLoops;
 import com.aerospike.client.policy.*;
 import com.aerospike.client.reactor.AerospikeReactorClient;
+import com.aerospike.client.reactor.IAerospikeReactorClient;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
-import org.springframework.boot.autoconfigure.data.aerospike.AerospikeDataProperties;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
-import org.springframework.data.aerospike.server.version.ServerVersionSupport;
 import reactor.core.publisher.Flux;
 
 import java.util.Optional;
@@ -43,35 +42,19 @@
  * @author Anastasiia Smirnova
  */
 @AutoConfiguration
-@ConditionalOnClass(AerospikeClient.class)
+@ConditionalOnClass(IAerospikeClient.class)
 @ConditionalOnProperty("spring.aerospike.hosts")
 @EnableConfigurationProperties(AerospikeProperties.class)
 public class AerospikeAutoConfiguration {
 
     @Bean(name = "aerospikeClient", destroyMethod = "close")
     @ConditionalOnMissingBean(IAerospikeClient.class)
-    public AerospikeClient aerospikeClient(AerospikeProperties properties,
-                                           ClientPolicy aerospikeClientPolicy) {
+    public IAerospikeClient aerospikeClient(AerospikeProperties properties,
+                                            ClientPolicy aerospikeClientPolicy) {
         Host[] hosts = Host.parseHosts(properties.getHosts(), properties.getDefaultPort());
         return new AerospikeClient(aerospikeClientPolicy, hosts);
     }
 
-    @Bean(name = "aerospikeServerVersionSupport")
-    @ConditionalOnMissingBean(ServerVersionSupport.class)
-    public ServerVersionSupport serverVersionSupport(IAerospikeClient aerospikeClient,
-                                                     AerospikeDataProperties properties) {
-        ServerVersionSupport serverVersionSupport = new ServerVersionSupport(aerospikeClient);
-        processServerVersionRefreshFrequency(properties.getServerVersionRefreshSeconds(), serverVersionSupport);
-        return serverVersionSupport;
-    }
-
-    private void processServerVersionRefreshFrequency(int serverVersionRefreshSeconds,
-                                                      ServerVersionSupport serverVersionSupport) {
-        if (serverVersionRefreshSeconds > 0) {
-            serverVersionSupport.scheduleServerVersionRefresh(serverVersionRefreshSeconds);
-        }
-    }
-
     @Bean(name = "aerospikeClientPolicy")
     @ConditionalOnMissingBean
     public ClientPolicy aerospikeClientPolicy(AerospikeProperties properties,
@@ -102,14 +85,14 @@ public ClientPolicy aerospikeClientPolicy(AerospikeProperties properties,
         return clientPolicy;
     }
 
-    @ConditionalOnClass({AerospikeReactorClient.class, Flux.class})
+    @ConditionalOnClass({IAerospikeReactorClient.class, Flux.class})
     public static class AerospikeReactiveAutoConfiguration {
 
         @Bean(name = "aerospikeReactorClient", destroyMethod = "")
         @ConditionalOnMissingBean
         //disable destroy method, because we do not want AerospikeReactorClient to close AerospikeClient
-        public AerospikeReactorClient aerospikeReactorClient(IAerospikeClient aerospikeClient,
-                                                             EventLoops eventLoops) {
+        public IAerospikeReactorClient aerospikeReactorClient(IAerospikeClient aerospikeClient,
+                                                              EventLoops eventLoops) {
             return new AerospikeReactorClient(aerospikeClient, eventLoops);
         }
 

diff --git a/...e/src/main/java/org/springframework/boot/autoconfigure/aerospike/AerospikeProperties.java b/...e/src/main/java/org/springframework/boot/autoconfigure/aerospike/AerospikeProperties.java
@@ -38,21 +38,15 @@ public class AerospikeProperties {
      * <p>
      * See {@link com.aerospike.client.Host#parseHosts} documentation for more details.
      *
-     * @deprecated since 0.14.0, {@link AerospikeDataSettings} with the prefix "spring-data-aerospike.connection".
-     * will be used instead to read from application.properties
      */
-    @Deprecated(since = "0.14.0", forRemoval = true)
     private String hosts;
 
     /**
      * Port is used if no port specified in AerospikeProperties#hosts.
      * <p>
      * See {@link com.aerospike.client.Host#parseHosts} documentation for more details.
      *
-     * @deprecated since 0.14.0, {@link AerospikeDataSettings} with the prefix "spring-data-aerospike.connection".
-     * will be used instead to read from application.properties
      */
-    @Deprecated(since = "0.14.0", forRemoval = true)
     private int defaultPort = 3000;
 
     /**

diff --git a/...g/springframework/boot/autoconfigure/data/aerospike/AerospikeCommonDataConfiguration.java b/...g/springframework/boot/autoconfigure/data/aerospike/AerospikeCommonDataConfiguration.java
@@ -1,5 +1,6 @@
 package org.springframework.boot.autoconfigure.data.aerospike;
 
+import com.aerospike.client.IAerospikeClient;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.BeanUtils;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
@@ -22,6 +23,7 @@
 import org.springframework.data.aerospike.query.StatementBuilder;
 import org.springframework.data.aerospike.query.cache.IndexesCache;
 import org.springframework.data.aerospike.query.cache.IndexesCacheHolder;
+import org.springframework.data.aerospike.server.version.ServerVersionSupport;
 import org.springframework.data.annotation.Persistent;
 import org.springframework.data.mapping.model.FieldNamingStrategy;
 
@@ -31,6 +33,22 @@
 @AutoConfiguration
 class AerospikeCommonDataConfiguration {
 
+    @Bean(name = "aerospikeServerVersionSupport")
+    @ConditionalOnMissingBean(ServerVersionSupport.class)
+    public ServerVersionSupport serverVersionSupport(IAerospikeClient aerospikeClient,
+                                                     AerospikeDataProperties properties) {
+        ServerVersionSupport serverVersionSupport = new ServerVersionSupport(aerospikeClient);
+        processServerVersionRefreshFrequency(properties.getServerVersionRefreshSeconds(), serverVersionSupport);
+        return serverVersionSupport;
+    }
+
+    private void processServerVersionRefreshFrequency(int serverVersionRefreshSeconds,
+                                                      ServerVersionSupport serverVersionSupport) {
+        if (serverVersionRefreshSeconds > 0) {
+            serverVersionSupport.scheduleServerVersionRefresh(serverVersionRefreshSeconds);
+        }
+    }
+
     @Bean(name = "aerospikeFilterExpressionsBuilder")
     @ConditionalOnMissingBean(name = "aerospikeFilterExpressionsBuilder")
     public FilterExpressionsBuilder aerospikeFilterExpressionsBuilder() {

diff --git a/...org/springframework/boot/autoconfigure/data/aerospike/AerospikeDataAutoConfiguration.java b/...org/springframework/boot/autoconfigure/data/aerospike/AerospikeDataAutoConfiguration.java
@@ -16,7 +16,6 @@
 
 package org.springframework.boot.autoconfigure.data.aerospike;
 
-import com.aerospike.client.AerospikeClient;
 import com.aerospike.client.IAerospikeClient;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
@@ -39,8 +38,8 @@
 @AutoConfiguration
 // match only if we do not have reactive client
 // we want sync context to be loaded when only sync client is on classpath
-@ConditionalOnMissingClass("com.aerospike.client.reactor.AerospikeReactorClient")
-@ConditionalOnClass({AerospikeClient.class, AerospikeRepository.class})
+@ConditionalOnMissingClass("com.aerospike.client.reactor.IAerospikeReactorClient")
+@ConditionalOnClass({IAerospikeClient.class, AerospikeRepository.class})
 @ConditionalOnSingleCandidate(IAerospikeClient.class)
 @ConditionalOnProperty("spring.data.aerospike.namespace")
 @EnableConfigurationProperties(AerospikeDataProperties.class)

diff --git a/...n/java/org/springframework/boot/autoconfigure/data/aerospike/AerospikeDataProperties.java b/...n/java/org/springframework/boot/autoconfigure/data/aerospike/AerospikeDataProperties.java
@@ -23,13 +23,10 @@
 
 /**
  * Configuration properties for Spring Data Aerospike.
- * @deprecated since 0.14.0, {@link AerospikeDataSettings} with the prefix "spring-data-aerospike.data".
- * will be used instead to read from application.properties.
  *
  * @author Igor Ermolenko
  * @author Anastasiia Smirnova
  */
-@Deprecated(since = "0.14.0", forRemoval = true)
 @ConfigurationProperties(prefix = "spring.data.aerospike")
 @Getter
 @Setter

diff --git a/...ngframework/boot/autoconfigure/data/aerospike/AerospikeReactiveDataAutoConfiguration.java b/...ngframework/boot/autoconfigure/data/aerospike/AerospikeReactiveDataAutoConfiguration.java
@@ -16,7 +16,7 @@
 
 package org.springframework.boot.autoconfigure.data.aerospike;
 
-import com.aerospike.client.reactor.AerospikeReactorClient;
+import com.aerospike.client.reactor.IAerospikeReactorClient;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
@@ -36,8 +36,8 @@
  * @author Anastasiia Smirnova
  */
 @AutoConfiguration
-@ConditionalOnClass({AerospikeReactorClient.class, ReactiveAerospikeRepository.class, Flux.class})
-@ConditionalOnSingleCandidate(AerospikeReactorClient.class)
+@ConditionalOnClass({IAerospikeReactorClient.class, ReactiveAerospikeRepository.class, Flux.class})
+@ConditionalOnSingleCandidate(IAerospikeReactorClient.class)
 @ConditionalOnProperty("spring.data.aerospike.namespace")
 @AutoConfigureAfter(AerospikeAutoConfiguration.class)
 @EnableConfigurationProperties(AerospikeDataProperties.class)

diff --git a/...springframework/boot/autoconfigure/data/aerospike/AerospikeReactiveDataConfiguration.java b/...springframework/boot/autoconfigure/data/aerospike/AerospikeReactiveDataConfiguration.java
@@ -16,7 +16,7 @@
 
 package org.springframework.boot.autoconfigure.data.aerospike;
 
-import com.aerospike.client.reactor.AerospikeReactorClient;
+import com.aerospike.client.reactor.IAerospikeReactorClient;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -53,7 +53,7 @@ public ReactiveAerospikeTemplate reactiveAerospikeTemplate(MappingAerospikeConve
                                                                AerospikeDataProperties aerospikeDataProperties,
                                                                AerospikeMappingContext aerospikeMappingContext,
                                                                AerospikeExceptionTranslator aerospikeExceptionTranslator,
-                                                               AerospikeReactorClient aerospikeReactorClient,
+                                                               IAerospikeReactorClient aerospikeReactorClient,
                                                                ReactorQueryEngine reactorQueryEngine,
                                                                ReactorIndexRefresher reactorIndexRefresher,
                                                                ServerVersionSupport serverVersionSupport) {
@@ -64,7 +64,7 @@ public ReactiveAerospikeTemplate reactiveAerospikeTemplate(MappingAerospikeConve
 
     @Bean(name = "reactiveAerospikeQueryEngine")
     @ConditionalOnMissingBean(name = "reactiveAerospikeQueryEngine")
-    public ReactorQueryEngine reactiveAerospikeQueryEngine(AerospikeReactorClient aerospikeReactorClient,
+    public ReactorQueryEngine reactiveAerospikeQueryEngine(IAerospikeReactorClient aerospikeReactorClient,
                                                            AerospikeDataProperties aerospikeDataProperties,
                                                            FilterExpressionsBuilder filterExpressionsBuilder,
                                                            StatementBuilder statementBuilder,
@@ -78,7 +78,7 @@ public ReactorQueryEngine reactiveAerospikeQueryEngine(AerospikeReactorClient ae
 
     @Bean(name = "reactiveAerospikeIndexRefresher")
     @ConditionalOnMissingBean(name = "reactiveAerospikeIndexRefresher")
-    public ReactorIndexRefresher reactiveAerospikeIndexRefresher(AerospikeReactorClient aerospikeReactorClient,
+    public ReactorIndexRefresher reactiveAerospikeIndexRefresher(IAerospikeReactorClient aerospikeReactorClient,
                                                                  IndexesCacheUpdater indexesCacheUpdater,
                                                                  ServerVersionSupport serverVersionSupport) {
         ReactorIndexRefresher refresher = new ReactorIndexRefresher(aerospikeReactorClient, aerospikeReactorClient.getInfoPolicyDefault(),

diff --git a/...ork/boot/autoconfigure/data/aerospike/AerospikeReactiveRepositoriesAutoConfiguration.java b/...ork/boot/autoconfigure/data/aerospike/AerospikeReactiveRepositoriesAutoConfiguration.java
@@ -16,7 +16,7 @@
 
 package org.springframework.boot.autoconfigure.data.aerospike;
 
-import com.aerospike.client.reactor.AerospikeReactorClient;
+import com.aerospike.client.reactor.IAerospikeReactorClient;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -34,7 +34,7 @@
  * @author Igor Ermolenko
  */
 @AutoConfiguration
-@ConditionalOnClass({AerospikeReactorClient.class, ReactiveAerospikeRepository.class, Flux.class})
+@ConditionalOnClass({IAerospikeReactorClient.class, ReactiveAerospikeRepository.class, Flux.class})
 @ConditionalOnRepositoryType(store = "aerospike", type = RepositoryType.REACTIVE)
 @ConditionalOnMissingBean(ReactiveAerospikeRepositoryFactoryBean.class)
 @Import(AerospikeReactiveRepositoriesRegistrar.class)

diff --git a/...ngframework/boot/autoconfigure/data/aerospike/AerospikeRepositoriesAutoConfiguration.java b/...ngframework/boot/autoconfigure/data/aerospike/AerospikeRepositoriesAutoConfiguration.java
@@ -16,7 +16,7 @@
 
 package org.springframework.boot.autoconfigure.data.aerospike;
 
-import com.aerospike.client.AerospikeClient;
+import com.aerospike.client.IAerospikeClient;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -33,7 +33,7 @@
  * @author Igor Ermolenko
  */
 @AutoConfiguration
-@ConditionalOnClass({AerospikeClient.class, ReactiveAerospikeRepository.class})
+@ConditionalOnClass({IAerospikeClient.class, ReactiveAerospikeRepository.class})
 @ConditionalOnRepositoryType(store = "aerospike", type = RepositoryType.IMPERATIVE)
 @ConditionalOnMissingBean(AerospikeRepositoryFactoryBean.class)
 @Import(AerospikeRepositoriesRegistrar.class)

diff --git a/...springframework/boot/autoconfigure/data/aerospike/AerospikeDataAutoConfigurationTest.java b/...springframework/boot/autoconfigure/data/aerospike/AerospikeDataAutoConfigurationTest.java
@@ -18,6 +18,8 @@
 
 import com.aerospike.client.AerospikeClient;
 import com.aerospike.client.reactor.AerospikeReactorClient;
+import com.aerospike.client.reactor.IAerospikeReactorClient;
+import com.aerospike.client.reactor.retry.AerospikeReactorRetryClient;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.autoconfigure.aerospike.AerospikeAutoConfiguration;
@@ -49,7 +51,7 @@
 public class AerospikeDataAutoConfigurationTest {
 
     private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
-            .withClassLoader(new FilteredClassLoader(AerospikeReactorClient.class))
+            .withClassLoader(new FilteredClassLoader(IAerospikeReactorClient.class))
             .withConfiguration(AutoConfigurations.of(
                     AerospikeAutoConfiguration.class, AerospikeDataAutoConfiguration.class));
 
@@ -151,4 +153,35 @@ public void configurationIsApplied() {
                     assertThat(context).hasSingleBean(AerospikeMappingContext.class);
                 });
     }
+
+    @Test
+    public void dataConfigurationIsNotAppliedWithBothClients() {
+        contextRunner
+                .withPropertyValues("spring.aerospike.hosts=localhost:3000")
+                .withPropertyValues("spring.data.aerospike.namespace=TEST")
+                .withUserConfiguration(AerospikeClientMockConfiguration.class,
+                        AerospikeServerVersionSupportMockConfiguration.class)
+                .withClassLoader(AerospikeReactorClient.class.getClassLoader())
+                .run(context -> {
+                    assertThat(context).doesNotHaveBean(ReactiveAerospikeTemplate.class);
+                    assertThat(context).doesNotHaveBean(AerospikeTemplate.class);
+                    assertThat(context).doesNotHaveBean(AerospikeDataProperties.class);
+                    assertThat(context).hasSingleBean(AerospikeProperties.class);
+                    assertThat(context).doesNotHaveBean(AerospikeMappingContext.class);
+                });
+
+        contextRunner
+                .withPropertyValues("spring.aerospike.hosts=localhost:3000")
+                .withPropertyValues("spring.data.aerospike.namespace=TEST")
+                .withUserConfiguration(AerospikeClientMockConfiguration.class,
+                        AerospikeServerVersionSupportMockConfiguration.class)
+                .withClassLoader(AerospikeReactorRetryClient.class.getClassLoader())
+                .run(context -> {
+                    assertThat(context).doesNotHaveBean(ReactiveAerospikeTemplate.class);
+                    assertThat(context).doesNotHaveBean(AerospikeTemplate.class);
+                    assertThat(context).doesNotHaveBean(AerospikeDataProperties.class);
+                    assertThat(context).hasSingleBean(AerospikeProperties.class);
+                    assertThat(context).doesNotHaveBean(AerospikeMappingContext.class);
+                });
+    }
 }
diff --git a/...amework/boot/autoconfigure/data/aerospike/AerospikeReactiveDataAutoConfigurationTest.java b/...amework/boot/autoconfigure/data/aerospike/AerospikeReactiveDataAutoConfigurationTest.java
@@ -16,7 +16,7 @@
 
 package org.springframework.boot.autoconfigure.data.aerospike;
 
-import com.aerospike.client.AerospikeClient;
+import com.aerospike.client.IAerospikeClient;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.autoconfigure.aerospike.AerospikeAutoConfiguration;
@@ -52,7 +52,7 @@ public class AerospikeReactiveDataAutoConfigurationTest {
     @Test
     public void aerospikeTemplateAndClientAreNotSetupWhenNeitherClientNorDataPropertiesConfigured() {
         contextRunner.run(context -> {
-            assertThat(context).doesNotHaveBean(AerospikeClient.class);
+            assertThat(context).doesNotHaveBean(IAerospikeClient.class);
             assertThat(context).doesNotHaveBean(AerospikeTemplate.class);
             assertThat(context).doesNotHaveBean(ReactiveAerospikeTemplate.class);
             assertThat(context).doesNotHaveBean(AerospikeDataProperties.class);

diff --git a/...xample/reactive/src/test/java/com/aerospike/example/reactive/ReactiveIntegrationTest.java b/...xample/reactive/src/test/java/com/aerospike/example/reactive/ReactiveIntegrationTest.java
@@ -61,8 +61,7 @@ void savesAndGets() {
                 .assertThat()
                 .statusCode(200)
                 .body("id", equalTo("andrea"))
-                .body("age", equalTo(61))
-        ;
+                .body("age", equalTo(61));
     }
 
     @Order(2)
@@ -82,7 +81,6 @@ void savesAndFindsByLastName() {
                 .assertThat()
                 .statusCode(200)
                 .body("[0].id", equalTo("andrea"))
-                .body("[0].age", equalTo(61))
-        ;
+                .body("[0].age", equalTo(61));
     }
 }