Bug 37190398 - [37190387->25.03] SimilaritySearch aggregator does not work from clients

(merge main -> ce/main 112012, 112013)

[git-p4: depot-paths = "//dev/coherence-ce/main/": change = 112014]

Author: Jonathan Knight

prj/coherence-core/src/main/java/com/oracle/coherence/ai/search/ConverterResult.java

@@ -8,9 +8,12 @@
 package com.oracle.coherence.ai.search;
 
 import com.oracle.coherence.ai.QueryResult;
+import com.tangosol.io.SerializationSupport;
 import com.tangosol.util.Binary;
 import com.tangosol.util.Converter;
 
+import java.io.ObjectStreamException;
+import java.io.Serializable;
 import java.util.Objects;
 
 /**
@@ -22,7 +25,7 @@
  */
 @SuppressWarnings("unchecked")
 public class ConverterResult<K, V>
-        implements QueryResult<K, V>
+        implements QueryResult<K, V>, Serializable, SerializationSupport
     {
     /**
      * Create a {@link ConverterResult}.
@@ -88,6 +91,12 @@ public String toString()
                 '}';
         }
 
+    @Override
+    public Object writeReplace() throws ObjectStreamException
+        {
+        return new SimpleQueryResult<>(getDistance(), getKey(), getValue());
+        }
+
     // ----- data members ---------------------------------------------------
 
     /**

prj/coherence-core/src/main/java/com/oracle/coherence/ai/search/SimilaritySearch.java

@@ -25,7 +25,6 @@
 import com.tangosol.util.Binary;
 import com.tangosol.util.BinaryEntry;
 import com.tangosol.util.Converter;
-import com.tangosol.util.ConverterCollections;
 import com.tangosol.util.ExternalizableHelper;
 import com.tangosol.util.Filter;
 import com.tangosol.util.InvocableMap;
@@ -43,12 +42,14 @@
 import java.io.DataOutput;
 import java.io.IOException;
 
+import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.stream.Collectors;
 
 /**
  * An {@link StreamingAggregator} to execute a similarity query.
@@ -275,8 +276,10 @@ public List<QueryResult<K, V>> finalizeResult()
     @Override
     public List<QueryResult<K, V>> finalizeResult(Converter<Binary, ?> converterBin)
         {
-        Converter<BinaryQueryResult, QueryResult<K, V>> convUp = r -> new ConverterResult<>(r, converterBin);
-        return ConverterCollections.getList(new ArrayList<>(m_results), convUp, x -> null);
+        Converter<BinaryQueryResult, QueryResult<K, V>> convUp = new ResultConverter<>(converterBin);
+        return m_results.stream()
+                .map(convUp::convert)
+                .collect(Collectors.toList());
         }
 
     @Override
@@ -391,6 +394,23 @@ protected boolean searchPartition(BinaryEntry binaryEntry, Vector<T> vector)
         return false;
         }
 
+    public static class ResultConverter<K, V>
+            implements Converter<BinaryQueryResult, QueryResult<K, V>>, Serializable
+        {
+        public ResultConverter(Converter<Binary, ?> f_converterBin)
+            {
+            this.f_converterBin = f_converterBin;
+            }
+
+        @Override
+        public QueryResult<K, V> convert(BinaryQueryResult value)
+            {
+            return new ConverterResult<>(value, f_converterBin);
+            }
+
+        private final Converter<Binary, ?> f_converterBin;
+        }
+
     // ----- data members ---------------------------------------------------
 
     /**

prj/coherence-core/src/main/java/com/oracle/coherence/ai/search/SimpleQueryResult.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2000, 2024, Oracle and/or its affiliates.
+ *
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * https://oss.oracle.com/licenses/upl.
+ */
+
+package com.oracle.coherence.ai.search;
+
+public class SimpleQueryResult<K, V>
+        extends BaseQueryResult<K, V>
+    {
+    public SimpleQueryResult()
+        {
+        }
+
+    public SimpleQueryResult(double result, K key, V value)
+        {
+        super(result, key, value);
+        }
+    }

prj/coherence-core/src/main/resources/META-INF/type-aliases.properties

@@ -15,7 +15,7 @@ ai.distance.CosineSimilarity=com.oracle.coherence.ai.distance.CosineDistance
 ai.distance.InnerProductSimilarity=com.oracle.coherence.ai.distance.InnerProductDistance
 ai.distance.L2SquaredDistance=com.oracle.coherence.ai.distance.L2SquaredDistance
 ai.search.SimilarityAggregator=com.oracle.coherence.ai.search.SimilaritySearch
-ai.results.BinaryQueryResult=com.oracle.coherence.ai.search.BinaryQueryResult
+ai.results.QueryResult=com.oracle.coherence.ai.search.SimpleQueryResult
 
 common.base.SimpleHolder=com.oracle.coherence.common.base.SimpleHolder
 

prj/coherence-core/src/main/resources/coherence-pof-config.xml

@@ -1874,6 +1874,10 @@ descriptor: pof-config.xsd.
       <type-id>935</type-id>
       <class-name>com.oracle.coherence.ai.Float32Vector</class-name>
     </user-type>
+    <user-type>
+      <type-id>936</type-id>
+      <class-name>com.oracle.coherence.ai.search.SimpleQueryResult</class-name>
+    </user-type>
 
     <!-- java.time (940 - 949) -->
 

prj/coherence-json/src/main/java/com/oracle/coherence/io/json/JsonSerializer.java

@@ -7,6 +7,9 @@
 
 package com.oracle.coherence.io.json;
 
+import com.oracle.coherence.ai.QueryResult;
+import com.oracle.coherence.ai.search.ConverterResult;
+import com.oracle.coherence.ai.search.SimpleQueryResult;
 import com.oracle.coherence.common.base.Logger;
 
 import com.oracle.coherence.io.json.genson.GenericType;
@@ -41,6 +44,7 @@
 import com.oracle.coherence.io.json.internal.MapConverter;
 import com.oracle.coherence.io.json.internal.MathContextConverter;
 import com.oracle.coherence.io.json.internal.MissingClassConverter;
+import com.oracle.coherence.io.json.internal.QueryResultConverter;
 import com.oracle.coherence.io.json.internal.RoundingModeConverter;
 import com.oracle.coherence.io.json.internal.SerializationGate;
 import com.oracle.coherence.io.json.internal.SerializationSupportConverter;
@@ -171,6 +175,9 @@ public JsonSerializer(ClassLoader loader, Modifier<GensonBuilder> builderModifie
                 .withConverter(InetSocketAddressConverter.INSTANCE, InetSocketAddress.class)
                 .withConverter(JsonObjectConverter.INSTANCE, JsonObject.class)
                 .withConverter(MathContextConverter.INSTANCE, MathContext.class)
+                .withConverter(QueryResultConverter.INSTANCE, QueryResult.class)
+                .withConverter(QueryResultConverter.INSTANCE, ConverterResult.class)
+                .withConverter(QueryResultConverter.INSTANCE, SimpleQueryResult.class)
                 .withConverter(RoundingModeConverter.INSTANCE, RoundingMode.class);
 
         addSafeBundle(builder, JsonbBundle.class);

prj/coherence-json/src/main/java/com/oracle/coherence/io/json/internal/QueryResultConverter.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2000, 2024, Oracle and/or its affiliates.
+ *
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * https://oss.oracle.com/licenses/upl.
+ */
+
+package com.oracle.coherence.io.json.internal;
+
+import com.oracle.coherence.ai.QueryResult;
+import com.oracle.coherence.ai.search.SimpleQueryResult;
+import com.oracle.coherence.io.json.genson.Context;
+import com.oracle.coherence.io.json.genson.Converter;
+import com.oracle.coherence.io.json.genson.GenericType;
+import com.oracle.coherence.io.json.genson.stream.ObjectReader;
+import com.oracle.coherence.io.json.genson.stream.ObjectWriter;
+
+/**
+ * A converter to serialize a {@link QueryResult} to json.
+ */
+@SuppressWarnings("rawtypes")
+public class QueryResultConverter
+        implements Converter<QueryResult>
+    {
+    @Override
+    public void serialize(QueryResult result, ObjectWriter writer, Context ctx) throws Exception
+        {
+        writer.beginObject();
+        writer.writeNumber("distance", result.getDistance());
+        writer.writeName("key");
+        ctx.genson.serialize(result.getKey(), writer, ctx);
+        writer.writeName("value");
+        ctx.genson.serialize(result.getValue(), writer, ctx);
+        writer.endObject();
+        }
+
+    @Override
+    public QueryResult deserialize(ObjectReader reader, Context ctx) throws Exception
+        {
+        double distance = 0.0d;
+        Object key      = null;
+        Object value    = null;
+
+        reader.beginObject();
+        while (reader.hasNext())
+            {
+            reader.next();
+            switch (reader.name())
+                {
+                case "distance":
+                    distance = reader.valueAsDouble();
+                    break;
+                case "key":
+                    key = ctx.genson.deserialize(TYPE, reader, ctx);
+                    break;
+                case "value":
+                    value = ctx.genson.deserialize(TYPE, reader, ctx);
+                    break;
+                }
+            }
+        reader.endObject();
+        return new SimpleQueryResult<>(distance, key, value);
+        }
+
+    /**
+     * {@link GenericType} for {@link Object}.
+     */
+    private static final GenericType<Object> TYPE = GenericType.of(Object.class);
+
+    /**
+     * The singleton instance for {@code QueryResultConverter}.
+     */
+    public static final QueryResultConverter INSTANCE = new QueryResultConverter();
+    }

prj/test/distribution/grpc-compatibility/grpc-ce-22.06/pom.xml

@@ -33,6 +33,7 @@
 
         <coherence.compatability.minJavaVersion>11</coherence.compatability.minJavaVersion>
         <coherence.compatability.maxJavaVersion>21</coherence.compatability.maxJavaVersion>
+        <skip.similarity.search>true</skip.similarity.search>
     </properties>
 
     <dependencies>

prj/test/distribution/grpc-compatibility/grpc-compatibility-core/src/main/java/grpc/client/compatibility/ClientCompatibilityIT.java

@@ -323,6 +323,13 @@ public void shouldReturnTrueForContainsKeyWithExistingMapping(String sSerializer
         super.shouldReturnTrueForContainsAssociatedKeyWithExistingMapping(sSerializerName, serializer);
         }
 
+    @Override
+    public void shouldPerformSimilaritySearch(String sSerializerName, Serializer serializer) throws Exception
+        {
+        Assumptions.assumeFalse(Boolean.getBoolean("skip.similarity.search"), "Similarity search test is skipped");
+        super.shouldPerformSimilaritySearch(sSerializerName, serializer);
+        }
+
     @Override
     protected <K, V> NamedCache<K, V> createClient(String sCacheName, String sSerializerName, Serializer serializer)
         {

prj/test/distribution/grpc-compatibility/pom.xml

@@ -35,6 +35,7 @@
     <coherence.compatability.groupId/>
     <coherence.compatability.minJavaVersion/>
     <coherence.compatability.maxJavaVersion/>
+    <skip.similarity.search>false</skip.similarity.search>
 
     <maven.home.dir>${env.MAVEN_HOME}</maven.home.dir>
     <coherence.compatability.settings>${maven.home.dir}/conf/settings.xml</coherence.compatability.settings>
@@ -65,6 +66,7 @@
               <coherence.compatability.settings>${coherence.compatability.settings}</coherence.compatability.settings>
               <coherence.compatability.minJavaVersion>${coherence.compatability.minJavaVersion}</coherence.compatability.minJavaVersion>
               <coherence.compatability.maxJavaVersion>${coherence.compatability.maxJavaVersion}</coherence.compatability.maxJavaVersion>
+              <skip.similarity.search>${skip.similarity.search}</skip.similarity.search>
           </systemProperties>
         </configuration>
       </plugin>