Add support for Keypath filtering in notifications

CHANGELOG.md

@@ -4,7 +4,8 @@
 * None.
 
 ### Enhancements
-* Added support for keypaths in `asFlow()` methods on objects. This makes it possible to control which properties will trigger change events, including properties on objects below the default nested limit of 4. (Issue [#661](https://github.com/realm/realm-kotlin/issues/661))
+* Added support for keypaths in `asFlow()` methods on objects and queries. This makes it possible to control which properties will trigger change events, including properties on objects below the default nested limit of 4. (Issue [#661](https://github.com/realm/realm-kotlin/issues/661))
+* Support for experimental K2-compilation with `kotlin.experimental.tryK2=true`. (Issue [#1483](https://github.com/realm/realm-kotlin/issues/1483))
 
 ### Fixed
 * None.

packages/cinterop/src/commonMain/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt

@@ -438,7 +438,7 @@ expect object RealmInterop {
     ): RealmObjectPointer?
     fun realm_object_delete(obj: RealmObjectPointer)
 
-    fun create_key_paths_array(realm: RealmPointer, clazz: ClassKey, keyPaths: List<String>): RealmKeyPathArrayPointer
+    fun realm_create_key_paths_array(realm: RealmPointer, clazz: ClassKey, keyPaths: List<String>): RealmKeyPathArrayPointer
     fun realm_object_add_notification_callback(
         obj: RealmObjectPointer,
         keyPaths: RealmKeyPathArrayPointer?,

packages/cinterop/src/jvm/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt

@@ -813,7 +813,7 @@ actual object RealmInterop {
         return realmc.realm_dictionary_is_valid(dictionary.cptr())
     }
 
-    actual fun create_key_paths_array(realm: RealmPointer, clazz: ClassKey, keyPaths: List<String>): RealmKeyPathArrayPointer {
+    actual fun realm_create_key_paths_array(realm: RealmPointer, clazz: ClassKey, keyPaths: List<String>): RealmKeyPathArrayPointer {
         val ptr = realmc.jni_realm_create_key_path_array(realm.cptr(), clazz.key, keyPaths.size, keyPaths.toTypedArray())
         return LongPointerWrapper(ptr)
     }

packages/cinterop/src/nativeDarwin/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt

@@ -105,7 +105,6 @@ import realm_wrapper.realm_http_header_t
 import realm_wrapper.realm_http_request_method
 import realm_wrapper.realm_http_request_t
 import realm_wrapper.realm_http_response_t
-import realm_wrapper.realm_key_path_array_t
 import realm_wrapper.realm_link_t
 import realm_wrapper.realm_list_t
 import realm_wrapper.realm_object_id_t
@@ -1656,12 +1655,11 @@ actual object RealmInterop {
         checkedBooleanResult(realm_wrapper.realm_object_delete(obj.cptr()))
     }
 
-    actual fun create_key_paths_array(realm: RealmPointer, clazz: ClassKey, keyPaths: List<String>): RealmKeyPathArrayPointer {
+    actual fun realm_create_key_paths_array(realm: RealmPointer, clazz: ClassKey, keyPaths: List<String>): RealmKeyPathArrayPointer {
         memScoped {
-            val kps: CPointer<CPointerVarOf<CPointer<ByteVarOf<Byte>>>> = keyPaths.toCStringArray(this)
-            val kp = allocArray<CPointerVar<realm_key_path_array_t>>(1)
-            checkedBooleanResult(realm_wrapper.realm_create_key_path_array(realm.cptr(), clazz.key.toUInt(), keyPaths.size, kps, kp))
-            return CPointerWrapper(kp[0])
+            val userKeyPaths: CPointer<CPointerVarOf<CPointer<ByteVarOf<Byte>>>> = keyPaths.toCStringArray(this)
+            val keyPathPointer = realm_wrapper.realm_create_key_path_array(realm.cptr(), clazz.key.toUInt(), keyPaths.size, userKeyPaths)
+            return CPointerWrapper(keyPathPointer)
         }
     }
 

packages/jni-swig-stub/realm.i

@@ -423,8 +423,9 @@ import static io.realm.kotlin.internal.interop.realm_errno_e.*;
 /* This cleans up the memory we malloc'd before the function call */
 %typemap(freearg) char ** {
     int i;
-    for (i=0; i<size$argnum-1; i++)
-    free($1[i]);
+    for (i=0; i<size$argnum-1; i++) {
+        free($1[i]);
+    }
     free($1);
 }
 
@@ -454,7 +455,7 @@ import static io.realm.kotlin.internal.interop.realm_errno_e.*;
    and vice versa */
 %typemap(javain) char ** "$javainput"
 %typemap(javaout) char ** {
-return $jnicall;
+    return $jnicall;
 }
 // -- End
 

packages/jni-swig-stub/src/main/jni/realm_api_helpers.cpp

@@ -1073,10 +1073,9 @@ jni_realm_create_key_path_array(const realm_t* realm,
                             int user_key_paths_count,
                             const char** user_key_paths)
 {
-    realm_key_path_array_t* out = nullptr;
-    bool result = realm_create_key_path_array(realm, object_class_key, user_key_paths_count, user_key_paths, &out);
+    realm_key_path_array_t* result = realm_create_key_path_array(realm, object_class_key, user_key_paths_count, user_key_paths);
     if (result) {
-        return out;
+        return result ;
     } else {
         auto env = get_env();
         throw_last_error_as_java_exception(env);

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/ext/BaseRealmObjectExt.kt

@@ -85,12 +85,13 @@ public fun BaseRealmObject.isValid(): Boolean = runIfManaged {
  *
  * @param keyPaths An optional list of properties that defines when a change to the object will
  * result in a change being emitted. Nested properties can be defined using a dotted
- * syntex, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
+ * syntax, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
  * properties and nested properties 4 levels down will trigger a change.
  * @return a flow representing changes to the object.
  * @throws UnsupportedOperationException if called on a live [RealmObject] or [EmbeddedRealmObject]
  * from a write transaction ([Realm.write]) or on a [DynamicRealmObject] inside a migration
  * ([AutomaticSchemaMigration.migrate]).
+ * @throws IllegalArgumentException if an invalid keypath is provided.
  */
 public fun <T : BaseRealmObject> T.asFlow(keyPaths: List<String>? = null): Flow<ObjectChange<T>> = runIfManaged {
     checkNotificationsAvailable()

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/SuspendableNotifier.kt

@@ -96,7 +96,7 @@ internal class SuspendableNotifier(
     }
 
     internal fun <T : CoreNotifiable<T, C>, C> registerObserver(flowable: Observable<T, C>, keyPaths: Pair<ClassKey, List<String>>?): Flow<C> {
-        val keypathsPtr: RealmKeyPathArrayPointer? = keyPaths?.let { RealmInterop.create_key_paths_array(realm.owner.realmReference.dbPointer, keyPaths.first, keyPaths.second) }
+        val keypathsPtr: RealmKeyPathArrayPointer? = keyPaths?.let { RealmInterop.realm_create_key_paths_array(realm.owner.realmReference.dbPointer, keyPaths.first, keyPaths.second) }
         return callbackFlow {
             val token: AtomicRef<Cancellable> =
                 kotlinx.atomicfu.atomic(NO_OP_NOTIFICATION_TOKEN)

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/query/SingleQuery.kt

@@ -87,9 +87,9 @@ internal class SingleQuery<E : BaseRealmObject> constructor(
                 } else {
                     oldHead = newHead
                     if (!oldHeadDeleted) {
-                        newHead.asFlow()
+                        newHead.asFlow(keyPaths)
                     } else {
-                        newHead.asFlow().onStart { emit(DeletedObjectImpl()) }
+                        newHead.asFlow(keyPaths).onStart { emit(DeletedObjectImpl()) }
                     }
                 }
             }

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/query/RealmElementQuery.kt

@@ -60,8 +60,12 @@ public interface RealmElementQuery<T : BaseRealmObject> : Deleteable {
      *
      * **It is not allowed to call [asFlow] on queries generated from a [MutableRealm].**
      *
-     * @param keyPath TODO
+     * @param keyPaths An optional list of properties that defines when a change to the object will
+     * result in a change being emitted. Nested properties can be defined using a dotted
+     * syntax, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
+     * properties and nested properties 4 levels down will trigger a change.
      * @return a flow representing changes to the [RealmResults] resulting from running this query.
+     * @throws IllegalArgumentException if an invalid keypath is provided.
      */
     public fun asFlow(keyPath: List<String>? = null): Flow<ResultsChange<T>>
 }

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/query/RealmSingleQuery.kt

@@ -72,9 +72,13 @@ public interface RealmSingleQuery<T : BaseRealmObject> : Deleteable {
      * the elements in a timely manner the coroutine scope will be cancelled with a
      * [CancellationException].
      *
-     * @param keyPaths TODO
+     * @param keyPaths An optional list of properties that defines when a change to the object will
+     * result in a change being emitted. Nested properties can be defined using a dotted
+     * syntex, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
+     * properties and nested properties 4 levels down will trigger a change.
      * @return a flow representing changes to the [RealmObject] or [EmbeddedRealmObject] resulting from
      * running this query.
+     * @throws IllegalArgumentException if an invalid keypath is provided.
      */
     public fun asFlow(keyPaths: List<String>? = null): Flow<SingleQueryChange<T>>
 }

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/types/RealmList.kt

@@ -74,10 +74,10 @@ public interface RealmList<E> : MutableList<E>, Deleteable {
      *
      * @param keyPaths An optional list of properties that defines when a change to the object will
      * result in a change being emitted. Nested properties can be defined using a dotted
-     * syntex, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
+     * syntax, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
      * properties and nested properties 4 levels down will trigger a change.
      * @return a flow representing changes to the list.
-     * @throws IllegalArgumentException if keypaths are provided for lists not containing objects.
+     * @throws IllegalArgumentException if an invalid keypath is provided.
      * @throws CancellationException if the stream produces changes faster than the consumer can
      * consume them and results in a buffer overflow.
      */

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/types/RealmMap.kt

@@ -57,7 +57,7 @@ public interface RealmMap<K, V> : MutableMap<K, V> {
      *
      * @param keyPaths An optional list of properties that defines when a change to the object will
      * result in a change being emitted. Nested properties can be defined using a dotted
-     * syntex, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
+     * syntax, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
      * properties and nested properties 4 levels down will trigger a change.
      * @return a flow representing changes to the dictionary.
      * @throws IllegalArgumentException if keypaths are provided for maps not containing objects.

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/types/RealmSet.kt

@@ -54,10 +54,10 @@ public interface RealmSet<E> : MutableSet<E>, Deleteable {
      *
      * @param keyPaths An optional list of properties that defines when a change to the object will
      * result in a change being emitted. Nested properties can be defined using a dotted
-     * syntex, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
+     * syntax, e.g. `parent.child.name`. If no keypaths are provided, changes to all top-level
      * properties and nested properties 4 levels down will trigger a change.
      * @return a flow representing changes to the set.
-     * @throws IllegalArgumentException if keypaths are provided for sets not containing objects.
+     * @throws IllegalArgumentException if an invalid keypath is provided.
      * @throws CancellationException if the stream produces changes faster than the consumer can
      * consume them and results in a buffer overflow.
      */

packages/test-base/src/commonTest/kotlin/io/realm/kotlin/test/common/QueryTests.kt

@@ -2946,6 +2946,86 @@ class QueryTests {
         }
     }
 
+    @Test
+    fun asFlow_results_withKeyPath() {
+        val channel = Channel<ResultsChange<QuerySample>>(1)
+        runBlocking {
+            val observer = async {
+                realm.query<QuerySample>()
+                    .asFlow(listOf("stringField"))
+                    .collect { results ->
+                        assertNotNull(results)
+                        channel.send(results)
+                    }
+            }
+            channel.receiveOrFail().let { resultsChange ->
+                assertIs<InitialResults<*>>(resultsChange)
+                assertTrue(resultsChange.list.isEmpty())
+            }
+            val obj = realm.writeBlocking {
+                copyToRealm(QuerySample())
+            }
+            channel.receiveOrFail().let { resultsChange ->
+                assertIs<UpdatedResults<*>>(resultsChange)
+                assertEquals(1, resultsChange.list.size)
+            }
+            realm.writeBlocking {
+                // Should not trigger notification
+                findLatest(obj)!!.intField = 42
+            }
+            realm.writeBlocking {
+                // Should not trigger notification
+                findLatest(obj)!!.stringField = "update"
+            }
+            channel.receiveOrFail().let { resultsChange ->
+                assertIs<UpdatedResults<*>>(resultsChange)
+                assertEquals(1, resultsChange.list.size)
+            }
+            observer.cancel()
+            channel.close()
+        }
+    }
+
+    @Test
+    fun asFlow_objectBound_withKeyPath() {
+        val channel = Channel<SingleQueryChange<QuerySample>>(1)
+        runBlocking {
+            val observer = async {
+                realm.query<QuerySample>()
+                    .first()
+                    .asFlow(listOf("stringField"))
+                    .collect { change ->
+                        assertNotNull(change)
+                        channel.send(change)
+                    }
+            }
+            channel.receiveOrFail().let { objChange ->
+                assertIs<PendingObject<*>>(objChange)
+            }
+            val obj = realm.writeBlocking {
+                copyToRealm(QuerySample())
+            }
+            channel.receiveOrFail().let { objChange ->
+                assertIs<InitialObject<*>>(objChange)
+            }
+            realm.writeBlocking {
+                // Should not trigger notification
+                findLatest(obj)!!.intField = 42
+            }
+            realm.writeBlocking {
+                // Should trigger notification
+                findLatest(obj)!!.stringField = "update"
+            }
+            channel.receiveOrFail().let { objChange ->
+                assertIs<UpdatedObject<*>>(objChange)
+                assertEquals(1, objChange.changedFields.size)
+                assertEquals("stringField", objChange.changedFields.first())
+            }
+            observer.cancel()
+            channel.close()
+        }
+    }
+
     // ----------------
     // Coercion helpers
     // ----------------