Upgrade Couchbase support for Spring Boot 2.4

generators/cleanup.js

@@ -459,6 +459,13 @@ function cleanupOldServerFiles(generator, javaDir, testDir, mainResourceDir, tes
     if (generator.searchEngine === 'elasticsearch') {
       generator.removeFile(`${testDir}config/ElasticsearchTestConfiguration.java`);
     }
+    if (generator.databaseType === 'couchbase') {
+      generator.removeFile(`${javaDir}repository/N1qlCouchbaseRepository.java`);
+      generator.removeFile(`${testDir}config/DatabaseConfigurationIT.java`);
+      if (generator.searchEngine !== 'couchbase') {
+        generator.removeFile(`${javaDir}repository/CustomN1qlCouchbaseRepository.java`);
+      }
+    }
   }
   if (generator.isJhipsterVersionLessThan('7.0.0-beta.1')) {
     generator.removeFile(`${javaDir}config/CloudDatabaseConfiguration.java`);

generators/entity-server/templates/src/main/java/package/domain/Entity.java.ejs

@@ -71,7 +71,7 @@ import org.springframework.data.couchbase.core.mapping.Document;
 import org.springframework.data.couchbase.core.mapping.id.GeneratedValue;
 import org.springframework.data.couchbase.core.mapping.id.IdPrefix;
     <%_ } _%>
-import com.couchbase.client.java.repository.annotation.Field;
+import org.springframework.data.couchbase.core.mapping.Field;
     <%_ if (hasRelationship) { _%>
 import org.springframework.data.couchbase.core.query.FetchType;
 import org.springframework.data.couchbase.core.query.N1qlJoin;

generators/entity-server/templates/src/main/java/package/repository/EntityRepository.java.ejs

@@ -29,19 +29,24 @@ import org.springframework.data.jpa.repository.*;
     <%_ if (relationshipsContainEagerLoad) { _%>
 import org.springframework.data.repository.query.Param;
     <%_ } _%>
-<%_ } _%>
-<%_ if (databaseType === 'mongodb') { _%>
+<%_ } else if (databaseType === 'mongodb') { _%>
 import org.springframework.data.mongodb.repository.Query;
 import org.springframework.data.mongodb.repository.MongoRepository;
-<%_ } _%>
-<%_ if (databaseType === 'neo4j') { _%>
+<%_ } else if (databaseType === 'neo4j') { _%>
 import org.springframework.data.neo4j.repository.Neo4jRepository;
+<%_ } else if (databaseType === 'couchbase') { _%>
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+import com.couchbase.client.java.query.QueryScanConsistency;
+import org.springframework.data.couchbase.repository.CouchbaseRepository;
+import org.springframework.data.couchbase.repository.ScanConsistency;
 <%_ } _%>
 <%_ if (searchEngine === 'couchbase') { _%>
 import <%= packageName %>.repository.search.SearchCouchbaseRepository;
 <%_ } _%>
 <%_ if (databaseType === 'couchbase' && relationshipsContainEagerLoad === true) { _%>
-import org.springframework.data.couchbase.core.query.Query;
+import org.springframework.data.couchbase.repository.Query;
 <%_ } _%>
 <%_ if (databaseType === 'cassandra') { _%>
 import org.springframework.data.cassandra.repository.CassandraRepository;
@@ -56,7 +61,7 @@ if (databaseType === 'sql' || databaseType === 'mongodb' || databaseType === 'co
         }
     }
 _%>
-    <%_ if (importList) { _%>
+    <%_ if (importList || databaseType === 'couchbase') { _%>
 import java.util.List;
     <%_ } _%>
     <%_ if (relationshipsContainEagerLoad) { _%>
@@ -75,7 +80,7 @@ import java.util.UUID;
 @SuppressWarnings("unused")
 <%_ } _%>
 @Repository
-public interface <%= entityClass %>Repository extends <% if (databaseType === 'sql') { %>JpaRepository<% } %><% if (databaseType === 'mongodb') { %>MongoRepository<% } %><% if (databaseType === 'neo4j') { %>Neo4jRepository<% } %><% if (databaseType === 'cassandra') { %>CassandraRepository<% } %><% if (databaseType === 'couchbase') { %>N1qlCouchbaseRepository<% } %><<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% if (jpaMetamodelFiltering) { %>, JpaSpecificationExecutor<<%= asEntity(entityClass) %>><% } %><% if (searchEngine === 'couchbase') { %>, SearchCouchbaseRepository<<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% } %> {
+public interface <%= entityClass %>Repository extends <% if (databaseType === 'sql') { %>JpaRepository<% } %><% if (databaseType === 'mongodb') { %>MongoRepository<% } %><% if (databaseType === 'neo4j') { %>Neo4jRepository<% } %><% if (databaseType === 'cassandra') { %>CassandraRepository<% } %><% if (databaseType === 'couchbase') { %>CouchbaseRepository<% } %><<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% if (jpaMetamodelFiltering) { %>, JpaSpecificationExecutor<<%= asEntity(entityClass) %>><% } %><% if (searchEngine === 'couchbase') { %>, SearchCouchbaseRepository<<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% } %> {
     <%_ for (const relationship of relationships) {
         if (relationship.relationshipType === 'many-to-one' && relationship.otherEntityName === 'user' && databaseType === 'sql') { _%>
 
@@ -107,14 +112,32 @@ public interface <%= entityClass %>Repository extends <% if (databaseType === 's
         } else if (databaseType === 'mongodb' || databaseType === 'couchbase')  { _%>
 
     @Query("<%= (databaseType === 'mongodb') ? '{}' : '#{#n1ql.selectEntity} WHERE #{#n1ql.filter}' %>")
+    <% if (databaseType === 'couchbase') { %>@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)<% } %>
     Page<<%= asEntity(entityClass) %>> findAllWithEagerRelationships(Pageable pageable);
 
     @Query("<%= (databaseType === 'mongodb') ? '{}' : '#{#n1ql.selectEntity} WHERE #{#n1ql.filter}' %>")
+    <% if (databaseType === 'couchbase') { %>@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)<% } %>
     List<<%= asEntity(entityClass) %>> findAllWithEagerRelationships();
 
     @Query("<%- (databaseType === 'mongodb') ? "{'id': ?0}" : "#{#n1ql.selectEntity} USE KEYS $1 WHERE #{#n1ql.filter}" %>")
+    <% if (databaseType === 'couchbase') { %>@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)<% } %>
     Optional<<%= asEntity(entityClass) %>> findOneWithEagerRelationships(<%= primaryKey.type %> id);
     <%_
         }
     } _%>
+    <%_ if (databaseType === 'couchbase') { _%>
+    @Override
+    // Add ScanConsistency to fix issue with Spring Data Couchbase
+    // https://github.com/spring-projects/spring-data-couchbase/issues/897
+    @ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
+    List<<%= asEntity(entityClass) %>> findAll();
+
+    @Override
+    @ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
+    List<<%= asEntity(entityClass) %>> findAll(Sort sort);
+
+    @Override
+    @ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
+    Page<<%= asEntity(entityClass) %>> findAll(Pageable pageable);
+    <%_ } _%>
 }

generators/entity-server/templates/src/main/java/package/repository/EntityRepository_reactive.java.ejs

@@ -26,8 +26,11 @@ import org.springframework.data.cassandra.repository.ReactiveCassandraRepository
 import <%= packageName %>.repository.search.SearchCouchbaseRepository;
 <%_ } _%>
 <%_ if (databaseType === 'couchbase') { _%>
-import org.springframework.data.couchbase.core.query.Query;
-import org.springframework.data.couchbase.repository.ReactiveCouchbaseSortingRepository;
+import com.couchbase.client.java.query.QueryScanConsistency;
+import org.springframework.data.domain.Sort;
+import org.springframework.data.couchbase.repository.Query;
+import org.springframework.data.repository.reactive.ReactiveSortingRepository;
+import org.springframework.data.couchbase.repository.ScanConsistency;
 <%_ } _%>
 <%_ if (databaseType === 'neo4j') { _%>
 import org.springframework.data.neo4j.repository.ReactiveNeo4jRepository;
@@ -64,7 +67,7 @@ import java.util.UUID;
  */
 @SuppressWarnings("unused")
 @Repository
-public interface <%= entityClass %>Repository extends <% if (databaseType === 'sql') { %>R2dbc<% } if (databaseType === 'mongodb') { %>ReactiveMongo<% } if (databaseType === 'couchbase') { %>ReactiveN1qlCouchbase<% } if (databaseType === 'neo4j') { %>ReactiveNeo4j<% } if (databaseType === 'cassandra') { %>ReactiveCassandra<% } %>Repository<<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% if (searchEngine === 'couchbase') { %>, SearchCouchbaseRepository<<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% } %><% if (databaseType === 'sql') { %>, <%= entityClass %>RepositoryInternal<% } %> {
+public interface <%= entityClass %>Repository extends <% if (databaseType === 'sql') { %>R2dbc<% } if (databaseType === 'mongodb') { %>ReactiveMongo<% } if (databaseType === 'couchbase') { %>ReactiveSorting<% } if (databaseType === 'neo4j') { %>ReactiveNeo4j<% } if (databaseType === 'cassandra') { %>ReactiveCassandra<% } %>Repository<<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% if (searchEngine === 'couchbase') { %>, SearchCouchbaseRepository<<%= asEntity(entityClass) %>, <%= primaryKey.type %>><% } %><% if (databaseType === 'sql') { %>, <%= entityClass %>RepositoryInternal<% } %> {
 
     <%_ if (pagination !== 'no') { _%>
 
@@ -74,12 +77,15 @@ public interface <%= entityClass %>Repository extends <% if (databaseType === 's
         <%_ if (['couchbase', 'mongodb'].includes(databaseType)) { _%>
 
     @Query("<%= (databaseType === 'mongodb') ? '{}' : '#{#n1ql.selectEntity} WHERE #{#n1ql.filter}' %>")
+    <% if (databaseType === 'couchbase') { %>@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)<% } %>
     Flux<<%= asEntity(entityClass) %>> findAllWithEagerRelationships(Pageable pageable);
 
     @Query("<%= (databaseType === 'mongodb') ? '{}' : '#{#n1ql.selectEntity} WHERE #{#n1ql.filter}' %>")
+    <% if (databaseType === 'couchbase') { %>@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)<% } %>
     Flux<<%= asEntity(entityClass) %>> findAllWithEagerRelationships();
 
     @Query("<%- (databaseType === 'mongodb') ? "{'id': ?0}" : "#{#n1ql.selectEntity} USE KEYS $1 WHERE #{#n1ql.filter}" %>")
+    <% if (databaseType === 'couchbase') { %>@ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)<% } %>
     Mono<<%= asEntity(entityClass) %>> findOneWithEagerRelationships(<%= primaryKey.type %> id);
         <%_ } _%>
         <%_ if (databaseType === 'neo4j') { _%>
@@ -93,6 +99,17 @@ public interface <%= entityClass %>Repository extends <% if (databaseType === 's
     Mono<<%= asEntity(entityClass) %>> findOneWithEagerRelationships(<%= primaryKey.type %> id);
         <%_ } _%>
     <%_ } _%>
+    <%_ if (databaseType === 'couchbase') { _%>
+    // Add ScanConsistency to fix issue with Spring Data Couchbase
+    // https://github.com/spring-projects/spring-data-couchbase/issues/897
+    @Override
+    @ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
+    Flux<<%= asEntity(entityClass) %>> findAll();
+
+    @Override
+    @ScanConsistency(query = QueryScanConsistency.REQUEST_PLUS)
+    Flux<<%= asEntity(entityClass) %>> findAll(Sort sort);
+    <%_ } _%>
     <%_ if (databaseType === 'sql') {
             if (fieldsContainOwnerManyToMany) { _%>
 
@@ -136,7 +153,7 @@ public interface <%= entityClass %>Repository extends <% if (databaseType === 's
               <%_ } _%>
         <%_ } _%>
 
-    // just to avoid having unambigous methods
+    // just to avoid having unambiguous methods
     @Override
     Flux<<%= asEntity(entityClass) %>> findAll();
 

generators/server/files.js

@@ -895,50 +895,72 @@ const serverFiles = {
       ],
     },
     {
-      condition: generator => !generator.reactive && generator.databaseType === 'couchbase',
+      condition: generator => generator.databaseType === 'couchbase',
       path: SERVER_MAIN_SRC_DIR,
       templates: [
         {
-          file: 'package/repository/N1qlCouchbaseRepository.java',
-          renameTo: generator => `${generator.javaDir}repository/N1qlCouchbaseRepository.java`,
+          file: 'package/config/couchbase/CustomCouchbaseRepositoryFactory.java',
+          renameTo: generator => `${generator.javaDir}config/couchbase/CustomCouchbaseRepositoryFactory.java`,
+        },
+        {
+          file: 'package/config/couchbase/CustomCouchbaseRepositoryFactoryBean.java',
+          renameTo: generator => `${generator.javaDir}config/couchbase/CustomCouchbaseRepositoryFactoryBean.java`,
+        },
+        {
+          file: 'package/config/couchbase/CustomCouchbaseRepositoryQuery.java',
+          renameTo: generator => `${generator.javaDir}config/couchbase/CustomCouchbaseRepositoryQuery.java`,
+        },
+        {
+          file: 'package/config/couchbase/CustomN1qlQueryCreator.java',
+          renameTo: generator => `${generator.javaDir}config/couchbase/CustomN1qlQueryCreator.java`,
+        },
+        {
+          file: 'package/config/couchbase/CustomN1qlRepositoryQueryExecutor.java',
+          renameTo: generator => `${generator.javaDir}config/couchbase/CustomN1qlRepositoryQueryExecutor.java`,
         },
         {
-          file: 'package/repository/CustomN1qlCouchbaseRepository.java',
-          renameTo: generator => `${generator.javaDir}repository/CustomN1qlCouchbaseRepository.java`,
+          file: 'package/config/couchbase/package-info.java',
+          renameTo: generator => `${generator.javaDir}config/couchbase/package-info.java`,
         },
       ],
     },
     {
-      condition: generator => generator.searchEngine === 'couchbase',
+      condition: generator => !generator.reactive && generator.databaseType === 'couchbase',
       path: SERVER_MAIN_SRC_DIR,
       templates: [
         {
-          file: 'package/repository/search/SearchCouchbaseRepository.java',
-          renameTo: generator => `${generator.javaDir}repository/search/SearchCouchbaseRepository.java`,
+          file: 'package/repository/CustomCouchbaseRepository.java',
+          renameTo: generator => `${generator.javaDir}repository/CustomCouchbaseRepository.java`,
         },
       ],
     },
     {
-      condition: generator => generator.searchEngine === 'couchbase',
-      path: SERVER_TEST_SRC_DIR,
+      condition: generator => generator.reactive && generator.databaseType === 'couchbase',
+      path: SERVER_MAIN_SRC_DIR,
       templates: [
         {
-          file: 'package/repository/CustomN1qlCouchbaseRepositoryTest.java',
-          renameTo: generator => `${generator.testDir}repository/CustomN1qlCouchbaseRepositoryTest.java`,
+          file: 'package/repository/CustomReactiveCouchbaseRepository.java',
+          renameTo: generator => `${generator.javaDir}repository/CustomReactiveCouchbaseRepository.java`,
         },
       ],
     },
     {
-      condition: generator => generator.reactive && generator.databaseType === 'couchbase',
+      condition: generator => generator.searchEngine === 'couchbase',
       path: SERVER_MAIN_SRC_DIR,
       templates: [
         {
-          file: 'package/repository/ReactiveN1qlCouchbaseRepository.java',
-          renameTo: generator => `${generator.javaDir}repository/ReactiveN1qlCouchbaseRepository.java`,
+          file: 'package/repository/search/SearchCouchbaseRepository.java',
+          renameTo: generator => `${generator.javaDir}repository/search/SearchCouchbaseRepository.java`,
         },
+      ],
+    },
+    {
+      condition: generator => generator.searchEngine === 'couchbase',
+      path: SERVER_TEST_SRC_DIR,
+      templates: [
         {
-          file: 'package/repository/CustomReactiveN1qlCouchbaseRepository.java',
-          renameTo: generator => `${generator.javaDir}repository/CustomReactiveN1qlCouchbaseRepository.java`,
+          file: 'package/repository/CustomCouchbaseRepositoryTest.java',
+          renameTo: generator => `${generator.testDir}repository/CustomCouchbaseRepositoryTest.java`,
         },
       ],
     },
@@ -1185,8 +1207,8 @@ const serverFiles = {
       path: SERVER_TEST_SRC_DIR,
       templates: [
         {
-          file: 'package/config/DatabaseConfigurationIT.java',
-          renameTo: generator => `${generator.testDir}config/DatabaseConfigurationIT.java`,
+          file: 'package/CouchbaseTestContainerExtension.java',
+          renameTo: generator => `${generator.testDir}CouchbaseTestContainerExtension.java`,
         },
       ],
     },

generators/server/templates/build.gradle.ejs

@@ -501,7 +501,6 @@ dependencies {
     <%_ if (databaseType === 'couchbase') { _%>
     implementation "com.github.differentway:couchmove"
     implementation "com.couchbase.client:java-client"
-    implementation "com.couchbase.client:encryption"
     <%_ } _%>
     implementation ("io.springfox:springfox-oas")
     implementation ("io.springfox:springfox-swagger2")

generators/server/templates/pom.xml.ejs

@@ -365,10 +365,6 @@
             <groupId>com.couchbase.client</groupId>
             <artifactId>java-client</artifactId>
         </dependency>
-        <dependency>
-            <groupId>com.couchbase.client</groupId>
-            <artifactId>encryption</artifactId>
-        </dependency>
 <%_ } _%>
 <%_ if (databaseType === 'neo4j') { _%>
         <dependency>