convert Statistics to use Jackson for JSON processing (#2620)

Author: Vladimir Kotal

opengrok-indexer/pom.xml

@@ -173,6 +173,16 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
             <artifactId>activation</artifactId>
             <version>1.1.1</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

opengrok-indexer/src/main/java/org/opengrok/indexer/util/StatisticsUtils.java

@@ -23,11 +23,9 @@
 
 package org.opengrok.indexer.util;
 
-import org.json.simple.JSONObject;
-import org.json.simple.parser.JSONParser;
-import org.json.simple.parser.ParseException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
-import org.opengrok.indexer.web.Util;
+import org.opengrok.indexer.web.Statistics;
 
 import java.io.File;
 import java.io.FileInputStream;
@@ -37,6 +35,7 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStream;
+import java.io.Reader;
 
 public class StatisticsUtils {
     /**
@@ -74,16 +73,15 @@ public static void saveStatistics(File out) throws IOException {
      * @throws IOException
      */
     public static void saveStatistics(OutputStream out) throws IOException {
-        out.write(Util.statisticToJson(RuntimeEnvironment.getInstance().getStatistics()).toJSONString().getBytes());
+        out.write(RuntimeEnvironment.getInstance().getStatistics().toJson().getBytes());
     }
 
     /**
      * Load statistics from JSON file specified in configuration.
      *
      * @throws IOException
-     * @throws ParseException
      */
-    public static void loadStatistics() throws IOException, ParseException {
+    public static void loadStatistics() throws IOException {
         String path = RuntimeEnvironment.getInstance().getStatisticsFilePath();
         if (path == null) {
             throw new FileNotFoundException("Statistics file is not set (null)");
@@ -96,9 +94,8 @@ public static void loadStatistics() throws IOException, ParseException {
      *
      * @param in the file with json
      * @throws IOException
-     * @throws ParseException
      */
-    public static void loadStatistics(File in) throws IOException, ParseException {
+    public static void loadStatistics(File in) throws IOException {
         if (in == null) {
             throw new FileNotFoundException("Statistics file is not set (null)");
         }
@@ -112,12 +109,19 @@ public static void loadStatistics(File in) throws IOException, ParseException {
      *
      * @param in the file with json
      * @throws IOException
-     * @throws ParseException
      */
-    public static void loadStatistics(InputStream in) throws IOException, ParseException {
-        try (InputStreamReader iReader = new InputStreamReader(in)) {
-            JSONParser jsonParser = new JSONParser();
-            RuntimeEnvironment.getInstance().setStatistics(Util.jsonToStatistics((JSONObject) jsonParser.parse(iReader)));
+    public static void loadStatistics(InputStream in) throws IOException {
+        try (Reader iReader = new InputStreamReader(in, "UTF-8")) {
+            StringBuilder outputString = new StringBuilder();
+            final char[] buf = new char[1024];
+            int rsz;
+            while ((rsz = iReader.read(buf, 0, buf.length)) > 0) {
+                outputString.append(buf, 0, rsz);
+            }
+
+            ObjectMapper mapper = new ObjectMapper();
+            org.opengrok.indexer.web.Statistics newstats = mapper.readValue(outputString.toString(), Statistics.class);
+            RuntimeEnvironment.getInstance().setStatistics(newstats);
         }
     }
 

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

@@ -22,13 +22,17 @@
  */
 package org.opengrok.indexer.web;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.io.IOException;
 import java.util.Calendar;
 import java.util.Map;
 import java.util.TreeMap;
 import java.util.stream.Collectors;
 import java.util.stream.LongStream;
-import org.json.simple.JSONArray;
-import org.json.simple.JSONObject;
 
 /**
  * Framework for statistics gathering. So far used only by the webapp.
@@ -51,18 +55,35 @@ public class Statistics {
     protected static final String STATISTIC_DAY_HISTOGRAM = "day_histogram";
     protected static final String STATISTIC_MONTH_HISTOGRAM = "month_histogram";
 
+    @JsonProperty(STATISTIC_REQUEST_CATEGORIES)
     private Map<String, Long> requestCategories = new TreeMap<>();
+    @JsonProperty(STATISTIC_TIMING)
     private Map<String, Long> timing = new TreeMap<>();
+    @JsonProperty(STATISTIC_TIMING_MIN)
     private Map<String, Long> timingMin = new TreeMap<>();
+    @JsonProperty(STATISTIC_TIMING_MAX)
     private Map<String, Long> timingMax = new TreeMap<>();
+    @JsonProperty(STATISTIC_TIMING_AVG)
+    private Map<String, Double> timingAvg = new TreeMap<>();
+    @JsonProperty(STATISTIC_DAY_HISTOGRAM)
     private long[] dayHistogram = new long[24];
+    @JsonProperty(STATISTIC_MONTH_HISTOGRAM)
     private long[] monthHistogram = new long[31];
-    private long timeStart = System.currentTimeMillis();
+    @JsonProperty(STATISTIC_REQUESTS)
     private long requests = 0;
+    @JsonProperty(STATISTIC_MINUTES)
     private long minutes = 1;
+    @JsonProperty(STATISTIC_REQUESTS_PER_MINUTE)
     private long requestsPerMinute = 0;
+    @JsonProperty(STATISTIC_REQUESTS_PER_MINUTE_MIN)
     private long requestsPerMinuteMin = Long.MAX_VALUE;
+    @JsonProperty(STATISTIC_REQUESTS_PER_MINUTE_MAX)
     private long requestsPerMinuteMax = Long.MIN_VALUE;
+    @JsonProperty(STATISTIC_REQUESTS_PER_MINUTE_AVG)
+    private double requestsPerMinuteAvg = 0;
+
+    @JsonIgnore
+    private long timeStart = System.currentTimeMillis();
 
     /**
      * Adds a single request into all requests.
@@ -72,6 +93,7 @@ synchronized public void addRequest() {
 
         requestsPerMinute++;
         requests++;
+        requestsPerMinuteAvg = requests / (double) minutes;
 
         if (requestsPerMinute > requestsPerMinuteMax) {
             requestsPerMinuteMax = requestsPerMinute;
@@ -102,6 +124,7 @@ synchronized protected void maybeRefresh() {
      * @param category category
      */
     synchronized public void addRequest(String category) {
+        maybeRefresh();
         Long val = requestCategories.get(category);
         if (val == null) {
             val = 0L;
@@ -146,6 +169,10 @@ synchronized public void addRequestTime(String category, long v) {
         timing.put(category, val);
         timingMin.put(category, min);
         timingMax.put(category, max);
+
+        // Recompute the average for given category.
+        timingAvg.put(category,
+                timing.get(category).doubleValue() / requestCategories.get(category));
     }
 
     public Map<String, Long> getRequestCategories() {
@@ -171,11 +198,6 @@ public Map<String, Long> getTimingMax() {
      * @return map of averages for each category
      */
     public Map<String, Double> getTimingAvg() {
-        Map<String, Double> timingAvg = new TreeMap<>();
-        for (Map.Entry<String, Long> entry : timing.entrySet()) {
-            timingAvg.put(entry.getKey(), entry.getValue().doubleValue()
-                    / requestCategories.get(entry.getKey()));
-        }
         return timingAvg;
     }
 
@@ -195,6 +217,10 @@ synchronized public void setTimingMax(Map<String, Long> timing_max) {
         this.timingMax = timing_max;
     }
 
+    synchronized public void setTimingAvg(Map<String, Double> timing_avg) {
+        this.timingAvg = timing_avg;
+    }
+
     public long getTimeStart() {
         return timeStart;
     }
@@ -212,7 +238,6 @@ synchronized public void setRequests(long requests) {
     }
 
     public long getMinutes() {
-        maybeRefresh();
         return minutes;
     }
 
@@ -221,7 +246,6 @@ synchronized public void setMinutes(long minutes) {
     }
 
     public long getRequestsPerMinute() {
-        maybeRefresh();
         return requestsPerMinute;
     }
 
@@ -252,8 +276,11 @@ synchronized public void setRequestsPerMinuteMax(long requestsPerMinuteMax) {
     }
 
     public double getRequestsPerMinuteAvg() {
-        maybeRefresh();
-        return requests / (double) minutes;
+        return this.requestsPerMinuteAvg;
+    }
+
+    synchronized public void setRequestsPerMinuteAvg(double value) {
+        this.requestsPerMinuteAvg = value;
     }
 
     public long[] getDayHistogram() {
@@ -273,116 +300,41 @@ synchronized public void setMonthHistogram(long[] monthHistogram) {
     }
 
     /**
-     * Convert this statistics object into JSONObject.
+     * Convert this {@code Statistics} object into JSON
      *
-     * @return the json object
+     * @return the JSON string
      */
-    public JSONObject toJson() {
+    public String toJson() throws JsonProcessingException {
         return toJson(this);
     }
 
     /**
-     * Convert JSONObject object into statistics.
+     * Convert JSON into {@code Statistics} object.
      *
-     * @param input object containing statistics
-     * @return the statistics object
+     * @param jsonString String with JSON
+     * @return the {@code Statistics} object
      */
     @SuppressWarnings("unchecked")
-    public static Statistics from(JSONObject input) {
-        Statistics stats = new Statistics();
-        Object o;
-        if ((o = input.get(STATISTIC_REQUEST_CATEGORIES)) != null) {
-            stats.setRequestCategories((Map<String, Long>) o);
-        }
-        if ((o = input.get(STATISTIC_TIMING)) != null) {
-            stats.setTiming((Map<String, Long>) o);
-        }
-        if ((o = input.get(STATISTIC_TIMING_MIN)) != null) {
-            stats.setTimingMin((Map<String, Long>) o);
-        }
-        if ((o = input.get(STATISTIC_TIMING_MAX)) != null) {
-            stats.setTimingMax((Map<String, Long>) o);
-        }
-        if ((o = input.get(STATISTIC_REQUESTS)) != null) {
-            stats.setRequests((long) o);
-        }
-        if ((o = input.get(STATISTIC_MINUTES)) != null) {
-            stats.setMinutes((long) o);
-        }
-        if ((o = input.get(STATISTIC_REQUESTS_PER_MINUTE)) != null) {
-            stats.setRequestsPerMinute((long) o);
-        }
-        if ((o = input.get(STATISTIC_REQUESTS_PER_MINUTE_MIN)) != null) {
-            stats.setRequestsPerMinuteMin((long) o);
-        }
-        if ((o = input.get(STATISTIC_REQUESTS_PER_MINUTE_MAX)) != null) {
-            stats.setRequestsPerMinuteMax((long) o);
-        }
-        if ((o = input.get(STATISTIC_DAY_HISTOGRAM)) != null) {
-            stats.setDayHistogram(convertJSONArrayToArray((JSONArray) o, stats.getDayHistogram()));
-        }
-        if ((o = input.get(STATISTIC_MONTH_HISTOGRAM)) != null) {
-            stats.setMonthHistogram(convertJSONArrayToArray((JSONArray) o, stats.getMonthHistogram()));
-        }
+    public static Statistics fromJson(String jsonString) throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        Statistics stats = mapper.readValue(jsonString, Statistics.class);
         stats.setTimeStart(System.currentTimeMillis());
+
         return stats;
     }
 
     /**
-     * Convert statistics object into JSONObject.
+     * Convert statistics object into JSON.
      *
      * @param stats the statistics object
-     * @return the json object or empty json object if there was no request
-     */
-    @SuppressWarnings("unchecked")
-    public static JSONObject toJson(Statistics stats) {
-        JSONObject output = new JSONObject();
-        if (stats.getRequests() == 0) {
-            return output;
-        }
-        output.put(STATISTIC_REQUEST_CATEGORIES, new JSONObject(stats.getRequestCategories()));
-        output.put(STATISTIC_TIMING, new JSONObject(stats.getTiming()));
-        output.put(STATISTIC_TIMING_MIN, new JSONObject(stats.getTimingMin()));
-        output.put(STATISTIC_TIMING_MAX, new JSONObject(stats.getTimingMax()));
-        output.put(STATISTIC_TIMING_AVG, new JSONObject(stats.getTimingAvg()));
-        output.put(STATISTIC_MINUTES, stats.getMinutes());
-        output.put(STATISTIC_REQUESTS, stats.getRequests());
-        output.put(STATISTIC_REQUESTS_PER_MINUTE, stats.getRequestsPerMinute());
-        output.put(STATISTIC_REQUESTS_PER_MINUTE_MIN, stats.getRequestsPerMinuteMin());
-        output.put(STATISTIC_REQUESTS_PER_MINUTE_MAX, stats.getRequestsPerMinuteMax());
-        output.put(STATISTIC_REQUESTS_PER_MINUTE_AVG, stats.getRequestsPerMinuteAvg());
-        output.put(STATISTIC_DAY_HISTOGRAM, convertArrayToJSONArray(stats.getDayHistogram()));
-        output.put(STATISTIC_MONTH_HISTOGRAM, convertArrayToJSONArray(stats.getMonthHistogram()));
-        return output;
-    }
-
-    /**
-     * Converts an array into json array.
-     *
-     * @param array the input array
-     * @return the output json array
+     * @return String with JSON
      */
     @SuppressWarnings("unchecked")
-    private static JSONArray convertArrayToJSONArray(long[] array) {
-        JSONArray ret = new JSONArray();
-        for (long o : array) {
-            ret.add(o);
-        }
-        return ret;
-    }
+    public static String toJson(Statistics stats) throws JsonProcessingException {
+        ObjectMapper mapper = new ObjectMapper();
+        String jsonStr = mapper.writeValueAsString(stats);
 
-    /**
-     * Converts an json array into an array.
-     *
-     * @param dest the input json array
-     * @param target the output array
-     * @return target
-     */
-    private static long[] convertJSONArrayToArray(JSONArray dest, long[] target) {
-        for (int i = 0; i < target.length && i < dest.size(); i++) {
-            target[i] = (long) dest.get(i);
-        }
-        return target;
+        return jsonStr;
     }
 
     @Override
@@ -400,6 +352,5 @@ public String toString() {
                 + "\nrequestsPerMinuteAvg = " + getRequestsPerMinuteAvg()
                 + "\ndayHistogram = " + LongStream.of(getDayHistogram()).mapToObj(a -> Long.toString(a)).map(a -> a.toString()).collect(Collectors.joining(", "))
                 + "\nmonthHistogram = " + LongStream.of(getMonthHistogram()).mapToObj(a -> Long.toString(a)).map(a -> a.toString()).collect(Collectors.joining(", "));
-
     }
 }

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

@@ -1461,26 +1461,6 @@ public static JSONArray messagesToJson(Group group) {
         return messagesToJson(group, new String[0]);
     }
 
-    /**
-     * Convert statistics object into JSONObject.
-     *
-     * @param stats object containing statistics
-     * @return the json object
-     */
-    public static JSONObject statisticToJson(Statistics stats) {
-        return stats.toJson();
-    }
-
-    /**
-     * Convert JSONObject object into statistics.
-     *
-     * @param input object containing statistics
-     * @return the statistics object
-     */
-    public static Statistics jsonToStatistics(JSONObject input) {
-        return Statistics.from(input);
-    }
-
     /**
      * Print a row in an HTML table.
      *