Merge pull request #14971 from woocommerce/woomob-1697-disable-cellular-data-toggle-in-local-catalog-settings-in

[Woo POS][Local Catalog] Disable "cellular data" toggle if device doesn't have data modem

Author: kidinov

RELEASE-NOTES.txt

@@ -4,6 +4,7 @@
 
 23.8
 -----
+- [*] Optimized POS Local Catalog Settings screen [https://github.com/woocommerce/woocommerce-android/pull/14971]
 - [Internal][Woo POS] Improve detection and handling of deleted products during checkout [https://github.com/woocommerce/woocommerce-android/pull/14981]
 - [*][Woo POS] Fixed payment screen layout to properly position payment instructions text [https://github.com/woocommerce/woocommerce-android/pull/14991]
 - [*][Woo POS] Automatically scroll to newly created orders when returning to the Orders screen [https://github.com/woocommerce/woocommerce-android/pull/14990]

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/settings/details/localcatalog/WooPosSettingsLocalCatalogScreen.kt

@@ -84,12 +84,14 @@ private fun WooPosSettingsLocalCatalogScreen(
             catalogStatus = state.catalogStatus
         )
 
-        CellularDataSection(
-            allowCellularDataUpdate = state.allowCellularDataUpdate,
-            onToggleCellularData = onToggleCellularData,
-            isLoading = state.catalogStatus is WooPosSettingsLocalCatalogState.CatalogStatus.Loading ||
-                state.catalogStatus is WooPosSettingsLocalCatalogState.CatalogStatus.RefreshingCatalog
-        )
+        if (state.cellularCapability is WooPosSettingsLocalCatalogState.CellularCapability.Available) {
+            CellularDataSection(
+                allowCellularDataUpdate = state.cellularCapability.allowCellularDataUpdate,
+                onToggleCellularData = onToggleCellularData,
+                isLoading = state.catalogStatus is WooPosSettingsLocalCatalogState.CatalogStatus.Loading ||
+                    state.catalogStatus is WooPosSettingsLocalCatalogState.CatalogStatus.RefreshingCatalog
+            )
+        }
 
         ManualUpdateSection(
             catalogStatus = state.catalogStatus,
@@ -391,7 +393,29 @@ fun WooPosSettingsLocalCatalogScreenPreview() {
                     lastUpdate = "2 hours ago",
                     lastFullUpdate = "Yesterday at 3:45 PM"
                 ),
-                allowCellularDataUpdate = true
+                cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.Available(
+                    allowCellularDataUpdate = true
+                )
+            ),
+            onToggleCellularData = {},
+            onRefreshCatalog = {}
+        )
+    }
+}
+
+@WooPosPreview
+@Composable
+fun WooPosSettingsLocalCatalogScreenNoCellularPreview() {
+    WooPosTheme {
+        WooPosSettingsLocalCatalogScreen(
+            state = WooPosSettingsLocalCatalogState(
+                catalogStatus = WooPosSettingsLocalCatalogState.CatalogStatus.Available(
+                    productCount = 1250,
+                    variationCount = 3420,
+                    lastUpdate = "2 hours ago",
+                    lastFullUpdate = "Yesterday at 3:45 PM"
+                ),
+                cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.None
             ),
             onToggleCellularData = {},
             onRefreshCatalog = {}
@@ -406,7 +430,9 @@ fun WooPosSettingsLocalCatalogScreenLoadingPreview() {
         WooPosSettingsLocalCatalogScreen(
             state = WooPosSettingsLocalCatalogState(
                 catalogStatus = WooPosSettingsLocalCatalogState.CatalogStatus.Loading,
-                allowCellularDataUpdate = true
+                cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.Available(
+                    allowCellularDataUpdate = true
+                )
             ),
             onToggleCellularData = {},
             onRefreshCatalog = {}
@@ -421,7 +447,9 @@ fun WooPosSettingsLocalCatalogRefreshingPreview() {
         WooPosSettingsLocalCatalogScreen(
             state = WooPosSettingsLocalCatalogState(
                 catalogStatus = WooPosSettingsLocalCatalogState.CatalogStatus.RefreshingCatalog,
-                allowCellularDataUpdate = true
+                cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.Available(
+                    allowCellularDataUpdate = true
+                )
             ),
             onToggleCellularData = {},
             onRefreshCatalog = {}

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/settings/details/localcatalog/WooPosSettingsLocalCatalogState.kt

@@ -2,7 +2,7 @@ package com.woocommerce.android.ui.woopos.settings.details.localcatalog
 
 data class WooPosSettingsLocalCatalogState(
     val catalogStatus: CatalogStatus = CatalogStatus.Loading,
-    val allowCellularDataUpdate: Boolean = false,
+    val cellularCapability: CellularCapability = CellularCapability.None,
 ) {
     sealed class CatalogStatus {
         data class Available(
@@ -15,4 +15,9 @@ data class WooPosSettingsLocalCatalogState(
         object Loading : CatalogStatus()
         object RefreshingCatalog : CatalogStatus()
     }
+
+    sealed class CellularCapability {
+        object None : CellularCapability()
+        data class Available(val allowCellularDataUpdate: Boolean) : CellularCapability()
+    }
 }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/settings/details/localcatalog/WooPosSettingsLocalCatalogViewModel.kt

@@ -10,6 +10,7 @@ import com.woocommerce.android.ui.woopos.home.WooPosParentToChildrenEventReceive
 import com.woocommerce.android.ui.woopos.localcatalog.PosLocalCatalogSyncResult
 import com.woocommerce.android.ui.woopos.localcatalog.WooPosLocalCatalogSyncRepository
 import com.woocommerce.android.ui.woopos.localcatalog.WooPosLocalCatalogSyncScheduler
+import com.woocommerce.android.ui.woopos.util.WooPosCellularCapabilityDetector
 import com.woocommerce.android.ui.woopos.util.datastore.WooPosPreferencesRepository
 import com.woocommerce.android.ui.woopos.util.datastore.WooPosSyncTimestampManager
 import com.woocommerce.android.ui.woopos.util.format.WooPosDateFormatter
@@ -31,18 +32,30 @@ class WooPosSettingsLocalCatalogViewModel @Inject constructor(
     private val syncScheduler: WooPosLocalCatalogSyncScheduler,
     private val childToParentEventSender: WooPosChildrenToParentEventSender,
     private val parentToChildEventReceiver: WooPosParentToChildrenEventReceiver,
+    private val cellularCapabilityDetector: WooPosCellularCapabilityDetector,
 ) : ViewModel() {
     private val _state = MutableStateFlow(WooPosSettingsLocalCatalogState())
     val state: StateFlow<WooPosSettingsLocalCatalogState> = _state.asStateFlow()
 
     init {
+        checkCellularCapability()
+
         loadCatalogStatus()
 
         listenToCellularDataUpdateValue()
 
         listenToParentEvents()
     }
 
+    private fun checkCellularCapability() {
+        if (!cellularCapabilityDetector.hasCellularCapability()) {
+            _state.update { it.copy(cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.None) }
+            viewModelScope.launch {
+                preferencesRepository.setAllowCellularDataUpdate(false)
+            }
+        }
+    }
+
     private fun listenToParentEvents() {
         viewModelScope.launch {
             parentToChildEventReceiver.events.collect { event ->
@@ -90,8 +103,18 @@ class WooPosSettingsLocalCatalogViewModel @Inject constructor(
     private fun listenToCellularDataUpdateValue() {
         viewModelScope.launch {
             preferencesRepository.allowCellularDataUpdate.collect { allowCellularDataUpdate ->
-                _state.update {
-                    it.copy(allowCellularDataUpdate = allowCellularDataUpdate)
+                _state.update { currentState ->
+                    if (cellularCapabilityDetector.hasCellularCapability()) {
+                        currentState.copy(
+                            cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.Available(
+                                allowCellularDataUpdate = allowCellularDataUpdate
+                            )
+                        )
+                    } else {
+                        currentState.copy(
+                            cellularCapability = WooPosSettingsLocalCatalogState.CellularCapability.None
+                        )
+                    }
                 }
             }
         }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/util/WooPosCellularCapabilityDetector.kt

@@ -0,0 +1,16 @@
+package com.woocommerce.android.ui.woopos.util
+
+import android.content.Context
+import android.content.pm.PackageManager
+import dagger.Reusable
+import dagger.hilt.android.qualifiers.ApplicationContext
+import javax.inject.Inject
+
+@Reusable
+class WooPosCellularCapabilityDetector @Inject constructor(
+    @ApplicationContext private val context: Context
+) {
+    fun hasCellularCapability(): Boolean {
+        return context.packageManager.hasSystemFeature(PackageManager.FEATURE_TELEPHONY)
+    }
+}

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/woopos/settings/details/localcatalog/WooPosSettingsLocalCatalogViewModelTest.kt

@@ -8,6 +8,7 @@ import com.woocommerce.android.ui.woopos.home.WooPosParentToChildrenEventReceive
 import com.woocommerce.android.ui.woopos.localcatalog.PosLocalCatalogSyncResult
 import com.woocommerce.android.ui.woopos.localcatalog.WooPosLocalCatalogSyncRepository
 import com.woocommerce.android.ui.woopos.localcatalog.WooPosLocalCatalogSyncScheduler
+import com.woocommerce.android.ui.woopos.util.WooPosCellularCapabilityDetector
 import com.woocommerce.android.ui.woopos.util.WooPosCoroutineTestRule
 import com.woocommerce.android.ui.woopos.util.datastore.WooPosPreferencesRepository
 import com.woocommerce.android.ui.woopos.util.datastore.WooPosSyncTimestampManager
@@ -45,6 +46,7 @@ class WooPosSettingsLocalCatalogViewModelTest {
     private val syncScheduler: WooPosLocalCatalogSyncScheduler = mock()
     private val childToParentEventSender: WooPosChildrenToParentEventSender = mock()
     private val parentToChildEventReceiver: WooPosParentToChildrenEventReceiver = mock()
+    private val cellularCapabilityDetector: WooPosCellularCapabilityDetector = mock()
 
     private val mockSite: SiteModel = mock()
     private val allowCellularDataFlow = MutableStateFlow(false)
@@ -57,6 +59,7 @@ class WooPosSettingsLocalCatalogViewModelTest {
         whenever(selectedSite.get()).thenReturn(mockSite)
         whenever(preferencesRepository.allowCellularDataUpdate).thenReturn(allowCellularDataFlow)
         whenever(parentToChildEventReceiver.events).thenReturn(parentEventsFlow)
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(true)
         whenever(localCatalogSyncRepository.syncLocalCatalogFull(any()))
             .thenReturn(
                 PosLocalCatalogSyncResult.Success(
@@ -79,26 +82,34 @@ class WooPosSettingsLocalCatalogViewModelTest {
     fun `given cellular data is disabled, when init, then state reflects disabled preference`() = runTest {
         // GIVEN
         allowCellularDataFlow.value = false
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(true)
 
         // WHEN
         sut = createViewModel()
         advanceUntilIdle()
 
         // THEN
-        assertThat(sut.state.value.allowCellularDataUpdate).isFalse()
+        val capability = sut.state.value.cellularCapability
+        assertThat(capability).isInstanceOf(WooPosSettingsLocalCatalogState.CellularCapability.Available::class.java)
+        assertThat((capability as WooPosSettingsLocalCatalogState.CellularCapability.Available).allowCellularDataUpdate)
+            .isFalse()
     }
 
     @Test
     fun `given cellular data is enabled, when init, then state reflects enabled preference`() = runTest {
         // GIVEN
         allowCellularDataFlow.value = true
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(true)
 
         // WHEN
         sut = createViewModel()
         advanceUntilIdle()
 
         // THEN
-        assertThat(sut.state.value.allowCellularDataUpdate).isTrue()
+        val capability = sut.state.value.cellularCapability
+        assertThat(capability).isInstanceOf(WooPosSettingsLocalCatalogState.CellularCapability.Available::class.java)
+        assertThat((capability as WooPosSettingsLocalCatalogState.CellularCapability.Available).allowCellularDataUpdate)
+            .isTrue()
     }
 
     @Test
@@ -118,16 +129,24 @@ class WooPosSettingsLocalCatalogViewModelTest {
     @Test
     fun `when cellular data preference changes, then state is updated`() = runTest {
         // GIVEN
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(true)
         sut = createViewModel()
         advanceUntilIdle()
-        assertThat(sut.state.value.allowCellularDataUpdate).isFalse()
+
+        var capability = sut.state.value.cellularCapability
+        assertThat(capability).isInstanceOf(WooPosSettingsLocalCatalogState.CellularCapability.Available::class.java)
+        assertThat((capability as WooPosSettingsLocalCatalogState.CellularCapability.Available).allowCellularDataUpdate)
+            .isFalse()
 
         // WHEN
         allowCellularDataFlow.value = true
         advanceUntilIdle()
 
         // THEN
-        assertThat(sut.state.value.allowCellularDataUpdate).isTrue()
+        capability = sut.state.value.cellularCapability
+        assertThat(capability).isInstanceOf(WooPosSettingsLocalCatalogState.CellularCapability.Available::class.java)
+        assertThat((capability as WooPosSettingsLocalCatalogState.CellularCapability.Available).allowCellularDataUpdate)
+            .isTrue()
     }
 
     @Test
@@ -295,6 +314,60 @@ class WooPosSettingsLocalCatalogViewModelTest {
             .isInstanceOf(WooPosSettingsLocalCatalogState.CatalogStatus.Available::class.java)
     }
 
+    @Test
+    fun `given device has cellular capability, when init, then cellularCapability is Available`() = runTest {
+        // GIVEN
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(true)
+
+        // WHEN
+        sut = createViewModel()
+        advanceUntilIdle()
+
+        // THEN
+        assertThat(sut.state.value.cellularCapability)
+            .isInstanceOf(WooPosSettingsLocalCatalogState.CellularCapability.Available::class.java)
+    }
+
+    @Test
+    fun `given device has no cellular capability, when init, then cellularCapability is None`() = runTest {
+        // GIVEN
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(false)
+
+        // WHEN
+        sut = createViewModel()
+        advanceUntilIdle()
+
+        // THEN
+        assertThat(sut.state.value.cellularCapability)
+            .isEqualTo(WooPosSettingsLocalCatalogState.CellularCapability.None)
+    }
+
+    @Test
+    fun `given device has no cellular capability, when init, then allowCellularDataUpdate is set to false in preferences`() = runTest {
+        // GIVEN
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(false)
+
+        // WHEN
+        sut = createViewModel()
+        advanceUntilIdle()
+
+        // THEN
+        verify(preferencesRepository).setAllowCellularDataUpdate(false)
+    }
+
+    @Test
+    fun `given device has cellular capability, when init, then allowCellularDataUpdate preference is not modified`() = runTest {
+        // GIVEN
+        whenever(cellularCapabilityDetector.hasCellularCapability()).thenReturn(true)
+
+        // WHEN
+        sut = createViewModel()
+        advanceUntilIdle()
+
+        // THEN
+        verify(preferencesRepository, times(0)).setAllowCellularDataUpdate(false)
+    }
+
     private fun createViewModel() = WooPosSettingsLocalCatalogViewModel(
         syncTimestampManager = syncTimestampManager,
         localCatalogSyncRepository = localCatalogSyncRepository,
@@ -304,5 +377,6 @@ class WooPosSettingsLocalCatalogViewModelTest {
         syncScheduler = syncScheduler,
         childToParentEventSender = childToParentEventSender,
         parentToChildEventReceiver = parentToChildEventReceiver,
+        cellularCapabilityDetector = cellularCapabilityDetector,
     )
 }