EncodedObject to make encoding more robust

Author: Daeda88

firebase-common/src/androidMain/kotlin/dev/gitlive/firebase/_encoders.kt

@@ -7,8 +7,26 @@ package dev.gitlive.firebase
 import kotlinx.serialization.descriptors.PolymorphicKind
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
+import java.lang.IllegalArgumentException
 import kotlin.collections.set
 
+actual data class EncodedObject(
+    val android: Map<String, Any?>
+)
+
+actual val emptyEncodedObject: EncodedObject = EncodedObject(emptyMap())
+
+@PublishedApi
+internal actual fun Map<*, *>.asEncodedObject() = EncodedObject(
+    map { (key, value) ->
+        if (key is String) {
+            key to value
+        } else {
+            throw IllegalArgumentException("Expected a String key but received $key")
+        }
+    }.toMap()
+)
+
 actual fun FirebaseEncoder.structureEncoder(descriptor: SerialDescriptor): FirebaseCompositeEncoder = when(descriptor.kind) {
     StructureKind.LIST -> mutableListOf<Any?>()
         .also { value = it }

firebase-common/src/commonMain/kotlin/dev/gitlive/firebase/encoders.kt

@@ -11,6 +11,10 @@ import kotlinx.serialization.encoding.CompositeEncoder
 import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.modules.SerializersModule
 
+expect class EncodedObject
+
+expect val emptyEncodedObject: EncodedObject
+
 @Deprecated("Deprecated. Use builder instead", replaceWith = ReplaceWith("encode(strategy, value) { encodeDefaults = shouldEncodeElementDefault }"))
 fun <T> encode(strategy: SerializationStrategy<T>, value: T, shouldEncodeElementDefault: Boolean): Any? = encode(strategy, value) {
     this.encodeDefaults = shouldEncodeElementDefault
@@ -31,6 +35,23 @@ inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean): An
 inline fun <reified T> encode(value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}) =
     encode(value, EncodeSettings.BuilderImpl().apply(buildSettings).buildEncodeSettings())
 
+inline fun <T : Any> encodeAsObject(strategy: SerializationStrategy<T>, value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): EncodedObject {
+    val encoded = encode(strategy, value, buildSettings)
+    return when (encoded) {
+        is Map<*, *> -> encoded.asEncodedObject()
+        null -> throw IllegalArgumentException("$value was encoded as null. Must be of the form Map<Key, Value>")
+        else -> throw IllegalArgumentException("$value was encoded as ${encoded::class}. Must be of the form Map<Key, Value>")
+    }
+}
+inline fun <reified T : Any> encodeAsObject(value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): EncodedObject {
+    val encoded = encode(value, buildSettings)
+    return when (encoded) {
+        is Map<*, *> -> encoded.asEncodedObject()
+        null -> throw IllegalArgumentException("$value was encoded as null. Must be of the form Map<Key, Value>")
+        else -> throw IllegalArgumentException("$value was encoded as ${encoded::class}. Must be of the form Map<Key, Value>")
+    }
+}
+
 @PublishedApi
 internal inline fun <reified T> encode(value: T, encodeSettings: EncodeSettings): Any? = value?.let {
     FirebaseEncoder(encodeSettings).apply {
@@ -45,6 +66,9 @@ internal inline fun <reified T> encode(value: T, encodeSettings: EncodeSettings)
     }.value
 }
 
+@PublishedApi
+internal expect fun Map<*, *>.asEncodedObject(): EncodedObject
+
 /**
  * An extension which which serializer to use for value. Handy in updating fields by name or path
  * where using annotation is not possible

firebase-common/src/commonTest/kotlin/dev/gitlive/firebase/EncodersTest.kt

@@ -74,13 +74,15 @@ data class NestedClass(
 class EncodersTest {
 
     @Test
-    fun encodeDecodeNullableString() {
-        val encoded = encode<String?>(null) { encodeDefaults = true }
-
-        nativeAssertEquals(null, encoded)
-
-        val decoded = decode(String.serializer().nullable, encoded)
-        assertNull(decoded)
+    fun encodeDecodePrimaryTypes() {
+        assertEncode(true)
+        assertEncode(42)
+        assertEncode(8.toShort())
+        assertEncode(Int.MAX_VALUE.toLong() + 3)
+        assertEncode(0x03F)
+        assertEncode(3.33)
+        assertEncode(6.65f)
+        assertEncode("Test")
     }
     @Test
     fun encodeDecodeList() {
@@ -413,4 +415,14 @@ class EncodersTest {
             reencoded
         )
     }
+
+    private inline fun <reified T> assertEncode(value: T) {
+        val encoded = encode(value)
+        assertEquals(value, encoded)
+        assertEquals(value, decode<T>(encoded))
+
+        val nullableEncoded = encode<T?>(null)
+        assertNull(nullableEncoded)
+        assertNull(decode<T?>(nullableEncoded))
+    }
 }

firebase-common/src/iosMain/kotlin/dev/gitlive/firebase/_encoders.kt

@@ -9,6 +9,18 @@ import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
 import kotlin.collections.set
 
+actual data class EncodedObject(
+    val ios: Map<Any?, *>
+)
+
+actual val emptyEncodedObject: EncodedObject = EncodedObject(emptyMap<Any?, Any?>())
+
+@PublishedApi
+internal actual fun Map<*, *>.asEncodedObject() = EncodedObject(
+    map { (key, value) ->
+        key to value
+    }.toMap()
+)
 actual fun FirebaseEncoder.structureEncoder(descriptor: SerialDescriptor): FirebaseCompositeEncoder = when(descriptor.kind) {
     StructureKind.LIST -> encodeAsList()
     StructureKind.MAP -> mutableListOf<Any?>()

firebase-common/src/jsMain/kotlin/dev/gitlive/firebase/_encoders.kt

@@ -7,8 +7,22 @@ package dev.gitlive.firebase
 import kotlinx.serialization.descriptors.PolymorphicKind
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
+import kotlin.js.Json
 import kotlin.js.json
 
+actual typealias EncodedObject = Json
+
+actual val emptyEncodedObject: EncodedObject = json()
+@PublishedApi
+internal actual fun Map<*, *>.asEncodedObject() = json(
+    *map { (key, value) ->
+        if (key is String) {
+            key to value
+        } else {
+            throw IllegalArgumentException("Expected a String key but received $key")
+        }
+    }.toTypedArray()
+)
 actual fun FirebaseEncoder.structureEncoder(descriptor: SerialDescriptor): FirebaseCompositeEncoder = when(descriptor.kind) {
     StructureKind.LIST -> encodeAsList(descriptor)
     StructureKind.MAP -> {

firebase-database/src/androidMain/kotlin/dev/gitlive/firebase/database/database.kt

@@ -13,6 +13,7 @@ import com.google.firebase.database.Transaction
 import com.google.firebase.database.ValueEventListener
 import dev.gitlive.firebase.DecodeSettings
 import dev.gitlive.firebase.EncodeDecodeSettingsBuilder
+import dev.gitlive.firebase.EncodedObject
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.FirebaseApp
 import dev.gitlive.firebase.database.ChildEvent.Type
@@ -205,9 +206,8 @@ internal actual class NativeDatabaseReference internal constructor(
         .run { if(persistenceEnabled) await() else awaitWhileOnline(database) }
         .run { Unit }
 
-    @Suppress("UNCHECKED_CAST")
-    actual suspend fun updateEncodedChildren(encodedUpdate: Any?) =
-        android.updateChildren(encodedUpdate as Map<String, Any?>)
+    actual suspend fun updateEncodedChildren(encodedUpdate: EncodedObject) =
+        android.updateChildren(encodedUpdate.android)
             .run { if(persistenceEnabled) await() else awaitWhileOnline(database) }
             .run { Unit }
 
@@ -253,7 +253,6 @@ internal actual class NativeDatabaseReference internal constructor(
 
 val DatabaseReference.android get() = nativeReference.android
 
-@Suppress("UNCHECKED_CAST")
 actual class DataSnapshot internal constructor(
     val android: com.google.firebase.database.DataSnapshot,
     private val persistenceEnabled: Boolean
@@ -297,9 +296,8 @@ internal actual class NativeOnDisconnect internal constructor(
         .run { if(persistenceEnabled) await() else awaitWhileOnline(database) }
         .run { Unit }
 
-    @Suppress("UNCHECKED_CAST")
-    actual suspend fun updateEncodedChildren(encodedUpdate: Any?) =
-        android.updateChildren(encodedUpdate as Map<String, Any?>)
+    actual suspend fun updateEncodedChildren(encodedUpdate: EncodedObject) =
+        android.updateChildren(encodedUpdate.android)
             .run { if(persistenceEnabled) await() else awaitWhileOnline(database) }
             .run { Unit }
 }

firebase-database/src/commonMain/kotlin/dev/gitlive/firebase/database/database.kt

@@ -7,13 +7,15 @@ package dev.gitlive.firebase.database
 import dev.gitlive.firebase.DecodeSettings
 import dev.gitlive.firebase.EncodeDecodeSettingsBuilder
 import dev.gitlive.firebase.EncodeSettings
+import dev.gitlive.firebase.EncodedObject
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.FirebaseApp
 import dev.gitlive.firebase.database.ChildEvent.Type.ADDED
 import dev.gitlive.firebase.database.ChildEvent.Type.CHANGED
 import dev.gitlive.firebase.database.ChildEvent.Type.MOVED
 import dev.gitlive.firebase.database.ChildEvent.Type.REMOVED
 import dev.gitlive.firebase.encode
+import dev.gitlive.firebase.encodeAsObject
 import kotlinx.coroutines.flow.Flow
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.KSerializer
@@ -82,7 +84,7 @@ internal expect class NativeDatabaseReference : NativeQuery {
     val key: String?
     fun push(): NativeDatabaseReference
     suspend fun setValueEncoded(encodedValue: Any?)
-    suspend fun updateEncodedChildren(encodedUpdate: Any?)
+    suspend fun updateEncodedChildren(encodedUpdate: EncodedObject)
     fun child(path: String): NativeDatabaseReference
     fun onDisconnect(): NativeOnDisconnect
 
@@ -118,7 +120,7 @@ class DatabaseReference internal constructor(@PublishedApi internal val nativeRe
         this.encodeDefaults = encodeDefaults
     }
     suspend inline fun updateChildren(update: Map<String, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit = {}) = nativeReference.updateEncodedChildren(
-        encode(update, buildSettings))
+        encodeAsObject(update, buildSettings))
 
     suspend fun removeValue() = nativeReference.removeValue()
 
@@ -144,7 +146,7 @@ internal expect class NativeOnDisconnect {
     suspend fun removeValue()
     suspend fun cancel()
     suspend fun setValue(encodedValue: Any?)
-    suspend fun updateEncodedChildren(encodedUpdate: Any?)
+    suspend fun updateEncodedChildren(encodedUpdate: EncodedObject)
 }
 
 class OnDisconnect internal constructor(@PublishedApi internal val native: NativeOnDisconnect) {
@@ -160,7 +162,9 @@ class OnDisconnect internal constructor(@PublishedApi internal val native: Nativ
         setValue(strategy, value) { this.encodeDefaults = encodeDefaults }
     suspend inline fun <T> setValue(strategy: SerializationStrategy<T>, value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}) = setValue(encode(strategy, value, buildSettings))
 
-    suspend inline fun updateChildren(update: Map<String, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit = {}) = native.updateEncodedChildren(encode(update, buildSettings))
+    suspend inline fun updateChildren(update: Map<String, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit = {}) = native.updateEncodedChildren(
+        encodeAsObject(update, buildSettings)
+    )
     @Deprecated("Deprecated. Use builder instead", replaceWith = ReplaceWith("updateChildren(update) { this.encodeDefaults = encodeDefaults }"))
     suspend fun updateChildren(update: Map<String, Any?>, encodeDefaults: Boolean) = updateChildren(update) {
         this.encodeDefaults = encodeDefaults

firebase-database/src/iosMain/kotlin/dev/gitlive/firebase/database/database.kt

@@ -16,6 +16,7 @@ import cocoapods.FirebaseDatabase.FIRDatabaseReference
 import cocoapods.FirebaseDatabase.FIRTransactionResult
 import dev.gitlive.firebase.DecodeSettings
 import dev.gitlive.firebase.EncodeDecodeSettingsBuilder
+import dev.gitlive.firebase.EncodedObject
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.FirebaseApp
 import dev.gitlive.firebase.database.ChildEvent.Type
@@ -168,9 +169,8 @@ internal actual class NativeDatabaseReference internal constructor(
         ios.await(persistenceEnabled) { setValue(encodedValue, it) }
     }
 
-    @Suppress("UNCHECKED_CAST")
-    actual suspend fun updateEncodedChildren(encodedUpdate: Any?) {
-        ios.await(persistenceEnabled) { updateChildValues(encodedUpdate as Map<Any?, *>, it) }
+    actual suspend fun updateEncodedChildren(encodedUpdate: EncodedObject) {
+        ios.await(persistenceEnabled) { updateChildValues(encodedUpdate.ios, it) }
     }
 
     actual suspend fun removeValue() {
@@ -199,7 +199,6 @@ internal actual class NativeDatabaseReference internal constructor(
 
 val DatabaseReference.ios: FIRDatabaseReference get() = nativeReference.ios
 
-@Suppress("UNCHECKED_CAST")
 actual class DataSnapshot internal constructor(
     val ios: FIRDataSnapshot,
     private val persistenceEnabled: Boolean
@@ -241,9 +240,8 @@ internal actual class NativeOnDisconnect internal constructor(
         ios.await(persistenceEnabled) { onDisconnectSetValue(encodedValue, it) }
     }
 
-    @Suppress("UNCHECKED_CAST")
-    actual suspend fun updateEncodedChildren(encodedUpdate: Any?) {
-        ios.await(persistenceEnabled) { onDisconnectUpdateChildValues(encodedUpdate as Map<Any?, *>, it) }
+    actual suspend fun updateEncodedChildren(encodedUpdate: EncodedObject) {
+        ios.await(persistenceEnabled) { onDisconnectUpdateChildValues(encodedUpdate.ios, it) }
     }
 }
 

firebase-database/src/jsMain/kotlin/dev/gitlive/firebase/database/database.kt

@@ -6,6 +6,7 @@ package dev.gitlive.firebase.database
 
 import dev.gitlive.firebase.DecodeSettings
 import dev.gitlive.firebase.EncodeDecodeSettingsBuilder
+import dev.gitlive.firebase.EncodedObject
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.FirebaseApp
 import dev.gitlive.firebase.database.externals.CancelCallback
@@ -182,8 +183,8 @@ internal actual class NativeDatabaseReference internal constructor(
         set(js, encodedValue).awaitWhileOnline(database)
     }
 
-    actual suspend fun updateEncodedChildren(encodedUpdate: Any?) =
-        rethrow { update(js, encodedUpdate ?: json()).awaitWhileOnline(database) }
+    actual suspend fun updateEncodedChildren(encodedUpdate: EncodedObject) =
+        rethrow { update(js, encodedUpdate).awaitWhileOnline(database) }
 
 
     actual suspend fun <T> runTransaction(strategy: KSerializer<T>, buildSettings: EncodeDecodeSettingsBuilder.() -> Unit, transactionUpdate: (currentData: T) -> T): DataSnapshot {
@@ -234,8 +235,8 @@ internal actual class NativeOnDisconnect internal constructor(
     actual suspend fun setValue(encodedValue: Any?) =
         rethrow { js.set(encodedValue).awaitWhileOnline(database) }
 
-    actual suspend fun updateEncodedChildren(encodedUpdate: Any?) =
-        rethrow { js.update(encodedUpdate ?: json()).awaitWhileOnline(database) }
+    actual suspend fun updateEncodedChildren(encodedUpdate: EncodedObject) =
+        rethrow { js.update(encodedUpdate).awaitWhileOnline(database) }
 
 }