Initial fix for ambiguous git hashes in index. Keeps the compact revision format for the annotate screen but uses full hash on the history view.

Author: harrisric

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

@@ -21,6 +21,7 @@
  * Copyright (c) 2007, 2022, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2019, Krystof Tulinger <[email protected]>.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2023, Ric Harris <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -66,7 +67,11 @@ public Annotation(AnnotationData annotationData) {
     }
 
     void addLine(String revision, String author, boolean enabled) {
-        annotationData.addLine(revision, author, enabled);
+        annotationData.addLine(revision, author, enabled, null);
+    }
+
+    void addLine(String revision, String author, boolean enabled, String displayRevision) {
+      annotationData.addLine(revision, author, enabled, displayRevision);
     }
 
     public String getFilename() {
@@ -104,6 +109,17 @@ public String getRevision(int line) {
         return annotationData.getRevision(line);
     }
 
+    /**
+     * Gets the revision for the last change to the specified line in a format that may be specifically for display purposes.
+     *
+     * @param line line number (counting from 1)
+     * @return revision string, or an empty string if there is no information
+     * about the specified line
+     */
+    public String getRevisionForDisplay(int line) {
+      return annotationData.getRevisionForDisplay(line);
+    }
+
     /**
      * Gets all revisions that are in use, first is the lowest one (sorted using natural order).
      *

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

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2007, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2023, Ric Harris <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -110,6 +111,23 @@ public String getRevision(int line) {
         }
     }
 
+    /**
+     * Gets the revision for the last change to the specified line.
+     *
+     * @param line line number (counting from 1)
+     * @return revision string, or an empty string if there is no information
+     * about the specified line
+     */
+    public String getRevisionForDisplay(int line) {
+        try {
+            AnnotationLine annotationLine = annotationLines.get(line - 1);
+            return annotationLine.getRevision();
+        } catch (IndexOutOfBoundsException e) {
+            return "";
+        }
+    }
+
+
     /**
      * Gets the enabled state for the last change to the specified line.
      *
@@ -177,18 +195,19 @@ public int getWidestAuthor() {
      */
     void addLine(final AnnotationLine annotationLine) {
         annotationLines.add(annotationLine);
-        widestRevision = Math.max(widestRevision, annotationLine.getRevision().length());
+        widestRevision = Math.max(widestRevision, annotationLine.getDisplayRevision().length());
         widestAuthor = Math.max(widestAuthor, annotationLine.getAuthor().length());
     }
 
     /**
      * @param revision revision number
      * @param author author name
      * @param enabled whether the line is enabled
+     * @param displayRevision a specialised revision number of display purposes. Can be null in which case the revision number will be used.
      * @see #addLine(AnnotationLine)
      */
-    void addLine(String revision, String author, boolean enabled) {
-        final AnnotationLine annotationLine = new AnnotationLine(revision, author, enabled);
+    void addLine(String revision, String author, boolean enabled, String displayRevision) {
+        final AnnotationLine annotationLine = new AnnotationLine(revision, author, enabled, displayRevision);
         addLine(annotationLine);
     }
 

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

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2007, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2023, Ric Harris <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -40,14 +41,17 @@ public class AnnotationLine implements Serializable {
     private String author;
     private boolean enabled;
 
+    private String displayRevision;
+
     public AnnotationLine() {
         // for serialization
     }
 
-    AnnotationLine(String revision, String author, boolean enabled) {
-        this.revision = (revision == null) ? "" : revision;
-        this.author = (author == null) ? "" : author;
+    AnnotationLine(String revision, String author, boolean enabled, String displayRevision) {
+        this.revision = revision == null ? "" : revision;
+        this.author = author == null ? "" : author;
         this.enabled = enabled;
+        this.setDisplayRevision(displayRevision);
     }
 
     public String getRevision() {
@@ -74,6 +78,19 @@ public void setEnabled(boolean enabled) {
         this.enabled = enabled;
     }
 
+    /**
+     * A specialised revision for display purposes.
+     *
+     * @return the display revision if not null, otherwise the revision.
+     */
+    public String getDisplayRevision() {
+      return displayRevision == null ? revision : displayRevision;
+    }
+
+    public void setDisplayRevision(String displayRevision) {
+      this.displayRevision = displayRevision;
+    }
+
     @Override
     public boolean equals(Object obj) {
         if (obj == null) {

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

@@ -21,6 +21,7 @@
  * Copyright (c) 2008, 2023, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, 2020, Chris Fraire <[email protected]>.
  * Portions Copyright (c) 2019, Krystof Tulinger <[email protected]>.
+ * Portions Copyright (c) 2023, Ric Harris <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -377,8 +378,10 @@ private Annotation getAnnotation(String revision, String filePath, String fileNa
                 for (int i = 0; i < rawText.size(); i++) {
                     final PersonIdent sourceAuthor = result.getSourceAuthor(i);
                     final RevCommit sourceCommit = result.getSourceCommit(i);
-                    annotation.addLine(sourceCommit.getId().abbreviate(GIT_ABBREV_LEN).
-                            name(), sourceAuthor.getName(), true);
+                    annotation.addLine(
+                      sourceCommit.getId().name(),
+                      sourceAuthor.getName(), true,
+                      sourceCommit.getId().abbreviate(GIT_ABBREV_LEN).name());
                 }
             }
         } catch (GitAPIException e) {
@@ -449,6 +452,7 @@ public int getPerPartesCount() {
         return MAX_CHANGESETS;
     }
 
+    @Override
     public void accept(String sinceRevision, Consumer<BoundaryChangesets.IdWithProgress> visitor, Progress progress)
             throws HistoryException {
 
@@ -476,10 +480,12 @@ public HistoryEntry getLastHistoryEntry(File file, boolean ui) throws HistoryExc
         return hist.getLastHistoryEntry();
     }
 
+    @Override
     public History getHistory(File file, String sinceRevision, String tillRevision) throws HistoryException {
         return getHistory(file, sinceRevision, tillRevision, null);
     }
 
+    @Override
     public void traverseHistory(File file, String sinceRevision, String tillRevision,
                               Integer numCommits, List<ChangesetVisitor> visitors) throws HistoryException {
 
@@ -496,7 +502,7 @@ public void traverseHistory(File file, String sinceRevision, String tillRevision
 
             int num = 0;
             for (RevCommit commit : walk) {
-                CommitInfo commitInfo = new CommitInfo(commit.getId().abbreviate(GIT_ABBREV_LEN).name(),
+                CommitInfo commitInfo = new CommitInfo(commit.getId().name(),
                         commit.getAuthorIdent().getWhen(), commit.getAuthorIdent().getName(),
                         commit.getAuthorIdent().getEmailAddress(), commit.getFullMessage());
 
@@ -734,7 +740,7 @@ private void rebuildTagList(File directory) {
 
                 for (Map.Entry<RevCommit, String> entry : commit2Tags.entrySet()) {
                     int commitTime = entry.getKey().getCommitTime();
-                    Date date = new Date((long) (commitTime) * 1000);
+                    Date date = new Date((long) commitTime * 1000);
                     GitTagEntry tagEntry = new GitTagEntry(entry.getKey().getName(),
                             date, entry.getValue());
                     this.tagList.add(tagEntry);
@@ -835,7 +841,7 @@ public String determineCurrentVersion(CommandTimeoutType cmdType) throws IOExcep
                 try (RevWalk walk = new RevWalk(repository); ObjectReader reader = repository.newObjectReader()) {
                     RevCommit commit = walk.parseCommit(head.getObjectId());
                     int commitTime = commit.getCommitTime();
-                    Date date = new Date((long) (commitTime) * 1000);
+                    Date date = new Date((long) commitTime * 1000);
                     return String.format("%s %s %s %s",
                             format(date),
                             reader.abbreviate(head.getObjectId()).name(),

opengrok-indexer/src/main/java/org/opengrok/indexer/web/Util.java

@@ -22,6 +22,7 @@
  * Portions Copyright (c) 2011, Jens Elkner.
  * Portions Copyright (c) 2017, 2020, Chris Fraire <[email protected]>.
  * Portions Copyright (c) 2019, Krystof Tulinger <[email protected]>.
+ * Portions Copyright (c) 2023, Ric Harris <[email protected]>.
  */
 package org.opengrok.indexer.web;
 
@@ -762,7 +763,7 @@ private static void writeAnnotation(int num, Writer out, Annotation annotation,
             buf.append("<span class=\"most_recent_revision\">");
             buf.append('*');
         }
-        htmlize(r, buf);
+        htmlize(annotation.getRevisionForDisplay(num), buf);
         if (most_recent_revision) {
             buf.append("</span>"); // recent revision span
         }

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

@@ -66,9 +66,9 @@ void testEqualsNegativeFileName() {
      */
     @Test
     void testEqualsNegative() {
-        final AnnotationLine annotationLine1 = new AnnotationLine("1.0", "Me", true);
-        final AnnotationLine annotationLine2 = new AnnotationLine("1.1", "Me", true);
-        final AnnotationLine annotationLine3 = new AnnotationLine("1.2", "Me", true);
+        final AnnotationLine annotationLine1 = new AnnotationLine("1.0", "Me", true, null);
+        final AnnotationLine annotationLine2 = new AnnotationLine("1.1", "Me", true, null);
+        final AnnotationLine annotationLine3 = new AnnotationLine("1.2", "Me", true, null);
 
         AnnotationData annotationData1 = new AnnotationData();
         annotationData1.addLine(annotationLine1);
@@ -88,8 +88,8 @@ void testEqualsNegative() {
      */
     @Test
     void testEqualsNegativeStoredRevision() {
-        final AnnotationLine annotationLine1 = new AnnotationLine("1.0", "Me", true);
-        final AnnotationLine annotationLine2 = new AnnotationLine("1.1", "Me", true);
+        final AnnotationLine annotationLine1 = new AnnotationLine("1.0", "Me", true, null);
+        final AnnotationLine annotationLine2 = new AnnotationLine("1.1", "Me", true, null);
 
         AnnotationData annotationData1 = new AnnotationData();
         annotationData1.addLine(annotationLine1);
@@ -111,9 +111,9 @@ void testEqualsNegativeStoredRevision() {
     @Test
     void testEqualsPositive() {
         final String fileName = "foo.txt";
-        final AnnotationLine annotationLine1 = new AnnotationLine("1.0", "Me", true);
-        final AnnotationLine annotationLine2 = new AnnotationLine("1.1", "Me", true);
-        final AnnotationLine annotationLine3 = new AnnotationLine("1.2", "Me", true);
+        final AnnotationLine annotationLine1 = new AnnotationLine("1.0", "Me", true, null);
+        final AnnotationLine annotationLine2 = new AnnotationLine("1.1", "Me", true, null);
+        final AnnotationLine annotationLine3 = new AnnotationLine("1.2", "Me", true, null);
 
         AnnotationData annotationData1 = new AnnotationData(fileName);
         annotationData1.addLine(annotationLine1);

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

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2023, Ric Harris <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -36,8 +37,8 @@ class AnnotationLineTest {
      */
     @Test
     void testEqualsNegative1() {
-        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true);
-        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "barX", true);
+        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true, null);
+        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "barX", true, null);
         assertNotEquals(annotationLine1, annotationLine2);
     }
 
@@ -46,8 +47,8 @@ void testEqualsNegative1() {
      */
     @Test
     void testEqualsNegative2() {
-        AnnotationLine annotationLine1 = new AnnotationLine("1.0.1", "bar", true);
-        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "bar", true);
+        AnnotationLine annotationLine1 = new AnnotationLine("1.0.1", "bar", true, null);
+        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "bar", true, null);
         assertNotEquals(annotationLine1, annotationLine2);
     }
 
@@ -56,8 +57,8 @@ void testEqualsNegative2() {
      */
     @Test
     void testEqualsNegative3() {
-        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true);
-        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "bar", false);
+        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true, null);
+        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "bar", false, null);
         assertNotEquals(annotationLine1, annotationLine2);
     }
 
@@ -66,8 +67,26 @@ void testEqualsNegative3() {
      */
     @Test
     void testEqualsPositive() {
-        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true);
-        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "bar", true);
+        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true, null);
+        AnnotationLine annotationLine2 = new AnnotationLine("1.0", "bar", true, null);
         assertEquals(annotationLine1, annotationLine2);
     }
+
+    /**
+     * Verify that the display revision getter falls back to the revision.
+     */
+    @Test
+    void testDisplayRevisionFallBack() {
+        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true, null);
+        assertEquals("1.0", annotationLine1.getDisplayRevision());
+    }
+
+    /**
+     * Verify that the display revision getter overrides the base revision.
+     */
+    @Test
+    void testDisplayRevisionOverrides() {
+        AnnotationLine annotationLine1 = new AnnotationLine("1.0", "bar", true, "1.0.abcd");
+        assertEquals("1.0.abcd", annotationLine1.getDisplayRevision());
+    }
 }

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

@@ -71,7 +71,7 @@ public void testStoreAndGet() throws Exception {
 
         cache.store(historyToStore, repo);
 
-        assertEquals("206f862b", cache.getLatestCachedRevision(repo), "latest git-octopus commit");
+        assertEquals("206f862b18a4e1a73025e6c0c82883cb92a89b1d", cache.getLatestCachedRevision(repo), "latest git-octopus commit");
 
         History dHist = cache.get(new File(reposRoot, "d"), repo, true);
         assertNotNull(dHist, "cache get() for git-octopus/d");

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

@@ -181,7 +181,7 @@ public void testOctopusHistory() throws Exception {
         assertEquals(4, allFiles.size(), "git-octopus files from log");
 
         HistoryEntry first = entries.get(0);
-        assertEquals("206f862b", first.getRevision(), "should be merge commit hash");
+        assertEquals("206f862b18a4e1a73025e6c0c82883cb92a89b1d", first.getRevision(), "should be merge commit hash");
         assertEquals("Merge branches 'file_a', 'file_b' and 'file_c' into master, and add d",
                 first.getMessage(),
                 "should be merge commit message");