Merge branch 'master' into ios-support

nbransby · web-flow · commit 9d72403ebcf3 · 2020-03-14T20:41:35.000Z
diff --git a/README.md b/README.md
@@ -5,9 +5,10 @@
   🔓 <a href="https://teamhub.typeform.com/to/uSS8cv">Request Early Access</a>
 <h4></h4>
 
-The Firebase Kotlin SDK implements the client-side libraries used by applications using Firebase services. 
+The Firebase Kotlin SDK is a Kotlin-first SDK for Firebase. It's API is similar to the [Firebase Android SDK Kotlin Extensions](https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/) but it also supports multiplatform projects, enabling you to use Firebase directly from your common source targeting *iOS*, *Android* or *JS*.
+
+## Kotlin-first design
 
-It a light-weight Kotlin layer that mirrors the [Firebase Android SDK Kotlin Extensions](https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/) but connects to the correct native Firebase SDK for each target platform, enabling you to use Firebase directly from your common source in multiplatform projects targeting *iOS*, *Android* or *JS*.
 
 ## Available libraries
 
diff --git a/firebase-app/package.json b/firebase-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@teamhubapp/firebase-app",
-  "version": "0.1.0-dev9",
+  "version": "0.1.0-dev12",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-app.js",
   "scripts": {
@@ -23,10 +23,10 @@
   },
   "homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",
   "dependencies": {
-    "@teamhubapp/firebase-common": "0.1.0-dev9",
+    "@teamhubapp/firebase-common": "0.1.0-dev12",
     "firebase": "6.2.3",
     "kotlin": "1.3.61",
-    "kotlinx-coroutines-core": "1.3.3"
+    "kotlinx-coroutines-core": "1.3.2"
   }
 }
 
diff --git a/firebase-app/src/jsMain/kotlin/dev/teamhub/firebase/firebase.kt b/firebase-app/src/jsMain/kotlin/dev/teamhub/firebase/firebase.kt
@@ -31,10 +31,10 @@ actual fun Firebase.apps(context: Any?) = firebase.apps.map { FirebaseApp(it) }
 private fun FirebaseOptions.toJson() = json(
     "apiKey" to apiKey,
     "applicationId" to applicationId,
-    "databaseURL" to databaseUrl,
-    "storageBucket" to storageBucket,
-    "projectId" to projectId,
-    "gaTrackingId" to gaTrackingId
+    "databaseURL" to (databaseUrl ?: undefined),
+    "storageBucket" to (storageBucket ?: undefined),
+    "projectId" to (projectId ?: undefined),
+    "gaTrackingId" to (gaTrackingId ?: undefined)
 )
 
 actual open class FirebaseException(code: String?, cause: Throwable) : Exception("$code: ${cause.message}", cause)
diff --git a/firebase-auth/package.json b/firebase-auth/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@teamhubapp/firebase-auth",
-  "version": "0.1.0-dev9",
+  "version": "0.1.0-dev12",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-auth.js",
   "scripts": {
@@ -23,10 +23,10 @@
   },
   "homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",
   "dependencies": {
-    "@teamhubapp/firebase-app": "0.1.0-dev9",
+    "@teamhubapp/firebase-app": "0.1.0-dev12",
     "firebase": "6.2.3",
     "kotlin": "1.3.61",
-    "kotlinx-coroutines-core": "1.3.3"
+    "kotlinx-coroutines-core": "1.3.2"
   }
 }
 
diff --git a/firebase-common/build.gradle.kts b/firebase-common/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
     id("com.android.library")
     kotlin("multiplatform")
     kotlin("native.cocoapods")
+    kotlin("plugin.serialization") version "1.3.61"
     `maven-publish`
 }
 repositories {
@@ -80,6 +81,12 @@ kotlin {
             }
             kotlin.srcDir("src/androidMain/kotlin")
         }
+        val jvmTest by getting {
+            dependencies {
+                implementation(kotlin("test-junit"))
+            }
+            kotlin.srcDir("src/androidTest/kotlin")
+        }
         val iosMain by getting {
             dependencies {
                 implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime-native:0.14.0")
diff --git a/firebase-common/package.json b/firebase-common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@teamhubapp/firebase-common",
-  "version": "0.1.0-dev9",
+  "version": "0.1.0-dev14",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-common.js",
   "scripts": {
@@ -25,7 +25,7 @@
   "dependencies": {
     "firebase": "6.2.3",
     "kotlin": "1.3.61",
-    "kotlinx-coroutines-core": "1.3.3",
+    "kotlinx-coroutines-core": "1.3.2",
     "@cachet/kotlinx-serialization-runtime": "0.14.0-rc.2"
   }
 }
diff --git a/firebase-common/src/androidTest/kotlin/dev/teamhub/firebase/EncodersTest.kt b/firebase-common/src/androidTest/kotlin/dev/teamhub/firebase/EncodersTest.kt
@@ -0,0 +1,17 @@
+package dev.teamhub.firebase
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.serializer
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+@Serializable
+data class TestData(val map: Map<String, String>)
+
+class EncodersTest {
+    @Test
+    fun `encode a map`() {
+        val encoded = encode<TestData>(TestData::class.serializer(), TestData(mapOf("key" to "value")))
+        assertEquals(mapOf("key" to "value"), (encoded as Map<String, Any>)["map"])
+    }
+}
diff --git a/firebase-common/src/commonMain/kotlin/dev/teamhub/firebase/encoders.kt b/firebase-common/src/commonMain/kotlin/dev/teamhub/firebase/encoders.kt
@@ -1,6 +1,8 @@
 package dev.teamhub.firebase
 
 import kotlinx.serialization.*
+import kotlinx.serialization.internal.ListLikeSerializer
+import kotlinx.serialization.internal.MapLikeSerializer
 import kotlinx.serialization.modules.EmptyModule
 
 fun <T> encode(strategy: SerializationStrategy<T> , value: T, positiveInfinity: Any = Double.POSITIVE_INFINITY): Any? =
@@ -82,23 +84,24 @@ abstract class TimestampEncoder(internal val positiveInfinity: Any) {
     }
 }
 
-open class FirebaseCompositeEncoder(
+open class FirebaseCompositeEncoder constructor(
     positiveInfinity: Any,
-    private val end: () -> Unit = {},
     private val set: (desc: SerialDescriptor, index: Int, value: Any?) -> Unit
 ): TimestampEncoder(positiveInfinity), CompositeEncoder {
 
     override val context = EmptyModule
 
-    override fun endStructure(desc: SerialDescriptor) {
-        super.endStructure(desc)
+    private fun <T> SerializationStrategy<T>.toFirebase(): SerializationStrategy<T> = when(this) {
+        is MapLikeSerializer<*, *, *, *> -> FirebaseMapSerializer() as SerializationStrategy<T>
+        is ListLikeSerializer<*, *, *> -> FirebaseListSerializer() as SerializationStrategy<T>
+        else -> this
     }
 
     override fun <T : Any> encodeNullableSerializableElement(desc: SerialDescriptor, index: Int, serializer: SerializationStrategy<T>, value: T?) =
-        set(desc, index, value?.let { FirebaseEncoder(positiveInfinity).apply { encode(serializer, value) }.value })
+        set(desc, index, value?.let { FirebaseEncoder(positiveInfinity).apply { encode(serializer.toFirebase(), value) }.value })
 
     override fun <T> encodeSerializableElement(desc: SerialDescriptor, index: Int, serializer: SerializationStrategy<T>, value: T)  =
-        set(desc, index, FirebaseEncoder(positiveInfinity).apply { encode(serializer, value) }.value)
+        set(desc, index, FirebaseEncoder(positiveInfinity).apply { encode(serializer.toFirebase(), value) }.value)
 
     override fun encodeNonSerializableElement(desc: SerialDescriptor, index: Int, value: Any) = set(desc, index, value)
 
diff --git a/firebase-common/src/jsMain/kotlin/dev/teamhub/firebase/_encoders.kt b/firebase-common/src/jsMain/kotlin/dev/teamhub/firebase/_encoders.kt
@@ -7,8 +7,9 @@ import kotlinx.serialization.StructureKind
 import kotlin.js.json
 
 actual fun FirebaseEncoder.structureEncoder(desc: SerialDescriptor, vararg typeParams: KSerializer<*>): CompositeEncoder = when(desc.kind as StructureKind) {
-    StructureKind.LIST -> mutableListOf<Any?>()
-        .let { FirebaseCompositeEncoder(positiveInfinity, { value = it.toTypedArray() }) { _, index, value -> it.add(index, value) } }
+    StructureKind.LIST -> Array<Any?>(desc.elementsCount) { null }
+        .also { value = it }
+        .let { FirebaseCompositeEncoder(positiveInfinity) { _, index, value -> it[index] = value } }
     StructureKind.MAP, StructureKind.CLASS -> json()
         .also { value = it }
         .let { FirebaseCompositeEncoder(positiveInfinity) { _, index, value -> it[desc.getElementName(index)] = value } }
diff --git a/firebase-database/package.json b/firebase-database/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@teamhubapp/firebase-database",
-  "version": "0.1.0-dev9",
+  "version": "0.1.0-dev12",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-database.js",
   "scripts": {
@@ -23,10 +23,10 @@
   },
   "homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",
   "dependencies": {
-    "@teamhubapp/firebase-app": "0.1.0-dev9",
+    "@teamhubapp/firebase-app": "0.1.0-dev12",
     "firebase": "6.2.3",
     "kotlin": "1.3.61",
-    "kotlinx-coroutines-core": "1.3.3"
+    "kotlinx-coroutines-core": "1.3.2"
   }
 }
 
diff --git a/firebase-database/src/jsMain/kotlin/dev/teamhub/firebase/database/database.kt b/firebase-database/src/jsMain/kotlin/dev/teamhub/firebase/database/database.kt
@@ -70,11 +70,11 @@ actual open class Query internal constructor(open val js: firebase.database.Quer
         awaitClose { rethrow { listeners.forEach { (eventType, listener) -> js.off(eventType, listener) } } }
     }
 
-    actual fun startAt(value: String, key: String?) = Query(js.startAt(value, key))
+    actual fun startAt(value: String, key: String?) = Query(js.startAt(value, key ?: undefined))
 
-    actual fun startAt(value: Double, key: String?) = Query(js.startAt(value, key))
+    actual fun startAt(value: Double, key: String?) = Query(js.startAt(value, key ?: undefined))
 
-    actual fun startAt(value: Boolean, key: String?) = Query(js.startAt(value, key))
+    actual fun startAt(value: Boolean, key: String?) = Query(js.startAt(value, key ?: undefined))
 
     override fun toString() = js.toString()
 
@@ -137,7 +137,7 @@ actual class OnDisconnect internal constructor(val js: firebase.database.OnDisco
 }
 
 actual class DatabaseException(error: dynamic) :
-    RuntimeException("${error?.code}: ${error.message}", error.unsafeCast<Throwable>())
+    RuntimeException("${error.code ?: "UNKNOWN"}: ${error.message}", error.unsafeCast<Throwable>())
 
 inline fun <T, R> T.rethrow(function: T.() -> R): R = dev.teamhub.firebase.database.rethrow { function() }
 
diff --git a/firebase-firestore/package.json b/firebase-firestore/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@teamhubapp/firebase-firestore",
-  "version": "0.1.0-dev9",
+  "version": "0.1.0-dev12",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-firestore.js",
   "scripts": {
@@ -23,10 +23,10 @@
   },
   "homepage": "https://github.com/TeamHubApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@teamhubapp/firebase-app": "0.1.0-dev9",
+    "@teamhubapp/firebase-app": "0.1.0-dev12",
     "firebase": "6.2.3",
     "kotlin": "1.3.61",
-    "kotlinx-coroutines-core": "1.3.3"
+    "kotlinx-coroutines-core": "1.3.2"
   }
 }
 
diff --git a/firebase-functions/package.json b/firebase-functions/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@teamhubapp/firebase-functions",
-  "version": "0.1.0-dev9",
+  "version": "0.1.0-dev12",
   "description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",
   "main": "firebase-functions.js",
   "scripts": {
@@ -23,10 +23,10 @@
   },
   "homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",
   "dependencies": {
-    "@teamhubapp/firebase-app": "0.1.0-dev9",
+    "@teamhubapp/firebase-app": "0.1.0-dev12",
     "firebase": "6.2.3",
     "kotlin": "1.3.61",
-    "kotlinx-coroutines-core": "1.3.3"
+    "kotlinx-coroutines-core": "1.3.2"
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@teamhubapp/firebase-app",`
`3`		`- "version": "0.1.0-dev9",`
	`3`	`+ "version": "0.1.0-dev12",`
`4`	`4`	`"description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",`
`5`	`5`	`"main": "firebase-app.js",`
`6`	`6`	`"scripts": {`
`@@ -23,10 +23,10 @@`
`23`	`23`	`},`
`24`	`24`	`"homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",`
`25`	`25`	`"dependencies": {`
`26`		`- "@teamhubapp/firebase-common": "0.1.0-dev9",`
	`26`	`+ "@teamhubapp/firebase-common": "0.1.0-dev12",`
`27`	`27`	`"firebase": "6.2.3",`
`28`	`28`	`"kotlin": "1.3.61",`
`29`		`- "kotlinx-coroutines-core": "1.3.3"`
	`29`	`+ "kotlinx-coroutines-core": "1.3.2"`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@teamhubapp/firebase-auth",`
`3`		`- "version": "0.1.0-dev9",`
	`3`	`+ "version": "0.1.0-dev12",`
`4`	`4`	`"description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",`
`5`	`5`	`"main": "firebase-auth.js",`
`6`	`6`	`"scripts": {`
`@@ -23,10 +23,10 @@`
`23`	`23`	`},`
`24`	`24`	`"homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",`
`25`	`25`	`"dependencies": {`
`26`		`- "@teamhubapp/firebase-app": "0.1.0-dev9",`
	`26`	`+ "@teamhubapp/firebase-app": "0.1.0-dev12",`
`27`	`27`	`"firebase": "6.2.3",`
`28`	`28`	`"kotlin": "1.3.61",`
`29`		`- "kotlinx-coroutines-core": "1.3.3"`
	`29`	`+ "kotlinx-coroutines-core": "1.3.2"`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@teamhubapp/firebase-common",`
`3`		`- "version": "0.1.0-dev9",`
	`3`	`+ "version": "0.1.0-dev14",`
`4`	`4`	`"description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",`
`5`	`5`	`"main": "firebase-common.js",`
`6`	`6`	`"scripts": {`
`@@ -25,7 +25,7 @@`
`25`	`25`	`"dependencies": {`
`26`	`26`	`"firebase": "6.2.3",`
`27`	`27`	`"kotlin": "1.3.61",`
`28`		`- "kotlinx-coroutines-core": "1.3.3",`
	`28`	`+ "kotlinx-coroutines-core": "1.3.2",`
`29`	`29`	`"@cachet/kotlinx-serialization-runtime": "0.14.0-rc.2"`
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@teamhubapp/firebase-database",`
`3`		`- "version": "0.1.0-dev9",`
	`3`	`+ "version": "0.1.0-dev12",`
`4`	`4`	`"description": "Wrapper around firebase for usage in Kotlin Multiplatform projects",`
`5`	`5`	`"main": "firebase-database.js",`
`6`	`6`	`"scripts": {`
`@@ -23,10 +23,10 @@`
`23`	`23`	`},`
`24`	`24`	`"homepage": "https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk",`
`25`	`25`	`"dependencies": {`
`26`		`- "@teamhubapp/firebase-app": "0.1.0-dev9",`
	`26`	`+ "@teamhubapp/firebase-app": "0.1.0-dev12",`
`27`	`27`	`"firebase": "6.2.3",`
`28`	`28`	`"kotlin": "1.3.61",`
`29`		`- "kotlinx-coroutines-core": "1.3.3"`
	`29`	`+ "kotlinx-coroutines-core": "1.3.2"`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`