Make suggestions time threshold configurable

Author: ahornace

src/org/opensolaris/opengrok/configuration/SuggesterConfig.java

@@ -49,6 +49,7 @@ public class SuggesterConfig {
     public static final boolean SHOW_TIME_DEFAULT = false;
     public static final String REBUILD_CRON_CONFIG_DEFAULT = "0 0 * * *"; // every day at midnight
     public static final int SUGGESTER_BUILD_TERMINATION_TIME_DEFAULT = 1800; // half an hour should be enough
+    public static final int TIME_THRESHOLD_DEFAULT = 2000; // 2 sec
 
     public static final Set<String> allowedProjectsDefault = null;
     public static final Set<String> allowedFieldsDefault = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
@@ -127,6 +128,12 @@ public class SuggesterConfig {
      */
     private int suggesterBuildTerminationTimeSec;
 
+    /**
+     * Time threshold for suggestions in milliseconds. If the computation exceeds this time,
+     * it will be stopped and partial results will be returned.
+     */
+    private int timeThreshold;
+
     public SuggesterConfig() {
         setEnabled(ENABLED_DEFAULT);
         setMaxResults(MAX_RESULTS_DEFAULT);
@@ -139,6 +146,7 @@ public SuggesterConfig() {
         setShowScores(SHOW_SCORES_DEFAULT);
         setShowProjects(SHOW_PROJECTS_DEFAULT);
         setShowTime(SHOW_TIME_DEFAULT);
+        setTimeThreshold(TIME_THRESHOLD_DEFAULT);
         // do not use setter because indexer invocation with --man will fail
         rebuildCronConfig = REBUILD_CRON_CONFIG_DEFAULT;
         setSuggesterBuildTerminationTimeSec(SUGGESTER_BUILD_TERMINATION_TIME_DEFAULT);
@@ -265,6 +273,17 @@ public void setSuggesterBuildTerminationTimeSec(final int suggesterBuildTerminat
         this.suggesterBuildTerminationTimeSec = suggesterBuildTerminationTimeSec;
     }
 
+    public int getTimeThreshold() {
+        return timeThreshold;
+    }
+
+    public void setTimeThreshold(final int timeThreshold) {
+        if (timeThreshold < 0) {
+            throw new IllegalArgumentException("Time threshold for suggestions cannot be negative");
+        }
+        this.timeThreshold = timeThreshold;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {

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

@@ -278,7 +278,10 @@ private void initSuggester() {
         suggester = new Suggester(suggesterDir,
                 suggesterConfig.getMaxResults(),
                 Duration.ofSeconds(suggesterConfig.getSuggesterBuildTerminationTimeSec()),
-                suggesterConfig.isAllowMostPopular(), env.isProjectsEnabled(), suggesterConfig.getAllowedFields());
+                suggesterConfig.isAllowMostPopular(),
+                env.isProjectsEnabled(),
+                suggesterConfig.getAllowedFields(),
+                suggesterConfig.getTimeThreshold());
 
         new Thread(() -> {
             suggester.init(getAllProjectIndexDirs());

suggester/src/main/java/org/opengrok/suggest/Suggester.java

@@ -63,8 +63,6 @@ public final class Suggester implements Closeable {
 
     private static final String PROJECTS_DISABLED_KEY = "";
 
-    private static final int MAX_TIME_MS = 1000;
-
     private static final Logger logger = Logger.getLogger(Suggester.class.getName());
 
     private final Map<String, SuggesterProjectData> projectData = new ConcurrentHashMap<>();
@@ -83,6 +81,8 @@ public final class Suggester implements Closeable {
 
     private final Set<String> allowedFields;
 
+    private final int timeThreshold;
+
     private final ExecutorService executorService = Executors.newWorkStealingPool();
 
     /**
@@ -100,7 +100,8 @@ public Suggester(
             final Duration awaitTerminationTime,
             final boolean allowMostPopular,
             final boolean projectsEnabled,
-            final Set<String> allowedFields
+            final Set<String> allowedFields,
+            final int timeThreshold
     ) {
         if (suggesterDir == null) {
             throw new IllegalArgumentException("Suggester needs to have directory specified");
@@ -117,6 +118,7 @@ public Suggester(
         this.allowMostPopular = allowMostPopular;
         this.projectsEnabled = projectsEnabled;
         this.allowedFields = new HashSet<>(allowedFields);
+        this.timeThreshold = timeThreshold;
     }
 
     /**
@@ -343,7 +345,7 @@ private List<LookupResultItem> complexLookup(
         }
 
         try {
-            executorService.invokeAll(searchTasks, MAX_TIME_MS, TimeUnit.MILLISECONDS);
+            executorService.invokeAll(searchTasks, timeThreshold, TimeUnit.MILLISECONDS);
         } catch (InterruptedException e) {
             logger.log(Level.WARNING, "Interrupted while invoking suggester search", e);
             Thread.currentThread().interrupt();

suggester/src/test/java/org/opengrok/suggest/SuggesterTest.java

@@ -91,14 +91,14 @@ private Suggester.NamedIndexReader getNamedIndexReader() throws IOException {
 
     @Test(expected = IllegalArgumentException.class)
     public void testNullSuggesterDir() {
-        new Suggester(null, 10, Duration.ofMinutes(5), false, true, null);
+        new Suggester(null, 10, Duration.ofMinutes(5), false, true, null, Integer.MAX_VALUE);
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void testNullDuration() throws IOException {
         Path tempFile = Files.createTempFile("opengrok", "test");
         try {
-            new Suggester(tempFile.toFile(), 10, null, false, true, null);
+            new Suggester(tempFile.toFile(), 10, null, false, true, null, Integer.MAX_VALUE);
         } finally {
             tempFile.toFile().delete();
         }
@@ -108,7 +108,7 @@ public void testNullDuration() throws IOException {
     public void testNegativeDuration() throws IOException {
         Path tempFile = Files.createTempFile("opengrok", "test");
         try {
-            new Suggester(tempFile.toFile(), 10, Duration.ofMinutes(-4), false, true, null);
+            new Suggester(tempFile.toFile(), 10, Duration.ofMinutes(-4), false, true, null, Integer.MAX_VALUE);
         } finally {
             tempFile.toFile().delete();
         }
@@ -125,7 +125,7 @@ private SuggesterTestData initSuggester() throws IOException {
         Path tempSuggesterDir = Files.createTempDirectory("opengrok");
 
         Suggester s = new Suggester(tempSuggesterDir.toFile(), 10, Duration.ofMinutes(1), true,
-                true, Collections.singleton("test"));
+                true, Collections.singleton("test"), Integer.MAX_VALUE);
 
         s.init(Collections.singleton(new Suggester.NamedIndexDir("test", tempIndexDir)));
 
@@ -197,7 +197,7 @@ public void testIndexChangedWhileOffline() throws IOException {
         addText(t.getIndexDirectory(), "a1 a2");
 
         t.s = new Suggester(t.suggesterDir.toFile(), 10, Duration.ofMinutes(1), false,
-                true, Collections.singleton("test"));
+                true, Collections.singleton("test"), Integer.MAX_VALUE);
 
         t.s.init(Collections.singleton(t.getNamedIndexDir()));