control the fallback to repository#getHistory()

Author: vladak

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

@@ -205,7 +205,7 @@ public final class Configuration {
      * Set to false if we want to disable fetching history of individual files
      * (by running appropriate SCM command) when the history is not found
      * in history cache for repositories capable of fetching history for
-     * directories. This option affects file based history cache only.
+     * directories.
      */
     private boolean fetchHistoryWhenNotInCache;
     /*

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

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2008, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2018, 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
@@ -638,6 +638,14 @@ private void createDirectoriesForFiles(Set<String> files, Repository repository,
     @Override
     public History get(File file, Repository repository, boolean withFiles)
             throws HistoryException, ForbiddenSymlinkException {
+
+        return get(file, repository, withFiles, env.isFetchHistoryWhenNotInCache());
+    }
+
+    @Override
+    public History get(File file, Repository repository, boolean withFiles, boolean fallback)
+            throws HistoryException, ForbiddenSymlinkException {
+
         File cacheFile = getCachedFile(file);
         if (isUpToDate(file, cacheFile)) {
             try {
@@ -661,9 +669,8 @@ public History get(File file, Repository repository, boolean withFiles)
          * since the history of all files in this repository should have been
          * fetched in the first phase of indexing.
          */
-        if (isHistoryIndexDone() && repository.isHistoryEnabled() &&
-                repository.hasHistoryForDirectories() &&
-                !env.isFetchHistoryWhenNotInCache()) {
+        if (isHistoryIndexDone() && repository.isHistoryEnabled() && repository.hasHistoryForDirectories() &&
+                !fallback) {
             return null;
         }
 

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

@@ -18,13 +18,15 @@
  */
 
 /*
- * Copyright (c) 2006, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 2022, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.history;
 
 import java.io.File;
 import java.util.Date;
 import java.util.Map;
+
+import org.jetbrains.annotations.Nullable;
 import org.opengrok.indexer.util.ForbiddenSymlinkException;
 
 interface HistoryCache {
@@ -51,17 +53,23 @@ interface HistoryCache {
      * parsing the history information in the repository.
      *
      * @param file The file to retrieve history for
-     * @param repository The external repository to read the history from (can
-     * be <code>null</code>)
-     * @param withFiles A flag saying whether or not the returned history
-     * should include a list of files touched by each changeset. If false,
-     * the implementation is allowed to skip the file list, but it doesn't
-     * have to.
+     * @param repository The external repository to read the history from (can be <code>null</code>)
+     * @param withFiles A flag saying whether the returned history should include a list of files
+     *                  touched by each changeset. If false, the implementation is allowed to skip the file list,
+     *                  but it doesn't have to.
+     * @param fallback whether to fall back to {@link Repository#getHistory(File)}
+     *                 if the history cannot be retrieved from the cache
      * @throws HistoryException if the history cannot be fetched
      * @throws ForbiddenSymlinkException if symbolic-link checking encounters
      * an ineligible link
      */
-    History get(File file, Repository repository, boolean withFiles)
+    History get(File file, @Nullable Repository repository, boolean withFiles, boolean fallback)
+            throws HistoryException, ForbiddenSymlinkException;
+
+    /**
+     * Usually a wrapper of {@link HistoryCache#get(File, Repository, boolean, boolean)}.
+     */
+    History get(File file, @Nullable Repository repository, boolean withFiles)
             throws HistoryException, ForbiddenSymlinkException;
 
     /**

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

@@ -241,11 +241,11 @@ boolean isRepoHistoryEligible(Repository repo, File file, boolean ui) {
     }
 
     @Nullable
-    private History getHistoryFromCache(File file, Repository repository, boolean withFiles, boolean ui)
+    private History getHistoryFromCache(File file, Repository repository, boolean withFiles, boolean fallback)
             throws HistoryException, ForbiddenSymlinkException {
 
         if (useCache() && historyCache.supportsRepository(repository)) {
-            return historyCache.get(file, repository, withFiles);
+            return historyCache.get(file, repository, withFiles, fallback);
         }
 
         return null;
@@ -268,7 +268,7 @@ public HistoryEntry getLastHistoryEntry(File file, boolean ui) throws HistoryExc
 
         History history;
         try {
-            history = getHistoryFromCache(file, repository, false, ui);
+            history = getHistoryFromCache(file, repository, false, false);
             if (history != null) {
                 HistoryEntry lastHistoryEntry = history.getLastHistoryEntry();
                 if (lastHistoryEntry != null) {
@@ -306,7 +306,7 @@ public History getHistory(File file, boolean withFiles, boolean ui) throws Histo
 
         History history;
         try {
-            history = getHistoryFromCache(file, repository, withFiles, ui);
+            history = getHistoryFromCache(file, repository, withFiles, true);
             if (history != null) {
                 return history;
             }
@@ -315,7 +315,7 @@ public History getHistory(File file, boolean withFiles, boolean ui) throws Histo
             return null;
         }
 
-        return repository.getHistory(file);
+        return null;
     }
 
     /**

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

@@ -887,18 +887,17 @@ void testRenamedFile() throws Exception {
                 updatedHistory.getHistoryEntries(), false);
     }
 
-    private void checkNoHistoryFetchRepo(String reponame, String filename, boolean hasHistory) throws Exception {
+    private void checkNoHistoryFetchRepo(String repoName, String filename, boolean hasHistory) throws Exception {
 
-        File reposRoot = new File(repositories.getSourceRoot(), reponame);
+        File reposRoot = new File(repositories.getSourceRoot(), repoName);
         Repository repo = RepositoryFactory.getRepository(reposRoot);
 
         // Make sure the file exists in the repository.
         File repoFile = new File(reposRoot, filename);
         assertTrue(repoFile.exists());
 
         // Try to fetch the history for given file. With default setting of
-        // FetchHistoryWhenNotInCache this should create corresponding file
-        // in history cache.
+        // FetchHistoryWhenNotInCache this should get the history even if not in cache.
         History retrievedHistory = cache.get(repoFile, repo, true);
         assertEquals(hasHistory, retrievedHistory != null);
     }