implement /suggest/rebuild API endpoints

Author: Vladimir Kotal

apiary.apib

@@ -362,6 +362,17 @@ with a colon. If the type cannot be determined "N/A" is returned.
             [{"iso":3},{"the":3},{"to":3},{"conform":3},{"-":2},
              {"sc_window_set":1},{"_lso_outbound":1},{"missing":1}]
 
+## Suggester data rebuild [/suggest/rebuild]
+
+### rebuilds suggester data for all projects [PUT]
+
+## Suggester project data rebuild [/suggest/rebuild/{project}]
+
+### rebuilds suggester data for given project [PUT]
+
++ Parameters
+  + project - project name
+
 ## Index searchers refresh [/system/refresh]
 
 ### refreshes index searchers for specified project [PUT]

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/ProjectsController.java

@@ -215,7 +215,7 @@ public void markIndexed(@PathParam("project") final String projectName) throws E
                     }
                 }
             }
-            suggester.refresh(projectName);
+            suggester.rebuild(projectName);
         } else {
             logger.log(Level.WARNING, "cannot find project {0} to mark as indexed", projectName);
         }

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/SuggesterController.java

@@ -50,6 +50,7 @@
 import javax.ws.rs.DefaultValue;
 import javax.ws.rs.GET;
 import javax.ws.rs.POST;
+import javax.ws.rs.PUT;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
@@ -164,6 +165,20 @@ public SuggesterConfig getConfig() {
         return env.getSuggesterConfig();
     }
 
+    @PUT
+    @Path("/rebuild")
+    public void rebuild() {
+        // TODO run this async in a thread so that the request get a response instantly
+        suggester.rebuild();
+    }
+
+    @PUT
+    @Path("/rebuild/{project}")
+    public void rebuild(@PathParam("project") final String project) {
+        // TODO run this async in a thread so that the request get a response instantly
+        suggester.rebuild(project);
+    }
+
     /**
      * Initializes the search data used by suggester to perform most popular completion. The passed {@code urls} are
      * decomposed into single terms which search counts are then increased by 1.

opengrok-web/src/main/java/org/opengrok/web/api/v1/controller/SystemController.java

@@ -48,7 +48,7 @@ public class SystemController {
     @Consumes(MediaType.TEXT_PLAIN)
     public void refresh(final String project) {
         env.maybeRefreshIndexSearchers(Collections.singleton(project));
-        suggester.refresh(project);
+        suggester.rebuild(project);
     }
 
     @PUT

opengrok-web/src/main/java/org/opengrok/web/api/v1/suggester/provider/service/SuggesterService.java

@@ -51,10 +51,15 @@ public interface SuggesterService {
     void refresh();
 
     /**
-     * Refreshes the suggester for specified {@code project}.
-     * @param project name of the project to refresh
+     * Rebuild suggester data structures. This is a subset of what {@code refresh} does.
      */
-    void refresh(String project);
+    void rebuild();
+
+    /**
+     * Rebuilds suggester data structures for given project. This is a subset of what {@code refresh} does.
+     * @param project project name
+     */
+    void rebuild(String project);
 
     /**
      * Deletes all suggester data for the {@code project}.

opengrok-web/src/main/java/org/opengrok/web/api/v1/suggester/provider/service/impl/SuggesterServiceImpl.java

@@ -43,6 +43,7 @@
 import org.opengrok.indexer.index.IndexDatabase;
 import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.web.api.v1.suggester.provider.service.SuggesterService;
+import sun.reflect.generics.reflectiveObjects.NotImplementedException;
 
 import java.io.File;
 import java.io.IOException;
@@ -175,21 +176,36 @@ public void refresh() {
 
     /** {@inheritDoc} */
     @Override
-    public void refresh(final String project) {
+    public void rebuild() {
+        lock.readLock().lock();
+        try {
+            if (suggester == null) {
+                logger.log(Level.FINE, "Cannot perform rebuild because suggester is not initialized");
+                return;
+            }
+            suggester.rebuild(getAllProjectIndexDirs());
+        } finally {
+            lock.readLock().unlock();
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void rebuild(final String project) {
         Project p = env.getProjects().get(project);
         if (p == null) {
-            logger.log(Level.WARNING, "Cannot refresh suggester because project for name {0} was not found",
+            logger.log(Level.WARNING, "Cannot rebuild suggester because project for name {0} was not found",
                     project);
             return;
         }
         if (!p.isIndexed()) {
-            logger.log(Level.WARNING, "Cannot refresh project {0} because it is not indexed yet", project);
+            logger.log(Level.WARNING, "Cannot rebuild project {0} because it is not indexed yet", project);
             return;
         }
         lock.readLock().lock();
         try {
             if (suggester == null) {
-                logger.log(Level.FINE, "Cannot refresh {0} because suggester is not initialized", project);
+                logger.log(Level.FINE, "Cannot rebuild {0} because suggester is not initialized", project);
                 return;
             }
             suggester.rebuild(Collections.singleton(getNamedIndexDir(p)));

opengrok-web/src/test/java/org/opengrok/web/api/v1/controller/SuggesterControllerTest.java

@@ -25,6 +25,7 @@
 import org.apache.lucene.index.Term;
 import org.glassfish.jersey.test.JerseyTest;
 import org.junit.*;
+import org.junit.runners.MethodSorters;
 import org.opengrok.suggest.Suggester;
 import org.opengrok.indexer.condition.ConditionalRun;
 import org.opengrok.indexer.condition.ConditionalRunRule;
@@ -61,6 +62,7 @@
 import static org.junit.Assert.assertThat;
 
 @ConditionalRun(CtagsInstalled.class)
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class SuggesterControllerTest extends JerseyTest {
 
     public static class Result {
@@ -640,4 +642,25 @@ public void testWildcardQueryEndingWithAsterisk() {
         assertThat(res.suggestions.stream().map(r -> r.phrase).collect(Collectors.toList()),
                 containsInAnyOrder("print", "printf"));
     }
+
+    @Test
+    public void ZtestRebuild() {
+        Response res = target(SuggesterController.PATH)
+                .path("rebuild")
+                .request()
+                .put(Entity.text(""));
+
+        assertEquals(Response.Status.NO_CONTENT.getStatusCode(), res.getStatus());
+    }
+
+    @Test
+    public void ZtestRebuildProject() {
+        Response res = target(SuggesterController.PATH)
+                .path("rebuild")
+                .path("c")
+                .request()
+                .put(Entity.text(""));
+
+        assertEquals(Response.Status.NO_CONTENT.getStatusCode(), res.getStatus());
+    }
 }