Merge pull request #19512 from wordpress-mobile/task/adds_store_link_referrer

Adds referrer information when opening a Google Play store link

Author: irfano

WordPress/src/main/java/org/wordpress/android/ui/ActivityLauncherWrapper.kt

@@ -11,6 +11,7 @@ import org.wordpress.android.R
 import org.wordpress.android.fluxc.model.PostImmutableModel
 import org.wordpress.android.fluxc.model.SiteModel
 import org.wordpress.android.ui.posts.RemotePreviewLogicHelper.RemotePreviewType
+import org.wordpress.android.util.UrlUtils
 import javax.inject.Inject
 
 /**
@@ -36,13 +37,13 @@ class ActivityLauncherWrapper @Inject constructor() {
     ) = ActivityLauncher.previewPostOrPageForResult(activity, site, post, remotePreviewType)
 
     @Suppress("SwallowedException")
-    fun openPlayStoreLink(activity: Activity, packageName: String) {
+    fun openPlayStoreLink(activity: Activity, packageName: String, utmCampaign: String? = null) {
         var intent: Intent? = activity.packageManager.getLaunchIntentForPackage(packageName)
         val isAppAlreadyInstalled = intent != null
 
         if (intent == null) {
             intent = Intent(Intent.ACTION_VIEW).apply {
-                data = Uri.parse("https://play.google.com/store/apps/details?id=$packageName")
+                data = Uri.parse(getPlayStoreUrl(activity.application.packageName, packageName, utmCampaign))
                 flags = Intent.FLAG_ACTIVITY_NEW_TASK
                 setPackage("com.android.vending")
             }
@@ -60,6 +61,15 @@ class ActivityLauncherWrapper @Inject constructor() {
         }
     }
 
+    fun getPlayStoreUrl(appPackageName: String, destinationPackageName: String, utmCampaign: String? = null): String {
+        val referrer = utmCampaign?.let {
+            val encoded = UrlUtils.urlEncode("$GOOGLE_STORE_UTM_SOURCE=$appPackageName&$GOOGLE_STORE_UTM_CAMPAIGN=$it")
+            "$GOOGLE_STORE_REFERRER=$encoded"
+        }
+        val storeUrl = "$GOOGLE_STORE_URL_APP_DETAILS?$GOOGLE_STORE_URL_APP_ID=$destinationPackageName"
+        return referrer?.let { "$storeUrl&$it" } ?: storeUrl
+    }
+
     private fun preventBackNavigation(activity: Activity, shouldPrevent: Boolean) {
         if (shouldPrevent) {
             activity.finishAffinity()
@@ -68,5 +78,15 @@ class ActivityLauncherWrapper @Inject constructor() {
 
     companion object {
         const val JETPACK_PACKAGE_NAME = "com.jetpack.android"
+        const val GOOGLE_STORE_URL_APP_DETAILS = "https://play.google.com/store/apps/details"
+        const val GOOGLE_STORE_URL_APP_ID = "id"
+        const val GOOGLE_STORE_REFERRER = "referrer"
+        const val GOOGLE_STORE_UTM_SOURCE = "utm_source"
+        const val GOOGLE_STORE_UTM_CAMPAIGN = "utm_campaign"
+        const val CAMPAIGN_SITE_CREATION = "site_creation"
+        const val CAMPAIGN_BOTTOM_SHEET = "bottom_sheet"
+        const val CAMPAIGN_STATIC_POSTER = "static_poster"
+        const val CAMPAIGN_INDIVIDUAL_PLUGIN = "individual_plugin"
+        const val CAMPAIGN_JETPACK_OVERLAY = "jetpack_overlay"
     }
 }

WordPress/src/main/java/org/wordpress/android/ui/jetpackoverlay/JetpackFeatureFullScreenOverlayFragment.kt

@@ -10,6 +10,7 @@ import com.google.android.material.bottomsheet.BottomSheetDialogFragment
 import dagger.hilt.android.AndroidEntryPoint
 import org.wordpress.android.databinding.JetpackFeatureRemovalOverlayBinding
 import org.wordpress.android.ui.ActivityLauncherWrapper
+import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.CAMPAIGN_JETPACK_OVERLAY
 import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.JETPACK_PACKAGE_NAME
 import org.wordpress.android.ui.WPWebViewActivity
 import org.wordpress.android.ui.jetpackoverlay.JetpackFeatureOverlayActions.DismissDialog
@@ -93,7 +94,7 @@ class JetpackFeatureFullScreenOverlayFragment : BottomSheetDialogFragment() {
                 is OpenPlayStore -> {
                     dismiss()
                     activity?.let {
-                        activityLauncherWrapper.openPlayStoreLink(it, JETPACK_PACKAGE_NAME)
+                        activityLauncherWrapper.openPlayStoreLink(it, JETPACK_PACKAGE_NAME, CAMPAIGN_JETPACK_OVERLAY)
                     }
                 }
                 is DismissDialog -> {

WordPress/src/main/java/org/wordpress/android/ui/jetpackoverlay/individualplugin/WPJetpackIndividualPluginFragment.kt

@@ -81,7 +81,8 @@ class WPJetpackIndividualPluginFragment : BottomSheetDialogFragment() {
         when (actionEvent) {
             is ActionEvent.PrimaryButtonClick -> activityLauncher.openPlayStoreLink(
                 requireActivity(),
-                ActivityLauncherWrapper.JETPACK_PACKAGE_NAME
+                ActivityLauncherWrapper.JETPACK_PACKAGE_NAME,
+                ActivityLauncherWrapper.CAMPAIGN_INDIVIDUAL_PLUGIN
             )
 
             is ActionEvent.Dismiss -> dismiss()

WordPress/src/main/java/org/wordpress/android/ui/main/jetpack/staticposter/JetpackStaticPosterFragment.kt

@@ -12,6 +12,7 @@ import androidx.fragment.app.Fragment
 import androidx.fragment.app.viewModels
 import dagger.hilt.android.AndroidEntryPoint
 import org.wordpress.android.ui.ActivityLauncherWrapper
+import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.CAMPAIGN_STATIC_POSTER
 import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.JETPACK_PACKAGE_NAME
 import org.wordpress.android.ui.WPWebViewActivity
 import org.wordpress.android.ui.compose.theme.AppTheme
@@ -59,7 +60,8 @@ class JetpackStaticPosterFragment : Fragment() {
             when (event) {
                 is Event.PrimaryButtonClick -> activityLauncher.openPlayStoreLink(
                     requireActivity(),
-                    JETPACK_PACKAGE_NAME
+                    JETPACK_PACKAGE_NAME,
+                    CAMPAIGN_STATIC_POSTER
                 )
                 is Event.SecondaryButtonClick -> event.url?.let {
                     WPWebViewActivity.openURL(requireContext(), UrlUtils.addUrlSchemeIfNeeded(it, true))

WordPress/src/main/java/org/wordpress/android/ui/mysite/jetpackbadge/JetpackPoweredBottomSheetFragment.kt

@@ -17,6 +17,7 @@ import org.wordpress.android.R
 import org.wordpress.android.databinding.JetpackPoweredBottomSheetBinding
 import org.wordpress.android.databinding.JetpackPoweredExpandedBottomSheetBinding
 import org.wordpress.android.ui.ActivityLauncherWrapper
+import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.CAMPAIGN_BOTTOM_SHEET
 import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.JETPACK_PACKAGE_NAME
 import org.wordpress.android.ui.main.WPMainNavigationView.PageType
 import org.wordpress.android.ui.main.WPMainNavigationView.PageType.ME
@@ -130,7 +131,7 @@ class JetpackPoweredBottomSheetFragment : BottomSheetDialogFragment() {
                 is OpenPlayStore -> {
                     dismiss()
                     activity?.let {
-                        activityLauncherWrapper.openPlayStoreLink(it, JETPACK_PACKAGE_NAME)
+                        activityLauncherWrapper.openPlayStoreLink(it, JETPACK_PACKAGE_NAME, CAMPAIGN_BOTTOM_SHEET)
                     }
                 }
                 is DismissDialog -> {

WordPress/src/main/java/org/wordpress/android/ui/sitecreation/SiteCreationActivity.kt

@@ -14,6 +14,7 @@ import org.wordpress.android.BuildConfig
 import org.wordpress.android.R
 import org.wordpress.android.ui.ActivityLauncher
 import org.wordpress.android.ui.ActivityLauncherWrapper
+import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.CAMPAIGN_SITE_CREATION
 import org.wordpress.android.ui.ActivityLauncherWrapper.Companion.JETPACK_PACKAGE_NAME
 import org.wordpress.android.ui.LocaleAwareActivity
 import org.wordpress.android.ui.accounts.HelpActivity.Origin
@@ -188,7 +189,7 @@ class SiteCreationActivity : LocaleAwareActivity(),
             when (action) {
                 is OpenPlayStore -> {
                     fragment.dismiss()
-                    activityLauncherWrapper.openPlayStoreLink(this, JETPACK_PACKAGE_NAME)
+                    activityLauncherWrapper.openPlayStoreLink(this, JETPACK_PACKAGE_NAME, CAMPAIGN_SITE_CREATION)
                 }
                 is DismissDialog -> {
                     fragment.dismiss()

WordPress/src/test/java/org/wordpress/android/ui/ActivityLauncherWrapperTest.kt

@@ -1,8 +1,10 @@
 package org.wordpress.android.ui
 
 import android.app.Activity
+import android.app.Application
 import android.content.pm.PackageManager
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import org.assertj.core.api.Assertions.assertThat
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
@@ -45,16 +47,39 @@ class ActivityLauncherWrapperTest {
         verify(activity).finishAffinity()
     }
 
+    @Test
+    fun `when a campaign is passed the store url includes a referrer`() {
+        val expectedStoreUrl = "https://play.google.com/store/apps/details?id=com.jetpack.android" +
+                "&referrer=utm_source%3Dorg.wordpress.android%26utm_campaign%3Dtest_campaign"
+        val actualStoreUrl = classToTest.getPlayStoreUrl(SOURCE_PACKAGE, TARGET_PACKAGE, TEST_CAMPAIGN)
+        assertThat(actualStoreUrl).isEqualTo(expectedStoreUrl)
+    }
+
+    @Test
+    fun `when a campaign is not passed the store url does not include a referrer`() {
+        val expectedStoreUrl = "https://play.google.com/store/apps/details?id=com.jetpack.android"
+        val actualStoreUrl = classToTest.getPlayStoreUrl(SOURCE_PACKAGE, TARGET_PACKAGE)
+        assertThat(actualStoreUrl).isEqualTo(expectedStoreUrl)
+    }
 
     private fun mockAppPreinstalled(isInstalled: Boolean): Activity {
         val activity = mock<Activity>()
+        val application = mock<Application>()
         val packageManager = mock<PackageManager>()
         whenever(activity.packageManager).thenReturn(packageManager)
+        whenever(activity.application).thenReturn(application)
+        whenever(application.packageName).thenReturn(SOURCE_PACKAGE)
 
         if (isInstalled) {
             whenever(packageManager.getLaunchIntentForPackage(any())).thenReturn(mock())
         }
 
         return activity
     }
+
+    companion object {
+        const val SOURCE_PACKAGE = "org.wordpress.android"
+        const val TARGET_PACKAGE = "com.jetpack.android"
+        const val TEST_CAMPAIGN = "test_campaign"
+    }
 }