feat: read/write PhoneNumber and GeoCoordinates data

Author: bevzzz

src/it/java/io/weaviate/integration/DataITest.java

@@ -14,6 +14,7 @@
 import io.weaviate.ConcurrentTest;
 import io.weaviate.client6.v1.api.WeaviateApiException;
 import io.weaviate.client6.v1.api.WeaviateClient;
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
 import io.weaviate.client6.v1.api.collections.PhoneNumber;
 import io.weaviate.client6.v1.api.collections.Property;
 import io.weaviate.client6.v1.api.collections.ReferenceProperty;
@@ -461,6 +462,7 @@ public void testDataTypes() throws IOException {
         Map.entry("prop_uuid_array", List.of(uuid, uuid)),
         Map.entry("prop_text_array", List.of("a", "b", "c")),
         Map.entry("prop_phone_number", PhoneNumber.international("+380 95 1433336")),
+        Map.entry("prop_geo_coordinates", new GeoCoordinates(1f, 2f)),
         Map.entry("prop_object", Map.of("marco", "polo")),
         Map.entry("prop_object_array", List.of(Map.of("marco", "polo"))));
 
@@ -472,8 +474,10 @@ public void testDataTypes() throws IOException {
     Assertions.assertThat(got).get()
         .extracting(WeaviateObject::properties)
         .asInstanceOf(InstanceOfAssertFactories.map(String.class, Object.class))
-        .containsAllEntriesOf(want);
-
+        // Most of PhoneNumber fields are only present on read and are null on write.
+        .usingRecursiveComparison()
+        .withComparatorForType(ORMITest::comparePhoneNumbers, PhoneNumber.class)
+        .isEqualTo(want);
   }
 
   record Address(

src/it/java/io/weaviate/integration/ORMITest.java

@@ -15,6 +15,8 @@
 import io.weaviate.ConcurrentTest;
 import io.weaviate.client6.v1.api.WeaviateClient;
 import io.weaviate.client6.v1.api.collections.CollectionConfig;
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
 import io.weaviate.client6.v1.api.collections.WeaviateObject;
 import io.weaviate.client6.v1.api.collections.annotations.Collection;
 import io.weaviate.client6.v1.api.collections.annotations.Property;
@@ -79,7 +81,10 @@ static record Thing(
       Boolean booleanBoxed,
       boolean[] booleanArray,
       Boolean[] booleanBoxedArray,
-      List<Boolean> booleanBoxedList) {
+      List<Boolean> booleanBoxedList,
+
+      PhoneNumber phoneNumber,
+      GeoCoordinates geoCoordinates) {
   }
 
   @BeforeClass
@@ -150,14 +155,18 @@ public void test_createCollection() throws Exception {
             Map.entry("booleanBoxed", "boolean"),
             Map.entry("booleanArray", "boolean[]"),
             Map.entry("booleanBoxedArray", "boolean[]"),
-            Map.entry("booleanBoxedList", "boolean[]"));
+            Map.entry("booleanBoxedList", "boolean[]"),
+
+            Map.entry("phoneNumber", "phoneNumber"),
+            Map.entry("geoCoordinates", "geoCoordinates"));
   }
 
-  private final RecursiveComparisonConfiguration COMPARISON_CONFIG = RecursiveComparisonConfiguration.builder()
+  private static final RecursiveComparisonConfiguration COMPARISON_CONFIG = RecursiveComparisonConfiguration.builder()
       // Assertj is having a really bad time comparing List<Float>,
       // so we'll just always return true here.
       .withComparatorForFields((a, b) -> 0, "floatBoxedList")
       .withComparatorForType((a, b) -> Double.compare(a.doubleValue(), b.doubleValue()), Number.class)
+      .withComparatorForType(ORMITest::comparePhoneNumbers, PhoneNumber.class)
       .build();
 
   @Test
@@ -219,7 +228,10 @@ public void test_insertAndQuery() throws Exception {
         boolean_,
         new boolean[] { boolean_ },
         new Boolean[] { boolean_ },
-        List.of(boolean_));
+        List.of(boolean_),
+
+        PhoneNumber.international("+380 95 1433336"),
+        new GeoCoordinates(1f, 2f));
 
     var things = client.collections.use(Thing.class);
 
@@ -294,7 +306,10 @@ public void test_insertManyAndQuery() throws Exception {
         boolean_,
         new boolean[] { boolean_ },
         new Boolean[] { boolean_ },
-        List.of(boolean_));
+        List.of(boolean_),
+
+        PhoneNumber.international("+380 95 1433336"),
+        new GeoCoordinates(1f, 2f));
 
     var things = client.collections.use(Thing.class);
 
@@ -351,7 +366,7 @@ public void test_partialScan() throws IOException {
         .returns(null, Song::monthlyListeners);
   }
 
-  @Test
-  public void test_nestedProperties() throws IOException {
+  static int comparePhoneNumbers(PhoneNumber phone1, PhoneNumber phone2) {
+    return phone1.rawInput().compareTo(phone2.rawInput());
   }
 }

src/main/java/io/weaviate/client6/v1/api/collections/data/InsertManyRequest.java

@@ -8,7 +8,9 @@
 import java.util.UUID;
 
 import io.weaviate.client6.v1.api.collections.CollectionHandleDefaults;
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
 import io.weaviate.client6.v1.api.collections.ObjectMetadata;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
 import io.weaviate.client6.v1.api.collections.WeaviateObject;
 import io.weaviate.client6.v1.internal.MapUtil;
 import io.weaviate.client6.v1.internal.grpc.ByteStringUtil;
@@ -181,6 +183,23 @@ private static com.google.protobuf.Value marshalValue(Object value) {
       protoValue.setBoolValue(v.booleanValue());
     } else if (value instanceof Number v) {
       protoValue.setNumberValue(v.doubleValue());
+    } else if (value instanceof PhoneNumber phone) {
+      var phoneProto = com.google.protobuf.Struct.newBuilder();
+      if (phone.rawInput() != null) {
+        var input = com.google.protobuf.Value.newBuilder().setStringValue(phone.rawInput());
+        phoneProto.putFields("input", input.build());
+      }
+      if (phone.defaultCountry() != null) {
+        var defaultCountry = com.google.protobuf.Value.newBuilder().setStringValue(phone.defaultCountry());
+        phoneProto.putFields("defaultCountry", defaultCountry.build());
+      }
+      protoValue.setStructValue(phoneProto);
+    } else if (value instanceof GeoCoordinates geo) {
+      var latitude = com.google.protobuf.Value.newBuilder().setNumberValue(geo.latitude());
+      var longitude = com.google.protobuf.Value.newBuilder().setNumberValue(geo.longitude());
+      protoValue.setStructValue(com.google.protobuf.Struct.newBuilder()
+          .putFields("latitude", latitude.build())
+          .putFields("longitude", longitude.build()));
     } else if (value instanceof List<?> v) {
       protoValue.setListValue(
           com.google.protobuf.ListValue.newBuilder()

src/main/java/io/weaviate/client6/v1/api/collections/query/QueryResponse.java

@@ -6,7 +6,9 @@
 import java.util.UUID;
 import java.util.stream.Stream;
 
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
 import io.weaviate.client6.v1.api.collections.ObjectMetadata;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
 import io.weaviate.client6.v1.api.collections.Vectors;
 import io.weaviate.client6.v1.api.collections.WeaviateObject;
 import io.weaviate.client6.v1.internal.DateUtil;
@@ -159,6 +161,21 @@ static <PropertiesT> void setProperty(String property, WeaviateProtoProperties.V
       builder.setOffsetDateTime(property, DateUtil.fromISO8601(value.getDateValue()));
     } else if (value.hasUuidValue()) {
       builder.setUuid(property, UUID.fromString(value.getUuidValue()));
+    } else if (value.hasPhoneValue()) {
+      var phone = value.getPhoneValue();
+      builder.setPhoneNumber(property, new PhoneNumber(
+          phone.getInput(),
+          phone.getDefaultCountry(),
+          Long.valueOf(phone.getCountryCode()).intValue(),
+          phone.getInternationalFormatted(),
+          Long.valueOf(phone.getNational()).intValue(),
+          phone.getNationalFormatted(),
+          phone.getValid()));
+    } else if (value.hasGeoValue()) {
+      var geo = value.getGeoValue();
+      builder.setGeoCoordinates(property, new GeoCoordinates(
+          geo.getLatitude(),
+          geo.getLongitude()));
     } else if (value.hasListValue()) {
       var list = value.getListValue();
       if (list.hasTextValues()) {

src/main/java/io/weaviate/client6/v1/internal/orm/MapBuilder.java

@@ -6,6 +6,9 @@
 import java.util.Map;
 import java.util.UUID;
 
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
+
 public class MapBuilder implements PropertiesBuilder<Map<String, Object>> {
   private final Map<String, Object> properties = new HashMap<>();
 
@@ -89,8 +92,18 @@ public void setNestedObjectArray(String property, List<? extends Object> value)
     properties.put(property, value);
   }
 
+  @Override
+  public void setPhoneNumber(String property, PhoneNumber value) {
+    properties.put(property, value);
+  }
+
+  @Override
+  public void setGeoCoordinates(String property, GeoCoordinates value) {
+    properties.put(property, value);
+  }
+
   @Override
   public Map<String, Object> build() {
-    return properties;
+    return new HashMap<>(properties);
   }
 }

src/main/java/io/weaviate/client6/v1/internal/orm/PojoBuilder.java

@@ -10,6 +10,9 @@
 
 import org.apache.commons.lang3.ArrayUtils;
 
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
+
 final class PojoBuilder<PropertiesT extends Record> implements PropertiesBuilder<PropertiesT> {
   private static final Map<Class<?>, Object> PRIMITIVE_DEFAULTS;
 
@@ -237,6 +240,16 @@ public void setNestedObjectArray(String property, List<? extends Object> value)
     throw new UnsupportedOperationException("Unimplemented method 'setNestedObjectArray'");
   }
 
+  @Override
+  public void setPhoneNumber(String propertyName, PhoneNumber value) {
+    setValue(propertyName, value);
+  }
+
+  @Override
+  public void setGeoCoordinates(String propertyName, GeoCoordinates value) {
+    setValue(propertyName, value);
+  }
+
   @Override
   public PropertiesT build() {
     Object[] args = ctorArgs.values().stream().map(Arg::value).toArray();

src/main/java/io/weaviate/client6/v1/internal/orm/PojoDescriptor.java

@@ -16,6 +16,8 @@
 import com.google.gson.reflect.TypeToken;
 
 import io.weaviate.client6.v1.api.collections.CollectionConfig;
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
 import io.weaviate.client6.v1.api.collections.Property;
 import io.weaviate.client6.v1.api.collections.annotations.Collection;
 import io.weaviate.client6.v1.internal.ObjectBuilder;
@@ -65,6 +67,9 @@ final class PojoDescriptor<T extends Record> implements CollectionDescriptor<T>
         put(Double[].class, Property::numberArray);
 
         put(Map.class, Property::object);
+
+        put(PhoneNumber.class, Property::phoneNumber);
+        put(GeoCoordinates.class, Property::geoCoordinates);
       }
     };
     CTORS = Collections.unmodifiableMap(ctors);

src/main/java/io/weaviate/client6/v1/internal/orm/PropertiesBuilder.java

@@ -4,6 +4,9 @@
 import java.util.List;
 import java.util.UUID;
 
+import io.weaviate.client6.v1.api.collections.GeoCoordinates;
+import io.weaviate.client6.v1.api.collections.PhoneNumber;
+
 public interface PropertiesBuilder<T> {
   void setNull(String property);
 
@@ -37,5 +40,9 @@ public interface PropertiesBuilder<T> {
 
   void setNestedObjectArray(String property, List<? extends Object> value);
 
+  void setPhoneNumber(String property, PhoneNumber value);
+
+  void setGeoCoordinates(String property, GeoCoordinates value);
+
   T build();
 }