Merge "Make ViewModels submit Snackbar messages directly" into main

Author: jdkoren

mobile/src/main/java/com/google/samples/apps/iosched/ui/MainActivity.kt

@@ -40,6 +40,7 @@ import com.google.samples.apps.iosched.shared.di.ExploreArEnabledFlag
 import com.google.samples.apps.iosched.shared.di.MapFeatureEnabledFlag
 import com.google.samples.apps.iosched.shared.domain.ar.ArConstants
 import com.google.samples.apps.iosched.shared.result.EventObserver
+import com.google.samples.apps.iosched.ui.messages.SnackbarMessage
 import com.google.samples.apps.iosched.ui.messages.SnackbarMessageManager
 import com.google.samples.apps.iosched.ui.signin.SignInDialogFragment
 import com.google.samples.apps.iosched.ui.signin.SignOutDialogFragment

mobile/src/main/java/com/google/samples/apps/iosched/ui/SnackbarMessageFragmentExtensions.kt

@@ -42,7 +42,7 @@ import com.google.samples.apps.iosched.ui.feed.FeedNavigationAction.NavigateToSe
 import com.google.samples.apps.iosched.ui.feed.FeedNavigationAction.OpenLiveStreamAction
 import com.google.samples.apps.iosched.ui.feed.FeedNavigationAction.OpenSignInDialogAction
 import com.google.samples.apps.iosched.ui.messages.SnackbarMessageManager
-import com.google.samples.apps.iosched.ui.setUpSnackbar
+import com.google.samples.apps.iosched.ui.messages.setupSnackbarManager
 import com.google.samples.apps.iosched.ui.signin.SignInDialogFragment
 import com.google.samples.apps.iosched.ui.signin.setupProfileMenuItem
 import com.google.samples.apps.iosched.util.doOnApplyWindowInsets
@@ -76,8 +76,7 @@ class FeedFragment : MainNavigationFragment() {
         inflater: LayoutInflater,
         container: ViewGroup?,
         savedInstanceState: Bundle?
-    ): View? {
-
+    ): View {
         binding = FragmentFeedBinding.inflate(
             inflater, container, false
         ).apply {
@@ -131,7 +130,7 @@ class FeedFragment : MainNavigationFragment() {
             v.updatePaddingRelative(bottom = padding.bottom + insets.systemWindowInsetBottom)
         }
 
-        setUpSnackbar(model.snackBarMessages, binding.snackbar, snackbarMessageManager)
+        setupSnackbarManager(snackbarMessageManager, binding.snackbar)
 
         // Observe feed
         viewLifecycleOwner.lifecycleScope.launchWhenStarted {

mobile/src/main/java/com/google/samples/apps/iosched/ui/feed/FeedFragment.kt

@@ -40,21 +40,20 @@ import com.google.samples.apps.iosched.shared.domain.feed.LoadCurrentMomentUseCa
 import com.google.samples.apps.iosched.shared.domain.sessions.LoadStarredAndReservedSessionsUseCase
 import com.google.samples.apps.iosched.shared.domain.settings.GetTimeZoneUseCase
 import com.google.samples.apps.iosched.shared.result.Result
-import com.google.samples.apps.iosched.shared.result.Result.Loading
 import com.google.samples.apps.iosched.shared.result.successOr
 import com.google.samples.apps.iosched.shared.time.TimeProvider
 import com.google.samples.apps.iosched.shared.util.TimeUtils
 import com.google.samples.apps.iosched.shared.util.TimeUtils.ConferenceDays
 import com.google.samples.apps.iosched.shared.util.toEpochMilli
 import com.google.samples.apps.iosched.shared.util.tryOffer
-import com.google.samples.apps.iosched.ui.SnackbarMessage
+import com.google.samples.apps.iosched.ui.messages.SnackbarMessage
+import com.google.samples.apps.iosched.ui.messages.SnackbarMessageManager
 import com.google.samples.apps.iosched.ui.sessioncommon.EventActions
 import com.google.samples.apps.iosched.ui.sessiondetail.SessionDetailFragmentDirections
 import com.google.samples.apps.iosched.ui.signin.SignInViewModelDelegate
 import com.google.samples.apps.iosched.ui.theme.ThemedActivityDelegate
 import com.google.samples.apps.iosched.util.WhileViewSubscribed
 import dagger.hilt.android.lifecycle.HiltViewModel
-import kotlinx.coroutines.channels.BufferOverflow.DROP_LATEST
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.StateFlow
@@ -64,7 +63,6 @@ import kotlinx.coroutines.flow.flow
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.receiveAsFlow
-import kotlinx.coroutines.flow.shareIn
 import kotlinx.coroutines.flow.stateIn
 import org.threeten.bp.ZoneId
 import org.threeten.bp.ZonedDateTime
@@ -85,7 +83,8 @@ class FeedViewModel @Inject constructor(
     private val timeProvider: TimeProvider,
     private val analyticsHelper: AnalyticsHelper,
     private val signInViewModelDelegate: SignInViewModelDelegate,
-    themedActivityDelegate: ThemedActivityDelegate
+    themedActivityDelegate: ThemedActivityDelegate,
+    private val snackbarMessageManager: SnackbarMessageManager
 ) : ViewModel(),
     FeedEventListener,
     ThemedActivityDelegate by themedActivityDelegate,
@@ -140,7 +139,7 @@ class FeedViewModel @Inject constructor(
     private val conferenceState: StateFlow<ConferenceState> = getConferenceStateUseCase(Unit)
         .onEach {
             if (it is Result.Error) {
-                _snackBarMessages.tryOffer(SnackbarMessage(R.string.feed_loading_error))
+                snackbarMessageManager.addMessage(SnackbarMessage(R.string.feed_loading_error))
             }
         }
         .map { it.successOr(UPCOMING) }
@@ -160,15 +159,15 @@ class FeedViewModel @Inject constructor(
         emit(loadAnnouncementsUseCase(timeProvider.now()))
     }.onEach {
         if (it is Result.Error) {
-            _snackBarMessages.tryOffer(SnackbarMessage(R.string.feed_loading_error))
+            snackbarMessageManager.addMessage(SnackbarMessage(R.string.feed_loading_error))
         }
     }.stateIn(viewModelScope, WhileViewSubscribed, Result.Loading)
 
     private val announcementsPreview: StateFlow<List<Any>> = loadAnnouncementsResult.map {
         val announcementsHeader = AnnouncementsHeader(
             showPastNotificationsButton = it.successOr(emptyList()).size > 1
         )
-        if (it is Loading) {
+        if (it is Result.Loading) {
             listOf(announcementsHeader, LoadingIndicator)
         } else {
             listOf(
@@ -178,12 +177,6 @@ class FeedViewModel @Inject constructor(
         }
     }.stateIn(viewModelScope, WhileViewSubscribed, emptyList())
 
-    // SIDE EFFECTS: Snackbar messages
-    // Guard against too many Snackbar messages by limiting to 3, keeping the oldest.
-    private val _snackBarMessages = Channel<SnackbarMessage>(3, DROP_LATEST)
-    val snackBarMessages: Flow<SnackbarMessage> =
-        _snackBarMessages.receiveAsFlow().shareIn(viewModelScope, WhileViewSubscribed)
-
     private val feedSessionsContainer: Flow<FeedSessions> = loadSessionsResult
         .combine(timeZoneIdFlow) { sessions, timeZone ->
             createFeedSessionsContainer(sessions, timeZone)
@@ -196,7 +189,8 @@ class FeedViewModel @Inject constructor(
             signInViewModelDelegate.currentUserInfoFlow
         ) { sessionsContainer: FeedSessions,
             conferenceState: ConferenceState,
-            userInfo: AuthenticatedUserInfo? ->
+            userInfo: AuthenticatedUserInfo?
+            ->
             val isSignedIn = userInfo?.isSignedIn() ?: false
             val isRegistered = userInfo?.isRegistered() ?: false
             if (conferenceState != ENDED && isSignedIn && isRegistered &&
@@ -268,7 +262,7 @@ class FeedViewModel @Inject constructor(
             actionTextId = actionId,
             userSessions = upcomingReservedSessions,
             timeZoneId = timeZoneId,
-            isLoading = sessionsResult is Loading,
+            isLoading = sessionsResult is Result.Loading,
             isMapFeatureEnabled = isMapEnabledByRemoteConfig
         )
     }

mobile/src/main/java/com/google/samples/apps/iosched/ui/feed/FeedViewModel.kt

@@ -35,7 +35,7 @@ import com.google.samples.apps.iosched.model.ConferenceWifiInfo
 import com.google.samples.apps.iosched.shared.di.AssistantAppEnabledFlag
 import com.google.samples.apps.iosched.shared.util.TimeUtils
 import com.google.samples.apps.iosched.ui.messages.SnackbarMessageManager
-import com.google.samples.apps.iosched.ui.setupSnackbarManager
+import com.google.samples.apps.iosched.ui.messages.setupSnackbarManager
 import com.google.samples.apps.iosched.util.doOnApplyWindowInsets
 import com.google.samples.apps.iosched.util.launchAndRepeatWithViewLifecycle
 import com.google.samples.apps.iosched.widget.FadingSnackbar
@@ -74,7 +74,7 @@ class EventFragment : Fragment() {
         }
 
         val snackbarLayout = requireActivity().findViewById<FadingSnackbar>(R.id.snackbar)
-        setupSnackbarManager(snackbarMessageManager, snackbarLayout) { }
+        setupSnackbarManager(snackbarMessageManager, snackbarLayout)
 
         return binding.root
     }

mobile/src/main/java/com/google/samples/apps/iosched/ui/info/EventFragment.kt

@@ -26,7 +26,7 @@ import com.google.samples.apps.iosched.shared.analytics.AnalyticsHelper
 import com.google.samples.apps.iosched.shared.domain.logistics.LoadWifiInfoUseCase
 import com.google.samples.apps.iosched.shared.result.data
 import com.google.samples.apps.iosched.shared.util.tryOffer
-import com.google.samples.apps.iosched.ui.SnackbarMessage
+import com.google.samples.apps.iosched.ui.messages.SnackbarMessage
 import com.google.samples.apps.iosched.ui.messages.SnackbarMessageManager
 import com.google.samples.apps.iosched.util.WhileViewSubscribed
 import com.google.samples.apps.iosched.util.wifi.WifiInstaller

mobile/src/main/java/com/google/samples/apps/iosched/ui/info/EventInfoViewModel.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.google.samples.apps.iosched.ui
+package com.google.samples.apps.iosched.ui.messages
 
 import com.google.samples.apps.iosched.model.Session
 

mobile/src/main/java/com/google/samples/apps/iosched/ui/SnackbarMessage.kt renamed to mobile/src/main/java/com/google/samples/apps/iosched/ui/messages/SnackbarMessage.kt

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 com.google.samples.apps.iosched.ui.messages
+
+import androidx.core.text.HtmlCompat
+import androidx.core.text.HtmlCompat.FROM_HTML_MODE_LEGACY
+import androidx.fragment.app.Fragment
+import androidx.lifecycle.lifecycleScope
+import com.google.samples.apps.iosched.widget.FadingSnackbar
+import kotlinx.coroutines.flow.collect
+
+/**
+ * An extension for Fragments that sets up a Snackbar with a [SnackbarMessageManager].
+ */
+fun Fragment.setupSnackbarManager(
+    snackbarMessageManager: SnackbarMessageManager,
+    fadingSnackbar: FadingSnackbar
+) {
+    viewLifecycleOwner.lifecycleScope.launchWhenStarted {
+        snackbarMessageManager.currentSnackbar.collect { message ->
+            if (message == null) { return@collect }
+            val messageText = HtmlCompat.fromHtml(
+                requireContext().getString(message.messageId, message.session?.title),
+                FROM_HTML_MODE_LEGACY
+            )
+            fadingSnackbar.show(
+                messageText = messageText,
+                actionId = message.actionId,
+                longDuration = message.longDuration,
+                actionClick = {
+                    snackbarMessageManager.processDismissedMessage(message)
+                    fadingSnackbar.dismiss()
+                },
+                // When the snackbar is dismissed, ping the snackbar message manager in case there
+                // are pending messages.
+                dismissListener = {
+                    snackbarMessageManager.removeMessageAndLoadNext(message)
+                }
+            )
+        }
+    }
+}

mobile/src/main/java/com/google/samples/apps/iosched/ui/messages/SnackbarMessageFragmentExtensions.kt

@@ -19,10 +19,13 @@ package com.google.samples.apps.iosched.ui.messages
 import androidx.annotation.VisibleForTesting
 import com.google.samples.apps.iosched.R
 import com.google.samples.apps.iosched.shared.data.prefs.PreferenceStorage
-import com.google.samples.apps.iosched.ui.SnackbarMessage
+import com.google.samples.apps.iosched.shared.di.ApplicationScope
+import com.google.samples.apps.iosched.shared.domain.prefs.StopSnackbarActionUseCase
 import com.google.samples.apps.iosched.ui.messages.SnackbarMessageManager.Companion.MAX_ITEMS
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.launch
 import timber.log.Timber
 import javax.inject.Inject
 import javax.inject.Singleton
@@ -40,7 +43,9 @@ import javax.inject.Singleton
  */
 @Singleton
 open class SnackbarMessageManager @Inject constructor(
-    private val preferenceStorage: PreferenceStorage
+    private val preferenceStorage: PreferenceStorage,
+    @ApplicationScope private val coroutineScope: CoroutineScope,
+    private val stopSnackbarActionUseCase: StopSnackbarActionUseCase
 ) {
     companion object {
         // Keep a fixed number of old items
@@ -86,6 +91,14 @@ open class SnackbarMessageManager @Inject constructor(
         loadNext()
     }
 
+    fun processDismissedMessage(message: SnackbarMessage) {
+        if (message.actionId == R.string.dont_show) {
+            coroutineScope.launch {
+                stopSnackbarActionUseCase(true)
+            }
+        }
+    }
+
     private fun shouldSnackbarBeIgnored(msg: SnackbarMessage): Boolean {
         // TODO: This should call a suspend fun (migrate to datastore)
         return preferenceStorage.observableSnackbarIsStopped.value == true &&