[Draft] Added snackbar to show success / failure of network data

app/res/values/strings.xml

@@ -699,5 +699,7 @@
     <string name="personalid_tooltip_location_success_message">We use location data to ensure secure usage of this application.\n\n<a href="https://www.dimagi.com/terms/latest/privacy/">Click here for more info</a>.</string>
 
     <string name="network_forbidden_error">Access denied. Please contact customer support if the problem persists.</string>
+    <string name="new_network_data_success">New data is available; press here to refresh.</string>
+    <string name="new_network_data_failure">Failed to refresh. You may be viewing outdated data.</string>
 
 </resources>

app/src/org/commcare/fragments/base/BaseConnectFragment.kt

@@ -6,9 +6,14 @@ import android.view.View
 import android.view.ViewGroup
 import android.widget.FrameLayout
 import androidx.fragment.app.Fragment
+import androidx.lifecycle.Observer
 import androidx.viewbinding.ViewBinding
+import org.commcare.dalvik.R
 import org.commcare.dalvik.databinding.LoadingBinding
+import org.commcare.fragments.connect.base.BaseNetworkStateViewModel
+import org.commcare.fragments.connect.base.BaseNetworkStateViewModel.NetworkState.Loading
 import org.commcare.interfaces.base.BaseConnectView
+import org.commcare.utils.ViewUtils
 
 abstract class BaseConnectFragment<B : ViewBinding> :
     Fragment(),
@@ -19,6 +24,8 @@ abstract class BaseConnectFragment<B : ViewBinding> :
     private lateinit var loadingBinding: LoadingBinding
     private lateinit var rootView: View
 
+    protected var baseNetworkStateViewModel: BaseNetworkStateViewModel? = null
+
     /**
      * Implement this method in child fragments to inflate their specific binding.
      */
@@ -75,4 +82,52 @@ abstract class BaseConnectFragment<B : ViewBinding> :
     override fun hideLoading() {
         loadingBinding.root.visibility = View.GONE
     }
+
+    fun startListeningToNetworkState() {
+        baseNetworkStateViewModel?.networkState?.observe(
+            getViewLifecycleOwner(),
+            Observer { networkState: BaseNetworkStateViewModel.NetworkState ->
+                when (networkState) {
+                    is BaseNetworkStateViewModel.NetworkState.Error -> {
+                        showNetworkFailureSnackBar()
+                    }
+                    Loading -> {
+                    }
+                    is BaseNetworkStateViewModel.NetworkState.Success -> {
+                        if (networkState.state) {
+                            showNetworkSuccessSnackBar()
+                        } else {
+                            showNetworkFailureSnackBar()
+                        }
+                    }
+                }
+            },
+        )
+    }
+
+    fun showNetworkSuccessSnackBar() {
+        ViewUtils.showSnackBarWith(
+            getString(R.string.refresh),
+            view,
+            getString(R.string.new_network_data_success),
+            View.OnClickListener { v: View? ->
+                refreshUiWithNetworkData()
+            },
+        )
+    }
+
+    fun showNetworkFailureSnackBar() {
+        ViewUtils.showSnackBarWith(
+            getString(R.string.ok),
+            view,
+            getString(R.string.new_network_data_failure),
+            View.OnClickListener { v: View? ->
+                showOldDataOnUi()
+            },
+        )
+    }
+
+    open fun refreshUiWithNetworkData() {}
+
+    open fun showOldDataOnUi() {}
 }

app/src/org/commcare/fragments/connect/ConnectDeliveryDetailsFragment.java

@@ -107,7 +107,7 @@ public void onFailure(@NonNull PersonalIdOrConnectApiErrorCodes errorCode, @Null
                 } else {
                     message = PersonalIdOrConnectApiErrorHandler.handle(requireActivity(), errorCode, t);
                 }
-                showSnackBarWithDismissAction(getBinding().getRoot(), message);
+                showSnackBarWithDismissAction(getString(R.string.ok),getBinding().getRoot(), message);
                 FirebaseAnalyticsUtil.reportCccApiClaimJob(false);
             }
         }.claimJob(requireContext(), user, job.getJobId());

app/src/org/commcare/fragments/connect/ConnectDeliveryProgressFragment.java

@@ -10,6 +10,7 @@
 import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentManager;
 import androidx.lifecycle.Lifecycle;
+import androidx.lifecycle.ViewModelProvider;
 import androidx.navigation.Navigation;
 import androidx.viewpager2.adapter.FragmentStateAdapter;
 import androidx.viewpager2.widget.ViewPager2;
@@ -58,6 +59,7 @@ public static ConnectDeliveryProgressFragment newInstance() {
             initialTabPosition = getArguments().getInt(TAB_POSITION, TAB_PROGRESS);
         }
 
+        setUpViewModel();
         setupTabViewPager();
         setupJobCard(job);
         setupRefreshAndConfirmationActions();
@@ -114,17 +116,28 @@ public void onTabReselected(TabLayout.Tab tab) {
         });
     }
 
+    private void setUpViewModel() {
+        setBaseNetworkStateViewModel(new ViewModelProvider(this).get(ConnectDeliveryProgressFragmentViewModel.class));
+        startListeningToNetworkState();
+    }
+
     @Override
-    public void refresh() {
+    public void refreshUiWithNetworkData() {
+        updateLastUpdatedText(new Date());
+        updateCardMessage();
+        updatePaymentConfirmationTile(false);
+        viewPagerAdapter.refresh();
+    }
+
+    public void fetchDeliveryProgress() {
         setWaitDialogEnabled(false);
-        ConnectJobHelper.INSTANCE.updateDeliveryProgress(getContext(), job, true, this, success -> {
-            if (success) {
-                updateLastUpdatedText(new Date());
-                updateCardMessage();
-                updatePaymentConfirmationTile(false);
-                viewPagerAdapter.refresh();
-            }
-        });
+        ((ConnectDeliveryProgressFragmentViewModel)getBaseNetworkStateViewModel()).fetchData(requireContext(), job, this);
+    }
+
+    @Override
+    public void refresh() {
+        ((ConnectDeliveryProgressFragmentViewModel)getBaseNetworkStateViewModel()).setShowLoading(true);
+        fetchDeliveryProgress();
     }
 
     private void setWaitDialogEnabled(boolean enabled) {
@@ -176,7 +189,7 @@ private void setupJobCard(ConnectJobRecord job) {
     public void onResume() {
         super.onResume();
         if (PersonalIdManager.getInstance().isloggedIn()) {
-            refresh();
+            fetchDeliveryProgress();
         }
     }
 

app/src/org/commcare/fragments/connect/ConnectDeliveryProgressFragmentViewModel.kt

@@ -0,0 +1,44 @@
+package org.commcare.fragments.connect
+
+import android.content.Context
+import org.commcare.android.database.connect.models.ConnectJobRecord
+import org.commcare.connect.ConnectActivityCompleteListener
+import org.commcare.connect.ConnectJobHelper
+import org.commcare.fragments.connect.base.BaseNetworkStateViewModel
+import org.commcare.interfaces.base.BaseConnectView
+import java.util.Date
+
+class ConnectDeliveryProgressFragmentViewModel : BaseNetworkStateViewModel() {
+    var previousLastUpdatedOn: Date? = null
+    var showLoading = false // by default should be false, only true whenever user presses sync button
+
+    fun fetchData(
+        context: Context,
+        job: ConnectJobRecord,
+        view: BaseConnectView,
+    ) {
+//        TODO
+//        lastModifiedOn = job.lastUpdate // this parameter is not coming currently from server.
+        launchTask {
+            ConnectJobHelper.updateDeliveryProgress(
+                context,
+                job,
+                showLoading,
+                view,
+                object : ConnectActivityCompleteListener {
+                    override fun connectActivityComplete(success: Boolean) {
+                        showLoading = false // back to default value
+                        //  TODO
+                        //  Real check is `success && job.lastUpdate>previousLastUpdatedOn`
+                        //  to be used whenever server starts sending lastModifiedOn
+                        if (success) {
+                            networkStateLiveData.value = NetworkState.Success(success)
+                        } else {
+                            networkStateLiveData.value = NetworkState.Error(Exception("UNKNOWN_EXCEPTION"))
+                        }
+                    }
+                },
+            )
+        }
+    }
+}

app/src/org/commcare/fragments/connect/base/BaseNetworkStateViewModel.kt

@@ -0,0 +1,37 @@
+package org.commcare.fragments.connect.base
+
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import kotlinx.coroutines.CoroutineExceptionHandler
+import kotlinx.coroutines.launch
+
+open class BaseNetworkStateViewModel : ViewModel() {
+    sealed class NetworkState {
+        object Loading : NetworkState()
+
+        data class Success(
+            val state: Boolean,
+        ) : NetworkState()
+
+        data class Error(
+            val exception: Exception,
+        ) : NetworkState()
+    }
+
+    protected val networkStateLiveData = MutableLiveData<NetworkState>()
+    val networkState: LiveData<NetworkState> = networkStateLiveData
+
+    protected val handler =
+        CoroutineExceptionHandler { _, exception ->
+            networkStateLiveData.value = NetworkState.Error(if (exception is Exception) exception else Exception(exception))
+        }
+
+    protected fun launchTask(task: suspend () -> Unit) {
+        viewModelScope.launch(handler) {
+            networkStateLiveData.value = NetworkState.Loading
+            task()
+        }
+    }
+}

app/src/org/commcare/fragments/personalId/PersonalIdBiometricConfigFragment.java

@@ -40,7 +40,7 @@
 import static org.commcare.connect.PersonalIdManager.BIOMETRIC_INVALIDATION_KEY;
 import static org.commcare.google.services.analytics.AnalyticsParamValue.CONTINUE_WITH_FINGERPRINT;
 import static org.commcare.google.services.analytics.AnalyticsParamValue.CONTINUE_WITH_PIN;
-import static org.commcare.utils.ViewUtils.showSnackBarWithOk;
+import static org.commcare.utils.ViewUtils.showSnackBarWith;
 
 /**
  * Fragment that handles biometric or PIN verification for Connect ID authentication.
@@ -297,7 +297,7 @@ private void navigateForward(boolean enrollmentFailed) {
                 } else {
                     View view = getView();
                     if (view != null) {
-                        showSnackBarWithOk(view, getString(R.string.connect_verify_skip_phone_number),
+                        showSnackBarWith(getString(R.string.ok),view, getString(R.string.connect_verify_skip_phone_number),
                                 v -> NavHostFragment.findNavController(this).navigate(navigateToNameScreen()));
                     }
                 }

app/src/org/commcare/utils/ViewUtils.java

@@ -8,21 +8,22 @@
 
 public class ViewUtils {
     /**
-     * Displays a SnackBar with the given message and an "OK" button.
-     * The SnackBar will remain visible indefinitely until the "OK" button is pressed.
+     * Displays a SnackBar with the given message and an button with provided text.
+     * The SnackBar will remain visible indefinitely until the button is pressed.
      *
+     * @param btnText         Button text
      * @param view            The view to find a parent from. This view is used to create the SnackBar.
      * @param message         The message text to show in the SnackBar.
      * @param okClickListener The callback to be invoked when the "OK" button is clicked.
      */
-    public static void showSnackBarWithOk(View view, String message, View.OnClickListener okClickListener) {
+    public static void showSnackBarWith(String btnText, View view, String message, View.OnClickListener okClickListener) {
         Snackbar.make(view, message, Snackbar.LENGTH_INDEFINITE)
-                .setAction("OK", okClickListener)
+                .setAction(btnText, okClickListener)
                 .show();
     }
-    public static void showSnackBarWithDismissAction(View view, String message) {
+    public static void showSnackBarWithDismissAction(String btnText,View view, String message) {
         Snackbar snackbar = Snackbar.make(view, message, Snackbar.LENGTH_INDEFINITE);
-        snackbar.setAction(view.getContext().getString(R.string.ok),v -> snackbar.dismiss());
+        snackbar.setAction(btnText,v -> snackbar.dismiss());
         snackbar.show();
     }
 }