add tunable for index check timeout

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java

@@ -302,6 +302,8 @@ public final class Configuration {
     private int connectTimeout = -1;    // connect timeout in seconds
     private int apiTimeout = -1;    // API timeout in seconds
 
+    private int indexCheckTimeout;
+
     private boolean historyBasedReindex;
 
     /**
@@ -416,6 +418,25 @@ public void setRestfulCommandTimeout(int timeout) throws IllegalArgumentExceptio
         this.restfulCommandTimeout = timeout;
     }
 
+    public int getIndexCheckTimeout() {
+        return indexCheckTimeout;
+    }
+
+    /**
+     * Set the index check timeout (performed by the webapp on startup) to a new value.
+     *
+     * @see org.opengrok.indexer.index.IndexCheck
+     * @param timeout the new value
+     * @throws IllegalArgumentException when the timeout is negative
+     */
+    public void setIndexCheckTimeout(int timeout) throws IllegalArgumentException {
+        if (timeout < 0) {
+            throw new IllegalArgumentException(
+                    String.format(NEGATIVE_NUMBER_ERROR, "indexCheckTimeout", timeout));
+        }
+        this.indexCheckTimeout = timeout;
+    }
+
     public int getWebappStartCommandTimeout() {
         return webappStartCommandTimeout;
     }
@@ -552,6 +573,7 @@ public Configuration() {
         setHitsPerPage(25);
         setIgnoredNames(new IgnoredNames());
         setIncludedNames(new Filter());
+        setIndexCheckTimeout(60);
         setIndexVersionedFilesOnly(false);
         setLastEditedDisplayMode(true);
         //luceneLocking default is OFF

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java

@@ -325,6 +325,14 @@ public void setWebappStartCommandTimeout(int timeout) {
         syncWriteConfiguration(timeout, Configuration::setWebappStartCommandTimeout);
     }
 
+    public int getIndexCheckTimeout() {
+        return syncReadConfiguration(Configuration::getIndexCheckTimeout);
+    }
+
+    public void setIndexCheckTimeout(int timeout) {
+        syncWriteConfiguration(timeout, Configuration::setIndexCheckTimeout);
+    }
+
     public int getIndexerCommandTimeout() {
         return syncReadConfiguration(Configuration::getIndexerCommandTimeout);
     }

opengrok-web/src/main/java/org/opengrok/web/WebappListener.java

@@ -150,7 +150,7 @@ private void checkIndex(RuntimeEnvironment env) {
             Map<String, Project> projects = env.getProjects();
             Path indexRoot = Path.of(env.getDataRootPath(), IndexDatabase.INDEX_DIR);
             if (indexRoot.toFile().exists()) {
-                LOGGER.log(Level.FINE, "Checking indexes for all projects");
+                LOGGER.log(Level.FINE, "Checking index versions for all projects");
                 Statistics statistics = new Statistics();
                 ExecutorService executor = Executors.newFixedThreadPool(env.getRepositoryInvalidationParallelism(),
                         new OpenGrokThreadFactory("webapp-index-check"));
@@ -169,16 +169,16 @@ private void checkIndex(RuntimeEnvironment env) {
                 }
                 executor.shutdown();
                 try {
-                    // TODO: make the timeout tunable
-                    if (!executor.awaitTermination(60, TimeUnit.SECONDS)) {
-                        LOGGER.log(Level.WARNING, "index check took more than 60 seconds");
+                    if (!executor.awaitTermination(env.getIndexCheckTimeout(), TimeUnit.SECONDS)) {
+                        LOGGER.log(Level.WARNING, "index version check took more than {0} seconds",
+                                env.getIndexCheckTimeout());
                         executor.shutdownNow();
                     }
                 } catch (InterruptedException e) {
-                    LOGGER.log(Level.WARNING, "failed to await termination of index check");
+                    LOGGER.log(Level.WARNING, "failed to await termination of index version check");
                     executor.shutdownNow();
                 }
-                statistics.report(LOGGER, Level.FINE, "Index check for all projects done");
+                statistics.report(LOGGER, Level.FINE, "Index version check for all projects done");
             }
         } else {
             LOGGER.log(Level.FINE, "Checking index");