RealmAny datatype (#7398)

Author: clementetb

CHANGELOG.md

@@ -1,8 +1,16 @@
 ## 11.0.0 (YYYY-MM-DD)
 
+### Breaking Changes
+* Queries no longer do nullability checks on non-nullable fields, so using `null` as an argument will not throw an `IllegalArgumentException`.
+* String query filters `contains`, `beginsWith`, `endsWith`, and `like`, now throw a null pointer exception on null values.
+* The query builder no longer throw `IllegalStateException` but `IllegalArgumentException`.
+* The `distinct` query filter on unsupported fields no longer throws an exception when applied through when querying across relationships.
+* The `distinct` query filter no longer throws an exception when applied on non-existent fields.
+
 ### Enhancements
 * Added support for `java.util.UUID` as supported field in model classes.
 * Added support for `java.util.UUID` as a primary key.
+* Added support for `RealmAny` as supported field in model classes. A `RealmAny` is used to represent a polymorphic Realm value or Realm Object, is indexable but cannot be used as a primary key. See [Javadoc for RealmAny](https://docs.mongodb.com/realm-sdks/java/latest/io/realm/RealmAny.html).
 * Allow UTF8 encoded characters in property names in string-based queries ([#4467](https://github.com/realm/realm-core/issues/4467))
 * The error message when the initial steps of opening a Realm file fails is now more descriptive.
 * Make conversion of Decimal128 to/from string work for numbers with more than 19 significant digits. ([#4548](https://github.com/realm/realm-core/issues/4548))
@@ -11,6 +19,10 @@
   a backup, if a) an attempt is made to open a realm file with a "future" file format and b) a backup file exist
   that fits the current file format. ([#4166](https://github.com/realm/realm-core/pull/4166))
 * Remove type coercion on bool and ObjectId when doing queries.
+* Allow passing arguments into string-based query predicates.
+* Queries across relationships now support the `between` operator.
+* Queries on numerical fields (byte, short, int, long, float, double, decimal128) now accept any numerical value as an argument.
+* `isEmpty` query filter can now be applied on `RealmList` and `RealmObject` fields.
 
 ### Fixed
 * Fix assertion failures such as "!m_notifier_skip_version.version" or "m_notifier_sg->get_version() + 1 == new_version.version" when performing writes inside change notification callbacks. Previously refreshing the Realm by beginning a write transaction would skip delivering notifications, leaving things in an inconsistent state. Notifications are now delivered recursively when needed instead. ([Cocoa #7165](https://github.com/realm/realm-cocoa/issues/7165)).

dependencies.list

@@ -4,7 +4,7 @@ REALM_CORE=10.3.3
 
 # Version of MongoDB Realm used by integration tests
 # See https://github.com/realm/ci/packages/147854 for available versions
-MONGODB_REALM_SERVER=2021-03-22
+MONGODB_REALM_SERVER=2021-03-29
 
 # Common Android settings across projects
 GRADLE_BUILD_TOOLS=4.0.0

realm-annotations/src/main/java/io/realm/annotations/Required.java

@@ -35,6 +35,9 @@
  * annotation are never allowed to hold {@code null} values even if the datatype would otherwise allow it.
  * Realm will throw an exception if you attempt to store null values into a list marked {@code \@Required}.
  * <p>
+ * This annotation cannot be used on a {@code RealmAny}, as the inner value of a RealmAny field is always nullable.
+ * Realm will throw an exception if you attempt mark a {@code RealmAny} as {@code \@Required}.
+ * <p>
  * Compiling will fail if the {@link Required} annotation is put an a {@code RealmList} containing references to other
  * Realm objects.
  */

realm/kotlin-extensions/src/androidTest/kotlin/io/realm/CoroutinesTests.kt

@@ -4,9 +4,7 @@ import io.realm.entities.AllTypes
 import io.realm.entities.Dog
 import io.realm.entities.SimpleClass
 import io.realm.kotlin.*
-import io.realm.log.RealmLog
 import io.realm.rule.BlockingLooperThread
-import io.realm.rule.TestRealmConfigurationFactory
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.*
 import kotlinx.coroutines.test.TestCoroutineDispatcher

realm/kotlin-extensions/src/androidTest/kotlin/io/realm/KotlinRealmModelTests.kt

@@ -7,7 +7,6 @@ import io.realm.entities.SimpleClass
 import io.realm.kotlin.*
 import io.realm.rule.RunInLooperThread
 import io.realm.rule.RunTestInLooperThread
-import io.realm.rule.TestRealmConfigurationFactory
 import org.junit.*
 import org.junit.Assert.*
 import org.junit.runner.RunWith

realm/kotlin-extensions/src/androidTest/kotlin/io/realm/KotlinRealmQueryTests.kt

@@ -6,7 +6,6 @@ import io.realm.entities.AllPropTypesClass
 import io.realm.kotlin.createObject
 import io.realm.kotlin.oneOf
 import io.realm.kotlin.where
-import io.realm.rule.TestRealmConfigurationFactory
 import org.junit.After
 import org.junit.Assert.assertEquals
 import org.junit.Before

realm/kotlin-extensions/src/androidTest/kotlin/io/realm/KotlinRealmTests.kt

@@ -5,7 +5,6 @@ import io.realm.entities.PrimaryKeyClass
 import io.realm.entities.SimpleClass
 import io.realm.kotlin.createObject
 import io.realm.kotlin.where
-import io.realm.rule.TestRealmConfigurationFactory
 import org.junit.After
 import org.junit.Before
 import org.junit.Rule

realm/realm-annotations-processor/src/main/java/io/realm/processor/ClassMetaData.kt

@@ -81,7 +81,8 @@ class ClassMetaData(env: ProcessingEnvironment, typeMirrors: TypeMirrors, privat
             typeMirrors.DATE_MIRROR,
             typeMirrors.DECIMAL128_MIRROR,
             typeMirrors.OBJECT_ID_MIRROR,
-            typeMirrors.UUID_MIRROR
+            typeMirrors.UUID_MIRROR,
+            typeMirrors.MIXED_MIRROR
     )
     private val stringType = typeMirrors.STRING_MIRROR
 
@@ -519,10 +520,11 @@ class ClassMetaData(env: ProcessingEnvironment, typeMirrors: TypeMirrors, privat
             val hasRequiredAnnotation = hasRequiredAnnotation(field)
             val listGenericType = (field.asType() as DeclaredType).typeArguments
             val containsRealmModelClasses = (listGenericType.isNotEmpty() && Utils.isRealmModel(listGenericType[0]))
+            val containsRealmAny = (listGenericType.isNotEmpty() && Utils.isRealmAny(listGenericType[0]))
 
             // @Required not allowed if the list contains Realm model classes
-            if (hasRequiredAnnotation && containsRealmModelClasses) {
-                Utils.error("@Required not allowed on RealmList's that contain other Realm model classes.")
+            if (hasRequiredAnnotation && (containsRealmModelClasses || containsRealmAny)) {
+                Utils.error("@Required not allowed on RealmList's that contain other Realm model classes or RealmAny.")
                 return false
             }
 
@@ -568,7 +570,7 @@ class ClassMetaData(env: ProcessingEnvironment, typeMirrors: TypeMirrors, privat
 
         // Standard field that appears to be valid (more fine grained checks might fail later).
         fields.add(field)
-        if (Utils.isRealmModel(field) || Utils.isRealmModelList(field)) {
+        if (Utils.isRealmModel(field) || Utils.isRealmModelList(field) || Utils.isRealmAnyList(field) || Utils.isRealmAny(field)) {
             _objectReferenceFields.add(field)
         } else {
             basicTypeFields.add(field)
@@ -633,11 +635,11 @@ class ClassMetaData(env: ProcessingEnvironment, typeMirrors: TypeMirrors, privat
     }
 
     // The field has the @Index annotation. It's only valid for column types:
-    // STRING, DATE, INTEGER, BOOLEAN, RealmMutableInteger, OBJECT_ID and UUID
+    // STRING, DATE, INTEGER, BOOLEAN, RealmMutableInteger, OBJECT_ID, UUID and MIXED
     private fun categorizeIndexField(element: Element, fieldElement: RealmFieldElement): Boolean {
         var indexable = false
 
-        if (Utils.isMutableRealmInteger(fieldElement)) {
+        if (Utils.isMutableRealmInteger(fieldElement) || Utils.isRealmAny(fieldElement)) {
             indexable = true
         } else {
             when (Constants.JAVA_TO_REALM_TYPES[fieldElement.asType().toString()]) {
@@ -680,6 +682,11 @@ class ClassMetaData(env: ProcessingEnvironment, typeMirrors: TypeMirrors, privat
             }
         }
 
+        if (Utils.isRealmAny(field)) {
+            Utils.error(String.format(Locale.US, "RealmAny field \"${field}\" cannot be @Required or @NotNull."))
+            return false
+        }
+
         // Should never get here - user should remove @Required
         if (nullableFields.contains(field)) {
             Utils.error(String.format(Locale.US,

realm/realm-annotations-processor/src/main/java/io/realm/processor/Constants.kt

@@ -66,7 +66,8 @@ object Constants {
             "byte[]" to RealmFieldType.BINARY_LIST,
             "org.bson.types.Decimal128" to RealmFieldType.DECIMAL128_LIST,
             "org.bson.types.ObjectId" to RealmFieldType.OBJECT_ID_LIST,
-            "java.util.UUID" to RealmFieldType.UUID_LIST
+            "java.util.UUID" to RealmFieldType.UUID_LIST,
+            "io.realm.RealmAny" to RealmFieldType.MIXED_LIST
     )
 
     /**
@@ -85,6 +86,7 @@ object Constants {
         DATE("DATE", "Date"),
         BINARY("BINARY", "BinaryByteArray"),
         REALM_INTEGER("INTEGER", "Long"),
+        MIXED("MIXED", "RealmAny"),
         OBJECT("OBJECT", "Object"),
         LIST("LIST", "List"),
         DECIMAL128("DECIMAL128", "Decimal128"),
@@ -102,7 +104,8 @@ object Constants {
         DOUBLE_LIST("DOUBLE_LIST", "List"),
         DECIMAL128_LIST("DECIMAL128_LIST", "List"),
         OBJECT_ID_LIST("OBJECT_ID_LIST", "List"),
-        UUID_LIST("UUID_LIST", "List");
+        UUID_LIST("UUID_LIST", "List"),
+        MIXED_LIST("MIXED_LIST", "List");
 
         /**
          * The name of the enum, used in the Java bindings, used to represent the corresponding type.

realm/realm-annotations-processor/src/main/java/io/realm/processor/ModuleMetaData.kt

@@ -16,21 +16,11 @@
 
 package io.realm.processor
 
-import java.util.ArrayList
-import java.util.HashMap
-import java.util.HashSet
-import java.util.LinkedHashMap
-import java.util.LinkedHashSet
-
-import javax.lang.model.element.AnnotationMirror
-import javax.lang.model.element.AnnotationValue
-import javax.lang.model.element.Element
-import javax.lang.model.element.ElementKind
-import javax.lang.model.element.TypeElement
-
 import io.realm.annotations.RealmModule
 import io.realm.annotations.RealmNamingPolicy
 import io.realm.processor.nameconverter.NameConverter
+import java.util.*
+import javax.lang.model.element.*
 
 /**
  * Utility class for holding metadata for the Realm modules.