[AND-419] Prevent crash when accessing ChatClient.globalState. (#5702)

* [AND-419] Prevent crash when accessing globalState.

* [AND-419] Prevent crash when accessing globalState.

* [AND-419] Update CHANGELOG.md.

* [AND-419] Simplify ChatClient.globalStateFlow extension.

* [AND-419] Add warning logs.

* [AND-419] Update CHANGELOG.md.

---------

Co-authored-by: PetarVelikov <[email protected]>

Author: VelikovPetar

CHANGELOG.md

@@ -45,6 +45,7 @@
 
 ### ✅ Added
 - Add `GlobalState.channelDraftMessages` and `GlobalState.threadDraftMessages` properties providing access to the draft messages. [#5682](https://github.com/GetStream/stream-chat-android/pull/5682) 
+- Add `ChatClient.globalStateFlow` flow holding the `GlobalState` object, which emits values only if the user is connected. [#5702](https://github.com/GetStream/stream-chat-android/pull/5702)
 
 ### ⚠️ Changed
 
@@ -65,6 +66,7 @@
 ## stream-chat-android-ui-components
 ### 🐞 Fixed
 - Fix audio recording attachments not paused when the app goes to the background or the screen is covered with another one. [#5685](https://github.com/GetStream/stream-chat-android/pull/5685)
+- Fix crash happening after process death when accessing `GlobalState` from the UI components. [#5702](https://github.com/GetStream/stream-chat-android/pull/5702)
 
 ### ⬆️ Improved
 - Enable pagination in `MentionListView`. [#5692](https://github.com/GetStream/stream-chat-android/pull/5692)
@@ -74,6 +76,7 @@
 
 ### ⚠️ Changed
 - 🚨Breaking change: Move `MentionListViewModel` logic and its state to a shared component so they can be reused in Compose. [#5692](https://github.com/GetStream/stream-chat-android/pull/5692)
+- 🚨Breaking change: `ChannelListViewModel` now accepts a `Flow<GlobalState>` instead of `GlobalState` for the `globalState` constructor parameter.  [#5702](https://github.com/GetStream/stream-chat-android/pull/5702)
 
 ### ❌ Removed
 
@@ -82,6 +85,7 @@
 - Fix audio recording attachments not paused when the app goes to the background or the screen is covered with another one. [#5685](https://github.com/GetStream/stream-chat-android/pull/5685)
 - Not show deleted poll messages. [#5689](https://github.com/GetStream/stream-chat-android/pull/5689)
 - Fix "Thread reply" item shown in the message options menu for messages in a Thread. [#5683](https://github.com/GetStream/stream-chat-android/pull/5683)
+- Fix crash happening after process death when accessing `GlobalState` from the UI components. [#5702](https://github.com/GetStream/stream-chat-android/pull/5702)
 
 ### ⬆️ Improved
 

stream-chat-android-compose/api/stream-chat-android-compose.api

@@ -3924,8 +3924,8 @@ public final class io/getstream/chat/android/compose/util/KeyValuePair {
 
 public final class io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModel : androidx/lifecycle/ViewModel {
 	public static final field $stable I
-	public fun <init> (Lio/getstream/chat/android/client/ChatClient;Lio/getstream/chat/android/models/querysort/QuerySorter;Lio/getstream/chat/android/models/FilterObject;IIILio/getstream/chat/android/state/event/handler/chat/factory/ChatEventHandlerFactory;JZ)V
-	public synthetic fun <init> (Lio/getstream/chat/android/client/ChatClient;Lio/getstream/chat/android/models/querysort/QuerySorter;Lio/getstream/chat/android/models/FilterObject;IIILio/getstream/chat/android/state/event/handler/chat/factory/ChatEventHandlerFactory;JZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/getstream/chat/android/client/ChatClient;Lio/getstream/chat/android/models/querysort/QuerySorter;Lio/getstream/chat/android/models/FilterObject;IIILio/getstream/chat/android/state/event/handler/chat/factory/ChatEventHandlerFactory;JZLkotlinx/coroutines/flow/Flow;)V
+	public synthetic fun <init> (Lio/getstream/chat/android/client/ChatClient;Lio/getstream/chat/android/models/querysort/QuerySorter;Lio/getstream/chat/android/models/FilterObject;IIILio/getstream/chat/android/state/event/handler/chat/factory/ChatEventHandlerFactory;JZLkotlinx/coroutines/flow/Flow;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun archiveChannel (Lio/getstream/chat/android/models/Channel;)V
 	public final fun deleteConversation (Lio/getstream/chat/android/models/Channel;)V
 	public final fun dismissChannelAction ()V

stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/channels/ChannelListViewModel.kt

@@ -41,25 +41,30 @@ import io.getstream.chat.android.models.TypingEvent
 import io.getstream.chat.android.models.User
 import io.getstream.chat.android.models.querysort.QuerySorter
 import io.getstream.chat.android.state.event.handler.chat.factory.ChatEventHandlerFactory
-import io.getstream.chat.android.state.extensions.globalState
+import io.getstream.chat.android.state.extensions.globalStateFlow
 import io.getstream.chat.android.state.extensions.queryChannelsAsState
+import io.getstream.chat.android.state.plugin.state.global.GlobalState
 import io.getstream.chat.android.state.plugin.state.querychannels.ChannelsStateData
 import io.getstream.chat.android.state.plugin.state.querychannels.QueryChannelsState
 import io.getstream.chat.android.ui.common.state.channels.actions.Cancel
 import io.getstream.chat.android.ui.common.state.channels.actions.ChannelAction
 import io.getstream.chat.android.uiutils.extension.defaultChannelListFilter
 import io.getstream.log.taggedLogger
 import io.getstream.result.call.toUnitCall
+import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.cancelChildren
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.collectLatest
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.filterNotNull
 import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.flow.flatMapLatest
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.plus
@@ -79,7 +84,9 @@ import kotlin.coroutines.cancellation.CancellationException
  * @param chatEventHandlerFactory The instance of [ChatEventHandlerFactory] used to create [ChatEventHandler].
  * @param searchDebounceMs The debounce time for search queries.
  * @param isDraftMessageEnabled If the draft message feature is enabled.
+ * @param globalState A flow emitting the current [GlobalState].
  */
+@OptIn(ExperimentalCoroutinesApi::class)
 @Suppress("TooManyFunctions")
 public class ChannelListViewModel(
     public val chatClient: ChatClient,
@@ -91,6 +98,7 @@ public class ChannelListViewModel(
     private val chatEventHandlerFactory: ChatEventHandlerFactory = ChatEventHandlerFactory(chatClient.clientState),
     searchDebounceMs: Long = SEARCH_DEBOUNCE_MS,
     private val isDraftMessageEnabled: Boolean,
+    private val globalState: Flow<GlobalState> = chatClient.globalStateFlow,
 ) : ViewModel() {
 
     private val logger by taggedLogger("Chat:ChannelListVM")
@@ -182,7 +190,17 @@ public class ChannelListViewModel(
     /**
      * Gives us the information about the list of channels mutes by the current user.
      */
-    public val channelMutes: StateFlow<List<ChannelMute>> = chatClient.globalState.channelMutes
+    public val channelMutes: StateFlow<List<ChannelMute>> = globalState
+        .flatMapLatest { it.channelMutes }
+        .stateIn(viewModelScope, SharingStarted.Eagerly, emptyList())
+
+    private val typingChannels: StateFlow<Map<String, TypingEvent>> = globalState
+        .flatMapLatest { it.typingChannels }
+        .stateIn(viewModelScope, SharingStarted.Eagerly, emptyMap())
+
+    private val channelDraftMessages: StateFlow<Map<String, DraftMessage>> = globalState
+        .flatMapLatest { it.channelDraftMessages }
+        .stateIn(viewModelScope, SharingStarted.Eagerly, emptyMap())
 
     /**
      * Builds the default channel filter, which represents "messaging" channels that the current user is a part of.
@@ -394,8 +412,8 @@ public class ChannelListViewModel(
                 combine(
                     queryChannelsState.channelsStateData,
                     channelMutes,
-                    chatClient.globalState.typingChannels,
-                    chatClient.globalState.channelDraftMessages,
+                    typingChannels,
+                    channelDraftMessages,
                 ) { state, channelMutes, typingChannels, channelDraftMessages ->
                     when (state) {
                         ChannelsStateData.NoQueryActive,

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

@@ -420,6 +420,7 @@ internal class ChannelListViewModelTest {
                 initialFilters = initialFilters,
                 isDraftMessageEnabled = false,
                 chatEventHandlerFactory = ChatEventHandlerFactory(clientState),
+                globalState = MutableStateFlow(globalState),
             )
             testScope.advanceUntilIdle()
             return channelListViewModel

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

@@ -392,6 +392,8 @@ internal class MessageComposerViewModelTest {
             whenever(statePlugin.resolveDependency(eq(StateRegistry::class))) doReturn stateRegistry
             whenever(statePlugin.resolveDependency(eq(GlobalState::class))) doReturn globalState
             whenever(statePluginFactory.resolveDependency(eq(StatePluginConfig::class))) doReturn statePluginConfig
+            whenever(globalState.channelDraftMessages) doReturn MutableStateFlow(emptyMap())
+            whenever(globalState.threadDraftMessages) doReturn MutableStateFlow(emptyMap())
             whenever(chatClient.plugins) doReturn listOf(statePlugin)
             whenever(chatClient.pluginFactories) doReturn listOf(statePluginFactory)
             whenever(chatClient.audioPlayer) doReturn mock()
@@ -439,11 +441,11 @@ internal class MessageComposerViewModelTest {
                     mediaRecorder = mock(),
                     userLookupHandler = DefaultUserLookupHandler(chatClient, channelId),
                     fileToUri = { it.path },
-                    globalState = globalState,
                     config = MessageComposerController.Config(
                         maxAttachmentCount = maxAttachmentCount,
                     ),
                     channelState = MutableStateFlow(channelState),
+                    globalState = MutableStateFlow(globalState),
                 ),
             )
         }

stream-chat-android-docs/src/main/kotlin/io/getstream/chat/docs/kotlin/compose/channels/ChannelListHeader.kt

@@ -16,7 +16,6 @@ import androidx.compose.ui.Modifier
 import io.getstream.chat.android.client.ChatClient
 import io.getstream.chat.android.compose.ui.channels.header.ChannelListHeader
 import io.getstream.chat.android.compose.ui.theme.ChatTheme
-import io.getstream.chat.android.state.extensions.globalState
 
 /**
  * [Usage](https://getstream.io/chat/docs/sdk/android/compose/channel-components/channel-list-header/#usage)

stream-chat-android-state/api/stream-chat-android-state.api

@@ -72,6 +72,7 @@ public final class io/getstream/chat/android/state/extensions/ChatClientExtensio
 	public static final fun cancelEphemeralMessage (Lio/getstream/chat/android/client/ChatClient;Lio/getstream/chat/android/models/Message;)Lio/getstream/result/call/Call;
 	public static final fun downloadAttachment (Lio/getstream/chat/android/client/ChatClient;Landroid/content/Context;Lio/getstream/chat/android/models/Attachment;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;)Lio/getstream/result/call/Call;
 	public static final fun getGlobalState (Lio/getstream/chat/android/client/ChatClient;)Lio/getstream/chat/android/state/plugin/state/global/GlobalState;
+	public static final fun getGlobalStateFlow (Lio/getstream/chat/android/client/ChatClient;)Lkotlinx/coroutines/flow/Flow;
 	public static final fun getMessageUsingCache (Lio/getstream/chat/android/client/ChatClient;Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public static final fun getRepliesAsState (Lio/getstream/chat/android/client/ChatClient;Ljava/lang/String;IZLkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static final fun getRepliesAsState (Lio/getstream/chat/android/client/ChatClient;Ljava/lang/String;IZLkotlinx/coroutines/CoroutineScope;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;

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

@@ -58,12 +58,15 @@ import io.getstream.result.call.CoroutineCall
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.coroutineScope
+import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.distinctUntilChanged
+import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.mapLatest
+import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.stateIn
 import java.text.SimpleDateFormat
 import java.util.Date
@@ -90,6 +93,20 @@ public val ChatClient.globalState: GlobalState
     @Throws(IllegalArgumentException::class)
     get() = resolveDependency<StatePlugin, GlobalState>()
 
+/**
+ * Retrieves a [Flow] holding the [GlobalState] object, which emits only if the user is connected, and the [ChatClient]
+ * is in [InitializationState.COMPLETE] state.
+ */
+public val ChatClient.globalStateFlow: Flow<GlobalState>
+    get() = clientState.initializationState
+        .onEach {
+            if (it == InitializationState.NOT_INITIALIZED) {
+                StreamLog.w(TAG) { "ChatClient::connectUser() must be called to ensure the globalState is initialized" }
+            }
+        }
+        .filter { it == InitializationState.COMPLETE }
+        .map { globalState }
+
 /**
  * [StatePluginConfig] instance used to configure [io.getstream.chat.android.state.plugin.internal.StatePlugin].
  *

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

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.getstream.chat.android.state.extensions
+
+import app.cash.turbine.test
+import io.getstream.chat.android.client.ChatClient
+import io.getstream.chat.android.client.setup.state.ClientState
+import io.getstream.chat.android.models.InitializationState
+import io.getstream.chat.android.state.plugin.internal.StatePlugin
+import io.getstream.chat.android.state.plugin.state.global.GlobalState
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.test.runTest
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.jupiter.api.Test
+import org.mockito.kotlin.any
+import org.mockito.kotlin.doReturn
+import org.mockito.kotlin.eq
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+
+internal class ChatClientExtensionsTest {
+
+    @Test
+    fun `Given ChatClient not initialized, When collecting globalStateFlow, There are no emissions()`() = runTest {
+        // given
+        val initializationState = InitializationState.NOT_INITIALIZED
+        val globalState = mock<GlobalState>()
+        val sut = Fixture().get(initializationState, globalState)
+        // when
+        sut.globalStateFlow.test {
+            // then
+            expectNoEvents()
+        }
+    }
+
+    @Test
+    fun `Given ChatClient initializing, When collecting globalStateFlow, There are no emissions()`() = runTest {
+        // given
+        val initializationState = InitializationState.INITIALIZING
+        val globalState = mock<GlobalState>()
+        val sut = Fixture().get(initializationState, globalState)
+        // when / then
+        sut.globalStateFlow.test {
+            // then
+            expectNoEvents()
+        }
+    }
+
+    @Test
+    fun `Given ChatClient initialized, When collecting globalStateFlow, Then globalState is emitted()`() = runTest {
+        // given
+        val initializationState = InitializationState.COMPLETE
+        val globalState = mock<GlobalState>()
+        val sut = Fixture().get(initializationState, globalState)
+        // when / then
+        sut.globalStateFlow.test {
+            // then
+            val emission = awaitItem()
+            emission shouldBeEqualTo globalState
+            expectNoEvents()
+        }
+    }
+
+    private class Fixture {
+
+        fun get(
+            initializationState: InitializationState,
+            globalState: GlobalState,
+        ): ChatClient {
+            val client = mock<ChatClient>()
+            // Prepare initialization state
+            val clientState = mock<ClientState>()
+            whenever(clientState.initializationState)
+                .thenReturn(MutableStateFlow(initializationState))
+            whenever(client.awaitInitializationState(any()))
+                .thenReturn(initializationState)
+            // Prepare StatePlugin
+            val statePlugin: StatePlugin = mock()
+            whenever(statePlugin.resolveDependency(eq(GlobalState::class))) doReturn globalState
+            whenever(client.plugins).thenReturn(listOf(statePlugin))
+            whenever(client.clientState).thenReturn(clientState)
+            return client
+        }
+    }
+}