Bug 1981147 - Updating when the terms of use bottom sheet trigger behavior r=android-reviewers,gmalekpour

JohnOberhauser · JohnOberhauser · commit 169d5a2780bb · 2025-08-12T18:11:10.000Z
Differential Revision: https://phabricator.services.mozilla.com/D260377
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/HomeActivity.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/HomeActivity.kt
@@ -709,6 +709,8 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity {
         // DO NOT MOVE ANYTHING ABOVE THIS getProfilerTime CALL.
         val startProfilerTime = components.core.engine.profiler?.getProfilerTime()
 
+        components.termsOfUseManager.onStart()
+
         super.onStart()
 
         // Diagnostic breadcrumb for "Display already aquired" crash:
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/browser/BrowserFragment.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/browser/BrowserFragment.kt
@@ -59,7 +59,6 @@ import org.mozilla.fenix.home.HomeFragment
 import org.mozilla.fenix.nimbus.FxNimbus
 import org.mozilla.fenix.settings.quicksettings.protections.cookiebanners.getCookieBannerUIMode
 import org.mozilla.fenix.shortcut.PwaOnboardingObserver
-import org.mozilla.fenix.termsofuse.shouldShowTermsOfUsePrompt
 import org.mozilla.fenix.theme.ThemeManager
 
 /**
@@ -158,12 +157,6 @@ class BrowserFragment : BaseBrowserFragment(), UserInteractionHandler {
                 view = view,
             )
         }
-
-        if (requireContext().settings().shouldShowTermsOfUsePrompt()) {
-            findNavController().navigate(
-                BrowserFragmentDirections.actionGlobalTermsOfUseDialog(),
-            )
-        }
     }
 
     private fun initBrowserToolbarViewActions(rootView: View) {
@@ -554,6 +547,12 @@ class BrowserFragment : BaseBrowserFragment(), UserInteractionHandler {
 
         subscribeToTabCollections()
         updateLastBrowseActivity()
+
+        if (requireComponents.termsOfUseManager.shouldShowTermsOfUsePromptOnBrowserFragment()) {
+            findNavController().navigate(
+                BrowserFragmentDirections.actionGlobalTermsOfUseDialog(),
+            )
+        }
     }
 
     override fun onStop() {
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/components/Components.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/components/Components.kt
@@ -70,6 +70,7 @@ import org.mozilla.fenix.perf.StartupStateProvider
 import org.mozilla.fenix.perf.StrictModeManager
 import org.mozilla.fenix.perf.lazyMonitored
 import org.mozilla.fenix.reviewprompt.ReviewPromptMiddleware
+import org.mozilla.fenix.termsofuse.TermsOfUseManager
 import org.mozilla.fenix.utils.Settings
 import org.mozilla.fenix.utils.isLargeScreenSize
 import org.mozilla.fenix.wifi.WifiConnectionMonitor
@@ -332,6 +333,10 @@ class Components(private val context: Context) {
             distributionSettings = DefaultDistributionSettings(settings),
         )
     }
+
+    val termsOfUseManager by lazyMonitored {
+        TermsOfUseManager(settings)
+    }
 }
 
 /**
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/home/HomeFragment.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/home/HomeFragment.kt
@@ -160,7 +160,6 @@ import org.mozilla.fenix.snackbar.FenixSnackbarDelegate
 import org.mozilla.fenix.snackbar.SnackbarBinding
 import org.mozilla.fenix.tabstray.Page
 import org.mozilla.fenix.tabstray.TabsTrayAccessPoint
-import org.mozilla.fenix.termsofuse.shouldShowTermsOfUsePrompt
 import org.mozilla.fenix.theme.FirefoxTheme
 import org.mozilla.fenix.utils.allowUndo
 import org.mozilla.fenix.utils.showAddSearchWidgetPromptIfSupported
@@ -570,12 +569,6 @@ class HomeFragment : Fragment() {
 
         FxNimbus.features.homescreen.recordExposure()
 
-        if (requireContext().settings().shouldShowTermsOfUsePrompt()) {
-            findNavController().navigate(
-                BrowserFragmentDirections.actionGlobalTermsOfUseDialog(),
-            )
-        }
-
         // DO NOT MOVE ANYTHING BELOW THIS addMarker CALL!
         requireComponents.core.engine.profiler?.addMarker(
             MarkersFragmentLifecycleCallbacks.MARKER_NAME,
@@ -1155,6 +1148,12 @@ class HomeFragment : Fragment() {
 
         // Trigger review prompt logic and show the appropriate prompt variation if applicable
         requireComponents.appStore.dispatch(CheckIfEligibleForReviewPrompt)
+
+        if (requireComponents.termsOfUseManager.shouldShowTermsOfUsePromptOnHomepage()) {
+            findNavController().navigate(
+                BrowserFragmentDirections.actionGlobalTermsOfUseDialog(),
+            )
+        }
     }
 
     @VisibleForTesting
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/TermsOfUseManager.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/TermsOfUseManager.kt
@@ -0,0 +1,72 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package org.mozilla.fenix.termsofuse
+
+import org.mozilla.fenix.Config
+import org.mozilla.fenix.utils.Settings
+import org.mozilla.fenix.utils.Settings.Companion.FIVE_DAYS_MS
+
+/**
+ * Helps determine when the terms of use prompt should show.
+ *
+ * @param settings app settings
+ */
+class TermsOfUseManager(private val settings: Settings) {
+
+    private var isFirstCheckSinceStartingApp: Boolean = false
+
+    /**
+     * Determines whether the Terms of Use bottom sheet should be shown on the homepage.
+     */
+    fun shouldShowTermsOfUsePromptOnHomepage() =
+        shouldShowTermsOfUsePrompt(ignoreFirstCheckSinceStartingApp = true)
+
+    /**
+     * Determines whether the Terms of Use bottom sheet should be shown in the browser fragment.
+     */
+    fun shouldShowTermsOfUsePromptOnBrowserFragment() = shouldShowTermsOfUsePrompt()
+
+    /**
+     * Determines whether the Terms of Use bottom sheet should be shown.
+     *
+     * This function returns `true` if:
+     * - The user has not accepted the Terms of Use.
+     * - The user has not postponed accepting the Terms of Use or it's been at least 5 days since they did.
+     * - This is the first time checking to see if we should show the prompt since starting the app
+     *   OR the [ignoreFirstCheckSinceStartingApp] flag is true (we should ignore this when checking from homepage).
+     * - The current build channel is a debug build.
+     *
+     * @param ignoreFirstCheckSinceStartingApp if we should ignore the [isFirstCheckSinceStartingApp] value.
+     *   It should be ignored when checking from homepage.
+     * @param currentTimeInMillis the current time in milliseconds
+     * @return `true` if the Terms of Use bottom sheet should be shown; otherwise, `false`.
+     */
+    @Suppress("ReturnCount")
+    private fun shouldShowTermsOfUsePrompt(
+        ignoreFirstCheckSinceStartingApp: Boolean = false,
+        currentTimeInMillis: Long = System.currentTimeMillis(),
+    ): Boolean {
+        if (settings.hasAcceptedTermsOfService) return false
+
+        val isFirstCheck = isFirstCheckSinceStartingApp
+        isFirstCheckSinceStartingApp = false
+
+        val durationSinceLastPrompt = currentTimeInMillis - settings.lastTermsOfUsePromptTimeInMillis
+
+        if (settings.hasPostponedAcceptingTermsOfUse && durationSinceLastPrompt < FIVE_DAYS_MS) return false
+        if (!ignoreFirstCheckSinceStartingApp && !isFirstCheck) return false
+        if (!Config.channel.isDebug) return false
+
+        return true
+    }
+
+    /**
+     * Called from the [org.mozilla.fenix.HomeActivity]'s onStart.  Used to track the first check
+     * since starting the app.
+     */
+    fun onStart() {
+        isFirstCheckSinceStartingApp = true
+    }
+}
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/TermsOfUseUtils.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/TermsOfUseUtils.kt
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptPreferencesMiddleware.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptPreferencesMiddleware.kt
@@ -32,6 +32,10 @@ class TermsOfUsePromptPreferencesMiddleware(
             is TermsOfUsePromptAction.OnPromptManuallyDismissed -> {
                 repository.updateHasPostponedAcceptingTermsOfUsePreference()
             }
+
+            is TermsOfUsePromptAction.OnPromptDismissed -> {
+                repository.updateLastTermsOfUsePromptTimeInMillis()
+            }
         }
 
         next(action)
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptRepository.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptRepository.kt
@@ -19,6 +19,13 @@ interface TermsOfUsePromptRepository {
      * Updates the hasPostponedAcceptingTermsOfService preference to true
      */
     fun updateHasPostponedAcceptingTermsOfUsePreference()
+
+    /**
+     * Updates the lastTermsOfUsePromptTimeInMillis preference to the current time
+     *
+     * @param time the current time in milliseconds
+     */
+    fun updateLastTermsOfUsePromptTimeInMillis(time: Long = System.currentTimeMillis())
 }
 
 /**
@@ -34,6 +41,10 @@ class DefaultTermsOfUsePromptRepository(
     }
 
     override fun updateHasPostponedAcceptingTermsOfUsePreference() {
-        settings.hasPostponedAcceptingTermsOfService = true
+        settings.hasPostponedAcceptingTermsOfUse = true
+    }
+
+    override fun updateLastTermsOfUsePromptTimeInMillis(time: Long) {
+        settings.lastTermsOfUsePromptTimeInMillis = time
     }
 }
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptStore.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptStore.kt
@@ -33,6 +33,11 @@ sealed interface TermsOfUsePromptAction : Action {
      * background scrim
      */
     data object OnPromptManuallyDismissed : TermsOfUsePromptAction
+
+    /**
+     * Triggered when the prompt is dismissed for any reason.
+     */
+    data object OnPromptDismissed : TermsOfUsePromptAction
 }
 
 /**
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/ui/TermsOfUseBottomSheetFragment.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/termsofuse/ui/TermsOfUseBottomSheetFragment.kt
@@ -5,6 +5,7 @@
 package org.mozilla.fenix.termsofuse.ui
 
 import android.app.Dialog
+import android.content.DialogInterface
 import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.View
@@ -16,6 +17,7 @@ import org.mozilla.fenix.components.lazyStore
 import org.mozilla.fenix.ext.settings
 import org.mozilla.fenix.settings.SupportUtils
 import org.mozilla.fenix.termsofuse.store.DefaultTermsOfUsePromptRepository
+import org.mozilla.fenix.termsofuse.store.TermsOfUsePromptAction
 import org.mozilla.fenix.termsofuse.store.TermsOfUsePromptPreferencesMiddleware
 import org.mozilla.fenix.termsofuse.store.TermsOfUsePromptStore
 import org.mozilla.fenix.theme.FirefoxTheme
@@ -55,7 +57,9 @@ class TermsOfUseBottomSheetFragment : BottomSheetDialogFragment() {
             FirefoxTheme {
                 TermsOfUseBottomSheet(
                     store = termsOfUsePromptStore,
-                    onDismiss = { dismiss() },
+                    onDismiss = {
+                        dismiss()
+                    },
                     onTermsOfUseClicked = {
                         SupportUtils.launchSandboxCustomTab(
                             context,
@@ -82,4 +86,9 @@ class TermsOfUseBottomSheetFragment : BottomSheetDialogFragment() {
             }
         }
     }
+
+    override fun onDismiss(dialog: DialogInterface) {
+        super.onDismiss(dialog)
+        termsOfUsePromptStore.dispatch(TermsOfUsePromptAction.OnPromptDismissed)
+    }
 }
diff --git a/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/utils/Settings.kt b/mobile/android/fenix/app/src/main/java/org/mozilla/fenix/utils/Settings.kt
@@ -97,6 +97,7 @@ class Settings(private val appContext: Context) : PreferencesHolder {
         const val ONE_DAY_MS = 60 * 60 * 24 * 1000L
         const val TWO_DAYS_MS = 2 * ONE_DAY_MS
         const val THREE_DAYS_MS = 3 * ONE_DAY_MS
+        const val FIVE_DAYS_MS = 5 * ONE_DAY_MS
         const val ONE_WEEK_MS = 60 * 60 * 24 * 7 * 1000L
         const val ONE_MONTH_MS = (60 * 60 * 24 * 365 * 1000L) / 12
 
@@ -535,11 +536,20 @@ class Settings(private val appContext: Context) : PreferencesHolder {
         default = false,
     )
 
+    /**
+     * Timestamp in milliseconds when the terms of use prompt was last shown to the user.
+     * A value of 0L indicates that the prompt has never been shown.
+     */
+    var lastTermsOfUsePromptTimeInMillis: Long by longPreference(
+        appContext.getPreferenceKey(R.string.pref_key_terms_last_prompt_time),
+        default = 0L,
+    )
+
     /**
      * Users who have not accepted ToS will see a popup asking them to accept.
      * They can select "Not now" to postpone accepting.
      */
-    var hasPostponedAcceptingTermsOfService by booleanPreference(
+    var hasPostponedAcceptingTermsOfUse by booleanPreference(
         appContext.getPreferenceKey(R.string.pref_key_terms_postponed),
         default = false,
     )
diff --git a/mobile/android/fenix/app/src/main/res/values/preference_keys.xml b/mobile/android/fenix/app/src/main/res/values/preference_keys.xml
@@ -83,6 +83,7 @@
     <string name="pref_key_show_first_time_translation" translatable="false">pref_key_show_first_time_translation</string>
     <string name="pref_key_translations_offer" translatable="false">pref_key_translations_offer</string>
     <string name="pref_key_terms_accepted" translatable="false">pref_key_terms_accepted</string>
+    <string name="pref_key_terms_last_prompt_time" translatable="false">pref_key_terms_last_prompt_time</string>
     <string name="pref_key_terms_postponed" translatable="false">pref_key_terms_postponed</string>
     <string name="pref_key_should_show_marketing_onboarding" translatable="false">pref_key_should_show_marketing_onboarding</string>
     <string name="pref_key_crash_pull_never_show_again" translatable="false">pref_key_crash_pull_never_show_again</string>
diff --git a/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/TermsOfUseManagerTest.kt b/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/TermsOfUseManagerTest.kt
diff --git a/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/TermsOfUseUtilsTest.kt b/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/TermsOfUseUtilsTest.kt
diff --git a/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptPreferencesMiddlewareTest.kt b/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptPreferencesMiddlewareTest.kt
diff --git a/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptRepositoryTest.kt b/mobile/android/fenix/app/src/test/java/org/mozilla/fenix/termsofuse/store/TermsOfUsePromptRepositoryTest.kt

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ import org.mozilla.fenix.perf.StartupStateProvider`
`70`	`70`	`import org.mozilla.fenix.perf.StrictModeManager`
`71`	`71`	`import org.mozilla.fenix.perf.lazyMonitored`
`72`	`72`	`import org.mozilla.fenix.reviewprompt.ReviewPromptMiddleware`
	`73`	`+import org.mozilla.fenix.termsofuse.TermsOfUseManager`
`73`	`74`	`import org.mozilla.fenix.utils.Settings`
`74`	`75`	`import org.mozilla.fenix.utils.isLargeScreenSize`
`75`	`76`	`import org.mozilla.fenix.wifi.WifiConnectionMonitor`
`@@ -332,6 +333,10 @@ class Components(private val context: Context) {`
`332`	`333`	`distributionSettings = DefaultDistributionSettings(settings),`
`333`	`334`	`)`
`334`	`335`	`}`
	`336`	`+`
	`337`	`+ val termsOfUseManager by lazyMonitored {`
	`338`	`+ TermsOfUseManager(settings)`
	`339`	`+ }`
`335`	`340`	`}`
`336`	`341`
`337`	`342`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,10 @@ class TermsOfUsePromptPreferencesMiddleware(`
`32`	`32`	`is TermsOfUsePromptAction.OnPromptManuallyDismissed -> {`
`33`	`33`	`repository.updateHasPostponedAcceptingTermsOfUsePreference()`
`34`	`34`	`}`
	`35`	`+`
	`36`	`+ is TermsOfUsePromptAction.OnPromptDismissed -> {`
	`37`	`+ repository.updateLastTermsOfUsePromptTimeInMillis()`
	`38`	`+ }`
`35`	`39`	`}`
`36`	`40`
`37`	`41`	`next(action)`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,13 @@ interface TermsOfUsePromptRepository {`
`19`	`19`	`* Updates the hasPostponedAcceptingTermsOfService preference to true`
`20`	`20`	`*/`
`21`	`21`	`fun updateHasPostponedAcceptingTermsOfUsePreference()`
	`22`	`+`
	`23`	`+ /**`
	`24`	`+ * Updates the lastTermsOfUsePromptTimeInMillis preference to the current time`
	`25`	`+ *`
	`26`	`+ * @param time the current time in milliseconds`
	`27`	`+ */`
	`28`	`+ fun updateLastTermsOfUsePromptTimeInMillis(time: Long = System.currentTimeMillis())`
`22`	`29`	`}`
`23`	`30`
`24`	`31`	`/**`
`@@ -34,6 +41,10 @@ class DefaultTermsOfUsePromptRepository(`
`34`	`41`	`}`
`35`	`42`
`36`	`43`	`override fun updateHasPostponedAcceptingTermsOfUsePreference() {`
`37`		`- settings.hasPostponedAcceptingTermsOfService = true`
	`44`	`+ settings.hasPostponedAcceptingTermsOfUse = true`
	`45`	`+ }`
	`46`	`+`
	`47`	`+ override fun updateLastTermsOfUsePromptTimeInMillis(time: Long) {`
	`48`	`+ settings.lastTermsOfUsePromptTimeInMillis = time`
`38`	`49`	`}`
`39`	`50`	`}`