Merge pull request #9929 from vespa-engine/bratseth/make-JsonRenderer-subclassable

Allow subclassing by making some hooks protected

4 files changed, 64 insertions, 20 deletions

diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java
index 63cce619333..a18d1eee0fc 100644
--- a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java
+++ b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java
@@ -19,7 +19,10 @@ import com.yahoo.processing.response.Streamed;
 
 import java.io.IOException;
 import java.io.OutputStream;
-import java.util.*;
+import java.util.ArrayDeque;
+import java.util.Collections;
+import java.util.Deque;
+import java.util.List;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executor;
 import java.util.concurrent.LinkedBlockingQueue;
diff --git a/container-search/abi-spec.json b/container-search/abi-spec.json
index cc06710480d..e69303c2d01 100644
--- a/container-search/abi-spec.json
+++ b/container-search/abi-spec.json
@@ -6810,6 +6810,25 @@
     ],
     "fields": []
   },
+  "com.yahoo.search.rendering.JsonRenderer$FieldConsumer": {
+    "superClass": "java.lang.Object",
+    "interfaces": [
+      "com.yahoo.search.result.Hit$RawUtf8Consumer"
+    ],
+    "attributes": [
+      "public"
+    ],
+    "methods": [
+      "public void <init>(com.fasterxml.jackson.core.JsonGenerator, boolean)",
+      "public void accept(java.lang.String, java.lang.Object)",
+      "public void accept(java.lang.String, byte[], int, int)",
+      "protected boolean shouldRender(java.lang.String, java.lang.Object)",
+      "protected boolean shouldRenderUtf8Value(java.lang.String, int)",
+      "protected void renderFieldContents(java.lang.Object)",
+      "public bridge synthetic void accept(java.lang.Object, java.lang.Object)"
+    ],
+    "fields": []
+  },
   "com.yahoo.search.rendering.JsonRenderer": {
     "superClass": "com.yahoo.processing.rendering.AsynchronousSectionedRenderer",
     "interfaces": [],
@@ -6822,13 +6841,25 @@
       "protected static com.fasterxml.jackson.databind.ObjectMapper createJsonCodec()",
       "public void init()",
       "public void beginResponse(java.io.OutputStream)",
+      "protected void renderTrace(com.yahoo.processing.execution.Execution$Trace)",
       "public void beginList(com.yahoo.processing.response.DataList)",
       "protected void moreChildren()",
+      "protected void renderHitGroupHead(com.yahoo.search.result.HitGroup)",
+      "protected void renderErrors(java.util.Set)",
+      "protected void renderCoverage()",
+      "protected void renderHit(com.yahoo.search.result.Hit)",
+      "protected boolean shouldRender(com.yahoo.search.result.Hit)",
+      "protected void renderHitContents(com.yahoo.search.result.Hit)",
+      "protected void renderAllFields(com.yahoo.search.result.Hit)",
+      "protected void renderContinuations(java.util.Map)",
+      "protected void renderGroupMetadata(com.yahoo.search.grouping.result.GroupId)",
+      "protected void renderTotalHitCount(com.yahoo.search.result.Hit)",
       "public void data(com.yahoo.processing.response.Data)",
       "public void endList(com.yahoo.processing.response.DataList)",
       "public void endResponse()",
       "public java.lang.String getEncoding()",
-      "public java.lang.String getMimeType()"
+      "public java.lang.String getMimeType()",
+      "protected com.yahoo.search.rendering.JsonRenderer$FieldConsumer createFieldConsumer(com.fasterxml.jackson.core.JsonGenerator, boolean)"
     ],
     "fields": []
   },
diff --git a/container-search/src/main/java/com/yahoo/search/rendering/JsonRenderer.java b/container-search/src/main/java/com/yahoo/search/rendering/JsonRenderer.java
index 4bcb48447db..54dfbfe1a85 100644
--- a/container-search/src/main/java/com/yahoo/search/rendering/JsonRenderer.java
+++ b/container-search/src/main/java/com/yahoo/search/rendering/JsonRenderer.java
@@ -18,7 +18,6 @@ import com.yahoo.document.datatypes.StringFieldValue;
 import com.yahoo.document.datatypes.TensorFieldValue;
 import com.yahoo.document.json.JsonWriter;
 import com.yahoo.lang.MutableBoolean;
-import com.yahoo.prelude.fastsearch.FastHit;
 import com.yahoo.processing.Response;
 import com.yahoo.processing.execution.Execution.Trace;
 import com.yahoo.processing.rendering.AsynchronousSectionedRenderer;
@@ -345,7 +344,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         return q != null && q.properties().getBoolean(DEBUG_RENDERING_KEY, false);
     }
 
-    private void renderTrace(Trace trace) throws IOException {
+    protected void renderTrace(Trace trace) throws IOException {
         if (!trace.traceNode().children().iterator().hasNext()) return;
         if (getResult().getQuery().getTraceLevel() == 0) return;
 
@@ -388,7 +387,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         }
     }
 
-    private void renderHitGroupHead(HitGroup hitGroup) throws IOException {
+    protected void renderHitGroupHead(HitGroup hitGroup) throws IOException {
         generator.writeStartObject();
 
         renderHitContents(hitGroup);
@@ -402,7 +401,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         // the framework will invoke begin methods as needed from here
     }
 
-    private void renderErrors(Set<ErrorMessage> errors) throws IOException {
+    protected void renderErrors(Set<ErrorMessage> errors) throws IOException {
         if (errors.isEmpty()) return;
 
         generator.writeArrayFieldStart(ERRORS);
@@ -434,7 +433,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
 
     }
 
-    private void renderCoverage() throws IOException {
+    protected void renderCoverage() throws IOException {
         Coverage c = getResult().getCoverage(false);
         if (c == null) return;
 
@@ -456,7 +455,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         generator.writeEndObject();
     }
 
-    private void renderHit(Hit hit) throws IOException {
+    protected void renderHit(Hit hit) throws IOException {
         if (!shouldRender(hit)) return;
 
         childrenArray();
@@ -465,11 +464,11 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         generator.writeEndObject();
     }
 
-    private boolean shouldRender(Hit hit) {
+    protected boolean shouldRender(Hit hit) {
         return ! (hit instanceof DefaultErrorHit);
     }
 
-    private void renderHitContents(Hit hit) throws IOException {
+    protected void renderHitContents(Hit hit) throws IOException {
         String id = hit.getDisplayId();
         if (id != null)
             generator.writeStringField(ID, id);
@@ -493,7 +492,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         renderAllFields(hit);
     }
 
-    private void renderAllFields(Hit hit) throws IOException {
+    protected void renderAllFields(Hit hit) throws IOException {
         fieldConsumer.startHitFields();
         renderTotalHitCount(hit);
         renderStandardFields(hit);
@@ -529,7 +528,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         generator.writeStringField(LABEL, a.getLabel());
     }
 
-    private void renderContinuations(Map<String, Continuation> continuations) throws IOException {
+    protected void renderContinuations(Map<String, Continuation> continuations) throws IOException {
         if (continuations.isEmpty()) return;
 
         generator.writeObjectFieldStart(CONTINUATION);
@@ -539,7 +538,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         generator.writeEndObject();
     }
 
-    private void renderGroupMetadata(GroupId id) throws IOException {
+    protected void renderGroupMetadata(GroupId id) throws IOException {
         if (!(id instanceof ValueGroupId || id instanceof BucketGroupId)) return;
 
         if (id instanceof ValueGroupId) {
@@ -566,7 +565,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
         return (id instanceof RawBucketId ? Arrays.toString(((RawBucketId) id).getTo()) : id.getTo()).toString();
     }
 
-    private void renderTotalHitCount(Hit hit) throws IOException {
+    protected void renderTotalHitCount(Hit hit) throws IOException {
         if ( ! (getRecursionLevel() == 1 && hit instanceof HitGroup)) return;
 
         fieldConsumer.ensureFieldsField();
@@ -653,7 +652,11 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
 
     private void setGenerator(JsonGenerator generator, boolean debugRendering) {
         this.generator = generator;
-        this.fieldConsumer = generator == null ? null : new FieldConsumer(generator, debugRendering);
+        this.fieldConsumer = generator == null ? null : createFieldConsumer(generator, debugRendering);
+    }
+
+    protected FieldConsumer createFieldConsumer(JsonGenerator generator, boolean debugRendering) {
+        return new FieldConsumer(generator, debugRendering);
     }
 
     /**
@@ -668,7 +671,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
      * This instance is reused for all hits of a Result since we are in a single-threaded context
      * and want to limit object creation.
      */
-    private static class FieldConsumer implements Hit.RawUtf8Consumer {
+    public static class FieldConsumer implements Hit.RawUtf8Consumer {
 
         private final JsonGenerator generator;
         private final boolean debugRendering;
@@ -730,7 +733,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
             }
         }
 
-        private boolean shouldRender(String name, Object value) {
+        protected boolean shouldRender(String name, Object value) {
             if (debugRendering) return true;
             if (name.startsWith(VESPA_HIDDEN_FIELD_PREFIX)) return false;
             if (value instanceof CharSequence && ((CharSequence) value).length() == 0) return false;
@@ -740,7 +743,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
             return true;
         }
 
-        private boolean shouldRenderUtf8Value(String name, int length) {
+        protected boolean shouldRenderUtf8Value(String name, int length) {
             if (debugRendering) return true;
             if (name.startsWith(VESPA_HIDDEN_FIELD_PREFIX)) return false;
             if (length == 0) return false;
@@ -782,7 +785,7 @@ public class JsonRenderer extends AsynchronousSectionedRenderer<Result> {
             generator.writeRawValue(intermediate.toString());
         }
 
-        private void renderFieldContents(Object field) throws IOException {
+        protected void renderFieldContents(Object field) throws IOException {
             if (field instanceof Inspectable && ! (field instanceof FeatureData)) {
                 renderInspector(((Inspectable)field).inspect());
             } else {
diff --git a/container-search/src/main/java/com/yahoo/search/rendering/SyncDefaultRenderer.java b/container-search/src/main/java/com/yahoo/search/rendering/SyncDefaultRenderer.java
index 9a716e4b18b..9d0e110a6dd 100644
--- a/container-search/src/main/java/com/yahoo/search/rendering/SyncDefaultRenderer.java
+++ b/container-search/src/main/java/com/yahoo/search/rendering/SyncDefaultRenderer.java
@@ -12,7 +12,14 @@ import com.yahoo.search.Query;
 import com.yahoo.search.Result;
 import com.yahoo.search.grouping.result.HitRenderer;
 import com.yahoo.search.query.context.QueryContext;
-import com.yahoo.search.result.*;
+import com.yahoo.search.result.Coverage;
+import com.yahoo.search.result.DefaultErrorHit;
+import com.yahoo.search.result.ErrorHit;
+import com.yahoo.search.result.ErrorMessage;
+import com.yahoo.search.result.Hit;
+import com.yahoo.search.result.HitGroup;
+import com.yahoo.search.result.Relevance;
+import com.yahoo.search.result.StructuredData;
 import com.yahoo.text.Utf8String;
 import com.yahoo.text.XML;
 import com.yahoo.text.XMLWriter;