add serverTimestamp() to FieldValue (#127)

* add serverTimestamp() to FieldValue
support Timestamp to Double decoding

* fix FirebaseFirestoreTest

Author: nbransby

README.md

@@ -86,7 +86,7 @@ You can also omit the serializer but this is discouraged due to a [current limit
 
 <h4><a href="https://firebase.google.com/docs/firestore/manage-data/add-data#server_timestamp">Server Timestamp</a></h3>
 
-[Firestore](https://firebase.google.com/docs/reference/js/firebase.database.ServerValue#timestamp) and the [Realtime Database](https://firebase.google.com/docs/reference/android/com/google/firebase/database/ServerValue#TIMESTAMP) provide a sentinel value you can use to set a field in your document to a server timestamp. So you can use these values in custom classes they are of type `Double`:
+[Firestore](https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue?hl=en#serverTimestamp()) and the [Realtime Database](https://firebase.google.com/docs/reference/android/com/google/firebase/database/ServerValue#TIMESTAMP) provide a sentinel value you can use to set a field in your document to a server timestamp. So you can use these values in custom classes they are of type `Double`:
 
 ```kotlin
 @Serializable

build.gradle.kts

@@ -19,7 +19,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath("com.android.tools.build:gradle:4.1.1")
+        classpath("com.android.tools.build:gradle:4.0.2")
         classpath("de.undercouch:gradle-download-task:4.1.1")
         classpath("com.adarshr:gradle-test-logger-plugin:2.0.0")
     }

firebase-app/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-common": "1.0.0",
+    "@gitlive/firebase-common": "1.1.0",
     "firebase": "8.2.0",
     "kotlin": "1.4.21",
     "kotlinx-coroutines-core": "1.4.2"

firebase-app/src/jsTest/kotlin/dev/gitlive/firebase/firebase.kt

@@ -9,4 +9,4 @@ import kotlinx.coroutines.promise
 
 actual val context: Any = Unit
 
-actual fun runTest(test: suspend () -> Unit) = GlobalScope.promise { test() }.unsafeCast<Unit>()
+actual fun runTest(test: suspend () -> Unit) = GlobalScope.promise { test() }.asDynamic()

firebase-auth/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.0.0",
+    "@gitlive/firebase-app": "1.1.0",
     "firebase": "8.2.0",
     "kotlin": "1.4.21",
     "kotlinx-coroutines-core": "1.4.2"

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

@@ -119,7 +119,7 @@ actual open class FirebaseAuthWebException(code: String?, cause: Throwable): Fir
 
 internal inline fun <T, R> T.rethrow(function: T.() -> R): R = dev.gitlive.firebase.auth.rethrow { function() }
 
-internal inline fun <R> rethrow(function: () -> R): R {
+private inline fun <R> rethrow(function: () -> R): R {
     try {
         return function()
     } catch (e: Exception) {

firebase-auth/src/jsTest/kotlin/dev/gitlive/firebase/auth/auth.kt

@@ -9,4 +9,4 @@ import kotlinx.coroutines.promise
 
 actual val context: Any = Unit
 
-actual fun runTest(test: suspend () -> Unit) = GlobalScope.promise { test() }.unsafeCast<Unit>()
+actual fun runTest(test: suspend () -> Unit) = GlobalScope.promise { test() }.asDynamic()

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

@@ -6,17 +6,18 @@ package dev.gitlive.firebase
 
 import kotlinx.serialization.encoding.CompositeDecoder
 import kotlinx.serialization.KSerializer
+import kotlinx.serialization.SerializationException
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
 
-actual fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor): CompositeDecoder = when(descriptor.kind as StructureKind) {
+actual fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor, decodeDouble: (value: Any?) -> Double?): CompositeDecoder = when(descriptor.kind as StructureKind) {
         StructureKind.CLASS, StructureKind.OBJECT -> (value as Map<*, *>).let { map ->
-            FirebaseClassDecoder(map.size, { map.containsKey(it) }) { desc, index -> map[desc.getElementName(index)] }
+            FirebaseClassDecoder(decodeDouble, map.size, { map.containsKey(it) }) { desc, index -> map[desc.getElementName(index)] }
         }
         StructureKind.LIST -> (value as List<*>).let {
-            FirebaseCompositeDecoder(it.size) { _, index -> it[index] }
+            FirebaseCompositeDecoder(decodeDouble, it.size) { _, index -> it[index] }
         }
         StructureKind.MAP -> (value as Map<*, *>).entries.toList().let {
-            FirebaseCompositeDecoder(it.size) { _, index -> it[index/2].run { if(index % 2 == 0) key else value }  }
+            FirebaseCompositeDecoder(decodeDouble, it.size) { _, index -> it[index/2].run { if(index % 2 == 0) key else value }  }
         }
     }

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

@@ -16,28 +16,28 @@ import kotlinx.serialization.modules.SerializersModule
 import kotlinx.serialization.serializer
 
 @Suppress("UNCHECKED_CAST")
-inline fun <reified T> decode(value: Any?): T {
+inline fun <reified T> decode(value: Any?, noinline decodeDouble: (value: Any?) -> Double? = { null }): T {
     val strategy = serializer<T>()
-    return decode(strategy as DeserializationStrategy<T>, value)
+    return decode(strategy as DeserializationStrategy<T>, value, decodeDouble)
 }
 
-fun <T> decode(strategy: DeserializationStrategy<T>, value: Any?): T {
+fun <T> decode(strategy: DeserializationStrategy<T>, value: Any?, decodeDouble: (value: Any?) -> Double? = { null }): T {
     require(value != null || strategy.descriptor.isNullable) { "Value was null for non-nullable type ${strategy.descriptor.serialName}" }
-    return FirebaseDecoder(value).decodeSerializableValue(strategy)
+    return FirebaseDecoder(value, decodeDouble).decodeSerializableValue(strategy)
 }
 
-expect fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor): CompositeDecoder
+expect fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor, decodeDouble: (value: Any?) -> Double?): CompositeDecoder
 
-class FirebaseDecoder(internal val value: Any?) : Decoder {
+class FirebaseDecoder(internal val value: Any?, private val decodeDouble: (value: Any?) -> Double?) : Decoder {
 
     override val serializersModule: SerializersModule
         get() = EmptySerializersModule
 
-    override fun beginStructure(descriptor: SerialDescriptor) = structureDecoder(descriptor)
+    override fun beginStructure(descriptor: SerialDescriptor) = structureDecoder(descriptor, decodeDouble)
 
     override fun decodeString() = decodeString(value)
 
-    override fun decodeDouble() = decodeDouble(value)
+    override fun decodeDouble() = decodeDouble(value, decodeDouble)
 
     override fun decodeLong() = decodeLong(value)
 
@@ -61,10 +61,11 @@ class FirebaseDecoder(internal val value: Any?) : Decoder {
 }
 
 class FirebaseClassDecoder(
+    decodeDouble: (value: Any?) -> Double?,
     size: Int,
     private val containsKey: (name: String) -> Boolean,
     get: (descriptor: SerialDescriptor, index: Int) -> Any?
-) : FirebaseCompositeDecoder(size, get) {
+) : FirebaseCompositeDecoder(decodeDouble, size, get) {
     private var index: Int = 0
 
     override fun decodeSequentially() = false
@@ -84,6 +85,7 @@ class FirebaseClassDecoder(
 }
 
 open class FirebaseCompositeDecoder constructor(
+    private val decodeDouble: (value: Any?) -> Double?,
     private val size: Int,
     private val get: (descriptor: SerialDescriptor, index: Int) -> Any?
 ): CompositeDecoder {
@@ -98,7 +100,7 @@ open class FirebaseCompositeDecoder constructor(
 
     override fun <T> decodeSerializableElement(descriptor: SerialDescriptor,
                                                index: Int, deserializer: DeserializationStrategy<T>, previousValue: T? ): T {
-        return deserializer.deserialize(FirebaseDecoder(get(descriptor, index)))
+        return deserializer.deserialize(FirebaseDecoder(get(descriptor, index), decodeDouble))
     }
 
     override fun decodeBooleanElement(descriptor: SerialDescriptor, index: Int) = decodeBoolean(get(descriptor, index))
@@ -107,7 +109,7 @@ open class FirebaseCompositeDecoder constructor(
 
     override fun decodeCharElement(descriptor: SerialDescriptor, index: Int) = decodeChar(get(descriptor, index))
 
-    override fun decodeDoubleElement(descriptor: SerialDescriptor, index: Int) = decodeDouble(get(descriptor, index))
+    override fun decodeDoubleElement(descriptor: SerialDescriptor, index: Int) = decodeDouble(get(descriptor, index), decodeDouble)
 
     override fun decodeFloatElement(descriptor: SerialDescriptor, index: Int) = decodeFloat(get(descriptor, index))
 
@@ -133,10 +135,10 @@ open class FirebaseCompositeDecoder constructor(
 
 private fun decodeString(value: Any?) = value.toString()
 
-private fun decodeDouble(value: Any?) = when(value) {
+private fun decodeDouble(value: Any?, decodeDouble: (value: Any?) -> Double?) = when(value) {
     is Number -> value.toDouble()
     is String -> value.toDouble()
-    else -> throw SerializationException("Expected $value to be double")
+    else -> decodeDouble(value) ?: throw SerializationException("Expected $value to be double")
 }
 
 private fun decodeLong(value: Any?) = when(value) {

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

@@ -6,17 +6,18 @@ package dev.gitlive.firebase
 
 import kotlinx.serialization.encoding.CompositeDecoder
 import kotlinx.serialization.KSerializer
+import kotlinx.serialization.SerializationException
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
 
-actual fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor): CompositeDecoder = when(descriptor.kind as StructureKind) {
+actual fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor, decodeDouble: (value: Any?) -> Double?): CompositeDecoder = when(descriptor.kind as StructureKind) {
     StructureKind.CLASS, StructureKind.OBJECT -> (value as Map<*, *>).let { map ->
-        FirebaseClassDecoder(map.size, { map.containsKey(it) }) { desc, index -> map[desc.getElementName(index)] }
+        FirebaseClassDecoder(decodeDouble, map.size, { map.containsKey(it) }) { desc, index -> map[desc.getElementName(index)] }
     }
     StructureKind.LIST -> (value as List<*>).let {
-        FirebaseCompositeDecoder(it.size) { _, index -> it[index] }
+        FirebaseCompositeDecoder(decodeDouble, it.size) { _, index -> it[index] }
     }
     StructureKind.MAP -> (value as Map<*, *>).entries.toList().let {
-        FirebaseCompositeDecoder(it.size) { _, index -> it[index/2].run { if(index % 2 == 0) key else value }  }
+        FirebaseCompositeDecoder(decodeDouble, it.size) { _, index -> it[index/2].run { if(index % 2 == 0) key else value }  }
     }
 }

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

@@ -6,21 +6,22 @@ package dev.gitlive.firebase
 
 import kotlinx.serialization.encoding.CompositeDecoder
 import kotlinx.serialization.KSerializer
+import kotlinx.serialization.SerializationException
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
 import kotlin.js.Json
 
 @Suppress("UNCHECKED_CAST_TO_EXTERNAL_INTERFACE")
-actual fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor): CompositeDecoder = when(descriptor.kind as StructureKind) {
+actual fun FirebaseDecoder.structureDecoder(descriptor: SerialDescriptor, decodeDouble: (value: Any?) -> Double?): CompositeDecoder = when(descriptor.kind as StructureKind) {
     StructureKind.CLASS, StructureKind.OBJECT -> (value as Json).let { json ->
-        FirebaseClassDecoder(js("Object").keys(value).length as Int, { json[it] != undefined }) {
+        FirebaseClassDecoder(decodeDouble, js("Object").keys(value).length as Int, { json[it] != undefined }) {
                 desc, index -> json[desc.getElementName(index)]
         }
     }
     StructureKind.LIST -> (value as Array<*>).let {
-        FirebaseCompositeDecoder(it.size) { _, index -> it[index] }
+        FirebaseCompositeDecoder(decodeDouble, it.size) { _, index -> it[index] }
     }
     StructureKind.MAP -> (js("Object").entries(value) as Array<Array<Any>>).let {
-        FirebaseCompositeDecoder(it.size) { _, index -> it[index/2].run { if(index % 2 == 0) get(0) else get(1) } }
+        FirebaseCompositeDecoder(decodeDouble, it.size) { _, index -> it[index/2].run { if(index % 2 == 0) get(0) else get(1) } }
     }
-}
+}

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

@@ -339,6 +339,12 @@ external object firebase {
 
         open class FieldPath constructor(vararg fieldNames: String)
 
+        open class Timestamp {
+            val seconds: Double
+            val nanoseconds: Double
+            fun toMillis(): Double
+        }
+
         open class Query {
             fun get(options: Any? = definedExternally): Promise<QuerySnapshot>
             fun where(field: Any, opStr: String, value: Any?): Query
@@ -404,6 +410,7 @@ external object firebase {
 
         abstract class FieldValue {
             companion object {
+                fun serverTimestamp(): FieldValue
                 fun delete(): FieldValue
                 fun arrayRemove(vararg elements: Any): FieldValue
                 fun arrayUnion(vararg elements: Any): FieldValue

firebase-database/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.0.0",
+    "@gitlive/firebase-app": "1.1.0",
     "firebase": "8.2.0",
     "kotlin": "1.4.21",
     "kotlinx-coroutines-core": "1.4.2"

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

@@ -27,10 +27,11 @@ import kotlinx.coroutines.tasks.await
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.SerializationStrategy
 
-inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean) =
+@PublishedApi
+internal inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean) =
     dev.gitlive.firebase.encode(value, shouldEncodeElementDefault, ServerValue.TIMESTAMP)
 
-fun <T> encode(strategy: SerializationStrategy<T> , value: T, shouldEncodeElementDefault: Boolean): Any? =
+internal fun <T> encode(strategy: SerializationStrategy<T> , value: T, shouldEncodeElementDefault: Boolean): Any? =
     dev.gitlive.firebase.encode(strategy, value, shouldEncodeElementDefault, ServerValue.TIMESTAMP)
 
 @OptIn(FlowPreview::class)

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

@@ -27,9 +27,11 @@ import platform.Foundation.*
 import kotlin.collections.component1
 import kotlin.collections.component2
 
-fun encode(value: Any?, shouldEncodeElementDefault: Boolean) =
+@PublishedApi
+internal inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean) =
     dev.gitlive.firebase.encode(value, shouldEncodeElementDefault, FIRServerValue.timestamp())
-fun <T> encode(strategy: SerializationStrategy<T> , value: T, shouldEncodeElementDefault: Boolean): Any? =
+
+internal fun <T> encode(strategy: SerializationStrategy<T> , value: T, shouldEncodeElementDefault: Boolean): Any? =
     dev.gitlive.firebase.encode(strategy, value, shouldEncodeElementDefault, FIRServerValue.timestamp())
 
 actual val Firebase.database

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

@@ -11,9 +11,11 @@ import kotlinx.coroutines.flow.callbackFlow
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.SerializationStrategy
 
-fun encode(value: Any?, shouldEncodeElementDefault: Boolean) =
+@PublishedApi
+internal inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean) =
     encode(value, shouldEncodeElementDefault, firebase.database.ServerValue.TIMESTAMP)
-fun <T> encode(strategy: SerializationStrategy<T>, value: T, shouldEncodeElementDefault: Boolean): Any? =
+
+internal fun <T> encode(strategy: SerializationStrategy<T>, value: T, shouldEncodeElementDefault: Boolean): Any? =
     encode(strategy, value, shouldEncodeElementDefault, firebase.database.ServerValue.TIMESTAMP)
 
 

firebase-firestore/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.0.0",
+    "@gitlive/firebase-app": "1.1.0",
     "firebase": "8.2.0",
     "kotlin": "1.4.21",
     "kotlinx-coroutines-core": "1.4.2"

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

@@ -5,14 +5,32 @@
 @file:JvmName("android")
 package dev.gitlive.firebase.firestore
 
+import com.google.firebase.Timestamp
+import com.google.firebase.firestore.FieldValue
 import com.google.firebase.firestore.SetOptions
 import dev.gitlive.firebase.*
+import dev.gitlive.firebase.firestore.encode
 import kotlinx.coroutines.channels.awaitClose
 import kotlinx.coroutines.flow.callbackFlow
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.tasks.await
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.SerializationStrategy
+import kotlinx.serialization.serializer
+
+@PublishedApi
+internal inline fun <reified T> decode(value: Any?): T =
+    decode(value) { (it as? Timestamp)?.run { seconds * 1000 + (nanoseconds / 1000000.0) } }
+
+internal fun <T> decode(strategy: DeserializationStrategy<T>, value: Any?): T =
+    decode(strategy, value) { (it as? Timestamp)?.run { seconds * 1000 + (nanoseconds / 1000000.0) } }
+
+@PublishedApi
+internal inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean) =
+    encode(value, shouldEncodeElementDefault, FieldValue.serverTimestamp())
+
+private fun <T> encode(strategy: SerializationStrategy<T> , value: T, shouldEncodeElementDefault: Boolean): Any? =
+    encode(strategy, value, shouldEncodeElementDefault, FieldValue.serverTimestamp())
 
 actual val Firebase.firestore get() =
     FirebaseFirestore(com.google.firebase.firestore.FirebaseFirestore.getInstance())
@@ -381,6 +399,7 @@ actual typealias FieldPath = com.google.firebase.firestore.FieldPath
 actual fun FieldPath(vararg fieldNames: String) = FieldPath.of(*fieldNames)
 
 actual object FieldValue {
+    actual fun serverTimestamp() = Double.POSITIVE_INFINITY
     actual fun delete(): Any = com.google.firebase.firestore.FieldValue.delete()
     actual fun arrayUnion(vararg elements: Any): Any = com.google.firebase.firestore.FieldValue.arrayUnion(*elements)
     actual fun arrayRemove(vararg elements: Any): Any = com.google.firebase.firestore.FieldValue.arrayRemove(*elements)

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

@@ -192,8 +192,8 @@ expect class FieldPath
 expect fun FieldPath(vararg fieldNames: String): FieldPath
 
 expect object FieldValue {
+    fun serverTimestamp(): Double
     fun delete(): Any
     fun arrayUnion(vararg elements: Any): Any
     fun arrayRemove(vararg elements: Any): Any
 }
-