avoid global isHistoryEnabled() checks in favor of per repository check

fixes #4063

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuru.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2025, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, 2021, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.analysis;
@@ -596,7 +596,7 @@ public void populateDocument(Document doc, File file, String path, AbstractAnaly
         doc.add(new SortedDocValuesField(QueryBuilder.FULLPATH,
                 new BytesRef(file.getAbsolutePath())));
 
-        if (RuntimeEnvironment.getInstance().isHistoryEnabled()) {
+        if (HistoryGuru.getInstance().repositorySupportsHistory(file)) {
             populateDocumentHistory(doc, file);
         }
         doc.add(new Field(QueryBuilder.DATE, date, string_ft_stored_nanalyzed_norms));

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2007, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2025, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, 2020, Chris Fraire <[email protected]>.
  * Portions Copyright (c) 2020, Aleksandr Kirillov <[email protected]>.
  */
@@ -580,7 +580,7 @@ public Configuration() {
         setHandleHistoryOfRenamedFiles(false);
         setHistoryBasedReindex(true);
         setHistoryCache(true);
-        setHistoryEnabled(true);
+        setHistoryEnabled(false);
         setHitsPerPage(25);
         setIgnoredNames(new IgnoredNames());
         setIncludedNames(new Filter());
@@ -1610,37 +1610,4 @@ public ConfigurationException(String message) {
             super(message);
         }
     }
-
-    /**
-     * Check if configuration is populated and self-consistent.
-     * @throws ConfigurationException on error
-     */
-    public void checkConfiguration() throws ConfigurationException {
-
-        if (getSourceRoot() == null) {
-            throw new ConfigurationException("Source root is not specified.");
-        }
-
-        if (getDataRoot() == null) {
-            throw new ConfigurationException("Data root is not specified.");
-        }
-
-        if (!new File(getSourceRoot()).canRead()) {
-            throw new ConfigurationException("Source root directory '" + getSourceRoot() + "' must be readable.");
-        }
-
-        if (!new File(getDataRoot()).canWrite()) {
-            throw new ConfigurationException("Data root directory '" + getDataRoot() + "' must be writable.");
-        }
-
-        if (!isHistoryEnabled() && isHistoryBasedReindex()) {
-            LOGGER.log(Level.INFO, "History based reindex is on, however history is off. " +
-                    "History has to be enabled for history based reindex.");
-        }
-
-        if (!isHistoryCache() && isHistoryBasedReindex()) {
-            LOGGER.log(Level.INFO, "History based reindex is on, however history cache is off. " +
-                    "History cache has to be enabled for history based reindex.");
-        }
-    }
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/HistoryGuru.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2025, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
@@ -54,7 +54,6 @@
 import org.opengrok.indexer.analysis.AnalyzerFactory;
 import org.opengrok.indexer.analysis.AnalyzerGuru;
 import org.opengrok.indexer.configuration.CommandTimeoutType;
-import org.opengrok.indexer.configuration.Configuration;
 import org.opengrok.indexer.configuration.Configuration.RemoteSCM;
 import org.opengrok.indexer.configuration.OpenGrokThreadFactory;
 import org.opengrok.indexer.configuration.PathAccepter;
@@ -630,6 +629,14 @@ public boolean hasHistory(File file) {
             }
         }
 
+        return repositorySupportsHistory(file);
+    }
+
+    /**
+     * @param file file object
+     * @return whether related {@link Repository} and settings allow for history retrieval
+     */
+    public boolean repositorySupportsHistory(File file) {
         Repository repo = getRepository(file);
         if (repo == null) {
             LOGGER.finest(() -> String.format("cannot find repository for '%s' to check history presence",
@@ -642,7 +649,7 @@ public boolean hasHistory(File file) {
         }
 
         // This should return true for Annotate view.
-        Configuration.RemoteSCM globalRemoteSupport = env.getRemoteScmSupported();
+        RemoteSCM globalRemoteSupport = env.getRemoteScmSupported();
         boolean remoteSupported = ((globalRemoteSupport == RemoteSCM.ON)
                 || (globalRemoteSupport == RemoteSCM.UIONLY)
                 || (globalRemoteSupport == RemoteSCM.DIRBASED)

opengrok-indexer/src/main/java/org/opengrok/indexer/history/LatestRevisionUtil.java

@@ -18,15 +18,14 @@
  */
 
 /*
- * Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2025, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.history;
 
 import org.apache.lucene.document.DateTools;
 import org.apache.lucene.document.Document;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.VisibleForTesting;
-import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.index.IndexDatabase;
 import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.indexer.search.QueryBuilder;
@@ -52,11 +51,11 @@ private LatestRevisionUtil() {
 
     /**
      * @param file file object corresponding to a file under source root
-     * @return last revision string for {@code file} or null
+     * @return last revision string for {@code file} or {@code null}
      */
     @Nullable
     public static String getLatestRevision(File file) {
-        if (!RuntimeEnvironment.getInstance().isHistoryEnabled()) {
+        if (!HistoryGuru.getInstance().repositorySupportsHistory(file)) {
             return null;
         }
 

opengrok-indexer/src/main/java/org/opengrok/indexer/index/Indexer.java

@@ -209,8 +209,6 @@ public static int runMain(String[] argv) {
                 exitWithHelp();
             }
 
-            checkConfiguration();
-
             if (awaitProfiler) {
                 pauseToAwaitProfiler();
             }
@@ -278,6 +276,8 @@ public static int runMain(String[] argv) {
                 }
             }
 
+            checkConfiguration(cfg);
+
             // Set updated configuration in RuntimeEnvironment. This is called so that the tunables set
             // via command line options are available.
             env.setConfiguration(cfg, subFilePaths, CommandTimeoutType.INDEXER);
@@ -494,11 +494,44 @@ private static void checkIndexAndExit(Set<String> subFileArgs) {
         System.exit(0);
     }
 
+    /**
+     * Check if configuration is populated and self-consistent.
+     * @throws Configuration.ConfigurationException on error
+     */
+    public static void checkConfigurationValues(Configuration cfg) throws Configuration.ConfigurationException {
+
+        if (cfg.getSourceRoot() == null) {
+            throw new Configuration.ConfigurationException("Source root is not specified.");
+        }
+
+        if (cfg.getDataRoot() == null) {
+            throw new Configuration.ConfigurationException("Data root is not specified.");
+        }
+
+        if (!new File(cfg.getSourceRoot()).canRead()) {
+            throw new Configuration.ConfigurationException("Source root directory '" + cfg.getSourceRoot() + "' must be readable.");
+        }
+
+        if (!new File(cfg.getDataRoot()).canWrite()) {
+            throw new Configuration.ConfigurationException("Data root directory '" + cfg.getDataRoot() + "' must be writable.");
+        }
+
+        if (!cfg.isHistoryEnabled() && cfg.isHistoryBasedReindex()) {
+            LOGGER.log(Level.INFO, "History based reindex is on, however history is off. " +
+                    "History has to be enabled for history based reindex.");
+        }
+
+        if (!cfg.isHistoryCache() && cfg.isHistoryBasedReindex()) {
+            LOGGER.log(Level.INFO, "History based reindex is on, however history cache is off. " +
+                    "History cache has to be enabled for history based reindex.");
+        }
+    }
+
     /**
      * This is supposed to be run after {@link #parseOptions(String[])}.
      * It will exit the program if there is some serious configuration (meaning {@link #cfg}) discrepancy.
      */
-    private static void checkConfiguration() {
+    private static void checkConfiguration(Configuration cfg) {
         if (bareConfig && (env.getConfigURI() == null || env.getConfigURI().isEmpty())) {
             die("Missing webappURI setting");
         }
@@ -513,7 +546,7 @@ private static void checkConfiguration() {
         }
 
         try {
-            cfg.checkConfiguration();
+            checkConfigurationValues(cfg);
         } catch (Configuration.ConfigurationException e) {
             die(e.getMessage());
         }
@@ -1026,8 +1059,6 @@ public static String[] parseOptions(String[] argv) throws ParseException {
             cfg = new Configuration();
         }
 
-        cfg.setHistoryEnabled(false);  // force user to turn on history capture
-
         argv = optParser.parse(argv);
 
         return argv;

opengrok-indexer/src/test/java/org/opengrok/indexer/history/FileAnnotationCacheTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2021, 2025, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.history;
 
@@ -61,6 +61,8 @@ void setUp() throws Exception {
         repositories = new TestRepository();
         repositories.create(getClass().getResource("/repositories"));
 
+        env.setHistoryEnabled(true);
+
         // This needs to be set before the call to env.setRepositories() below as it instantiates HistoryGuru.
         env.setAnnotationCacheEnabled(true);
 

opengrok-indexer/src/test/java/org/opengrok/indexer/history/HistoryGuruTest.java

@@ -90,6 +90,7 @@ class HistoryGuruTest {
     @BeforeAll
     static void setUpClass() throws Exception {
         env = RuntimeEnvironment.getInstance();
+        env.setHistoryEnabled(true);
         env.setAnnotationCacheEnabled(true);
         savedNestingMaximum = env.getNestingMaximum();
 

opengrok-indexer/src/test/java/org/opengrok/indexer/history/MercurialRepositoryTest.java

@@ -25,6 +25,7 @@
 
 import org.apache.commons.lang3.tuple.Pair;
 import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -108,6 +109,12 @@ private void setUpTestRepository() throws IOException, URISyntaxException {
         repositoryRoot = new File(repository.getSourceRoot(), "mercurial");
     }
 
+    @BeforeAll
+    static void setUpClass() throws Exception {
+        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
+        env.setHistoryEnabled(true);
+    }
+
     @BeforeEach
     void setup() throws IOException, URISyntaxException {
         setUpTestRepository();

opengrok-indexer/src/test/java/org/opengrok/indexer/index/IndexerVsDeletedDocumentsTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2023, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2025, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.index;
 
@@ -36,6 +36,7 @@
 import org.eclipse.jgit.treewalk.TreeWalk;
 import org.eclipse.jgit.treewalk.filter.PathFilter;
 import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
@@ -81,6 +82,12 @@
 class IndexerVsDeletedDocumentsTest {
     RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
+    @BeforeAll
+    static void setUpClass() {
+        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
+        env.setHistoryEnabled(true);
+    }
+
     private static String getRandomString(int numChars) {
         Random random = new Random();
         final StringBuilder sb = new StringBuilder();

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2018, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2025, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.web.api.v1.controller;
@@ -113,7 +113,7 @@ private void addProjectWorkHorse(String projectName) {
         if (!env.getProjects().containsKey(projectName)) {
             Project project = new Project(projectName, "/" + projectName);
 
-            if (env.isHistoryEnabled()) {
+            if (project.isHistoryEnabled()) {
                 // Add repositories in this project.
                 List<RepositoryInfo> repos = getRepositoriesInDir(projDir);
 
@@ -130,7 +130,7 @@ private void addProjectWorkHorse(String projectName) {
             Project project = env.getProjects().get(projectName);
             Map<Project, List<RepositoryInfo>> map = env.getProjectRepositoriesMap();
 
-            if (env.isHistoryEnabled()) {
+            if (project.isHistoryEnabled()) {
                 // Refresh the list of repositories of this project.
                 // This is the goal of this action: if an existing project
                 // is re-added, this means its list of repositories has changed.
@@ -202,7 +202,7 @@ private void deleteProjectWorkHorse(Project project) {
             group.getProjects().remove(project);
         }
 
-        if (env.isHistoryEnabled()) {
+        if (project.isHistoryEnabled()) {
             // Now remove the repositories associated with this project.
             List<RepositoryInfo> repos = env.getProjectRepositoriesMap().get(project);
             if (repos != null) {
@@ -302,11 +302,11 @@ private Project getProjectFromName(String projectNameParam) {
     public Response deleteHistoryCache(@Context HttpServletRequest request,
                                        @PathParam("project") String projectNameParam) {
 
-        if (!env.isHistoryEnabled()) {
+        Project project = getProjectFromName(projectNameParam);
+        if (!project.isHistoryEnabled()) {
             return Response.status(Response.Status.NO_CONTENT).build();
         }
 
-        Project project = getProjectFromName(projectNameParam);
         List<RepositoryInfo> repos = env.getProjectRepositoriesMap().get(project);
         if (repos == null || repos.isEmpty()) {
             LOGGER.log(Level.INFO, NO_REPO_LOG_MSG, project.getName());