Update to Core 13.24.0 (#1439)

* Update to Core 13.24.0

* Regenerate ffi bindings

* Retry calling the client reset function

Author: nirinchev

CHANGELOG.md

@@ -5,14 +5,18 @@
 
 ### Fixed
 * Fixed an issue where connections to Atlas App Services would fail on Android with a certificate expiration error. (Issue [#1430](https://github.com/realm/realm-dart/issues/1430))
+* Errors encountered while reapplying local changes for client reset recovery on partition-based sync Realms would result in the client reset attempt not being recorded, possibly resulting in an endless loop of attempting and failing to automatically recover the client reset. Flexible sync and errors from the server after completing the local recovery were handled correctly. (Core 13.24.0)
+* During a client reset with recovery when recovering a move or set operation on a `List` that operated on indices that were not also added in the recovery, links to an object which had been deleted by another client while offline would be recreated by the recovering client. But the objects of these links would only have the primary key populated and all other fields would be default values. Now, instead of creating these zombie objects, the lists being recovered skip such deleted links. (Core 13.24.0)
+* During a client reset recovery a Set of objects could be missing items, or an exception could be thrown that prevents recovery ex: "Requested index 1 calling get() on set 'source.collection' when max is 0". (Core 13.24.0)
+* Automatic client reset recovery would duplicate insertions in a list when recovering a write which made an unrecoverable change to a list (i.e. modifying or deleting a pre-existing entry), followed by a subscription change, followed by a write which added an entry to the list. (Core 13.24.0)
 
 ### Compatibility
 * Realm Studio: 13.0.0 or later.
 * Flutter: ^3.13.0
 * Dart: ^3.1.0
 
 ### Internal
-* Using Core 13.23.2.
+* Using Core 13.24.0.
 
 ## 1.6.0 (2023-11-15)
 
@@ -55,7 +59,7 @@
 * Sync protocol version bumped to 10. (Core upgrade)
 * Handle `badChangeset` error when printing changeset contents in debug. (Core upgrade)
 
-* Using Core 13.23.2.
+* Using Core 13.23.4.
 
 ## 1.5.0 (2023-09-18)
 

lib/src/native/realm_bindings.dart

@@ -3053,6 +3053,37 @@ class RealmLibrary {
       bool Function(
           ffi.Pointer<realm_t>, ffi.Pointer<ffi.Char>, realm_binary_t, bool)>();
 
+  /// Helper method for making it easier to to convert SDK input to the underlying
+  /// `realm_key_path_array_t`.
+  ///
+  /// @return A pointer to the converted key path array. NULL in case of an error.
+  ffi.Pointer<realm_key_path_array_t> realm_create_key_path_array(
+    ffi.Pointer<realm_t> realm,
+    int object_class_key,
+    int num_key_paths,
+    ffi.Pointer<ffi.Pointer<ffi.Char>> user_key_paths,
+  ) {
+    return _realm_create_key_path_array(
+      realm,
+      object_class_key,
+      num_key_paths,
+      user_key_paths,
+    );
+  }
+
+  late final _realm_create_key_path_arrayPtr = _lookup<
+          ffi.NativeFunction<
+              ffi.Pointer<realm_key_path_array_t> Function(
+                  ffi.Pointer<realm_t>,
+                  realm_class_key_t,
+                  ffi.Size,
+                  ffi.Pointer<ffi.Pointer<ffi.Char>>)>>(
+      'realm_create_key_path_array');
+  late final _realm_create_key_path_array =
+      _realm_create_key_path_arrayPtr.asFunction<
+          ffi.Pointer<realm_key_path_array_t> Function(ffi.Pointer<realm_t>,
+              int, int, ffi.Pointer<ffi.Pointer<ffi.Char>>)>();
+
   /// Get a thread-safe reference representing the same underlying object as some
   /// API object.
   ///
@@ -3925,14 +3956,14 @@ class RealmLibrary {
     ffi.Pointer<realm_dictionary_t> arg0,
     ffi.Pointer<ffi.Void> userdata,
     realm_free_userdata_func_t userdata_free,
-    ffi.Pointer<realm_key_path_array_t> arg3,
+    ffi.Pointer<realm_key_path_array_t> key_path_array,
     realm_on_dictionary_change_func_t on_change,
   ) {
     return _realm_dictionary_add_notification_callback(
       arg0,
       userdata,
       userdata_free,
-      arg3,
+      key_path_array,
       on_change,
     );
   }
@@ -5498,14 +5529,14 @@ class RealmLibrary {
     ffi.Pointer<realm_list_t> arg0,
     ffi.Pointer<ffi.Void> userdata,
     realm_free_userdata_func_t userdata_free,
-    ffi.Pointer<realm_key_path_array_t> arg3,
+    ffi.Pointer<realm_key_path_array_t> key_path_array,
     realm_on_collection_change_func_t on_change,
   ) {
     return _realm_list_add_notification_callback(
       arg0,
       userdata,
       userdata_free,
-      arg3,
+      key_path_array,
       on_change,
     );
   }
@@ -6553,14 +6584,14 @@ class RealmLibrary {
     ffi.Pointer<realm_object_t> arg0,
     ffi.Pointer<ffi.Void> userdata,
     realm_free_userdata_func_t userdata_free,
-    ffi.Pointer<realm_key_path_array_t> arg3,
+    ffi.Pointer<realm_key_path_array_t> key_path_array,
     realm_on_object_change_func_t on_change,
   ) {
     return _realm_object_add_notification_callback(
       arg0,
       userdata,
       userdata_free,
-      arg3,
+      key_path_array,
       on_change,
     );
   }
@@ -7407,14 +7438,14 @@ class RealmLibrary {
     ffi.Pointer<realm_results_t> arg0,
     ffi.Pointer<ffi.Void> userdata,
     realm_free_userdata_func_t userdata_free,
-    ffi.Pointer<realm_key_path_array_t> arg3,
+    ffi.Pointer<realm_key_path_array_t> key_path_array,
     realm_on_collection_change_func_t arg4,
   ) {
     return _realm_results_add_notification_callback(
       arg0,
       userdata,
       userdata_free,
-      arg3,
+      key_path_array,
       arg4,
     );
   }
@@ -8195,14 +8226,14 @@ class RealmLibrary {
     ffi.Pointer<realm_set_t> arg0,
     ffi.Pointer<ffi.Void> userdata,
     realm_free_userdata_func_t userdata_free,
-    ffi.Pointer<realm_key_path_array_t> arg3,
+    ffi.Pointer<realm_key_path_array_t> key_path_array,
     realm_on_collection_change_func_t on_change,
   ) {
     return _realm_set_add_notification_callback(
       arg0,
       userdata,
       userdata_free,
-      arg3,
+      key_path_array,
       on_change,
     );
   }
@@ -11688,33 +11719,10 @@ final class realm_index_range extends ffi.Struct {
 
 typedef realm_index_range_t = realm_index_range;
 
-final class realm_key_path extends ffi.Struct {
-  @ffi.Size()
-  external int nb_elements;
-
-  external ffi.Pointer<realm_key_path_elem_t> path_elements;
-}
-
-final class realm_key_path_array extends ffi.Struct {
-  @ffi.Size()
-  external int nb_elements;
-
-  external ffi.Pointer<realm_key_path_t> paths;
-}
+final class realm_key_path_array extends ffi.Opaque {}
 
 typedef realm_key_path_array_t = realm_key_path_array;
 
-final class realm_key_path_elem extends ffi.Struct {
-  @realm_class_key_t()
-  external int object;
-
-  @realm_property_key_t()
-  external int property;
-}
-
-typedef realm_key_path_elem_t = realm_key_path_elem;
-typedef realm_key_path_t = realm_key_path;
-
 final class realm_link extends ffi.Struct {
   @realm_class_key_t()
   external int target_table;

src/realm-core

@@ -653,8 +653,20 @@ Future<void> triggerClientReset(Realm realm, {bool restartSession = true}) async
   final userId = config.user.id;
   final appId = baasApps.values.firstWhere((element) => element.clientAppId == config.user.app.id).appId;
 
-  final result = await config.user.functions.call('triggerClientResetOnSyncServer', [userId, appId]) as Map<String, dynamic>;
-  expect(result['status'], 'success');
+  for (var i = 0; i < 5; i++) {
+    try {
+      final result = await config.user.functions.call('triggerClientResetOnSyncServer', [userId, appId]) as Map<String, dynamic>;
+      expect(result['status'], 'success');
+      break;
+    } catch (e) {
+      if (i == 4) {
+        rethrow;
+      }
+
+      print('Failed to trigger client reset: $e');
+      await Future.delayed(Duration(seconds: i));
+    }
+  }
 
   if (restartSession) {
     session.resume();