use CBOR to serialize AnnotationData

fixes #4096

Author: vladak

opengrok-indexer/pom.xml

@@ -194,6 +194,11 @@ Portions Copyright (c) 2020-2020, Lubos Kosco <[email protected]>.
             <artifactId>jackson-databind</artifactId>
             <version>${jackson.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-cbor</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>

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

@@ -75,7 +75,12 @@ File getCachedFile(File file) throws CacheException {
             throw new CacheException("Failed to get path relative to source root for " + file, e);
         }
 
-        return new File(TandemPath.join(sb.toString(), ".gz"));
+        String suffix = getCacheFileSuffix();
+        if (suffix != null && !suffix.isEmpty()) {
+            return new File(TandemPath.join(sb.toString(), suffix));
+        }
+
+        return new File(sb.toString());
     }
 
     public List<String> clearCache(Collection<RepositoryInfo> repositories) {
@@ -125,4 +130,8 @@ public void clearFile(String path) {
 
         clearWithParent(historyFile);
     }
+
+    public String getCacheFileSuffix() {
+        return ".gz";
+    }
 }

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

@@ -103,4 +103,9 @@ public interface Cache {
      * @throws CacheException on error
      */
     boolean isUpToDate(File file) throws CacheException;
+
+    /**
+     * @return suffix used for the cache files
+     */
+    String getCacheFileSuffix();
 }

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

@@ -22,6 +22,8 @@
  */
 package org.opengrok.indexer.history;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.cbor.databind.CBORMapper;
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.MeterRegistry;
 import org.jetbrains.annotations.Nullable;
@@ -30,22 +32,15 @@
 import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.indexer.util.Statistics;
 
-import java.beans.XMLDecoder;
-import java.io.BufferedInputStream;
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
-import java.io.InputStream;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-import java.util.zip.GZIPInputStream;
 
 public class FileAnnotationCache extends AbstractCache implements AnnotationCache {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(FileAnnotationCache.class);
 
-    private static final ClassLoader classLoader = new AnnotationDataClassLoader();
-
     private Counter fileAnnotationCacheHits;
     private Counter fileAnnotationCacheMisses;
 
@@ -65,18 +60,17 @@ public void initialize() {
         }
     }
 
-    private static XMLDecoder getDecoder(InputStream in) {
-        return new XMLDecoder(in, null, null, classLoader);
-    }
-
     /**
      * Read annotation from a file.
      */
     static Annotation readCache(File file) throws IOException {
-        try (FileInputStream in = new FileInputStream(file);
-             XMLDecoder d = getDecoder(new GZIPInputStream(new BufferedInputStream(in)))) {
-            return new Annotation((AnnotationData) d.readObject());
-        }
+        ObjectMapper mapper = new CBORMapper();
+        return new Annotation(mapper.readValue(file, AnnotationData.class));
+    }
+
+    @Override
+    public String getCacheFileSuffix() {
+        return "";
     }
 
     @VisibleForTesting
@@ -90,7 +84,10 @@ Annotation readAnnotation(File file) throws CacheException {
         }
 
         try {
-            return readCache(cacheFile);
+            Statistics statistics = new Statistics();
+            Annotation annotation = readCache(cacheFile);
+            statistics.report(LOGGER, Level.FINEST, String.format("deserialized annotation from cache for '%s'", file));
+            return annotation;
         } catch (IOException e) {
             throw new CacheException(String.format("failed to read annotation cache for '%s'", file), e);
         }
@@ -156,6 +153,11 @@ public Annotation get(File file, @Nullable String rev) throws CacheException {
         return annotation;
     }
 
+    private void writeCache(AnnotationData annotationData, File outfile) throws IOException {
+        ObjectMapper mapper = new CBORMapper();
+        mapper.writeValue(outfile, annotationData);
+    }
+
     public void store(File file, Annotation annotation) throws CacheException {
         if (annotation.getRevision() == null || annotation.getRevision().isEmpty()) {
             throw new CacheException(String.format("annotation for ''%s'' does not contain revision", file));
@@ -177,7 +179,7 @@ public void store(File file, Annotation annotation) throws CacheException {
 
         Statistics statistics = new Statistics();
         try {
-            CacheUtil.writeCache(annotation.annotationData, cacheFile);
+            writeCache(annotation.annotationData, cacheFile);
             statistics.report(LOGGER, Level.FINEST, String.format("wrote annotation for '%s'", file),
                     "cache.annotation.file.store.latency");
         } catch (IOException e) {

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

@@ -311,7 +311,9 @@ public Annotation annotate(File file, @Nullable String rev, boolean fallback) th
             return null;
         }
 
+        Statistics statistics = new Statistics();
         completeAnnotationWithHistory(file, annotation, repo);
+        statistics.report(LOGGER, Level.FINEST, String.format("completed annotation with history for '%s'", file));
 
         return annotation;
     }