Add support for multiplexing and SyncTimeoutOptions (#1578)

realm · Nov 28, 2023 · 6460014 · 6460014
1 parent 9d23735
commit 6460014
Show file tree

Hide file tree

Showing 9 changed files with 387 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@
 
 ### Enhancements
 * Support for experimental K2-compilation with `kotlin.experimental.tryK2=true`. (Issue [#1483](https://github.com/realm/realm-kotlin/issues/1483))
+* [Sync] Added support for multiplexing sync connections. When enabled, a single
+  connection is used per sync user rather than one per synchronized Realm. This
+  reduces resource consumption when multiple Realms are opened and will
+  typically improve performance. The behavior can be controlled through [AppConfiguration.Builder.enableSessionMultiplexing]. It will be made the default
+  in a future release. (Issue [#1578](https://github.com/realm/realm-kotlin/pull/1578))  
+* [Sync] Various sync timeout options can now be configured through `AppConfiguration.Builder.syncTimeouts()`. (Issue [#971](https://github.com/realm/realm-kotlin/issues/971)).
 
 ### Fixed
 * Fix compiler crash caused by a change in Kotlin 1.9.20 ((toIrConst moved under common IrUtils)[https://github.com/JetBrains/kotlin/commit/ca8db7d0b83f6dfd6afcea7a5fe7556d38f325d8]). (Issue [#1566](https://github.com/realm/realm-kotlin/issues/1566))

diff --git a/packages/cinterop/src/commonMain/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt b/packages/cinterop/src/commonMain/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt
@@ -581,6 +581,12 @@ expect object RealmInterop {
         applicationInfo: String
     )
 
+    fun realm_sync_client_config_set_connect_timeout(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong)
+    fun realm_sync_client_config_set_connection_linger_time(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong)
+    fun realm_sync_client_config_set_ping_keepalive_period(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong)
+    fun realm_sync_client_config_set_pong_keepalive_timeout(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong)
+    fun realm_sync_client_config_set_fast_reconnect_limit(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong)
+
     fun realm_sync_config_new(
         user: RealmUserPointer,
         partition: String

diff --git a/packages/cinterop/src/jvm/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt b/packages/cinterop/src/jvm/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt
@@ -1301,6 +1301,26 @@ actual object RealmInterop {
         )
     }
 
+    actual fun realm_sync_client_config_set_connect_timeout(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realmc.realm_sync_client_config_set_connect_timeout(syncClientConfig.cptr(), timeoutMs.toLong())
+    }
+
+    actual fun realm_sync_client_config_set_connection_linger_time(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realmc.realm_sync_client_config_set_connection_linger_time(syncClientConfig.cptr(), timeoutMs.toLong())
+    }
+
+    actual fun realm_sync_client_config_set_ping_keepalive_period(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realmc.realm_sync_client_config_set_ping_keepalive_period(syncClientConfig.cptr(), timeoutMs.toLong())
+    }
+
+    actual fun realm_sync_client_config_set_pong_keepalive_timeout(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realmc.realm_sync_client_config_set_pong_keepalive_timeout(syncClientConfig.cptr(), timeoutMs.toLong())
+    }
+
+    actual fun realm_sync_client_config_set_fast_reconnect_limit(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realmc.realm_sync_client_config_set_fast_reconnect_limit(syncClientConfig.cptr(), timeoutMs.toLong())
+    }
+
     actual fun realm_network_transport_new(networkTransport: NetworkTransport): RealmNetworkTransportPointer {
         return LongPointerWrapper(realmc.realm_network_transport_new(networkTransport))
     }

diff --git a/packages/cinterop/src/nativeDarwin/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt b/packages/cinterop/src/nativeDarwin/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt
@@ -2444,6 +2444,26 @@ actual object RealmInterop {
         )
     }
 
+    actual fun realm_sync_client_config_set_connect_timeout(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realm_wrapper.realm_sync_client_config_set_connect_timeout(syncClientConfig.cptr(), timeoutMs)
+    }
+
+    actual fun realm_sync_client_config_set_connection_linger_time(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realm_wrapper.realm_sync_client_config_set_connection_linger_time(syncClientConfig.cptr(), timeoutMs)
+    }
+
+    actual fun realm_sync_client_config_set_ping_keepalive_period(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realm_wrapper.realm_sync_client_config_set_ping_keepalive_period(syncClientConfig.cptr(), timeoutMs)
+    }
+
+    actual fun realm_sync_client_config_set_pong_keepalive_timeout(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realm_wrapper.realm_sync_client_config_set_pong_keepalive_timeout(syncClientConfig.cptr(), timeoutMs)
+    }
+
+    actual fun realm_sync_client_config_set_fast_reconnect_limit(syncClientConfig: RealmSyncClientConfigurationPointer, timeoutMs: ULong) {
+        realm_wrapper.realm_sync_client_config_set_fast_reconnect_limit(syncClientConfig.cptr(), timeoutMs)
+    }
+
     actual fun realm_sync_config_set_error_handler(
         syncConfig: RealmSyncConfigurationPointer,
         errorHandler: SyncErrorCallback

diff --git a/packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/AppConfiguration.kt b/packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/AppConfiguration.kt
@@ -39,6 +39,8 @@ import io.realm.kotlin.mongodb.internal.AppConfigurationImpl
 import io.realm.kotlin.mongodb.internal.KtorNetworkTransport
 import io.realm.kotlin.mongodb.internal.LogObfuscatorImpl
 import io.realm.kotlin.mongodb.sync.SyncConfiguration
+import io.realm.kotlin.mongodb.sync.SyncTimeoutOptions
+import io.realm.kotlin.mongodb.sync.SyncTimeoutOptionsBuilder
 import kotlinx.coroutines.CoroutineDispatcher
 import org.mongodb.kbson.ExperimentalKBsonSerializerApi
 import org.mongodb.kbson.serialization.EJson
@@ -102,6 +104,23 @@ public interface AppConfiguration {
      */
     public val httpLogObfuscator: HttpLogObfuscator?
 
+    /**
+     * If enabled, a single connection is used for all Realms opened
+     * with a single sync user. If disabled, a separate connection is used for each
+     * Realm.
+     *
+     * Session multiplexing reduces resources used and typically improves
+     * performance. When multiplexing is enabled, the connection is not immediately
+     * closed when the last session is closed, but remains open for
+     * [SyncTimeoutOptions.connectionLingerTime] defined in [syncTimeoutOptions].
+     */
+    public val enableSessionMultiplexing: Boolean
+
+    /**
+     * The configured timeouts for various aspects of the sync connection from realms.
+     */
+    public val syncTimeoutOptions: SyncTimeoutOptions
+
     public companion object {
         /**
          * The default url for App Services applications.
@@ -149,6 +168,8 @@ public interface AppConfiguration {
         private var httpLogObfuscator: HttpLogObfuscator? = LogObfuscatorImpl
         private val customRequestHeaders = mutableMapOf<String, String>()
         private var authorizationHeaderName: String = DEFAULT_AUTHORIZATION_HEADER_NAME
+        private var enableSessionMultiplexing: Boolean = false
+        private var syncTimeoutOptions: SyncTimeoutOptions = SyncTimeoutOptionsBuilder().build()
 
         /**
          * Sets the encryption key used to encrypt the user metadata Realm only. Individual
@@ -325,6 +346,33 @@ public interface AppConfiguration {
             this.ejson = ejson
         }
 
+        /**
+         * If enabled, a single connection is used for all Realms opened
+         * with a single sync user. If disabled, a separate connection is used for each
+         * Realm.
+         *
+         * Session multiplexing reduces resources used and typically improves
+         * performance. When multiplexing is enabled, the connection is not immediately
+         * closed when the last session is closed, but remains open for
+         * [SyncTimeoutOptions.connectionLingerTime] as defined by [syncTimeouts] (30 seconds by
+         * default).
+         */
+        public fun enableSessionMultiplexing(enabled: Boolean): Builder {
+            this.enableSessionMultiplexing = enabled
+            return this
+        }
+
+        /**
+         *  Configure the assorted types of connection timeouts for sync connections.
+         *  See [SyncTimeoutOptionsBuilder] for a description of each option.
+         */
+        public fun syncTimeouts(action: SyncTimeoutOptionsBuilder.() -> Unit): Builder {
+            val builder = SyncTimeoutOptionsBuilder()
+            action(builder)
+            syncTimeoutOptions = builder.build()
+            return this
+        }
+
         /**
          * Allows defining a custom network transport. It is used by some tests that require simulating
          * network responses.
@@ -411,6 +459,8 @@ public interface AppConfiguration {
                 httpLogObfuscator = httpLogObfuscator,
                 customRequestHeaders = customRequestHeaders,
                 authorizationHeaderName = authorizationHeaderName,
+                enableSessionMultiplexing = enableSessionMultiplexing,
+                syncTimeoutOptions = syncTimeoutOptions,
             )
         }
     }

diff --git a/...brary-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/AppConfigurationImpl.kt b/...brary-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/AppConfigurationImpl.kt
@@ -35,6 +35,7 @@ import io.realm.kotlin.internal.util.DispatcherHolder
 import io.realm.kotlin.mongodb.AppConfiguration
 import io.realm.kotlin.mongodb.AppConfiguration.Companion.DEFAULT_BASE_URL
 import io.realm.kotlin.mongodb.HttpLogObfuscator
+import io.realm.kotlin.mongodb.sync.SyncTimeoutOptions
 import org.mongodb.kbson.ExperimentalKBsonSerializerApi
 import org.mongodb.kbson.serialization.EJson
 
@@ -56,6 +57,8 @@ public class AppConfigurationImpl @OptIn(ExperimentalKBsonSerializerApi::class)
     override val httpLogObfuscator: HttpLogObfuscator?,
     override val customRequestHeaders: Map<String, String>,
     override val authorizationHeaderName: String,
+    override val enableSessionMultiplexing: Boolean,
+    override val syncTimeoutOptions: SyncTimeoutOptions,
 ) : AppConfiguration {
 
     /**
@@ -154,9 +157,6 @@ public class AppConfigurationImpl @OptIn(ExperimentalKBsonSerializerApi::class)
                     syncRootDirectory
                 )
 
-                // Disable multiplexing. See https://github.com/realm/realm-core/issues/6656
-                RealmInterop.realm_sync_client_config_set_multiplex_sessions(syncClientConfig, false)
-
                 encryptionKey?.let {
                     RealmInterop.realm_sync_client_config_set_metadata_encryption_key(
                         syncClientConfig,
@@ -177,6 +177,31 @@ public class AppConfigurationImpl @OptIn(ExperimentalKBsonSerializerApi::class)
                         it
                     )
                 }
+
+                // Setup multiplexing
+                RealmInterop.realm_sync_client_config_set_multiplex_sessions(syncClientConfig, enableSessionMultiplexing)
+
+                // Setup SyncTimeoutOptions
+                RealmInterop.realm_sync_client_config_set_connect_timeout(
+                    syncClientConfig,
+                    syncTimeoutOptions.connectTimeout.inWholeMilliseconds.toULong()
+                )
+                RealmInterop.realm_sync_client_config_set_connection_linger_time(
+                    syncClientConfig,
+                    syncTimeoutOptions.connectionLingerTime.inWholeMilliseconds.toULong()
+                )
+                RealmInterop.realm_sync_client_config_set_ping_keepalive_period(
+                    syncClientConfig,
+                    syncTimeoutOptions.pingKeepalivePeriod.inWholeMilliseconds.toULong()
+                )
+                RealmInterop.realm_sync_client_config_set_pong_keepalive_timeout(
+                    syncClientConfig,
+                    syncTimeoutOptions.pongKeepalivePeriod.inWholeMilliseconds.toULong()
+                )
+                RealmInterop.realm_sync_client_config_set_fast_reconnect_limit(
+                    syncClientConfig,
+                    syncTimeoutOptions.fastReconnectLimit.inWholeMilliseconds.toULong()
+                )
             }
 
     internal companion object {

diff --git a/...ges/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/sync/SyncTimeoutOptions.kt b/...ges/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/sync/SyncTimeoutOptions.kt
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2023 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.realm.kotlin.mongodb.sync
+
+import kotlin.time.Duration
+
+/**
+ * The configured timeouts for various aspects of the sync connection between synchronized realms
+ * and App Services.
+ *
+ * @see [io.realm.kotlin.mongodb.AppConfiguration.Builder.syncTimeouts]
+ */
+public data class SyncTimeoutOptions(
+
+    /**
+     * The maximum time to allow for a connection to become fully established. This includes
+     * the time to resolve the network address, the TCP connect operation, the SSL
+     * handshake, and the WebSocket handshake.
+     */
+    val connectTimeout: Duration,
+
+    /**
+     * If session multiplexing is enabled, how long to keep connections open while there are
+     * no active session.
+     */
+    val connectionLingerTime: Duration,
+
+    /**
+     * How long to wait between each ping message sent to the server. The client periodically
+     * sends ping messages to the server to check if the connection is still alive. Shorter
+     * periods make connection state change notifications more responsive at the cost of
+     * more trafic.
+     */
+    val pingKeepalivePeriod: Duration,
+
+    /**
+     * How long to wait for the server to respond to a ping message. Shorter values make
+     * connection state change notifications more responsive, but increase the chance of
+     * spurious disconnections.
+     */
+    val pongKeepalivePeriod: Duration,
+
+    /**
+     * When a client first connects to the server, it downloads all data from the server
+     * before it begins to upload local changes. This typically reduces the total amount
+     * of merging needed and gets the local client into a useful state faster. If a
+     * disconnect and reconnect happens within the time span of the fast reconnect limit,
+     * this is skipped and the session behaves as if it were continuously
+     * connected.
+     */
+    val fastReconnectLimit: Duration
+)