Skip to content

Commit 4be99fd

Browse files
Daeda88Daeda88
committed
PR remarks: Replaced readable settings with write only method
Ensures easier consistency between platforms
1 parent fef2847 commit 4be99fd

File tree

10 files changed

+72
-163
lines changed

10 files changed

+72
-163
lines changed

‎firebase-firestore/api/android/firebase-firestore.api‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,18 +258,18 @@ public final class dev/gitlive/firebase/firestore/FilterBuilder {
258258

259259
public final class dev/gitlive/firebase/firestore/FirebaseFirestore {
260260
public static final field Companion Ldev/gitlive/firebase/firestore/FirebaseFirestore$Companion;
261+
public final fun applySettings (Ldev/gitlive/firebase/firestore/FirebaseFirestoreSettings;)V
261262
public final fun batch ()Ldev/gitlive/firebase/firestore/WriteBatch;
262263
public final fun clearPersistence (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
263264
public final fun collection (Ljava/lang/String;)Ldev/gitlive/firebase/firestore/CollectionReference;
264265
public final fun collectionGroup (Ljava/lang/String;)Ldev/gitlive/firebase/firestore/Query;
265266
public final fun disableNetwork (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
266267
public final fun document (Ljava/lang/String;)Ldev/gitlive/firebase/firestore/DocumentReference;
267268
public final fun enableNetwork (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
268-
public final fun getSettings ()Ldev/gitlive/firebase/firestore/FirebaseFirestoreSettings;
269269
public final fun runTransaction (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
270270
public final fun setLoggingEnabled (Z)V
271-
public final fun setSettings (Ldev/gitlive/firebase/firestore/FirebaseFirestoreSettings;)V
272271
public final fun setSettings (Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/String;Ljava/lang/Long;)V
272+
public final fun setSettings (Lkotlin/jvm/functions/Function1;)V
273273
public static synthetic fun setSettings$default (Ldev/gitlive/firebase/firestore/FirebaseFirestore;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/String;Ljava/lang/Long;ILjava/lang/Object;)V
274274
public final fun useEmulator (Ljava/lang/String;I)V
275275
}

‎firebase-firestore/api/jvm/firebase-firestore.api‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,18 +258,18 @@ public final class dev/gitlive/firebase/firestore/FilterBuilder {
258258

259259
public final class dev/gitlive/firebase/firestore/FirebaseFirestore {
260260
public static final field Companion Ldev/gitlive/firebase/firestore/FirebaseFirestore$Companion;
261+
public final fun applySettings (Ldev/gitlive/firebase/firestore/FirebaseFirestoreSettings;)V
261262
public final fun batch ()Ldev/gitlive/firebase/firestore/WriteBatch;
262263
public final fun clearPersistence (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
263264
public final fun collection (Ljava/lang/String;)Ldev/gitlive/firebase/firestore/CollectionReference;
264265
public final fun collectionGroup (Ljava/lang/String;)Ldev/gitlive/firebase/firestore/Query;
265266
public final fun disableNetwork (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
266267
public final fun document (Ljava/lang/String;)Ldev/gitlive/firebase/firestore/DocumentReference;
267268
public final fun enableNetwork (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
268-
public final fun getSettings ()Ldev/gitlive/firebase/firestore/FirebaseFirestoreSettings;
269269
public final fun runTransaction (Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
270270
public final fun setLoggingEnabled (Z)V
271-
public final fun setSettings (Ldev/gitlive/firebase/firestore/FirebaseFirestoreSettings;)V
272271
public final fun setSettings (Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/String;Ljava/lang/Long;)V
272+
public final fun setSettings (Lkotlin/jvm/functions/Function1;)V
273273
public static synthetic fun setSettings$default (Ldev/gitlive/firebase/firestore/FirebaseFirestore;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/String;Ljava/lang/Long;ILjava/lang/Object;)V
274274
public final fun useEmulator (Ljava/lang/String;I)V
275275
}

‎firebase-firestore/src/androidMain/kotlin/dev/gitlive/firebase/firestore/internal/NativeFirebaseFirestoreWrapper.kt‎

Lines changed: 9 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
package dev.gitlive.firebase.firestore.internal
22

3-
import com.google.android.gms.tasks.TaskExecutors
4-
import com.google.firebase.firestore.MemoryCacheSettings
5-
import com.google.firebase.firestore.MemoryEagerGcSettings
6-
import com.google.firebase.firestore.MemoryLruGcSettings
7-
import com.google.firebase.firestore.PersistentCacheSettings
83
import com.google.firebase.firestore.firestoreSettings
94
import dev.gitlive.firebase.firestore.FirebaseFirestoreSettings
10-
import dev.gitlive.firebase.firestore.LocalCacheSettings
11-
import dev.gitlive.firebase.firestore.MemoryGarbageCollectorSettings
125
import dev.gitlive.firebase.firestore.NativeFirebaseFirestore
136
import dev.gitlive.firebase.firestore.NativeTransaction
147
import dev.gitlive.firebase.firestore.android
@@ -17,59 +10,6 @@ import kotlinx.coroutines.tasks.await
1710

1811
internal actual class NativeFirebaseFirestoreWrapper actual constructor(actual val native: NativeFirebaseFirestore) {
1912

20-
actual var settings: FirebaseFirestoreSettings
21-
get() = with(native.firestoreSettings) {
22-
FirebaseFirestoreSettings(
23-
isSslEnabled,
24-
host,
25-
cacheSettings?.let { localCacheSettings ->
26-
when (localCacheSettings) {
27-
is MemoryCacheSettings -> {
28-
val garbageCollectionSettings =
29-
when (val settings = localCacheSettings.garbageCollectorSettings) {
30-
is MemoryEagerGcSettings -> MemoryGarbageCollectorSettings.Eager
31-
is MemoryLruGcSettings -> MemoryGarbageCollectorSettings.LRUGC(
32-
settings.sizeBytes,
33-
)
34-
35-
else -> throw IllegalArgumentException("Existing settings does not have valid GarbageCollectionSettings")
36-
}
37-
LocalCacheSettings.Memory(garbageCollectionSettings)
38-
}
39-
40-
is PersistentCacheSettings -> LocalCacheSettings.Persistent(
41-
localCacheSettings.sizeBytes,
42-
)
43-
44-
else -> throw IllegalArgumentException("Existing settings is not of a valid type")
45-
}
46-
} ?: kotlin.run {
47-
@Suppress("DEPRECATION")
48-
when {
49-
isPersistenceEnabled -> LocalCacheSettings.Persistent(cacheSizeBytes)
50-
cacheSizeBytes == FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED -> LocalCacheSettings.Memory(
51-
MemoryGarbageCollectorSettings.Eager,
52-
)
53-
54-
else -> LocalCacheSettings.Memory(
55-
MemoryGarbageCollectorSettings.LRUGC(
56-
cacheSizeBytes,
57-
),
58-
)
59-
}
60-
},
61-
callbackExecutorMap[native] ?: TaskExecutors.MAIN_THREAD,
62-
)
63-
}
64-
set(value) {
65-
native.firestoreSettings = firestoreSettings {
66-
isSslEnabled = value.sslEnabled
67-
host = value.host
68-
setLocalCacheSettings(value.cacheSettings.android)
69-
}
70-
callbackExecutorMap[native] = value.callbackExecutor
71-
}
72-
7313
actual fun collection(collectionPath: String) = native.collection(collectionPath)
7414

7515
actual fun collectionGroup(collectionId: String) = native.collectionGroup(collectionId)
@@ -82,6 +22,15 @@ internal actual class NativeFirebaseFirestoreWrapper actual constructor(actual v
8222
actual fun setLoggingEnabled(loggingEnabled: Boolean) =
8323
com.google.firebase.firestore.FirebaseFirestore.setLoggingEnabled(loggingEnabled)
8424

25+
actual fun applySettings(settings: FirebaseFirestoreSettings) {
26+
native.firestoreSettings = firestoreSettings {
27+
isSslEnabled = settings.sslEnabled
28+
host = settings.host
29+
setLocalCacheSettings(settings.cacheSettings.android)
30+
}
31+
callbackExecutorMap[native] = settings.callbackExecutor
32+
}
33+
8534
actual suspend fun <T> runTransaction(func: suspend NativeTransaction.() -> T): T =
8635
native.runTransaction { runBlocking { it.func() } }.await()
8736

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

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,6 @@ public class FirebaseFirestore internal constructor(private val wrapper: NativeF
4444

4545
// Important to leave this as a get property since on JS it is initialized lazily
4646
internal val native: NativeFirebaseFirestore get() = wrapper.native
47-
public var settings: FirebaseFirestoreSettings
48-
get() = wrapper.settings
49-
set(value) {
50-
wrapper.settings = value
51-
}
5247

5348
public fun collection(collectionPath: String): CollectionReference = CollectionReference(wrapper.collection(collectionPath))
5449
public fun collectionGroup(collectionId: String): Query = Query(wrapper.collectionGroup(collectionId))
@@ -65,29 +60,36 @@ public class FirebaseFirestore internal constructor(private val wrapper: NativeF
6560
wrapper.useEmulator(host, port)
6661
}
6762

68-
@Deprecated("Use settings instead", replaceWith = ReplaceWith("settings = firestoreSettings{}"))
63+
@Deprecated("Use SettingsBuilder instead", replaceWith = ReplaceWith("setSettings { }"))
6964
public fun setSettings(
7065
persistenceEnabled: Boolean? = null,
7166
sslEnabled: Boolean? = null,
7267
host: String? = null,
7368
cacheSizeBytes: Long? = null,
74-
) {
75-
settings = firestoreSettings {
76-
this.sslEnabled = sslEnabled ?: true
77-
this.host = host ?: FirebaseFirestoreSettings.DEFAULT_HOST
78-
this.cacheSettings = if (persistenceEnabled != false) {
79-
LocalCacheSettings.Persistent(cacheSizeBytes ?: FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
69+
): Unit = setSettings {
70+
this.sslEnabled = sslEnabled ?: true
71+
this.host = host ?: FirebaseFirestoreSettings.DEFAULT_HOST
72+
this.cacheSettings = if (persistenceEnabled != false) {
73+
LocalCacheSettings.Persistent(cacheSizeBytes ?: FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
74+
} else {
75+
val cacheSize = cacheSizeBytes ?: FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED
76+
val garbageCollectionSettings = if (cacheSize == FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED) {
77+
MemoryGarbageCollectorSettings.Eager
8078
} else {
81-
val cacheSize = cacheSizeBytes ?: FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED
82-
val garbageCollectionSettings = if (cacheSize == FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED) {
83-
MemoryGarbageCollectorSettings.Eager
84-
} else {
85-
MemoryGarbageCollectorSettings.LRUGC(cacheSize)
86-
}
87-
LocalCacheSettings.Memory(garbageCollectionSettings)
79+
MemoryGarbageCollectorSettings.LRUGC(cacheSize)
8880
}
81+
LocalCacheSettings.Memory(garbageCollectionSettings)
8982
}
9083
}
84+
85+
public fun applySettings(settings: FirebaseFirestoreSettings) {
86+
wrapper.applySettings(settings)
87+
}
88+
89+
public fun setSettings(builder: FirebaseFirestoreSettings.Builder.() -> Unit): Unit = wrapper.applySettings(
90+
firestoreSettings(builder = builder),
91+
)
92+
9193
public suspend fun disableNetwork() {
9294
wrapper.disableNetwork()
9395
}

‎firebase-firestore/src/commonMain/kotlin/dev/gitlive/firebase/firestore/internal/NativeFirebaseFirestoreWrapper.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import dev.gitlive.firebase.firestore.NativeWriteBatch
99

1010
internal expect class NativeFirebaseFirestoreWrapper internal constructor(native: NativeFirebaseFirestore) {
1111
val native: NativeFirebaseFirestore
12-
var settings: FirebaseFirestoreSettings
1312

1413
fun collection(collectionPath: String): NativeCollectionReference
1514
fun collectionGroup(collectionId: String): NativeQuery
1615
fun document(documentPath: String): NativeDocumentReference
1716
fun batch(): NativeWriteBatch
1817
fun setLoggingEnabled(loggingEnabled: Boolean)
18+
fun applySettings(settings: FirebaseFirestoreSettings)
1919
suspend fun clearPersistence()
2020
suspend fun <T> runTransaction(func: suspend NativeTransaction.() -> T): T
2121
fun useEmulator(host: String, port: Int)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ class FirestoreSourceTest {
3939
)
4040

4141
firestore = Firebase.firestore(app).apply {
42-
useEmulator(emulatorHost, 8080)
43-
settings = firestoreSettings(settings) {
42+
setSettings {
4443
cacheSettings = if (persistenceEnabled) {
4544
persistentCacheSettings { }
4645
} else {
4746
memoryCacheSettings { }
4847
}
4948
}
49+
useEmulator(emulatorHost, 8080)
5050
}
5151
}
5252

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@ class FirebaseFirestoreTest {
105105
firebaseApp = app
106106

107107
firestore = Firebase.firestore(app).apply {
108-
useEmulator(emulatorHost, 8080)
109-
settings = firestoreSettings(settings) {
108+
setSettings {
110109
cacheSettings = memoryCacheSettings {
111110
gcSettings = memoryEagerGcSettings { }
112111
}
113112
}
113+
useEmulator(emulatorHost, 8080)
114114
}
115115
}
116116

‎firebase-firestore/src/iosMain/kotlin/dev/gitlive/firebase/firestore/internal/NativeFirebaseFirestoreWrapper.kt‎

Lines changed: 6 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,16 @@
11
package dev.gitlive.firebase.firestore.internal
22

33
import cocoapods.FirebaseFirestoreInternal.FIRFirestore
4-
import cocoapods.FirebaseFirestoreInternal.FIRMemoryCacheSettings
5-
import cocoapods.FirebaseFirestoreInternal.FIRPersistentCacheSettings
64
import dev.gitlive.firebase.firestore.FirebaseFirestoreSettings
7-
import dev.gitlive.firebase.firestore.LocalCacheSettings
8-
import dev.gitlive.firebase.firestore.MemoryGarbageCollectorSettings
95
import dev.gitlive.firebase.firestore.NativeFirebaseFirestore
106
import dev.gitlive.firebase.firestore.NativeTransaction
117
import dev.gitlive.firebase.firestore.await
128
import dev.gitlive.firebase.firestore.awaitResult
13-
import dev.gitlive.firebase.firestore.firestoreSettings
14-
import dev.gitlive.firebase.firestore.memoryCacheSettings
15-
import dev.gitlive.firebase.firestore.persistentCacheSettings
169
import kotlinx.coroutines.runBlocking
1710

1811
@Suppress("UNCHECKED_CAST")
1912
internal actual class NativeFirebaseFirestoreWrapper internal actual constructor(actual val native: NativeFirebaseFirestore) {
2013

21-
actual var settings: FirebaseFirestoreSettings
22-
get() = firestoreSettings {
23-
host = native.settings.host
24-
sslEnabled = native.settings.sslEnabled
25-
dispatchQueue = native.settings.dispatchQueue
26-
@Suppress("SENSELESS_NULL_IN_WHEN")
27-
cacheSettings = when (val nativeCacheSettings = native.settings.cacheSettings) {
28-
is FIRPersistentCacheSettings -> persistentCacheSettings {
29-
// SizeBytes cannot be determined
30-
}
31-
is FIRMemoryCacheSettings -> memoryCacheSettings {
32-
// Garbage collection settings cannot be determined
33-
}
34-
null -> when {
35-
native.settings.persistenceEnabled -> LocalCacheSettings.Persistent(native.settings.cacheSizeBytes)
36-
native.settings.cacheSizeBytes == FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED -> LocalCacheSettings.Memory(
37-
MemoryGarbageCollectorSettings.Eager,
38-
)
39-
else -> LocalCacheSettings.Memory(
40-
MemoryGarbageCollectorSettings.LRUGC(
41-
native.settings.cacheSizeBytes,
42-
),
43-
)
44-
}
45-
else -> error("Unknown cache settings $nativeCacheSettings")
46-
}
47-
}
48-
set(value) {
49-
native.settings = value.ios
50-
}
51-
5214
actual fun collection(collectionPath: String) = native.collectionWithPath(collectionPath)
5315

5416
actual fun collectionGroup(collectionId: String) = native.collectionGroupWithID(collectionId)
@@ -61,6 +23,10 @@ internal actual class NativeFirebaseFirestoreWrapper internal actual constructor
6123
actual fun setLoggingEnabled(loggingEnabled: Boolean): Unit =
6224
FIRFirestore.enableLogging(loggingEnabled)
6325

26+
actual fun applySettings(settings: FirebaseFirestoreSettings) {
27+
native.settings = settings.ios
28+
}
29+
6430
actual suspend fun <T> runTransaction(func: suspend NativeTransaction.() -> T) =
6531
awaitResult<Any?> {
6632
native.runTransactionWithBlock(
@@ -74,10 +40,8 @@ internal actual class NativeFirebaseFirestoreWrapper internal actual constructor
7440

7541
actual fun useEmulator(host: String, port: Int) {
7642
native.useEmulatorWithHost(host, port.toLong())
77-
settings = firestoreSettings(settings) {
78-
this.host = "$host:$port"
79-
cacheSettings = memoryCacheSettings { }
80-
sslEnabled = false
43+
native.settings = native.settings.apply {
44+
this.sslEnabled = false
8145
}
8246
}
8347

‎firebase-firestore/src/jsMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,10 @@ public actual val Firebase.firestore: FirebaseFirestore get() =
3737
public actual fun Firebase.firestore(app: FirebaseApp): FirebaseFirestore =
3838
rethrow { FirebaseFirestore(NativeFirebaseFirestoreWrapper(app.js)) }
3939

40-
internal actual data class NativeFirebaseFirestore(val js: JsFirestore, val settings: FirebaseFirestoreSettings)
40+
internal actual data class NativeFirebaseFirestore(val js: JsFirestore)
4141

4242
public operator fun FirebaseFirestore.Companion.invoke(js: JsFirestore): FirebaseFirestore = FirebaseFirestore(
43-
NativeFirebaseFirestore(
44-
js,
45-
FirebaseFirestoreSettings.Builder().build(),
46-
),
43+
NativeFirebaseFirestore(js),
4744
)
4845
public val FirebaseFirestore.js: JsFirestore get() = native.js
4946

0 commit comments

Comments
 (0)