Merge pull request #4 from FasterXML/tatu/3-add-currency-test

cowtowncoder · web-flow · commit 3a95f2a0ade1 · 2023-04-02T14:57:50.000-07:00
Fix #3: add "Currency"/POJO test case for Floating-point decoding performance
diff --git a/README.md b/README.md
@@ -8,12 +8,45 @@ This project contains simple set of performance micro-benchmarks, using excellen
 Has been used since Jackson 2.4 to track performance changes: see various `results-pojo-2.x-home.txt`
 files for numbers.
 
+## Usage
+
 Tests usually run with
 
-    profile-mediaitem.sh
+    run-mediaitem.sh
 
 or directly with something like
 
-    java -Xmx256m -jar target/microbenchmarks.jar ".*StdReadAfter.*PojoMediaItem.*" -wi 4 -w 1 -i 5 -r 1 -f 3 -t 1
+    java -Xmx256m -jar target/microbenchmarks.jar ".*StdReadVanilla.*PojoMediaItem.*" -wi 4 -w 1 -i 5 -r 1 -f 3 -t 1
 
 (see `results-pojo-2.13-home.txt` and others for specific invocations used for each group of numbers)
+
+## Profiling
+
+Can use
+
+    ./profile-mediaitem.sh
+
+to use basic JMH settings over runs.
+
+## Test sets
+
+### POJO: MediaItem
+
+`MediaItem` POJO comes from: https://github.com/eishay/jvm-serializers tests suite.
+Test input generated is about 300 bytes as JSON, and between 200 and 500 bytes across other formats (converted from JSON which is considered canonical).
+
+Settings to run tests include:
+
+* Standard: java -Xmx256m -jar target/microbenchmarks.jar ".*StdReadVan.*PojoMedia.*" -wi 4 -w 1 -i 5 -r 1 -f 9 -t 1
+* Afterburner: java -Xmx256m -jar target/microbenchmarks.jar ".*StdReadAfter.*PojoMedia.*" -wi 4 -w 1 -i 5 -r 1 -f 9 -t 
+1
+
+### POJO: Currency (floating-point)
+
+`Currency` POJO, and data file `./json/USD.json` (about 2kB) come from [Awesome JSON Datasets](https://github.com/jdorfman/awesome-json-datasets#currency).
+
+Settings to run tests include:
+
+* Default/JSON: java -Xmx256m -jar target/microbenchmarks.jar ".*Json.*readCurrencyPojoDefault.*" -wi 4 -w 1 -i 5 -r 1 -f 1 -t 1
+* FastFP/JSON: java -Xmx256m -jar target/microbenchmarks.jar ".*Json.*readCurrencyPojoFast.*" -wi 4 -w 1 -i 5 -r 1 -f 1 -t 1
+* All: java -Xmx256m -jar target/microbenchmarks.jar ".*readCurrencyPojo.*" -wi 4 -w 1 -i 5 -r 1 -f 1 -t 1
diff --git a/json/USD.json b/json/USD.json
@@ -0,0 +1,9 @@
+{"provider":"https://www.exchangerate-api.com",
+ "terms":"https://www.exchangerate-api.com/terms",
+ "base":"USD",
+ "date":"2023-04-01",
+ "time_last_updated":1680307201,
+ "rates":{
+   "USD":1,"AED":3.67,"AFN":86.8,"ALL":104.64,"AMD":389.34,"ANG":1.79,"AOA":510.31,"ARS":207.98,"AUD":1.49,"AWG":1.79,"AZN":1.7,"BAM":1.8,"BBD":2,"BDT":106.81,"BGN":1.8,"BHD":0.376,"BIF":2070.81,"BMD":1,"BND":1.33,"BOB":6.92,"BRL":5.08,"BSD":1,"BTN":82.19,"BWP":13.11,"BYN":2.68,"BZD":2,"CAD":1.35,"CDF":2049.44,"CHF":0.915,"CLP":790.44,"CNY":6.87,"COP":4649.49,"CRC":540.56,"CUP":24,"CVE":101.52,"CZK":21.62,"DJF":177.72,"DKK":6.87,"DOP":54.83,"DZD":135.57,"EGP":30.83,"ERN":15,"ETB":54.08,"EUR":0.921,"FJD":2.21,"FKP":0.81,"FOK":6.87,"GBP":0.81,"GEL":2.55,"GGP":0.81,"GHS":11.64,"GIP":0.81,"GMD":63.67,"GNF":8544.94,"GTQ":7.79,"GYD":211.26,"HKD":7.85,"HNL":24.61,"HRK":6.94,"HTG":155.07,"HUF":349.52,"IDR":14994.72,"ILS":3.6,"IMP":0.81,"INR":82.19,"IQD":1309.93,"IRR":42096.28,"ISK":136.34,"JEP":0.81,"JMD":150.96,"JOD":0.709,"JPY":132.92,"KES":132.34,"KGS":87.48,"KHR":4039.63,"KID":1.49,"KMF":452.95,"KRW":1304.07,"KWD":0.307,"KYD":0.833,"KZT":452.33,"LAK":16964.81,"LBP":15000,"LKR":324.88,"LRD":163.93,"LSL":17.78,"LYD":4.78,"MAD":10.22,"MDL":18.42,"MGA":4321.32,"MKD":56.71,"MMK":2097.95,"MNT":3524.66,"MOP":8.09,"MRU":34.22,"MUR":45.66,"MVR":15.43,"MWK":1031.23,"MXN":18.03,"MYR":4.42,"MZN":63.98,"NAD":17.78,"NGN":460.62,"NIO":36.55,"NOK":10.46,"NPR":131.51,"NZD":1.6,"OMR":0.384,"PAB":1,"PEN":3.76,"PGK":3.53,"PHP":54.3,"PKR":283.67,"PLN":4.3,"PYG":7151.72,"QAR":3.64,"RON":4.55,"RSD":107.87,"RUB":77.53,"RWF":1147.68,"SAR":3.75,"SBD":8.49,"SCR":13.29,"SDG":559.03,"SEK":10.37,"SGD":1.33,"SHP":0.81,"SLE":21.63,"SLL":21630.69,"SOS":568.44,"SRD":35.3,"SSP":856.64,"STN":22.56,"SYP":2521.05,"SZL":17.78,"THB":34.14,"TJS":10.91,"TMT":3.5,"TND":3.07,"TOP":2.36,"TRY":19.19,"TTD":6.75,"TVD":1.49,"TWD":30.46,"TZS":2342.17,"UAH":36.91,"UGX":3780.04,"UYU":38.73,"UZS":11414.47,"VES":24.53,"VND":23468.15,"VUV":119.05,"WST":2.71,"XAF":603.93,"XCD":2.7,"XDR":0.743,"XOF":603.93,"XPF":109.87,"YER":250.08,"ZAR":17.78,"ZMW":21.23,"ZWL":926.56
+  }
+}
diff --git a/src/main/java/com/fasterxml/jackson/perf/ReadPerfBaseFullJackson.java b/src/main/java/com/fasterxml/jackson/perf/ReadPerfBaseFullJackson.java
@@ -7,9 +7,11 @@
 import org.openjdk.jmh.infra.Blackhole;
 
 import com.fasterxml.jackson.core.FormatSchema;
+import com.fasterxml.jackson.core.StreamReadFeature;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.perf.data.InputConverter;
 import com.fasterxml.jackson.perf.data.InputData;
+import com.fasterxml.jackson.perf.model.Currency;
 
 public abstract class ReadPerfBaseFullJackson<T>
 	extends ReadPerfBaseBasicJackson<T>
@@ -20,12 +22,13 @@ public abstract class ReadPerfBaseFullJackson<T>
     protected final ObjectReader UNTYPED_READER;
     protected final ObjectReader NODE_READER;
 
+    protected final ObjectReader CURRENCY_READER_DEFAULT;
+    protected final ObjectReader CURRENCY_READER_FAST;
+
     protected ReadPerfBaseFullJackson(Class<T> type, InputConverter conv, ObjectMapper mapper)
     {
-        super(type, conv, mapper);
-        FULL_CONVERTER = conv;
-        UNTYPED_READER = mapper.readerFor(Object.class);
-        NODE_READER = mapper.readerFor(JsonNode.class);
+        this(type, conv, mapper, null);
+        
     }
 
     protected ReadPerfBaseFullJackson(Class<T> type, InputConverter conv,
@@ -45,6 +48,40 @@ protected ReadPerfBaseFullJackson(Class<T> type, InputConverter conv,
             r = r.with(schema);
         }
         NODE_READER = r;
+
+        // This is unlikely to actually work but:
+        r = mapper.readerFor(Currency.class);
+        if (schema != null) {
+            r = r.with(schema);
+        }
+        CURRENCY_READER_DEFAULT = r;
+
+        r = mapper.readerFor(Currency.class)
+                .with(StreamReadFeature.USE_FAST_DOUBLE_PARSER);
+        if (schema != null) {
+            r = r.with(schema);
+        }
+        CURRENCY_READER_FAST = r;
+    }
+
+    /*
+    /**********************************************************************
+    /* Secondary POJO tests
+    /**********************************************************************
+     */
+    
+    @Benchmark
+    @OutputTimeUnit(TimeUnit.SECONDS)
+    @Override
+    public void readCurrencyPojoDefault(Blackhole bh/*, AuxStateSize size*/) throws Exception {
+        bh.consume(read(FULL_CONVERTER.bytes(InputData.CURRENCY_WS), CURRENCY_READER_DEFAULT));
+    }
+
+    @Benchmark
+    @OutputTimeUnit(TimeUnit.SECONDS)
+    @Override
+    public void readCurrencyPojoFast(Blackhole bh/*, AuxStateSize size*/) throws Exception {
+        bh.consume(read(FULL_CONVERTER.bytes(InputData.CURRENCY_WS), CURRENCY_READER_FAST));
     }
     
     /*
diff --git a/src/main/java/com/fasterxml/jackson/perf/ReadPerfTestFull.java b/src/main/java/com/fasterxml/jackson/perf/ReadPerfTestFull.java
@@ -13,4 +13,7 @@ public interface ReadPerfTestFull extends ReadPerfTestBasic
     public void readNodeWebxml(Blackhole bh) throws Exception;
     public void readNodeMenu(Blackhole bh) throws Exception;
     public void readNodeMediaItem(Blackhole bh) throws Exception;
+
+    public void readCurrencyPojoDefault(Blackhole bh) throws Exception;
+    public void readCurrencyPojoFast(Blackhole bh) throws Exception;
 }
diff --git a/src/main/java/com/fasterxml/jackson/perf/data/InputData.java b/src/main/java/com/fasterxml/jackson/perf/data/InputData.java
@@ -10,6 +10,8 @@ public enum InputData
     WEBXML_WS("json/webxml_ws.json"),
     MENU_WS("json/menu_ws.json"),
 
+    // Data for alternate POJOs or untyped
+    CURRENCY_WS("json/USD.json")
     ;
 
     private final byte[] _json;
diff --git a/src/main/java/com/fasterxml/jackson/perf/json/JsonStringReadVanilla.java b/src/main/java/com/fasterxml/jackson/perf/json/JsonStringReadVanilla.java
@@ -9,10 +9,12 @@
 import org.openjdk.jmh.annotations.Scope;
 import org.openjdk.jmh.infra.Blackhole;
 
+import com.fasterxml.jackson.core.StreamReadFeature;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.perf.*;
 import com.fasterxml.jackson.perf.data.InputData;
 import com.fasterxml.jackson.perf.data.StringInputConverter;
+import com.fasterxml.jackson.perf.model.Currency;
 import com.fasterxml.jackson.perf.model.MediaItem;
 
 /**
@@ -34,7 +36,10 @@ public class JsonStringReadVanilla
     protected final ObjectReader UNTYPED_READER;
     protected final ObjectReader NODE_READER;
     protected final ObjectReader MEDIA_ITEM_READER;
-    
+
+    protected final ObjectReader CURRENCY_READER_DEFAULT;
+    protected final ObjectReader CURRENCY_READER_FAST;
+
     protected final StringInputConverter _converter;
 
     public JsonStringReadVanilla() {
@@ -43,6 +48,10 @@ public JsonStringReadVanilla() {
         UNTYPED_READER = MAPPER.readerFor(Object.class);
         NODE_READER = MAPPER.readerFor(JsonNode.class);
         MEDIA_ITEM_READER = MAPPER.readerFor(MediaItem.class);
+        CURRENCY_READER_DEFAULT = MAPPER.readerFor(Currency.class);
+        CURRENCY_READER_FAST = CURRENCY_READER_DEFAULT
+                .with(StreamReadFeature.USE_FAST_DOUBLE_PARSER);
+
     }
 
     protected Object read(String input, ObjectReader reader) throws IOException {
@@ -64,6 +73,24 @@ public void readPojoMediaItem(Blackhole bh/*, AuxStateSize size*/) throws Except
         bh.consume(read(input, MEDIA_ITEM_READER));
     }
 
+    @Benchmark
+    @OutputTimeUnit(TimeUnit.SECONDS)
+    @Override
+    public void readCurrencyPojoDefault(Blackhole bh/*, AuxStateSize size*/) throws Exception {
+        final String input = _converter.asString(InputData.CURRENCY_WS);
+//        size.set(input.length());
+        bh.consume(read(input, CURRENCY_READER_DEFAULT));
+    }
+
+    @Benchmark
+    @OutputTimeUnit(TimeUnit.SECONDS)
+    @Override
+    public void readCurrencyPojoFast(Blackhole bh/*, AuxStateSize size*/) throws Exception {
+        final String input = _converter.asString(InputData.CURRENCY_WS);
+//        size.set(input.length());
+        bh.consume(read(input, CURRENCY_READER_FAST));
+    }
+
     /*
     /**********************************************************************
     /* Untyped ("map") reading tests
diff --git a/src/main/java/com/fasterxml/jackson/perf/model/Currency.java b/src/main/java/com/fasterxml/jackson/perf/model/Currency.java
@@ -0,0 +1,21 @@
+package com.fasterxml.jackson.perf.model;
+
+import java.util.Map;
+
+import org.codehaus.jackson.annotate.JsonIgnoreProperties;
+
+/**
+ * Model class for data from
+ * <a href="https://www.exchangerate-api.com">Exchange Rate</a>;
+ * see {@code ./json/USD.json}.
+ *
+ */
+@JsonIgnoreProperties({
+    
+})
+public class Currency {
+    public String base, date, provider, terms;
+    public int time_last_updated;
+
+    public Map<String, Double> rates;
+}

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,7 @@ public interface ReadPerfTestFull extends ReadPerfTestBasic`
`13`	`13`	`public void readNodeWebxml(Blackhole bh) throws Exception;`
`14`	`14`	`public void readNodeMenu(Blackhole bh) throws Exception;`
`15`	`15`	`public void readNodeMediaItem(Blackhole bh) throws Exception;`
	`16`	`+`
	`17`	`+ public void readCurrencyPojoDefault(Blackhole bh) throws Exception;`
	`18`	`+ public void readCurrencyPojoFast(Blackhole bh) throws Exception;`
`16`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ public enum InputData`
`10`	`10`	`WEBXML_WS("json/webxml_ws.json"),`
`11`	`11`	`MENU_WS("json/menu_ws.json"),`
`12`	`12`
	`13`	`+ // Data for alternate POJOs or untyped`
	`14`	`+ CURRENCY_WS("json/USD.json")`
`13`	`15`	`;`
`14`	`16`
`15`	`17`	`private final byte[] _json;`