Bug 1919891 - added a checkbox to the redirect dialog layout and actions based on user clicks on the dialog r=android-reviewers,cwzilla,twhite,mavduevskiy

Differential Revision: https://phabricator.services.mozilla.com/D229368

Author: andrei popa

mobile/android/android-components/components/feature/app-links/src/main/java/mozilla/components/feature/app/links/AppLinksFeature.kt

@@ -116,7 +116,7 @@ class AppLinksFeature(
         }
 
         val dialog = getOrCreateDialog(tab.content.private, url)
-        dialog.onConfirmRedirect = doOpenApp
+        dialog.onConfirmRedirect = { doOpenApp() }
         dialog.onCancelRedirect = doNotOpenApp
 
         if (!isAlreadyADialogCreated()) {

mobile/android/android-components/components/feature/app-links/src/main/java/mozilla/components/feature/app/links/AppLinksInterceptor.kt

@@ -55,9 +55,12 @@ private const val MAPS = "maps."
  * have registered to open.
  * @param launchFromInterceptor If {true} then the interceptor will prompt and launch the link in
  * third-party apps if available.  Do not use this in conjunction with [AppLinksFeature]
+ * @param showCheckbox if {true} then the checkbox will be visible on [SimpleRedirectDialogFragment]
  * @param store [BrowserStore] containing the information about the currently open tabs.
  * @param shouldPrompt If {true} then we should prompt the user before redirect.
  * @param failedToLaunchAction Action to perform when failing to launch in third party app.
+ * @param checkboxCheckedAction Action to perform when checkbox is ticked and positive button is clicked
+ * on redirect prompt.
  */
 class AppLinksInterceptor(
     private val context: Context,
@@ -71,9 +74,11 @@ class AppLinksInterceptor(
         alwaysDeniedSchemes = alwaysDeniedSchemes,
     ),
     private val launchFromInterceptor: Boolean = false,
+    private val showCheckbox: Boolean = false,
     private val store: BrowserStore? = null,
     private val shouldPrompt: () -> Boolean = { true },
     private val failedToLaunchAction: (fallbackUrl: String?) -> Unit = {},
+    private val checkboxCheckedAction: () -> Unit = {},
 ) : RequestInterceptor {
     private var fragmentManager: FragmentManager? = null
     private val dialog: RedirectDialogFragment? = null
@@ -274,7 +279,12 @@ class AppLinksInterceptor(
 
         if (!fragmentManager.isStateSaved) {
             getOrCreateDialog(isPrivate, url).apply {
-                onConfirmRedirect = doOpenApp
+                onConfirmRedirect = { isCheckboxTicked ->
+                    if (isCheckboxTicked) {
+                        checkboxCheckedAction()
+                    }
+                    doOpenApp()
+                }
                 onCancelRedirect = doNotOpenApp
             }.showNow(fragmentManager, FRAGMENT_TAG)
         }
@@ -304,6 +314,7 @@ class AppLinksInterceptor(
         return SimpleRedirectDialogFragment.newInstance(
             dialogTitleText = dialogTitle,
             dialogMessageString = dialogMessage,
+            showCheckbox = showCheckbox,
             positiveButtonText = R.string.mozac_feature_applinks_confirm_dialog_confirm,
             negativeButtonText = R.string.mozac_feature_applinks_confirm_dialog_deny,
             maxSuccessiveDialogMillisLimit = MAX_SUCCESSIVE_DIALOG_MILLIS_LIMIT,

mobile/android/android-components/components/feature/app-links/src/main/java/mozilla/components/feature/app/links/RedirectDialogFragment.kt

@@ -15,11 +15,14 @@ import androidx.fragment.app.DialogFragment
 abstract class RedirectDialogFragment : DialogFragment() {
 
     /**
-     * A callback to trigger a download, call it when you are ready to open the linked app. For instance,
+     * A callback to trigger a redirect action. Call it when you are ready to open the linked app. For instance,
      * a valid use case can be in confirmation dialog, after the positive button is clicked,
      * this callback must be called.
+     *
+     * checkboxChecked - Boolean parameter indicating if the checkbox is ticked or not when clicking
+     * on the positive button
      */
-    var onConfirmRedirect: () -> Unit = {}
+    var onConfirmRedirect: (checkboxChecked: Boolean) -> Unit = {}
 
     /**
      * A callback to trigger when user dismisses the dialog.

mobile/android/android-components/components/feature/app-links/src/main/java/mozilla/components/feature/app/links/SimpleRedirectDialogFragment.kt

@@ -7,6 +7,10 @@ package mozilla.components.feature.app.links
 import android.app.Dialog
 import android.content.Context
 import android.os.Bundle
+import android.view.View
+import android.view.ViewGroup
+import android.widget.CheckBox
+import android.widget.FrameLayout
 import androidx.annotation.StringRes
 import androidx.annotation.StyleRes
 import androidx.annotation.VisibleForTesting
@@ -46,18 +50,32 @@ class SimpleRedirectDialogFragment(
             val dialogMessageString = getString(KEY_MESSAGE_STRING, "")
             val positiveButtonText = getInt(KEY_POSITIVE_TEXT, R.string.mozac_feature_applinks_confirm_dialog_confirm)
             val negativeButtonText = getInt(KEY_NEGATIVE_TEXT, R.string.mozac_feature_applinks_confirm_dialog_deny)
+            val checkboxText = getInt(KEY_CHECKBOX_TEXT, R.string.mozac_feature_applinks_confirm_dialog_checkbox_label)
             val themeResId = getInt(KEY_THEME_ID, 0)
             val cancelable = getBoolean(KEY_CANCELABLE, false)
+            val showCheckbox = getBoolean(KEY_CHECKBOX, false)
+
+            val checkbox = CheckBox(requireContext()).apply {
+                layoutParams = ViewGroup.MarginLayoutParams(
+                    ViewGroup.MarginLayoutParams.WRAP_CONTENT,
+                    ViewGroup.MarginLayoutParams.WRAP_CONTENT,
+                )
+                id = VIEW_ID
+                setText(checkboxText)
+            }
 
-            val dialog = getBuilder(themeResId)
-                .setTitle(dialogTitleText)
-                .setMessage(dialogMessageString)
-                .setPositiveButton(positiveButtonText) { _, _ -> }
-                .setNegativeButton(negativeButtonText) { _, _ ->
+            val dialog = getBuilder(themeResId).apply {
+                if (showCheckbox) {
+                    setView(getLayout(checkbox))
+                }
+                setTitle(dialogTitleText)
+                setMessage(dialogMessageString)
+                setPositiveButton(positiveButtonText) { _, _ -> }
+                setNegativeButton(negativeButtonText) { _, _ ->
                     onCancelRedirect()
                 }
-                .setCancelable(cancelable)
-                .create()
+                setCancelable(cancelable)
+            }.create()
 
             dialog.withCenterAlignedButtons()
             dialog.setOnShowListener {
@@ -66,7 +84,7 @@ class SimpleRedirectDialogFragment(
                     if (promptAbuserDetector.areDialogsBeingAbused()) {
                         promptAbuserDetector.updateJSDialogAbusedState()
                     } else {
-                        onConfirmRedirect()
+                        onConfirmRedirect(showCheckbox && checkbox.isChecked)
                         dialog.dismiss()
                     }
                 }
@@ -75,6 +93,13 @@ class SimpleRedirectDialogFragment(
         }
     }
 
+    private fun getLayout(view: View) = FrameLayout(requireContext()).apply {
+        val leftPadding = resources.getDimension(R.dimen.mozac_feature_applinks_confirm_dialog_checkbox_margin).toInt()
+
+        setPadding(leftPadding, 0, 0, 0)
+        addView(view)
+    }
+
     companion object {
         /**
          * A builder method for creating a [SimpleRedirectDialogFragment]
@@ -84,8 +109,10 @@ class SimpleRedirectDialogFragment(
             dialogMessageString: String = "",
             @StringRes positiveButtonText: Int = R.string.mozac_feature_applinks_confirm_dialog_confirm,
             @StringRes negativeButtonText: Int = R.string.mozac_feature_applinks_confirm_dialog_deny,
+            @StringRes checkboxText: Int? = null,
             @StyleRes themeResId: Int = 0,
             cancelable: Boolean = false,
+            showCheckbox: Boolean = false,
             maxSuccessiveDialogMillisLimit: Int = TIME_SHOWN_OFFSET_MILLIS,
         ): RedirectDialogFragment {
             val fragment = SimpleRedirectDialogFragment(maxSuccessiveDialogMillisLimit)
@@ -100,9 +127,15 @@ class SimpleRedirectDialogFragment(
 
                 putInt(KEY_NEGATIVE_TEXT, negativeButtonText)
 
+                checkboxText?.let {
+                    putInt(KEY_CHECKBOX_TEXT, it)
+                }
+
                 putInt(KEY_THEME_ID, themeResId)
 
                 putBoolean(KEY_CANCELABLE, cancelable)
+
+                putBoolean(KEY_CHECKBOX, showCheckbox)
             }
 
             fragment.arguments = arguments
@@ -115,14 +148,21 @@ class SimpleRedirectDialogFragment(
 
         const val KEY_NEGATIVE_TEXT = "KEY_NEGATIVE_TEXT"
 
+        const val KEY_CHECKBOX_TEXT = "KEY_CHECKBOX_TEXT"
+
         const val KEY_TITLE_TEXT = "KEY_TITLE_TEXT"
 
         const val KEY_MESSAGE_STRING = "KEY_MESSAGE_STRING"
 
         const val KEY_THEME_ID = "KEY_THEME_ID"
 
         const val KEY_CANCELABLE = "KEY_CANCELABLE"
+
+        private const val KEY_CHECKBOX = "KEY_CHECKBOX"
+
         private const val TIME_SHOWN_OFFSET_MILLIS = 1000
+
+        internal const val VIEW_ID = 111
     }
 
     private fun requireBundle(): Bundle {

mobile/android/android-components/components/feature/app-links/src/main/res/values/dimens.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 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/. -->
+<resources>
+    <dimen name="mozac_feature_applinks_confirm_dialog_checkbox_margin">18dp</dimen>
+</resources>

mobile/android/android-components/components/feature/app-links/src/main/res/values/strings.xml

@@ -19,4 +19,6 @@
     <string name="mozac_feature_applinks_confirm_dialog_confirm">Open</string>
     <!-- Cancels the prompt -->
     <string name="mozac_feature_applinks_confirm_dialog_deny">Cancel</string>
+    <!-- The label of the checkbox that, depending of user's choice, can change the Open links in apps setting -->
+    <string name="mozac_feature_applinks_confirm_dialog_checkbox_label">Always open links in apps</string>
 </resources>

mobile/android/android-components/components/feature/app-links/src/test/java/mozilla/components/feature/app/links/SimpleRedirectDialogFragmentTest.kt

@@ -6,9 +6,11 @@ package mozilla.components.feature.app.links
 
 import android.os.Looper.getMainLooper
 import android.widget.Button
+import android.widget.CheckBox
 import androidx.fragment.app.FragmentManager
 import androidx.fragment.app.FragmentTransaction
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import mozilla.components.feature.app.links.SimpleRedirectDialogFragment.Companion.VIEW_ID
 import mozilla.components.support.test.mock
 import mozilla.components.support.test.robolectric.testContext
 import org.junit.Assert.assertFalse
@@ -29,29 +31,50 @@ class SimpleRedirectDialogFragmentTest {
 
     @Test
     @Ignore("This will be addressed in another follow up ticket")
-    fun `Dialog confirmed callback is called correctly`() {
-        var onConfirmCalled = false
+    fun `GIVEN the checkbox is visible and ticked WHEN clicking on positive button THEN the callback is called correctly`() {
+        var onConfirmAlwaysUncheckCalled = false
+        var onConfirmedAlwaysCheckedCalled = false
         var onCancelCalled = false
 
-        val onConfirm = { onConfirmCalled = true }
         val onCancel = { onCancelCalled = true }
 
-        val fragment = spy(SimpleRedirectDialogFragment.newInstance(themeResId = themeResId))
+        val onConfirm: (Boolean?) -> Unit = { alwaysChecked ->
+            if (alwaysChecked == true) {
+                onConfirmedAlwaysCheckedCalled = true
+            } else {
+                onConfirmAlwaysUncheckCalled = true
+            }
+        }
+
+        val fragment = spy(
+            SimpleRedirectDialogFragment.newInstance(
+                themeResId = themeResId,
+                showCheckbox = true,
+            ),
+        )
         doNothing().`when`(fragment).dismiss()
 
         doReturn(testContext).`when`(fragment).requireContext()
 
-        fragment.onConfirmRedirect = onConfirm
-        fragment.onCancelRedirect = onCancel
-
         val dialog = fragment.onCreateDialog(null)
         dialog.show()
 
         val confirmButton = dialog.findViewById<Button>(android.R.id.button1)
+        val checkbox = dialog.findViewById<CheckBox>(VIEW_ID)
+        checkbox.isChecked = true
+
+        fragment.onConfirmRedirect = {
+            onConfirm(checkbox.isChecked)
+        }
+
+        fragment.onCancelRedirect = onCancel
+
         confirmButton?.performClick()
+
         shadowOf(getMainLooper()).idle()
 
-        assertTrue(onConfirmCalled)
+        assertTrue(onConfirmedAlwaysCheckedCalled)
+        assertFalse(onConfirmAlwaysUncheckCalled)
         assertFalse(onCancelCalled)
     }
 
@@ -68,7 +91,7 @@ class SimpleRedirectDialogFragmentTest {
 
         doReturn(testContext).`when`(fragment).requireContext()
 
-        fragment.onConfirmRedirect = onConfirm
+        fragment.onConfirmRedirect = { onConfirm() }
         fragment.onCancelRedirect = onCancel
 
         val dialog = fragment.onCreateDialog(null)
@@ -95,7 +118,7 @@ class SimpleRedirectDialogFragmentTest {
 
         doReturn(testContext).`when`(fragment).requireContext()
 
-        fragment.onConfirmRedirect = onConfirm
+        fragment.onConfirmRedirect = { onConfirm() }
         fragment.onCancelRedirect = onCancel
 
         val dialog = fragment.onCreateDialog(null)

mobile/android/fenix/app/src/main/java/org/mozilla/fenix/components/Services.kt

@@ -13,6 +13,7 @@ import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.feature.accounts.FirefoxAccountsAuthFeature
 import mozilla.components.feature.app.links.AppLinksInterceptor
 import mozilla.components.service.fxa.manager.FxaAccountManager
+import org.mozilla.fenix.R
 import org.mozilla.fenix.ext.settings
 import org.mozilla.fenix.perf.lazyMonitored
 import org.mozilla.fenix.settings.SupportUtils
@@ -47,8 +48,13 @@ class Services(
         AppLinksInterceptor(
             context = context,
             interceptLinkClicks = true,
+            showCheckbox = true,
             launchInApp = { context.settings().shouldOpenLinksInApp() },
             shouldPrompt = { context.settings().shouldPromptOpenLinksInApp() },
+            checkboxCheckedAction = {
+                context.settings().openLinksInExternalApp =
+                    context.getString(R.string.pref_key_open_links_in_apps_always)
+            },
             launchFromInterceptor = true,
             store = store,
         )