For mozilla-mobile#7506 promote search widget dialog

DonalMe · Sep 20, 2022 · ffa0fdf · ffa0fdf
1 parent 0086859
commit ffa0fdf
Show file tree

Hide file tree

Showing 31 changed files with 488 additions and 20 deletions.
diff --git a/.experimenter.yaml b/.experimenter.yaml
@@ -10,11 +10,6 @@ onboarding:
     is-enabled:
       type: boolean
       description: "If `true`, the app will show the new onboarding screen"
-tabs:
-  description: Nimbus feature name intended to control the multiple tabs feature in the app.
-  hasExposure: true
-  exposureDescription: ""
-  variables:
-    is_multi_tab:
+    is-promote-search-widget-dialog-enabled:
       type: boolean
-      description: "Nimbus variable of [FEATURE_TABS] allowing outside control of whether the multiple tabs feature should be enabled or not."
+      description: "If `true`, the app will show the new dialog for promote search widget"
diff --git a/app/metrics.yaml b/app/metrics.yaml
@@ -1997,3 +1997,53 @@ search_widget:
     metadata:
       tags:
         - Search
+  promote_dialog_shown:
+    type: event
+    description: |
+      Promote search widget dialog is shown to the user.
+    bugs:
+      - https://github.com/mozilla-mobile/focus-android/issues/7506
+    data_reviews:
+      - https://github.com/mozilla-mobile/focus-android/pull/
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - [email protected]
+    expires: 119
+    metadata:
+      tags:
+        - Search
+  add_to_home_screen_button:
+    type: event
+    description: |
+      The user has pressed on add search widget
+      to home screen button from promote dialog.
+    bugs:
+      - https://github.com/mozilla-mobile/focus-android/issues/7506
+    data_reviews:
+      - https://github.com/mozilla-mobile/focus-android/pull/
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - [email protected]
+    expires: 119
+    metadata:
+      tags:
+        - Search
+  widget_was_added:
+    type: event
+    description: |
+      The user has added successfully the search widget from
+      promote search widget dialog.
+    bugs:
+      - https://github.com/mozilla-mobile/focus-android/issues/7506
+    data_reviews:
+      - https://github.com/mozilla-mobile/focus-android/pull/
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - [email protected]
+    expires: 119
+    metadata:
+      tags:
+        - Search
diff --git a/...src/androidTest/java/org/mozilla/focus/activity/EnhancedTrackingProtectionSettingsTest.kt b/...src/androidTest/java/org/mozilla/focus/activity/EnhancedTrackingProtectionSettingsTest.kt
@@ -46,6 +46,7 @@ class EnhancedTrackingProtectionSettingsTest {
             dispatcher = MockWebServerHelper.AndroidAssetDispatcher()
             start()
         }
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
     }
 
     @After

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/EraseBrowsingDataTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/EraseBrowsingDataTest.kt
@@ -52,6 +52,7 @@ class EraseBrowsingDataTest {
             start()
         }
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
     }
 
     @After
@@ -60,6 +61,7 @@ class EraseBrowsingDataTest {
         featureSettingsHelper.resetAllFeatureFlags()
     }
 
+    @Ignore("https://github.com/mozilla-mobile/focus-android/issues/7695")
     @SmokeTest
     @Test
     fun trashButtonTest() {

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/SafeBrowsingTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/SafeBrowsingTest.kt
@@ -35,6 +35,7 @@ class SafeBrowsingTest {
     @Before
     fun setUp() {
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
         webServer = MockWebServer().apply {
             dispatcher = MockWebServerHelper.AndroidAssetDispatcher()
             start()

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/SearchTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/SearchTest.kt
@@ -29,6 +29,7 @@ class SearchTest {
     @Before
     fun setUp() {
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
     }
 
     @After

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/SettingsAdvancedTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/SettingsAdvancedTest.kt
@@ -36,6 +36,7 @@ class SettingsAdvancedTest {
             start()
         }
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
     }
 
     @After

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/ShortcutsTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/ShortcutsTest.kt
@@ -30,6 +30,7 @@ class ShortcutsTest {
     @Before
     fun setUp() {
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
         webServer = MockWebServer().apply {
             dispatcher = MockWebServerHelper.AndroidAssetDispatcher()
             start()

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/SitePermissionsTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/SitePermissionsTest.kt
@@ -52,6 +52,7 @@ class SitePermissionsTest {
     @Before
     fun setUp() {
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
         webServer = MockWebServer().apply {
             dispatcher = MockWebServerHelper.AndroidAssetDispatcher()
             start()

diff --git a/app/src/androidTest/java/org/mozilla/focus/activity/WebControlsTest.kt b/app/src/androidTest/java/org/mozilla/focus/activity/WebControlsTest.kt
@@ -44,6 +44,7 @@ class WebControlsTest {
             start()
         }
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
     }
 
     @After

diff --git a/app/src/androidTest/java/org/mozilla/focus/helpers/FeatureSettingsHelper.kt b/app/src/androidTest/java/org/mozilla/focus/helpers/FeatureSettingsHelper.kt
@@ -19,6 +19,14 @@ class FeatureSettingsHelper {
         settings.shouldShowCfrForTrackingProtection = enabled
     }
 
+    fun setSearchWidgetDialogEnabled(enabled: Boolean) {
+        if (enabled) {
+            settings.addClearBrowsingSessions(4)
+        } else {
+            settings.addClearBrowsingSessions(10)
+        }
+    }
+
     // Important:
     // Use this after each test if you have modified these feature settings
     // to make sure the app goes back to the default state

diff --git a/app/src/androidTest/java/org/mozilla/focus/privacy/LocalSessionStorageTest.kt b/app/src/androidTest/java/org/mozilla/focus/privacy/LocalSessionStorageTest.kt
@@ -42,6 +42,7 @@ class LocalSessionStorageTest {
             start()
         }
         featureSettingsHelper.setCfrForTrackingProtectionEnabled(false)
+        featureSettingsHelper.setSearchWidgetDialogEnabled(false)
     }
 
     @After

diff --git a/app/src/main/java/org/mozilla/focus/fragment/UrlInputFragment.kt b/app/src/main/java/org/mozilla/focus/fragment/UrlInputFragment.kt
@@ -196,6 +196,14 @@ class UrlInputFragment :
             binding.browserToolbar.editMode()
             isInitialized = true
         }
+
+        if (
+            requireComponents.settings.searchWidgetInstalled &&
+            requireComponents.appStore.state.showSearchWidgetSnackbar
+        ) {
+            ViewUtils.showBrandedSnackbar(view, R.string.promote_search_widget_snackbar_message, 0)
+            requireComponents.appStore.dispatch(AppAction.ShowSearchWidgetSnackBar(false))
+        }
     }
 
     override fun onPause() {
@@ -240,7 +248,6 @@ class UrlInputFragment :
                 TopSitesOverlay()
             }
         }
-
         return binding.root
     }
 

diff --git a/app/src/main/java/org/mozilla/focus/navigation/MainActivityNavigation.kt b/app/src/main/java/org/mozilla/focus/navigation/MainActivityNavigation.kt
@@ -5,6 +5,7 @@
 package org.mozilla.focus.navigation
 
 import android.os.Build
+import org.mozilla.experiments.nimbus.internal.FeatureHolder
 import org.mozilla.focus.R
 import org.mozilla.focus.activity.MainActivity
 import org.mozilla.focus.autocomplete.AutocompleteAddFragment
@@ -14,6 +15,7 @@ import org.mozilla.focus.autocomplete.AutocompleteSettingsFragment
 import org.mozilla.focus.biometrics.BiometricAuthenticationFragment
 import org.mozilla.focus.exceptions.ExceptionsListFragment
 import org.mozilla.focus.exceptions.ExceptionsRemoveFragment
+import org.mozilla.focus.ext.components
 import org.mozilla.focus.fragment.BrowserFragment
 import org.mozilla.focus.fragment.FirstrunFragment
 import org.mozilla.focus.fragment.UrlInputFragment
@@ -24,6 +26,8 @@ import org.mozilla.focus.fragment.onboarding.OnboardingStep
 import org.mozilla.focus.fragment.onboarding.OnboardingStorage
 import org.mozilla.focus.locale.screen.LanguageFragment
 import org.mozilla.focus.nimbus.FocusNimbus
+import org.mozilla.focus.nimbus.Onboarding
+import org.mozilla.focus.searchwidget.SearchWidgetUtils
 import org.mozilla.focus.settings.GeneralSettingsFragment
 import org.mozilla.focus.settings.InstalledSearchEnginesSettingsFragment
 import org.mozilla.focus.settings.ManualAddSearchEngineSettingsFragment
@@ -59,12 +63,19 @@ class MainActivityNavigation(
         val isShowingBrowser = browserFragment != null
         val crashReporterIsVisible = browserFragment?.crashReporterIsVisible() ?: false
 
+        val onboardingFeature = FocusNimbus.features.onboarding
+        val onboardingConfig = onboardingFeature.value(activity)
+
         if (isShowingBrowser && !crashReporterIsVisible) {
-            ViewUtils.showBrandedSnackbar(
-                activity.findViewById(android.R.id.content),
-                R.string.feedback_erase2,
-                activity.resources.getInteger(R.integer.erase_snackbar_delay),
-            )
+            if (onboardingConfig.isPromoteSearchWidgetDialogEnabled) {
+                showPromoteSearchWidgetDialog(onboardingFeature)
+            } else {
+                ViewUtils.showBrandedSnackbar(
+                    activity.findViewById(android.R.id.content),
+                    R.string.feedback_erase2,
+                    activity.resources.getInteger(R.integer.erase_snackbar_delay),
+                )
+            }
         }
 
         // We add the url input fragment to the layout if it doesn't exist yet.
@@ -88,10 +99,33 @@ class MainActivityNavigation(
         // Ideally we'd make it possible to pause observers while the app is in the background:
         // https://github.com/mozilla-mobile/android-components/issues/876
         transaction
-            .replace(R.id.container, UrlInputFragment.createWithoutSession(), UrlInputFragment.FRAGMENT_TAG)
+            .replace(
+                R.id.container,
+                UrlInputFragment.createWithoutSession(),
+                UrlInputFragment.FRAGMENT_TAG,
+            )
             .commitAllowingStateLoss()
     }
 
+    /**
+     * Display the widget promo at first data clearing action and if it wasn't added after 5th Focus session.
+     */
+    @Suppress("MagicNumber")
+    private fun showPromoteSearchWidgetDialog(onboardingFeature: FeatureHolder<Onboarding>) {
+        if (!activity.components.settings.searchWidgetInstalled) {
+            val clearBrowsingSessions = activity.components.settings.getClearBrowsingSessions()
+            activity.components.settings.addClearBrowsingSessions(1)
+            onboardingFeature.recordExposure()
+
+            if (
+                clearBrowsingSessions == 0 ||
+                clearBrowsingSessions == 4
+            ) {
+                SearchWidgetUtils.showPromoteSearchWidgetDialog(activity)
+            }
+        }
+    }
+
     /**
      * Show browser for tab with the given [tabId].
      */
-Original file line number
+Diff line change
@@ Expand Up / @@ -46,6 +46,7 @@ class EnhancedTrackingProtectionSettingsTest { @@
                 dispatcher = MockWebServerHelper.AndroidAssetDispatcher()
                 start()
             }
+            featureSettingsHelper.setSearchWidgetDialogEnabled(false)
         }
         @After
@@ Expand Down @@