[AND-172] Await Depednecy Resolve process until ChatClient is properly initialized

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### 🐞 Fixed
 
 ### ⬆️ Improved
+- Internal "Resolve Dependency" process improvements. [#5514](https://github.com/GetStream/stream-chat-android/pull/5514)
 
 ### ✅ Added
 - Add `Channel.membership.pinnedAt` property notifiying if/when a channel was pinned by the current user. [#5513](https://github.com/GetStream/stream-chat-android/pull/5513)

stream-chat-android-client/api/stream-chat-android-client.api

@@ -9,6 +9,7 @@ public final class io/getstream/chat/android/client/BuildConfig {
 public final class io/getstream/chat/android/client/ChatClient {
 	public static final field Companion Lio/getstream/chat/android/client/ChatClient$Companion;
 	public static final field DEFAULT_SORT Lio/getstream/chat/android/models/querysort/QuerySorter;
+	public static final field RESOLVE_DEPENDENCY_TIMEOUT J
 	public final fun acceptInvite (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun addDevice (Lio/getstream/chat/android/models/Device;)Lio/getstream/result/call/Call;
 	public final fun addMembers (Ljava/lang/String;Ljava/lang/String;Lio/getstream/chat/android/client/query/AddMembersParams;)Lio/getstream/result/call/Call;

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt

@@ -150,6 +150,7 @@ import io.getstream.chat.android.client.utils.observable.Disposable
 import io.getstream.chat.android.client.utils.retry.NoRetryPolicy
 import io.getstream.chat.android.client.utils.stringify
 import io.getstream.chat.android.core.internal.InternalStreamChatApi
+import io.getstream.chat.android.core.internal.StreamHandsOff
 import io.getstream.chat.android.models.AppSettings
 import io.getstream.chat.android.models.Attachment
 import io.getstream.chat.android.models.BannedUser
@@ -359,7 +360,7 @@ internal constructor(
     @Suppress("ThrowsCount")
     internal inline fun <reified P : DependencyResolver, reified T : Any> resolvePluginDependency(): T {
         StreamLog.v(TAG) { "[resolvePluginDependency] P: ${P::class.simpleName}, T: ${T::class.simpleName}" }
-        val initState = clientState.initializationState.value
+        val initState = awaitInitializationState(RESOLVE_DEPENDENCY_TIMEOUT)
         if (initState != InitializationState.COMPLETE) {
             StreamLog.e(TAG) { "[resolvePluginDependency] failed (initializationState is not COMPLETE): $initState " }
             throw IllegalStateException("ChatClient::connectUser() must be called before resolving any dependency")
@@ -375,6 +376,25 @@ internal constructor(
             )
     }
 
+    @InternalStreamChatApi
+    @StreamHandsOff(
+        "This method is used to avoid race-condition between plugin initialization and dependency resolution.",
+    )
+    public fun awaitInitializationState(timeoutMilliseconds: Long): InitializationState? {
+        var initState: InitializationState? = clientState.initializationState.value
+        var spendTime = 0L
+        inheritScope { Job(it) }.launch {
+            initState = withTimeoutOrNull(timeoutMilliseconds) {
+                clientState.initializationState.first { it == InitializationState.COMPLETE }
+            }
+        }
+        while (initState == InitializationState.INITIALIZING && spendTime < timeoutMilliseconds) {
+            java.lang.Thread.sleep(INITIALIZATION_DELAY)
+            spendTime += INITIALIZATION_DELAY
+        }
+        return initState
+    }
+
     /**
      * Error handlers for API calls.
      */
@@ -3947,6 +3967,7 @@ internal constructor(
         private const val MESSAGE_ACTION_SHUFFLE = "shuffle"
         private val THIRTY_DAYS_IN_MILLISECONDS = 30.days.inWholeMilliseconds
         private const val INITIALIZATION_DELAY = 100L
+        public const val RESOLVE_DEPENDENCY_TIMEOUT: Long = 10_000L
 
         private const val ARG_TYPING_PARENT_ID = "parent_id"
 

stream-chat-android-compose/src/test/kotlin/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModelTest.kt

@@ -330,6 +330,7 @@ internal class ChannelListViewModelTest {
         fun givenCurrentUser(currentUser: User = User(id = "Jc")) = apply {
             whenever(clientState.user) doReturn MutableStateFlow(currentUser)
             whenever(clientState.initializationState) doReturn MutableStateFlow(InitializationState.COMPLETE)
+            whenever(chatClient.awaitInitializationState(any())) doReturn InitializationState.COMPLETE
         }
 
         fun givenChannelMutes(channelMutes: List<ChannelMute> = emptyList()) = apply {

stream-chat-android-compose/src/test/kotlin/io/getstream/chat/android/compose/viewmodel/messages/MessageComposerViewModelTest.kt

@@ -402,6 +402,7 @@ internal class MessageComposerViewModelTest {
             whenever(clientState.user) doReturn MutableStateFlow(currentUser)
             whenever(chatClient.clientState) doReturn clientState
             whenever(clientState.initializationState) doReturn MutableStateFlow(InitializationState.COMPLETE)
+            whenever(chatClient.awaitInitializationState(any())) doReturn InitializationState.COMPLETE
         }
 
         fun givenChannelQuery(channel: Channel = Channel()) = apply {

stream-chat-android-state/src/test/java/io/getstream/chat/android/state/extensions/ChatClientExtensionTests.kt

@@ -46,6 +46,7 @@ import org.amshove.kluent.shouldBeEqualTo
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.RegisterExtension
+import org.mockito.kotlin.any
 import org.mockito.kotlin.doAnswer
 import org.mockito.kotlin.doReturn
 import org.mockito.kotlin.mock
@@ -136,6 +137,7 @@ internal class ChatClientExtensionTests {
                 userFlow.value = null
                 Unit.asCall()
             }
+            on(it.awaitInitializationState(any())) doReturn InitializationState.COMPLETE
         }
     }
 

stream-chat-android-ui-components/src/test/kotlin/io/getstream/chat/android/ui/viewmodels/channels/ChannelListViewModelTest.kt

@@ -264,6 +264,7 @@ internal class ChannelListViewModelTest {
             whenever(clientState.user) doReturn MutableStateFlow(currentUser)
             whenever(clientState.initializationState) doReturn MutableStateFlow(InitializationState.COMPLETE)
             whenever(chatClient.getCurrentUser()) doReturn currentUser
+            whenever(chatClient.awaitInitializationState(any())) doReturn InitializationState.COMPLETE
         }
 
         fun givenChannelMutes(channelMutes: List<ChannelMute> = emptyList()) = apply {

stream-chat-android-ui-components/src/test/kotlin/io/getstream/chat/android/ui/viewmodels/messages/MessageComposerViewModelTest.kt

@@ -403,6 +403,7 @@ internal class MessageComposerViewModelTest {
             whenever(clientState.user) doReturn MutableStateFlow(currentUser)
             whenever(chatClient.clientState) doReturn clientState
             whenever(clientState.initializationState) doReturn MutableStateFlow(InitializationState.COMPLETE)
+            whenever(chatClient.awaitInitializationState(any())) doReturn InitializationState.COMPLETE
         }
 
         fun givenChannelQuery(channel: Channel = Channel()) = apply {