Pixels around sync promotion (#4921)

Task/Issue URL: https://app.asana.com/0/72649045549333/1207997744789996/f 

### Description
Pixels around promoting sync feature.

### Steps to test this PR

Logcat filter: `message~:"Pixel sent: m_sync_signup_direct" | message~:"Pixel sent: m_sync_signup_connect" | message~:"Pixel sent: sync_promotion_" | message~:"Pixel sent: sync_get_other_devices"`

- [x] Fresh install 

## Sync promo banners

### Bookmarks
- [x] visit Bookmarks screen; verify no pixels in logs about promo.
- [x] Add >= 1 bookmark. then visit Bookmarks
- [x] Verify `sync_promotion_displayed` in logs
- [x] Choose **Set Up Sync**; verify `sync_promotion_confirmed` in logs, with `source=bookmarks`
- [x] Go back and dismiss the promo; verify `sync_promotion_dismissed` in logs, with `source=bookmarks`

### Passwords
This is a copy of the last tests, but with passwords instead of bookmarks. 
- [x] Repeat tests above, making sure the same pixels are in the logs but with `source=passwords` for each of them

## Get DuckDuckGo on Other Devices
There are 3 ways to get to this screen from the sync flow:
- not signed into sync
- just finishing signing into sync
- already signed into sync

The same pixels apply for each, but will have a different `source` parameter in each scenario.

### Not signed into sync
- [x] Open **Sync & Backup**, tap on **Get DuckDuckGo on Other Devices**
- [x] Verify `sync_get_other_devices` is in logs, with `source=not_activated`
- [x] Tap on the **Share Download Link** button; verify `sync_get_other_devices_share` in logs, with `source=not_activated`
- [x] Cancel share sheet, and tap on blue link. Verify `sync_get_other_devices_copy` in logs, with `source=not_activated`

### Signing into sync
- [x] When not signed in, go through the process of signing in until you see the **Your data is synced!** screen
- [x] Tap on **Get DuckDuckGo on Other Devices**; verify `sync_get_other_devices` in logs, with `source=activating`
- [x] Repeat the share button and copy link steps above, verifying that `source=activating`

### When already signed in
- [x] Open **Sync & Backup**, tap on **Get DuckDuckGo on Other Devices**
- [x] Verify `sync_get_other_devices` with `source=activated`
- [x] Repeat the share button and copy link steps above, verifying that `source= activated `

## Sync set up pixels

### Signing into sync "directly"
- [x] Sign out of sync
- [x] Use the **bookmarks** sync promo to get to sync settings
- [x] Choose **Sync and Backup This Device** and complete sync flow.
- [x] Verify `m_sync_signup_direct` in logs, with `source=promotion_bookmarks`
- [x] Repeat the above steps using the **passwords** promo, ensuring that `source=promotion_passwords`
- [x] Repeat the above steps but this time do not use a promo; open Sync settings directly. Verify `m_sync_signup_direct` in logs, with no source param

### Syncing with another device
- [x] Sign out of sync
- [x] Use the **bookmarks** sync promo to get to sync settings
- [x] Choose **Sync With Another Device** and complete sync
- [x] Verify `m_sync_signup_connect` in logs, with `source=promotion_bookmarks`
- [x] Repeat the steps from **passwords** promo, ensuring `source=promotion_passwords
- [x] Repeat the steps again by not using a promo, visiting Sync settings directly. Ensure `m_sync_signup_connect` in logs but with no source param

Author: CDRussell

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

@@ -25,6 +25,16 @@ import javax.inject.Inject
 @ContributesMultibinding(AppScope::class)
 class SyncPixelParamRemovalPlugin @Inject constructor() : PixelParamRemovalPlugin {
     override fun names(): List<Pair<String, Set<PixelParameter>>> {
-        return listOf(SyncPixelName.SYNC_PATCH_COMPRESS_FAILED.pixelName to PixelParameter.removeAtb())
+        return listOf(
+            SyncPixelName.SYNC_PATCH_COMPRESS_FAILED.pixelName to PixelParameter.removeAtb(),
+
+            SyncPixelName.SYNC_FEATURE_PROMOTION_DISPLAYED.pixelName to PixelParameter.removeAtb(),
+            SyncPixelName.SYNC_FEATURE_PROMOTION_CONFIRMED.pixelName to PixelParameter.removeAtb(),
+            SyncPixelName.SYNC_FEATURE_PROMOTION_DISMISSED.pixelName to PixelParameter.removeAtb(),
+
+            SyncPixelName.SYNC_GET_OTHER_DEVICES_SCREEN_SHOWN.pixelName to PixelParameter.removeAtb(),
+            SyncPixelName.SYNC_GET_OTHER_DEVICES_LINK_COPIED.pixelName to PixelParameter.removeAtb(),
+            SyncPixelName.SYNC_GET_OTHER_DEVICES_LINK_SHARED.pixelName to PixelParameter.removeAtb(),
+        )
     }
 }

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

@@ -26,6 +26,7 @@ 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.SYNC_FEATURE_PROMOTION_SOURCE
 import com.duckduckgo.sync.impl.stats.SyncStatsRepository
 import com.duckduckgo.sync.store.SharedPrefsProvider
 import com.squareup.anvil.annotations.ContributesBinding
@@ -61,13 +62,15 @@ interface SyncPixels {
 
     /**
      * Fired when user sets up a sync account from connect flow
+     * @param source: the source of the signup, e.g. "promotion_bookmarks", "promotion_passwords" etc.... Can be null if not applicable.
      */
-    fun fireSignupConnectPixel()
+    fun fireSignupConnectPixel(source: String?)
 
     /**
      * Fired when user sets up a sync account directly.
+     * @param source: the source of the signup, e.g. "promotion_bookmarks", "promotion_passwords" etc.... Can be null if not applicable.
      */
-    fun fireSignupDirectPixel()
+    fun fireSignupDirectPixel(source: String?)
 
     fun fireSyncAccountErrorPixel(
         result: Error,
@@ -115,12 +118,12 @@ class RealSyncPixels @Inject constructor(
         pixel.fire(SyncPixelName.SYNC_LOGIN)
     }
 
-    override fun fireSignupConnectPixel() {
-        pixel.fire(SyncPixelName.SYNC_SIGNUP_CONNECT)
+    override fun fireSignupConnectPixel(source: String?) {
+        pixel.fire(SyncPixelName.SYNC_SIGNUP_CONNECT, buildSourceMap(source))
     }
 
-    override fun fireSignupDirectPixel() {
-        pixel.fire(SyncPixelName.SYNC_SIGNUP_DIRECT)
+    override fun fireSignupDirectPixel(source: String?) {
+        pixel.fire(SyncPixelName.SYNC_SIGNUP_DIRECT, buildSourceMap(source))
     }
 
     override fun fireSyncAccountErrorPixel(
@@ -244,6 +247,14 @@ class RealSyncPixels @Inject constructor(
         return "${this}_timestamp"
     }
 
+    private fun buildSourceMap(source: String?): Map<String, String> {
+        return if (source != null) {
+            mapOf(SYNC_FEATURE_PROMOTION_SOURCE to source)
+        } else {
+            emptyMap()
+        }
+    }
+
     companion object {
         private const val SYNC_PIXELS_PREF_FILE = "com.duckduckgo.sync.pixels.v1"
     }
@@ -283,6 +294,14 @@ enum class SyncPixelName(override val pixelName: String) : Pixel.PixelName {
     SYNC_OBJECT_LIMIT_EXCEEDED_DAILY("m_sync_%s_object_limit_exceeded_daily"),
     SYNC_REQUEST_SIZE_LIMIT_EXCEEDED_DAILY("m_sync_%s_request_size_limit_exceeded_daily"),
     SYNC_VALIDATION_ERROR_DAILY("m_sync_%s_validation_error_daily"),
+
+    SYNC_FEATURE_PROMOTION_DISPLAYED("sync_promotion_displayed"),
+    SYNC_FEATURE_PROMOTION_CONFIRMED("sync_promotion_confirmed"),
+    SYNC_FEATURE_PROMOTION_DISMISSED("sync_promotion_dismissed"),
+
+    SYNC_GET_OTHER_DEVICES_SCREEN_SHOWN("sync_get_other_devices"),
+    SYNC_GET_OTHER_DEVICES_LINK_COPIED("sync_get_other_devices_copy"),
+    SYNC_GET_OTHER_DEVICES_LINK_SHARED("sync_get_other_devices_share"),
 }
 
 object SyncPixelParameters {
@@ -301,4 +320,6 @@ object SyncPixelParameters {
     const val ERROR_CODE = "code"
     const val ERROR_REASON = "reason"
     const val ERROR = "error"
+    const val SYNC_FEATURE_PROMOTION_SOURCE = "source"
+    const val GET_OTHER_DEVICES_SCREEN_LAUNCH_SOURCE = "source"
 }

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/promotion/SyncGetOnOtherPlatformsActivity.kt

@@ -18,17 +18,18 @@ package com.duckduckgo.sync.impl.promotion
 
 import android.annotation.SuppressLint
 import android.content.ActivityNotFoundException
-import android.content.Context
 import android.content.Intent
 import android.os.Bundle
 import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.flowWithLifecycle
 import androidx.lifecycle.lifecycleScope
+import com.duckduckgo.anvil.annotations.ContributeToActivityStarter
 import com.duckduckgo.anvil.annotations.InjectWith
 import com.duckduckgo.common.ui.DuckDuckGoActivity
 import com.duckduckgo.common.ui.viewbinding.viewBinding
 import com.duckduckgo.di.scopes.ActivityScope
 import com.duckduckgo.navigation.api.GlobalActivityStarter
+import com.duckduckgo.navigation.api.getActivityParams
 import com.duckduckgo.sync.impl.R
 import com.duckduckgo.sync.impl.databinding.ActivitySyncGetOnOtherDevicesBinding
 import com.duckduckgo.sync.impl.promotion.SyncGetOnOtherPlatformsViewModel.Command
@@ -41,6 +42,7 @@ import kotlinx.coroutines.flow.onEach
 import timber.log.Timber
 
 @InjectWith(ActivityScope::class)
+@ContributeToActivityStarter(SyncGetOnOtherPlatformsParams::class)
 class SyncGetOnOtherPlatformsActivity : DuckDuckGoActivity() {
 
     private val viewModel: SyncGetOnOtherPlatformsViewModel by bindViewModel()
@@ -59,14 +61,17 @@ class SyncGetOnOtherPlatformsActivity : DuckDuckGoActivity() {
         setContentView(binding.root)
         setupToolbar(binding.includeToolbar.toolbar)
         configureUiEventHandlers()
+        if (savedInstanceState == null) {
+            viewModel.onScreenShownToUser(extractLaunchSource())
+        }
     }
 
     private fun configureUiEventHandlers() {
         binding.shareLinkButton.setOnClickListener {
-            viewModel.onShareClicked()
+            viewModel.onShareClicked(extractLaunchSource())
         }
         binding.downloadLinkText.setOnClickListener {
-            viewModel.onLinkClicked()
+            viewModel.onLinkClicked(extractLaunchSource())
         }
     }
 
@@ -96,9 +101,9 @@ class SyncGetOnOtherPlatformsActivity : DuckDuckGoActivity() {
         }
     }
 
-    companion object {
-        fun intent(context: Context): Intent {
-            return Intent(context, SyncGetOnOtherPlatformsActivity::class.java)
-        }
+    private fun extractLaunchSource(): String? {
+        return intent.getActivityParams(SyncGetOnOtherPlatformsParams::class.java)?.source
     }
 }
+
+data class SyncGetOnOtherPlatformsParams(val source: String?) : GlobalActivityStarter.ActivityParams

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/promotion/SyncGetOnOtherPlatformsViewModel.kt

@@ -23,6 +23,8 @@ import com.duckduckgo.app.clipboard.ClipboardInteractor
 import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.common.utils.DispatcherProvider
 import com.duckduckgo.di.scopes.ActivityScope
+import com.duckduckgo.sync.impl.pixels.SyncPixelName
+import com.duckduckgo.sync.impl.pixels.SyncPixelParameters.GET_OTHER_DEVICES_SCREEN_LAUNCH_SOURCE
 import com.duckduckgo.sync.impl.promotion.SyncGetOnOtherPlatformsViewModel.Command.ShareLink
 import com.duckduckgo.sync.impl.promotion.SyncGetOnOtherPlatformsViewModel.Command.ShowCopiedNotification
 import javax.inject.Inject
@@ -48,28 +50,40 @@ class SyncGetOnOtherPlatformsViewModel @Inject constructor(
 
     data class ViewState(val windowsFeatureEnabled: Boolean)
 
-    fun onShareClicked() {
+    fun onShareClicked(launchSource: String?) {
         viewModelScope.launch {
             commandChannel.send(ShareLink(buildLink()))
 
-            // todo - pixels
+            pixel.fire(SyncPixelName.SYNC_GET_OTHER_DEVICES_LINK_SHARED, buildSourceMap(launchSource))
         }
     }
 
-    fun onLinkClicked() {
+    fun onLinkClicked(launchSource: String?) {
         viewModelScope.launch(dispatchers.io()) {
             if (!clipboardInteractor.copyToClipboard(buildLink(), isSensitive = false)) {
                 commandChannel.send(ShowCopiedNotification)
             }
 
-            // todo - pixels
+            pixel.fire(SyncPixelName.SYNC_GET_OTHER_DEVICES_LINK_COPIED, buildSourceMap(launchSource))
         }
     }
 
     private fun buildLink(): String {
         return "$BASE_LINK?$ATTRIBUTION"
     }
 
+    fun onScreenShownToUser(launchSource: String?) {
+        pixel.fire(SyncPixelName.SYNC_GET_OTHER_DEVICES_SCREEN_SHOWN, buildSourceMap(launchSource))
+    }
+
+    private fun buildSourceMap(source: String?): Map<String, String> {
+        return if (source != null) {
+            mapOf(GET_OTHER_DEVICES_SCREEN_LAUNCH_SOURCE to source)
+        } else {
+            emptyMap()
+        }
+    }
+
     companion object {
         private const val BASE_LINK = "https://duckduckgo.com/app"
         private const val ATTRIBUTION = "origin=funnel_browser_android_sync"

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/promotion/bookmarks/SyncBookmarksPromotion.kt

@@ -34,13 +34,13 @@ import com.duckduckgo.di.scopes.ViewScope
 import com.duckduckgo.navigation.api.GlobalActivityStarter
 import com.duckduckgo.savedsites.api.promotion.BookmarksScreenPromotionPlugin
 import com.duckduckgo.savedsites.api.promotion.BookmarksScreenPromotionPlugin.Callback
-import com.duckduckgo.sync.api.SyncActivityWithEmptyParams
 import com.duckduckgo.sync.impl.R
 import com.duckduckgo.sync.impl.databinding.ViewSyncPromoBinding
 import com.duckduckgo.sync.impl.promotion.SyncPromotions
 import com.duckduckgo.sync.impl.promotion.bookmarks.SyncBookmarksPromotionViewModel.Command
 import com.duckduckgo.sync.impl.promotion.bookmarks.SyncBookmarksPromotionViewModel.Command.LaunchSyncSettings
 import com.duckduckgo.sync.impl.promotion.bookmarks.SyncBookmarksPromotionViewModel.Command.ReevalutePromo
+import com.duckduckgo.sync.impl.ui.SyncActivityWithSourceParams
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.android.support.AndroidSupportInjection
 import javax.inject.Inject
@@ -99,6 +99,8 @@ class SyncBookmarksPromotionView @JvmOverloads constructor(
             .launchIn(coroutineScope)
 
         configureMessage()
+
+        viewModel.onPromoShown()
     }
 
     override fun onDetachedFromWindow() {
@@ -120,7 +122,7 @@ class SyncBookmarksPromotionView @JvmOverloads constructor(
 
     private fun launchSyncSettings() {
         context?.let {
-            val intent = globalActivityStarter.startIntent(it, SyncActivityWithEmptyParams)
+            val intent = globalActivityStarter.startIntent(it, SyncActivityWithSourceParams(source = "promotion_bookmarks"))
             context.startActivity(intent)
         }
     }

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/promotion/bookmarks/SyncBookmarksPromotionViewModel.kt

@@ -19,7 +19,10 @@ package com.duckduckgo.sync.impl.promotion.bookmarks
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.duckduckgo.anvil.annotations.ContributesViewModel
+import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.di.scopes.ViewScope
+import com.duckduckgo.sync.impl.pixels.SyncPixelName
+import com.duckduckgo.sync.impl.pixels.SyncPixelParameters
 import com.duckduckgo.sync.impl.promotion.SyncPromotions
 import com.duckduckgo.sync.impl.promotion.bookmarks.SyncBookmarksPromotionViewModel.Command.LaunchSyncSettings
 import com.duckduckgo.sync.impl.promotion.bookmarks.SyncBookmarksPromotionViewModel.Command.ReevalutePromo
@@ -33,6 +36,7 @@ import kotlinx.coroutines.launch
 @ContributesViewModel(ViewScope::class)
 class SyncBookmarksPromotionViewModel @Inject constructor(
     private val syncPromotions: SyncPromotions,
+    private val pixel: Pixel,
 ) : ViewModel() {
 
     sealed interface Command {
@@ -47,12 +51,20 @@ class SyncBookmarksPromotionViewModel @Inject constructor(
         viewModelScope.launch {
             command.send(LaunchSyncSettings)
         }
+        pixel.fire(SyncPixelName.SYNC_FEATURE_PROMOTION_CONFIRMED, sourceMap())
     }
 
     fun onUserCancelledSyncPromo() {
         viewModelScope.launch {
             syncPromotions.recordBookmarksPromotionDismissed()
             command.send(ReevalutePromo)
         }
+        pixel.fire(SyncPixelName.SYNC_FEATURE_PROMOTION_DISMISSED, sourceMap())
     }
+
+    fun onPromoShown() {
+        pixel.fire(SyncPixelName.SYNC_FEATURE_PROMOTION_DISPLAYED, sourceMap())
+    }
+
+    private fun sourceMap() = mapOf(SyncPixelParameters.SYNC_FEATURE_PROMOTION_SOURCE to "bookmarks")
 }

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/promotion/passwords/SyncPasswordsPromotion.kt

@@ -34,13 +34,13 @@ import com.duckduckgo.common.utils.ViewViewModelFactory
 import com.duckduckgo.di.scopes.AppScope
 import com.duckduckgo.di.scopes.ViewScope
 import com.duckduckgo.navigation.api.GlobalActivityStarter
-import com.duckduckgo.sync.api.SyncActivityWithEmptyParams
 import com.duckduckgo.sync.impl.R
 import com.duckduckgo.sync.impl.databinding.ViewSyncPromoBinding
 import com.duckduckgo.sync.impl.promotion.SyncPromotions
 import com.duckduckgo.sync.impl.promotion.passwords.SyncPasswordsPromotionViewModel.Command
 import com.duckduckgo.sync.impl.promotion.passwords.SyncPasswordsPromotionViewModel.Command.LaunchSyncSettings
 import com.duckduckgo.sync.impl.promotion.passwords.SyncPasswordsPromotionViewModel.Command.ReevalutePromo
+import com.duckduckgo.sync.impl.ui.SyncActivityWithSourceParams
 import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.android.support.AndroidSupportInjection
 import javax.inject.Inject
@@ -99,6 +99,8 @@ class SyncPasswordsPromotionView @JvmOverloads constructor(
             .launchIn(coroutineScope)
 
         configureMessage()
+
+        viewModel.onPromoShown()
     }
 
     override fun onDetachedFromWindow() {
@@ -120,7 +122,7 @@ class SyncPasswordsPromotionView @JvmOverloads constructor(
 
     private fun launchSyncSettings() {
         context?.let {
-            val intent = globalActivityStarter.startIntent(it, SyncActivityWithEmptyParams)
+            val intent = globalActivityStarter.startIntent(it, SyncActivityWithSourceParams(source = "promotion_passwords"))
             context.startActivity(intent)
         }
     }

sync/sync-impl/src/main/java/com/duckduckgo/sync/impl/promotion/passwords/SyncPasswordsPromotionViewModel.kt

@@ -19,7 +19,10 @@ package com.duckduckgo.sync.impl.promotion.passwords
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.duckduckgo.anvil.annotations.ContributesViewModel
+import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.di.scopes.ViewScope
+import com.duckduckgo.sync.impl.pixels.SyncPixelName
+import com.duckduckgo.sync.impl.pixels.SyncPixelParameters
 import com.duckduckgo.sync.impl.promotion.SyncPromotions
 import com.duckduckgo.sync.impl.promotion.passwords.SyncPasswordsPromotionViewModel.Command.LaunchSyncSettings
 import com.duckduckgo.sync.impl.promotion.passwords.SyncPasswordsPromotionViewModel.Command.ReevalutePromo
@@ -33,6 +36,7 @@ import kotlinx.coroutines.launch
 @ContributesViewModel(ViewScope::class)
 class SyncPasswordsPromotionViewModel @Inject constructor(
     private val syncPromotions: SyncPromotions,
+    private val pixel: Pixel,
 ) : ViewModel() {
 
     sealed interface Command {
@@ -47,12 +51,20 @@ class SyncPasswordsPromotionViewModel @Inject constructor(
         viewModelScope.launch {
             command.send(LaunchSyncSettings)
         }
+        pixel.fire(SyncPixelName.SYNC_FEATURE_PROMOTION_CONFIRMED, sourceMap())
     }
 
     fun onUserCancelledSyncPromo() {
         viewModelScope.launch {
             syncPromotions.recordPasswordsPromotionDismissed()
             command.send(ReevalutePromo)
         }
+        pixel.fire(SyncPixelName.SYNC_FEATURE_PROMOTION_DISMISSED, sourceMap())
     }
+
+    fun onPromoShown() {
+        pixel.fire(SyncPixelName.SYNC_FEATURE_PROMOTION_DISPLAYED, sourceMap())
+    }
+
+    private fun sourceMap() = mapOf(SyncPixelParameters.SYNC_FEATURE_PROMOTION_SOURCE to "passwords")
 }