refactor: only expose the await function

thatfiredev · thatfiredev · commit eea8af6dc84d · 2022-08-30T20:59:58.000+01:00
diff --git a/firebase-common/ktx/ktx.gradle b/firebase-common/ktx/ktx.gradle
@@ -41,10 +41,8 @@ dependencies {
     implementation project(':firebase-common')
     implementation project(':firebase-components')
     implementation 'androidx.annotation:annotation:1.1.0'
-
-    // We're exposing this library as a transitive dependency so developers can
-    // get Kotlin Coroutines support out-of-the-box for methods that return a Task
-    api "org.jetbrains.kotlinx:kotlinx-coroutines-play-services:$coroutinesVersion"
+    implementation "com.google.android.gms:play-services-tasks:18.0.2"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-play-services:$coroutinesVersion"
 
     testImplementation "org.robolectric:robolectric:$robolectricVersion"
     testImplementation 'junit:junit:4.12'
diff --git a/firebase-common/ktx/src/main/kotlin/com/google/firebase/ktx/Firebase.kt b/firebase-common/ktx/src/main/kotlin/com/google/firebase/ktx/Firebase.kt
@@ -15,11 +15,13 @@ package com.google.firebase.ktx
 
 import android.content.Context
 import androidx.annotation.Keep
+import com.google.android.gms.tasks.Task
 import com.google.firebase.FirebaseApp
 import com.google.firebase.FirebaseOptions
 import com.google.firebase.components.Component
 import com.google.firebase.components.ComponentRegistrar
 import com.google.firebase.platforminfo.LibraryVersionComponent
+import kotlinx.coroutines.tasks.await
 
 /**
  * Single access point to all firebase SDKs from Kotlin.
@@ -50,6 +52,15 @@ fun Firebase.initialize(context: Context, options: FirebaseOptions, name: String
 val Firebase.options: FirebaseOptions
     get() = Firebase.app.options
 
+/**
+ * Awaits the completion of the task without blocking a thread.
+ *
+ * This suspending function is cancellable.
+ * If the [Job] of the current coroutine is cancelled or completed while this suspending function is waiting, this function
+ * stops waiting for the completion stage and immediately resumes with [CancellationException].
+ */
+suspend fun <T> Task<T>.await(): T = await()
+
 internal const val LIBRARY_NAME: String = "fire-core-ktx"
 
 /** @suppress */
