Merge pull request #15601 from wordpress-mobile/issue/15215-my-site-dashboard-ptr

zwarm · web-flow · commit 2895daea5d46 · 2021-12-01T08:09:49.000-05:00
My Site Dashboard-Phase 2: Implement pull-to-refresh
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/mysite/MySiteFragment.kt b/WordPress/src/main/java/org/wordpress/android/ui/mysite/MySiteFragment.kt
@@ -95,6 +95,9 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
 
     private var binding: MySiteFragmentBinding? = null
 
+    // Capture and track the first `onResume` event so we can circumvent refreshing sources on initial onResume
+    private var isFirstResume = true
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         // The following prevents the soft keyboard from leaving a white space when dismissed.
@@ -174,7 +177,7 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
 
         swipeToRefreshHelper = buildSwipeToRefreshHelper(swipeRefreshLayout) {
             if (NetworkUtils.checkConnection(requireActivity())) {
-                viewModel.onPullToRefresh()
+                viewModel.refresh()
             } else {
                 swipeToRefreshHelper.isRefreshing = false
             }
@@ -185,6 +188,7 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
     private fun MySiteFragmentBinding.setupObservers() {
         viewModel.uiModel.observe(viewLifecycleOwner, { uiModel ->
             loadGravatar(uiModel.accountAvatarUrl)
+            hideRefreshIndicatorIfNeeded()
             when (val state = uiModel.state) {
                 is State.SiteSelected -> loadData(state.cardAndItems)
                 is State.NoSites -> loadEmptyView(state.shouldShowImage)
@@ -372,8 +376,8 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
 
     override fun onResume() {
         super.onResume()
-        viewModel.refresh()
-        viewModel.checkAndShowQuickStartNotice()
+        viewModel.onResume(isFirstResume)
+        isFirstResume = false
     }
 
     override fun onPause() {
@@ -512,10 +516,10 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
 
     private fun MySiteFragmentBinding.loadData(cardAndItems: List<MySiteCardAndItem>) {
         recyclerView.setVisible(true)
+        actionableEmptyView.setVisible(false)
         viewModel.setActionableEmptyViewGone(actionableEmptyView.isVisible) {
             actionableEmptyView.setVisible(false)
         }
-        swipeToRefreshHelper.isRefreshing = false
         (recyclerView.adapter as? MySiteAdapter)?.loadData(cardAndItems)
     }
 
@@ -525,7 +529,6 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
             actionableEmptyView.setVisible(true)
             actionableEmptyView.image.setVisible(shouldShowEmptyViewImage)
         }
-        swipeToRefreshHelper.isRefreshing = false
         actionableEmptyView.image.setVisible(shouldShowEmptyViewImage)
     }
 
@@ -555,6 +558,12 @@ class MySiteFragment : Fragment(R.layout.my_site_fragment),
         swipeToRefreshHelper.setEnabled(isEnabled)
     }
 
+    private fun hideRefreshIndicatorIfNeeded() {
+        if (swipeToRefreshHelper.isRefreshing) {
+            swipeToRefreshHelper.isRefreshing = viewModel.isRefreshing()
+        }
+    }
+
     companion object {
         private const val KEY_LIST_STATE = "key_list_state"
         private const val KEY_NESTED_LISTS_STATES = "key_nested_lists_states"
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/mysite/MySiteViewModel.kt b/WordPress/src/main/java/org/wordpress/android/ui/mysite/MySiteViewModel.kt
@@ -28,6 +28,7 @@ import org.wordpress.android.ui.mysite.MySiteCardAndItemBuilderParams.QuickActio
 import org.wordpress.android.ui.mysite.MySiteCardAndItemBuilderParams.QuickStartCardBuilderParams
 import org.wordpress.android.ui.mysite.MySiteCardAndItemBuilderParams.SiteInfoCardBuilderParams
 import org.wordpress.android.ui.mysite.MySiteCardAndItemBuilderParams.SiteItemsBuilderParams
+import org.wordpress.android.ui.mysite.MySiteSource.MySiteRefreshSource
 import org.wordpress.android.ui.mysite.MySiteSource.SiteIndependentSource
 import org.wordpress.android.ui.mysite.MySiteUiState.PartialState
 import org.wordpress.android.ui.mysite.MySiteViewModel.State.NoSites
@@ -114,10 +115,10 @@ class MySiteViewModel @Inject constructor(
     private val snackbarSequencer: SnackbarSequencer,
     private val cardsBuilder: CardsBuilder,
     private val dynamicCardsBuilder: DynamicCardsBuilder,
-    private val postCardsSource: PostCardsSource,
-    selectedSiteSource: SelectedSiteSource,
+    postCardsSource: PostCardsSource,
+    private val selectedSiteSource: SelectedSiteSource,
     siteIconProgressSource: SiteIconProgressSource,
-    mySiteDashboardPhase2FeatureConfig: MySiteDashboardPhase2FeatureConfig
+    private val mySiteDashboardPhase2FeatureConfig: MySiteDashboardPhase2FeatureConfig
 ) : ScopedViewModel(mainDispatcher) {
     private val _onSnackbarMessage = MutableLiveData<Event<SnackbarMessageHolder>>()
     private val _onTechInputDialogShown = MutableLiveData<Event<TextInputDialogModel>>()
@@ -126,7 +127,7 @@ class MySiteViewModel @Inject constructor(
     private val _onNavigation = MutableLiveData<Event<SiteNavigationAction>>()
     private val _onMediaUpload = MutableLiveData<Event<MediaModel>>()
     private val _activeTaskPosition = MutableLiveData<Pair<QuickStartTask, Int>>()
-    private val _onShowSwipeRefreshLayout = MutableLiveData((Event(mySiteDashboardPhase2FeatureConfig.isEnabled())))
+    private val _onShowSwipeRefreshLayout = MutableLiveData<Event<Boolean>>()
 
     val onScrollTo: LiveData<Event<Int>> = merge(
             _activeTaskPosition.distinctUntilChanged(),
@@ -159,25 +160,26 @@ class MySiteViewModel @Inject constructor(
             postCardsSource
     )
 
-    val state: LiveData<MySiteUiState> = selectedSiteRepository.siteSelected.switchMap { siteLocalId ->
-        val result = MediatorLiveData<SiteIdToState>()
-        val currentSources = if (siteLocalId != null) {
-            mySiteSources.map { source -> source.build(viewModelScope, siteLocalId).distinctUntilChanged() }
-        } else {
-            mySiteSources.filterIsInstance(SiteIndependentSource::class.java)
-                    .map { source -> source.build(viewModelScope).distinctUntilChanged() }
-        }
-        for (newSource in currentSources) {
-            result.addSource(newSource) { partialState ->
-                if (partialState != null) {
-                    result.value = (result.value ?: SiteIdToState(siteLocalId)).update(partialState)
+    val state: LiveData<MySiteUiState> =
+        selectedSiteRepository.siteSelected.switchMap { siteLocalId ->
+            val result = MediatorLiveData<SiteIdToState>()
+            val currentSources = if (siteLocalId != null) {
+                mySiteSources.map { source -> source.build(viewModelScope, siteLocalId).distinctUntilChanged() }
+            } else {
+                mySiteSources.filterIsInstance(SiteIndependentSource::class.java)
+                        .map { source -> source.build(viewModelScope).distinctUntilChanged() }
+            }
+            for (newSource in currentSources) {
+                result.addSource(newSource) { partialState ->
+                    if (partialState != null) {
+                        result.value = (result.value ?: SiteIdToState(siteLocalId)).update(partialState)
+                    }
                 }
             }
-        }
-        // We want to filter out the empty state where we have a site ID but site object is missing.
-        // Without this check there is an emission of a NoSites state even if we have the site
-        result.filter { it.siteId == null || it.state.site != null }.map { it.state }
-    }.distinctUntilChanged()
+            // We want to filter out the empty state where we have a site ID but site object is missing.
+            // Without this check there is an emission of a NoSites state even if we have the site
+            result.filter { it.siteId == null || it.state.site != null }.map { it.state }
+        }.distinctUntilChanged()
 
     val uiModel: LiveData<UiModel> = state.map { (
             currentAvatarUrl,
@@ -483,11 +485,36 @@ class MySiteViewModel @Inject constructor(
     }
 
     fun refresh() {
+        if (mySiteDashboardPhase2FeatureConfig.isEnabled()) {
+            refreshNew()
+        } else {
+            refreshOld()
+        }
+    }
+
+    private fun refreshNew() {
+        mySiteSources.filterIsInstance(MySiteRefreshSource::class.java).forEach { it.refresh() }
+    }
+
+    private fun refreshOld() {
         selectedSiteRepository.updateSiteSettingsIfNecessary()
         quickStartCardSource.refresh()
         currentAvatarSource.refresh()
     }
 
+    fun onResume(isFirstResume: Boolean) {
+        when (isFirstResume) {
+            true -> refreshOld()
+            false -> if (mySiteDashboardPhase2FeatureConfig.isEnabled()) {
+                refreshNew()
+            } else {
+                refreshOld()
+            }
+        }
+        checkAndShowQuickStartNotice()
+        _onShowSwipeRefreshLayout.postValue(Event(mySiteDashboardPhase2FeatureConfig.isEnabled()))
+    }
+
     fun clearActiveQuickStartTask() {
         quickStartRepository.clearActiveTask()
     }
@@ -671,6 +698,7 @@ class MySiteViewModel @Inject constructor(
         domainRegistrationSource.clear()
         quickStartRepository.clear()
         scanAndBackupSource.clear()
+        selectedSiteSource.clear()
         super.onCleared()
     }
 
@@ -738,10 +766,6 @@ class MySiteViewModel @Inject constructor(
         analyticsTrackerWrapper.track(Stat.QUICK_START_REQUEST_DIALOG_NEGATIVE_TAPPED)
     }
 
-    fun onPullToRefresh() {
-        postCardsSource.refresh()
-    }
-
     private fun onPostItemClick(postId: Int) {
         selectedSiteRepository.getSelectedSite()?.let { site ->
             _onNavigation.value = Event(SiteNavigationAction.EditPost(site, postId))
@@ -759,6 +783,19 @@ class MySiteViewModel @Inject constructor(
         }
     }
 
+    fun isRefreshing() = areSourcesRefreshing()
+
+    private fun areSourcesRefreshing(): Boolean {
+        if (mySiteDashboardPhase2FeatureConfig.isEnabled()) {
+            mySiteSources.filterIsInstance(MySiteRefreshSource::class.java).forEach {
+                if (it.isRefreshing() == true) {
+                    return true
+                }
+            }
+        }
+        return false
+    }
+
     fun setActionableEmptyViewGone(isVisible: Boolean, setGone: () -> Unit) {
         if (isVisible) analyticsTrackerWrapper.track(Stat.MY_SITE_NO_SITES_VIEW_HIDDEN)
         setGone()
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/mysite/SelectedSiteSource.kt b/WordPress/src/main/java/org/wordpress/android/ui/mysite/SelectedSiteSource.kt
@@ -12,9 +12,7 @@ import org.wordpress.android.ui.mysite.MySiteUiState.PartialState.SelectedSite
 import org.wordpress.android.util.filter
 import org.wordpress.android.util.map
 import javax.inject.Inject
-import javax.inject.Singleton
 
-@Singleton
 class SelectedSiteSource @Inject constructor(
     private val selectedSiteRepository: SelectedSiteRepository,
     private val dispatcher: Dispatcher
diff --git a/WordPress/src/test/java/org/wordpress/android/ui/mysite/MySiteViewModelTest.kt b/WordPress/src/test/java/org/wordpress/android/ui/mysite/MySiteViewModelTest.kt
