Merge pull request #21084 from vespa-engine/bratseth/deprecate-binary-encoding

Deprecate binary encoding outside VDS

3 files changed, 95 insertions, 18 deletions

diff --git a/container-search/src/main/java/com/yahoo/search/Query.java b/container-search/src/main/java/com/yahoo/search/Query.java
index 623c38fa9f0..77cd4f3b292 100644
--- a/container-search/src/main/java/com/yahoo/search/Query.java
+++ b/container-search/src/main/java/com/yahoo/search/Query.java
@@ -1048,6 +1048,7 @@ public class Query extends com.yahoo.processing.Request implements Cloneable {
         return new SessionId(requestId, getRanking().getProfile());
     }
 
+    @Deprecated // TODO: Remove on Vespa 8
     public boolean hasEncodableProperties() {
         if ( ! ranking.getProperties().isEmpty()) return true;
         if ( ! ranking.getFeatures().isEmpty()) return true;
@@ -1064,39 +1065,29 @@ public class Query extends com.yahoo.processing.Request implements Cloneable {
      * @param buffer the buffer to encode to
      * @param encodeQueryData true to encode all properties, false to only include session information, not actual query data
      * @return the encoded length
+     * @deprecated do not use
      */
+    @Deprecated // TODO: Remove on Vespa 8
     public int encodeAsProperties(ByteBuffer buffer, boolean encodeQueryData) {
         // Make sure we don't encode anything here if we have turned the property feature off
         // Due to sendQuery we sometimes end up turning this feature on and then encoding a 0 int as the number of
         // property maps - that's ok (probably we should simplify by just always turning the feature on)
         if (! hasEncodableProperties()) return 0;
-
         int start = buffer.position();
-
         int mapCountPosition = buffer.position();
         buffer.putInt(0); // map count will go here
-
         int mapCount = 0;
-
-        // TODO: Push down
         mapCount += ranking.getProperties().encode(buffer, encodeQueryData);
         if (encodeQueryData) {
             mapCount += ranking.getFeatures().encode(buffer);
-
-            // TODO: Push down
             if (presentation.getHighlight() != null) {
                 mapCount += MapEncoder.encodeMultiMap(Highlight.HIGHLIGHTTERMS, presentation.getHighlight().getHighlightTerms(), buffer);
             }
-
-            // TODO: Push down
             mapCount += MapEncoder.encodeMap("model", createModelMap(), buffer);
         }
         mapCount += MapEncoder.encodeSingleValue(DocumentDatabase.MATCH_PROPERTY, DocumentDatabase.SEARCH_DOC_TYPE_KEY, model.getDocumentDb(), buffer);
-
         mapCount += MapEncoder.encodeMap("caches", createCacheSettingMap(), buffer);
-
         buffer.putInt(mapCountPosition, mapCount);
-
         return buffer.position() - start;
     }
 
diff --git a/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/QueryEncoder.java b/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/QueryEncoder.java
new file mode 100644
index 00000000000..e252a230d4f
--- /dev/null
+++ b/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/QueryEncoder.java
@@ -0,0 +1,90 @@
+// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.vespa.streamingvisitors;
+
+import com.yahoo.fs4.MapEncoder;
+import com.yahoo.prelude.fastsearch.DocumentDatabase;
+import com.yahoo.prelude.query.Highlight;
+import com.yahoo.search.Query;
+import com.yahoo.search.dispatch.rpc.ProtobufSerialization;
+
+import java.nio.ByteBuffer;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Encodes the query in binary form.
+ *
+ * @author bratseth
+ */
+class QueryEncoder {
+
+    /**
+     * Encodes properties of this query.
+     *
+     * @param buffer the buffer to encode to
+     * @param encodeQueryData true to encode all properties, false to only include session information, not actual query data
+     * @return the encoded length
+     */
+    static int encodeAsProperties(Query query, ByteBuffer buffer, boolean encodeQueryData) {
+        // Make sure we don't encode anything here if we have turned the property feature off
+        // Due to sendQuery we sometimes end up turning this feature on and then encoding a 0 int as the number of
+        // property maps - that's ok (probably we should simplify by just always turning the feature on)
+        if (! hasEncodableProperties(query)) return 0;
+
+        int start = buffer.position();
+        int mapCountPosition = buffer.position();
+        buffer.putInt(0); // map count will go here
+        int mapCount = 0;
+        mapCount += query.getRanking().getProperties().encode(buffer, encodeQueryData);
+        if (encodeQueryData) {
+            mapCount += query.getRanking().getFeatures().encode(buffer);
+            if (query.getPresentation().getHighlight() != null) {
+                mapCount += MapEncoder.encodeMultiMap(Highlight.HIGHLIGHTTERMS,
+                                                      query.getPresentation().getHighlight().getHighlightTerms(), buffer);
+            }
+            mapCount += MapEncoder.encodeMap("model", createModelMap(query), buffer);
+        }
+        mapCount += MapEncoder.encodeSingleValue(DocumentDatabase.MATCH_PROPERTY, DocumentDatabase.SEARCH_DOC_TYPE_KEY,
+                                                 query.getModel().getDocumentDb(), buffer);
+        mapCount += MapEncoder.encodeMap("caches", createCacheSettingMap(query), buffer);
+        buffer.putInt(mapCountPosition, mapCount);
+        return buffer.position() - start;
+    }
+
+    static boolean hasEncodableProperties(Query query) {
+        if ( ! query.getRanking().getProperties().isEmpty()) return true;
+        if ( ! query.getRanking().getFeatures().isEmpty()) return true;
+        if ( query.getRanking().getFreshness() != null) return true;
+        if ( query.getModel().getSearchPath() != null) return true;
+        if ( query.getModel().getDocumentDb() != null) return true;
+        if ( query.getPresentation().getHighlight() != null &&
+             ! query.getPresentation().getHighlight().getHighlightItems().isEmpty()) return true;
+        return false;
+    }
+
+    private static Map<String, Boolean> createCacheSettingMap(Query query) {
+        if (query.getGroupingSessionCache() && query.getRanking().getQueryCache()) {
+            Map<String, Boolean> cacheSettingMap = new HashMap<>();
+            cacheSettingMap.put("grouping", true);
+            cacheSettingMap.put("query", true);
+            return cacheSettingMap;
+        }
+        if (query.getGroupingSessionCache())
+            return Collections.singletonMap("grouping", true);
+        if (query.getRanking().getQueryCache())
+            return Collections.singletonMap("query", true);
+        return Collections.emptyMap();
+    }
+
+    private static Map<String, String> createModelMap(Query query) {
+        Map<String, String> m = new HashMap<>();
+        if (query.getModel().getSearchPath() != null) m.put("searchpath", query.getModel().getSearchPath());
+
+        int traceLevel = ProtobufSerialization.getTraceLevelForBackend(query);
+        if (traceLevel > 0) m.put("tracelevel", String.valueOf(traceLevel));
+
+        return m;
+    }
+
+}
diff --git a/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/VdsVisitor.java b/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/VdsVisitor.java
index e2233d51ae4..b2e4821f164 100644
--- a/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/VdsVisitor.java
+++ b/container-search/src/main/java/com/yahoo/vespa/streamingvisitors/VdsVisitor.java
@@ -3,13 +3,10 @@ package com.yahoo.vespa.streamingvisitors;
 
 import com.yahoo.document.select.parser.ParseException;
 import com.yahoo.documentapi.AckToken;
-import com.yahoo.documentapi.DocumentAccess;
 import com.yahoo.documentapi.VisitorControlHandler;
 import com.yahoo.documentapi.VisitorDataHandler;
 import com.yahoo.documentapi.VisitorParameters;
 import com.yahoo.documentapi.VisitorSession;
-import com.yahoo.documentapi.messagebus.MessageBusDocumentAccess;
-import com.yahoo.documentapi.messagebus.MessageBusParams;
 import com.yahoo.documentapi.messagebus.loadtypes.LoadType;
 import com.yahoo.documentapi.messagebus.loadtypes.LoadTypeSet;
 import com.yahoo.documentapi.messagebus.protocol.DocumentProtocol;
@@ -41,7 +38,6 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Logger;
 
 /**
@@ -187,7 +183,7 @@ class VdsVisitor extends VisitorDataHandler implements Visitor {
             params.setLibraryParameter("location", af);
         }
 
-        if (query.hasEncodableProperties()) {
+        if (QueryEncoder.hasEncodableProperties(query)) {
             encodeQueryData(query, 1, ed);
             params.setLibraryParameter("rankproperties", ed.getEncodedData());
         }
@@ -254,7 +250,7 @@ class VdsVisitor extends VisitorDataHandler implements Visitor {
                         ed.setReturned(query.getModel().getQueryTree().getRoot().encode(buf));
                         break;
                     case 1:
-                        ed.setReturned(query.encodeAsProperties(buf, true));
+                        ed.setReturned(QueryEncoder.encodeAsProperties(query, buf, true));
                         break;
                     case 2:
                         throw new IllegalArgumentException("old aggregation no longer exists!");