✨ Add build and wait for deferred N1QL indexes

Author: tchlyah

src/main/java/com/github/couchmove/Couchmove.java

@@ -18,6 +18,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.time.Duration;
 import java.util.Comparator;
 import java.util.Date;
 import java.util.List;
@@ -196,6 +197,21 @@ void executeMigration(ChangeLog changeLog, int order) {
         }
     }
 
+    /**
+     * Instruct the query engine to trigger the build of indexes that have been deferred, within the default management
+     */
+    public void buildN1qlDeferredIndexes() {
+        dbService.buildN1qlDeferredIndexes();
+    }
+
+    /**
+     * Watches all indexes, polling the query service until they become
+     * "online" or the timeout has expired
+     */
+    public void waitForN1qlIndexes(Duration duration) {
+        dbService.waitForN1qlIndexes(duration);
+    }
+
     /**
      * Applies the {@link ChangeLog} according to it's {@link ChangeLog#type} :
      * <ul>

src/main/java/com/github/couchmove/repository/CouchbaseRepository.java

@@ -4,6 +4,8 @@
 import com.couchbase.client.java.manager.view.DesignDocument;
 import com.github.couchmove.pojo.CouchbaseEntity;
 
+import java.time.Duration;
+
 /**
  * A repository for encapsulating storage, retrieval, and removal of json documents to Couchbase {@link Bucket}
  *
@@ -97,4 +99,17 @@ public interface CouchbaseRepository<E extends CouchbaseEntity> {
      * @return name of the repository Couchbase {@link Bucket}
      */
     String getBucketName();
+
+    /**
+     * Instruct the query engine to trigger the build of indexes that have been deferred, within the default management
+     */
+    void buildN1qlDeferredIndexes();
+
+    /**
+     * Watches all indexes, polling the query service until they become
+     * "online" or the timeout has expired
+     *
+     * @param duration the maximum duration for which to poll for the index to become online.
+     */
+    void watchN1qlIndexes(Duration duration);
 }

src/main/java/com/github/couchmove/repository/CouchbaseRepositoryImpl.java

@@ -19,6 +19,7 @@
 import com.couchbase.client.java.kv.GetResult;
 import com.couchbase.client.java.kv.MutationResult;
 import com.couchbase.client.java.kv.UpsertOptions;
+import com.couchbase.client.java.manager.query.QueryIndex;
 import com.couchbase.client.java.manager.search.SearchIndex;
 import com.couchbase.client.java.manager.view.DesignDocument;
 import com.couchbase.client.java.manager.view.View;
@@ -34,7 +35,10 @@
 import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 
+import java.time.Duration;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import static com.couchbase.client.java.kv.InsertOptions.insertOptions;
 import static com.couchbase.client.java.kv.ReplaceOptions.replaceOptions;
@@ -182,6 +186,19 @@ public String getBucketName() {
         return getCollection().bucketName();
     }
 
+    @Override
+    public void buildN1qlDeferredIndexes() {
+        cluster.queryIndexes().buildDeferredIndexes(getBucketName());
+    }
+
+    @Override
+    public void watchN1qlIndexes(Duration duration) {
+        List<String> indexes = cluster.queryIndexes().getAllIndexes(getBucketName()).stream()
+                .map(QueryIndex::name)
+                .collect(Collectors.toList());
+        cluster.queryIndexes().watchIndexes(getBucketName(), indexes, duration);
+    }
+
     private static <SELF extends CommonOptions<SELF>> SELF withRetry(SELF options) {
         return options.retryStrategy(BestEffortRetryStrategy.INSTANCE);
     }

src/main/java/com/github/couchmove/service/ChangeLogDBService.java

@@ -12,6 +12,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.time.Duration;
 import java.util.*;
 import java.util.stream.Collectors;
 
@@ -144,6 +145,23 @@ public void importFtsIndex(String name, String content) {
         repository.importFtsIndex(name, content);
     }
 
+    /**
+     * Watches all indexes, polling the query service until they become
+     * "online" or the timeout has expired
+     *
+     * @param duration the maximum duration for which to poll for the index to become online.
+     */
+    public void waitForN1qlIndexes(Duration duration) {
+        repository.watchN1qlIndexes(duration);
+    }
+
+    /**
+     * Instruct the query engine to trigger the build of indexes that have been deferred, within the default management
+     */
+    public void buildN1qlDeferredIndexes() {
+        repository.buildN1qlDeferredIndexes();
+    }
+
     /**
      * Extract multiple requests, separated by ';' ignoring :
      * <ul>

src/test/java/com/github/couchmove/CouchmoveIT.java

@@ -17,9 +17,11 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.time.Duration;
 import java.util.Date;
 import java.util.List;
 import java.util.Optional;
+import java.util.concurrent.TimeUnit;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -192,7 +194,7 @@ public void should_update_changeLog() {
     }
 
     @Test
-    public void should_build_multiple_index_not_fail() {
+    public void should_build_deferred_indexes() {
         // Given a Couchmove instance configured for success migration folder
         Couchmove couchmove = getCouchmove("multiple-deferred-indexes");
 
@@ -208,14 +210,18 @@ public void should_build_multiple_index_not_fail() {
         assertEquals(2, changeLogs.size());
         assertLike(changeLogs.get(0),
                 "0", 1, "create deferred index", N1QL, "V0__create_deferred_index.n1ql",
-                "060f486279932b3838a90f23032a135ad20f8a364fbbda9305f6e20a5b065085",
+                "8987fdc8782fe4f8321cfae8f388d9005ac6c2eca726105a2739170cc4870a66",
                 EXECUTED);
         assertLike(changeLogs.get(1),
                 "1", 2, "create second deferred index", N1QL, "V1__create_second_deferred_index.n1ql",
-                "49fed597ee5f7012b6ab7eb66825e20de4906ecfb10ee9b5ae8f74dfe242b74a",
+                "77492051f8633e40032881e474207d97d87c3eb1e239a832b1ad11b22c933fe6",
                 EXECUTED);
 
-        // And successfully executed
+        // Trigger deferred index build
+        couchmove.buildN1qlDeferredIndexes();
+
+        // Wait for indexes to be built
+        couchmove.waitForN1qlIndexes(Duration.ofSeconds(5));
 
         // Index inserted
         Optional<QueryIndex> userIndexInfo = getCluster().queryIndexes().getAllIndexes(getBucket().name()).stream()

src/test/resources/db/migration/multiple-deferred-indexes/V0__create_deferred_index.n1ql

@@ -2,5 +2,3 @@
 CREATE INDEX buyer_index ON `${bucket}`(username)
   WHERE type = 'buyer'
   WITH { "defer_build" : true };
-
-BUILD INDEX ON `${bucket}`(buyer_index);

src/test/resources/db/migration/multiple-deferred-indexes/V1__create_second_deferred_index.n1ql

@@ -2,5 +2,3 @@
 CREATE INDEX merchant_index ON `${bucket}`(username)
   WHERE type = 'merchant'
   WITH { "defer_build" : true };
-
-BUILD INDEX ON `${bucket}`(merchant_index);