Make user agent configurable

Author: simolus3

PowerSyncKotlin/src/appleMain/kotlin/com/powersync/SDK.kt

@@ -3,6 +3,7 @@
 package com.powersync
 
 import com.powersync.sync.ConnectionMethod
+import com.powersync.sync.SyncOptions
 
 /**
  * Helper class designed to bridge SKIEE methods and allow them to throw
@@ -17,14 +18,23 @@ import com.powersync.sync.ConnectionMethod
 public fun throwPowerSyncException(exception: PowerSyncException): Unit = throw exception
 
 /**
- * Creates a [ConnectionMethod] from a simple boolean, because creating the actual instance with
+ * Creates a [ConnectionMethod] based on simple booleans, because creating the actual instance with
  * the default constructor is not possible from Swift due to an optional argument with an internal
  * default value.
  */
 @OptIn(ExperimentalPowerSyncAPI::class)
-public fun createConnectionMethod(webSocket: Boolean): ConnectionMethod =
-    if (webSocket) {
-        ConnectionMethod.WebSocket()
-    } else {
-        ConnectionMethod.Http
-    }
+public fun createSyncOptions(
+    newClient: Boolean,
+    webSocket: Boolean,
+    userAgent: String,
+): SyncOptions =
+    SyncOptions(
+        newClientImplementation = newClient,
+        method =
+            if (webSocket) {
+                ConnectionMethod.WebSocket()
+            } else {
+                ConnectionMethod.Http
+            },
+        userAgent = userAgent,
+    )

core/src/androidMain/kotlin/com/powersync/sync/UserAgent.android.kt

@@ -0,0 +1,5 @@
+package com.powersync.sync
+
+import android.os.Build
+
+internal actual fun userAgent(): String = "PowerSync Kotlin SDK (Android ${Build.VERSION.SDK_INT})"

core/src/commonMain/kotlin/com/powersync/sync/RSocketSupport.kt

@@ -42,6 +42,7 @@ import kotlin.coroutines.CoroutineContext
  */
 @OptIn(RSocketTransportApi::class, ExperimentalPowerSyncAPI::class)
 internal fun HttpClient.rSocketSyncStream(
+    userAgent: String,
     options: ConnectionMethod.WebSocket,
     req: JsonObject,
     credentials: PowerSyncCredentials,
@@ -90,7 +91,14 @@ internal fun HttpClient.rSocketSyncStream(
                     setupPayload {
                         buildPayload {
                             data("{}")
-                            metadata(JsonUtil.json.encodeToString(ConnectionSetupMetadata(token = "Bearer ${credentials.token}")))
+                            metadata(
+                                JsonUtil.json.encodeToString(
+                                    ConnectionSetupMetadata(
+                                        token = "Bearer ${credentials.token}",
+                                        userAgent = userAgent,
+                                    ),
+                                ),
+                            )
                         }
                     }
 
@@ -119,7 +127,7 @@ internal fun HttpClient.rSocketSyncStream(
 private class ConnectionSetupMetadata(
     val token: String,
     @SerialName("user_agent")
-    val userAgent: String = userAgent(),
+    val userAgent: String,
 )
 
 /**

core/src/commonMain/kotlin/com/powersync/sync/SyncOptions.kt

@@ -21,6 +21,10 @@ public class SyncOptions
         public val newClientImplementation: Boolean = false,
         @property:ExperimentalPowerSyncAPI
         public val method: ConnectionMethod = ConnectionMethod.Http,
+        /**
+         * The user agent to use for requests made to the PowerSync service.
+         */
+        public val userAgent: String = userAgent(),
     ) {
         public companion object {
             /**

core/src/commonMain/kotlin/com/powersync/sync/SyncStream.kt

@@ -83,7 +83,7 @@ internal class SyncStream(
 
             install(DefaultRequest) {
                 headers {
-                    append("User-Agent", userAgent())
+                    append("User-Agent", options.userAgent)
                 }
             }
         }
@@ -255,6 +255,7 @@ internal class SyncStream(
 
             emitAll(
                 httpClient.rSocketSyncStream(
+                    userAgent = this@SyncStream.options.userAgent,
                     options = options,
                     req = req,
                     credentials = credentials,

core/src/commonMain/kotlin/com/powersync/sync/UserAgent.kt

@@ -1,3 +1,3 @@
 package com.powersync.sync
 
-internal fun userAgent(): String = "PowerSync Kotlin SDK"
+internal expect fun userAgent(): String

core/src/jvmMain/kotlin/com/powersync/sync/UserAgent.jvm.kt

@@ -0,0 +1,9 @@
+package com.powersync.sync
+
+internal actual fun userAgent(): String {
+    val os = System.getProperty("os.name") ?: "unknown"
+    val osVersion = System.getProperty("os.version") ?: ""
+    val java = System.getProperty("java.vendor.version") ?: System.getProperty("java.runtime.version") ?: "unknown"
+
+    return "PowerSync Kotlin SDK (running Java $java on $os $osVersion)"
+}

core/src/nativeMain/kotlin/com/powersync/sync/UserAgent.native.kt

@@ -0,0 +1,6 @@
+package com.powersync.sync
+
+import kotlin.experimental.ExperimentalNativeApi
+
+@OptIn(ExperimentalNativeApi::class)
+internal actual fun userAgent(): String = "PowerSync Kotlin SDK (running on ${Platform.cpuArchitecture.name} ${Platform.osFamily.name})"