Improve sync observability around disabling (#6623)

Task/Issue URL:
https://app.asana.com/1/137249556945/project/488551667048375/task/1211103035810276?focus=true

### Description
Adds a pixel for when sync is disabled, and one for when it is disabled
with account deletion.

### Steps to test this PR
Add logcat filter `Pixel url request:.*sync_disabled`

- [x] Enable sync (`Settings -> Sync & Backup -> Sync and Back Up This
Device`)
- [x] Tap `Turn Off Sync & Backup` and confirm. Verify `sync_disabled`
pixel in logs.
- [x] Enable sync again
- [x] Tap `Turn Off and Delete Server Data` and confirm. 
- [x] Verify `sync_disabledanddeleted` pixel in logs, and it has param
`connected_devices`

Co-authored-by: Craig Russell <[email protected]>

Author: CDRussell

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/SyncAccountRepository.kt

@@ -564,6 +564,8 @@ class AppSyncAccountRepository @Inject constructor(
     }
 
     override fun deleteAccount(): Result<Boolean> {
+        syncPixels.fireUserConfirmedToTurnOffSyncAndDelete(connectedDevicesCached.size)
+
         val token = syncStore.token.takeUnless {
             it.isNullOrEmpty()
         } ?: return Error(reason = "Delete account: Token Empty").alsoFireDeleteAccountErrorPixel()

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/pixels/SyncPixels.kt

@@ -19,19 +19,24 @@ package com.duckduckgo.sync.impl.pixels
 import android.content.SharedPreferences
 import androidx.core.content.edit
 import com.duckduckgo.app.statistics.pixels.Pixel
+import com.duckduckgo.common.utils.plugins.pixel.PixelParamRemovalPlugin
+import com.duckduckgo.common.utils.plugins.pixel.PixelParamRemovalPlugin.PixelParameter
+import com.duckduckgo.common.utils.plugins.pixel.PixelParamRemovalPlugin.PixelParameter.Companion.removeAtb
 import com.duckduckgo.di.scopes.AppScope
 import com.duckduckgo.sync.api.engine.SyncableType
 import com.duckduckgo.sync.impl.API_CODE
 import com.duckduckgo.sync.impl.Result.Error
 import com.duckduckgo.sync.impl.pixels.SyncPixelName.SYNC_DAILY
 import com.duckduckgo.sync.impl.pixels.SyncPixelName.SYNC_DAILY_SUCCESS_RATE_PIXEL
 import com.duckduckgo.sync.impl.pixels.SyncPixelName.SYNC_OBJECT_LIMIT_EXCEEDED_DAILY
+import com.duckduckgo.sync.impl.pixels.SyncPixelParameters.CONNECTED_DEVICES_WHEN_DELETING
 import com.duckduckgo.sync.impl.pixels.SyncPixelParameters.SYNC_FEATURE_PROMOTION_SOURCE
 import com.duckduckgo.sync.impl.pixels.SyncPixelParameters.SYNC_SETUP_SCREEN_TYPE
 import com.duckduckgo.sync.impl.pixels.SyncPixels.ScreenType
 import com.duckduckgo.sync.impl.stats.SyncStatsRepository
 import com.duckduckgo.sync.store.SharedPrefsProvider
 import com.squareup.anvil.annotations.ContributesBinding
+import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.SingleInstanceIn
 import java.time.Instant
 import java.time.format.DateTimeFormatter
@@ -108,6 +113,8 @@ interface SyncPixels {
     fun fireSetupDeepLinkFlowStarted()
     fun fireSetupDeepLinkFlowSuccess()
     fun fireSetupDeepLinkFlowAbandoned()
+    fun fireUserConfirmedToTurnOffSync()
+    fun fireUserConfirmedToTurnOffSyncAndDelete(connectedDevices: Int)
 }
 
 @ContributesBinding(AppScope::class)
@@ -322,6 +329,15 @@ class RealSyncPixels @Inject constructor(
         pixel.fire(SyncPixelName.SYNC_SETUP_DEEP_LINK_FLOW_ABANDONED)
     }
 
+    override fun fireUserConfirmedToTurnOffSync() {
+        pixel.fire(SyncPixelName.SYNC_USER_CONFIRMED_TO_TURN_OFF_SYNC)
+    }
+
+    override fun fireUserConfirmedToTurnOffSyncAndDelete(connectedDevices: Int) {
+        val params = mapOf(CONNECTED_DEVICES_WHEN_DELETING to connectedDevices.toString())
+        pixel.fire(SyncPixelName.SYNC_USER_CONFIRMED_TO_TURN_OFF_SYNC_AND_DELETE, parameters = params)
+    }
+
     override fun fireSyncBarcodeScreenShown(screenType: ScreenType) {
         val params = mapOf(SYNC_SETUP_SCREEN_TYPE to screenType.value)
         pixel.fire(SyncPixelName.SYNC_SETUP_BARCODE_SCREEN_SHOWN, parameters = params)
@@ -434,6 +450,8 @@ enum class SyncPixelName(override val pixelName: String) : Pixel.PixelName {
     SYNC_SETUP_MANUAL_CODE_ENTERED_FAILED("sync_setup_manual_code_entered_failed"),
     SYNC_SETUP_ENDED_ABANDONED("sync_setup_ended_abandoned"),
     SYNC_SETUP_ENDED_SUCCESS("sync_setup_ended_successful"),
+    SYNC_USER_CONFIRMED_TO_TURN_OFF_SYNC("sync_disabled"),
+    SYNC_USER_CONFIRMED_TO_TURN_OFF_SYNC_AND_DELETE("sync_disabledanddeleted"),
 }
 
 object SyncPixelParameters {
@@ -455,4 +473,18 @@ object SyncPixelParameters {
     const val SYNC_FEATURE_PROMOTION_SOURCE = "source"
     const val GET_OTHER_DEVICES_SCREEN_LAUNCH_SOURCE = "source"
     const val SYNC_SETUP_SCREEN_TYPE = "source"
+    const val CONNECTED_DEVICES_WHEN_DELETING = "connected_devices"
+}
+
+@ContributesMultibinding(
+    scope = AppScope::class,
+    boundType = PixelParamRemovalPlugin::class,
+)
+object SyncPixelsRequiringDataCleaning : PixelParamRemovalPlugin {
+    override fun names(): List<Pair<String, Set<PixelParameter>>> {
+        return listOf(
+            SyncPixelName.SYNC_USER_CONFIRMED_TO_TURN_OFF_SYNC.pixelName to removeAtb(),
+            SyncPixelName.SYNC_USER_CONFIRMED_TO_TURN_OFF_SYNC_AND_DELETE.pixelName to removeAtb(),
+        )
+    }
 }

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/ui/SyncActivityViewModel.kt

@@ -264,6 +264,8 @@ class SyncActivityViewModel @Inject constructor(
 
     fun onTurnOffSyncConfirmed(connectedDevice: ConnectedDevice) {
         viewModelScope.launch(dispatchers.io()) {
+            syncPixels.fireUserConfirmedToTurnOffSync()
+
             viewState.value = viewState.value.hideAccount()
             when (val result = syncAccountRepository.logout(connectedDevice.deviceId)) {
                 is Error -> {

sync/sync-impl/src/test/java/com/duckduckgo/sync/impl/AppSyncAccountRepositoryTest.kt

@@ -883,6 +883,32 @@ class AppSyncAccountRepositoryTest {
         }
     }
 
+    @Test
+    fun whenAccountDeletedWithASingleConnectedDeviceThenPixelFired() {
+        prepareForExchangeSuccess()
+        whenever(syncApi.deleteAccount(token)).thenReturn(deleteAccountSuccess)
+        configureAsSignedWithConnectedDevices(1)
+        syncRepo.deleteAccount()
+        verify(syncPixels).fireUserConfirmedToTurnOffSyncAndDelete(eq(1))
+    }
+
+    @Test
+    fun whenAccountDeletedWithMultipleConnectedDevicesThenPixelFired() {
+        prepareForExchangeSuccess()
+        whenever(syncApi.deleteAccount(token)).thenReturn(deleteAccountSuccess)
+        configureAsSignedWithConnectedDevices(10)
+        syncRepo.deleteAccount()
+        verify(syncPixels).fireUserConfirmedToTurnOffSyncAndDelete(eq(10))
+    }
+
+    @Test
+    fun whenAccountDeletedWithNoConnectedDevicesThenPixelFired() {
+        prepareForExchangeSuccess()
+        whenever(syncApi.deleteAccount(token)).thenReturn(deleteAccountSuccess)
+        syncRepo.deleteAccount()
+        verify(syncPixels).fireUserConfirmedToTurnOffSyncAndDelete(eq(0))
+    }
+
     private fun configureUrlWrappedCodeFeatureFlagState(enabled: Boolean) {
         syncFeature.syncSetupBarcodeIsUrlBased().setRawStoredState(State(enable = enabled))
     }

sync/sync-impl/src/test/java/com/duckduckgo/sync/impl/ui/SyncActivityViewModelTest.kt

@@ -263,6 +263,16 @@ class SyncActivityViewModelTest {
         verify(syncAccountRepository).logout(deviceId)
     }
 
+    @Test
+    fun whenTurnOffSyncConfirmedThenPixelFired() = runTest {
+        whenever(syncAccountRepository.getThisConnectedDevice()).thenReturn(connectedDevice)
+        whenever(syncAccountRepository.logout(deviceId)).thenReturn(Result.Success(true))
+
+        testee.onTurnOffSyncConfirmed(connectedDevice)
+
+        verify(syncPixels).fireUserConfirmedToTurnOffSync()
+    }
+
     @Test
     fun whenLogoutSuccessThenUpdateViewState() = runTest {
         givenAuthenticatedUser()