Merge pull request #284 from GitLiveApp/add-field-value-increment-to-firestore

Add field value increment to firestore

Author: nbransby

firebase-app/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-common": "1.4.3",
+    "@gitlive/firebase-common": "1.5.0",
     "firebase": "9.4.1",
     "kotlin": "1.5.31",
     "kotlinx-coroutines-core": "1.5.2-native-mt"

firebase-auth/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.4.3",
+    "@gitlive/firebase-app": "1.5.0",
     "firebase": "9.4.1",
     "kotlin": "1.5.31",
     "kotlinx-coroutines-core": "1.5.2-native-mt"

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

@@ -462,6 +462,7 @@ external object firebase {
             companion object {
                 fun serverTimestamp(): FieldValue
                 fun delete(): FieldValue
+                fun increment(value: Int): FieldValue
                 fun arrayRemove(vararg elements: Any): FieldValue
                 fun arrayUnion(vararg elements: Any): FieldValue
             }

firebase-config/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.4.3",
+    "@gitlive/firebase-app": "1.5.0",
     "firebase": "9.4.1",
     "kotlin": "1.5.31",
     "kotlinx-coroutines-core": "1.5.2-native-mt"

firebase-database/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.4.3",
+    "@gitlive/firebase-app": "1.5.0",
     "firebase": "9.4.1",
     "kotlin": "1.5.31",
     "kotlinx-coroutines-core": "1.5.2-native-mt"

firebase-firestore/package.json

@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/GitLiveApp/firebase-kotlin-sdk",
   "dependencies": {
-    "@gitlive/firebase-app": "1.4.3",
+    "@gitlive/firebase-app": "1.5.0",
     "firebase": "9.4.1",
     "kotlin": "1.5.31",
     "kotlinx-coroutines-core": "1.5.2-native-mt"

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

@@ -465,6 +465,7 @@ actual class FieldPath private constructor(val android: com.google.firebase.fire
 actual object FieldValue {
     actual val serverTimestamp = Double.POSITIVE_INFINITY
     actual val delete: Any get() = FieldValue.delete()
+    actual fun increment(value: Int): Any = FieldValue.increment(value.toDouble())
     actual fun arrayUnion(vararg elements: Any): Any = FieldValue.arrayUnion(*elements)
     actual fun arrayRemove(vararg elements: Any): Any = FieldValue.arrayRemove(*elements)
     actual fun delete(): Any = delete

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

@@ -227,6 +227,7 @@ expect class FieldPath(vararg fieldNames: String) {
 expect object FieldValue {
     val serverTimestamp: Double
     val delete: Any
+    fun increment(value: Int): Any
     fun arrayUnion(vararg elements: Any): Any
     fun arrayRemove(vararg elements: Any): Any
     @Deprecated("Replaced with FieldValue.delete")

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

@@ -31,7 +31,7 @@ expect fun runTest(test: suspend CoroutineScope.() -> Unit)
 class FirebaseFirestoreTest {
 
     @Serializable
-    data class FirestoreTest(val prop1: String, val time: Double = 0.0)
+    data class FirestoreTest(val prop1: String, val time: Double = 0.0, val count: Int = 0)
 
     @BeforeTest
     fun initializeFirebase() {
@@ -57,7 +57,7 @@ class FirebaseFirestoreTest {
     fun testStringOrderBy() = runTest {
         setupFirestoreData()
         val resultDocs = Firebase.firestore
-            .collection("FirebaseFirestoreTest")
+            .collection("testFirestoreQuerying")
             .orderBy("prop1")
             .get()
             .documents
@@ -71,7 +71,7 @@ class FirebaseFirestoreTest {
     fun testFieldOrderBy() = runTest {
         setupFirestoreData()
 
-        val resultDocs = Firebase.firestore.collection("FirebaseFirestoreTest")
+        val resultDocs = Firebase.firestore.collection("testFirestoreQuerying")
             .orderBy(FieldPath("prop1")).get().documents
         assertEquals(3, resultDocs.size)
         assertEquals("aaa", resultDocs[0].get("prop1"))
@@ -83,7 +83,7 @@ class FirebaseFirestoreTest {
     fun testStringOrderByAscending() = runTest {
         setupFirestoreData()
 
-        val resultDocs = Firebase.firestore.collection("FirebaseFirestoreTest")
+        val resultDocs = Firebase.firestore.collection("testFirestoreQuerying")
             .orderBy("prop1", Direction.ASCENDING).get().documents
         assertEquals(3, resultDocs.size)
         assertEquals("aaa", resultDocs[0].get("prop1"))
@@ -95,7 +95,7 @@ class FirebaseFirestoreTest {
     fun testFieldOrderByAscending() = runTest {
         setupFirestoreData()
 
-        val resultDocs = Firebase.firestore.collection("FirebaseFirestoreTest")
+        val resultDocs = Firebase.firestore.collection("testFirestoreQuerying")
             .orderBy(FieldPath("prop1"), Direction.ASCENDING).get().documents
         assertEquals(3, resultDocs.size)
         assertEquals("aaa", resultDocs[0].get("prop1"))
@@ -107,7 +107,7 @@ class FirebaseFirestoreTest {
     fun testStringOrderByDescending() = runTest {
         setupFirestoreData()
 
-        val resultDocs = Firebase.firestore.collection("FirebaseFirestoreTest")
+        val resultDocs = Firebase.firestore.collection("testFirestoreQuerying")
             .orderBy("prop1", Direction.DESCENDING).get().documents
         assertEquals(3, resultDocs.size)
         assertEquals("ccc", resultDocs[0].get("prop1"))
@@ -119,7 +119,7 @@ class FirebaseFirestoreTest {
     fun testFieldOrderByDescending() = runTest {
         setupFirestoreData()
 
-        val resultDocs = Firebase.firestore.collection("FirebaseFirestoreTest")
+        val resultDocs = Firebase.firestore.collection("testFirestoreQuerying")
             .orderBy(FieldPath("prop1"), Direction.DESCENDING).get().documents
         assertEquals(3, resultDocs.size)
         assertEquals("ccc", resultDocs[0].get("prop1"))
@@ -224,7 +224,7 @@ class FirebaseFirestoreTest {
     fun testStartAfterDocumentSnapshot() = runTest {
         setupFirestoreData()
         val query = Firebase.firestore
-            .collection("FirebaseFirestoreTest")
+            .collection("testFirestoreQuerying")
             .orderBy("prop1", Direction.ASCENDING)
 
         val firstPage = query.limit(2).get().documents // First 2 results
@@ -239,14 +239,29 @@ class FirebaseFirestoreTest {
         assertEquals("ccc", secondPage[0].get("prop1"))
     }
 
+    @Test
+    fun testIncrementFieldValue() = runTest {
+        val doc = Firebase.firestore
+            .collection("testFirestoreIncrementFieldValue")
+            .document("test1")
+
+        doc.set(FirestoreTest.serializer(), FirestoreTest("increment1", count = 0))
+        val dataBefore = doc.get().data(FirestoreTest.serializer())
+        assertEquals(0, dataBefore.count)
+
+        doc.update("count" to FieldValue.increment(5))
+        val dataAfter = doc.get().data(FirestoreTest.serializer())
+        assertEquals(5, dataAfter.count)
+    }
+
     private suspend fun setupFirestoreData() {
-        Firebase.firestore.collection("FirebaseFirestoreTest")
+        Firebase.firestore.collection("testFirestoreQuerying")
             .document("one")
             .set(FirestoreTest.serializer(), FirestoreTest("aaa"))
-        Firebase.firestore.collection("FirebaseFirestoreTest")
+        Firebase.firestore.collection("testFirestoreQuerying")
             .document("two")
             .set(FirestoreTest.serializer(), FirestoreTest("bbb"))
-        Firebase.firestore.collection("FirebaseFirestoreTest")
+        Firebase.firestore.collection("testFirestoreQuerying")
             .document("three")
             .set(FirestoreTest.serializer(), FirestoreTest("ccc"))
     }

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

@@ -438,6 +438,7 @@ actual class FieldPath private constructor(val ios: FIRFieldPath) {
 actual object FieldValue {
     actual val serverTimestamp = Double.POSITIVE_INFINITY
     actual val delete: Any get() = FIRFieldValue.fieldValueForDelete()
+    actual fun increment(value: Int): Any = FIRFieldValue.fieldValueForIntegerIncrement(value.toLong())
     actual fun arrayUnion(vararg elements: Any): Any = FIRFieldValue.fieldValueForArrayUnion(elements.asList())
     actual fun arrayRemove(vararg elements: Any): Any = FIRFieldValue.fieldValueForArrayRemove(elements.asList())
     actual fun delete(): Any = delete