Merge pull request #14827 from woocommerce/issue/WOOMOB-1585-ipp-setup-authenticated-webview

hichamboushaba · web-flow · commit d970832738f3 · 2025-10-27T19:41:08.000+01:00
Use Authenticated WebView for IPP setup
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -4,6 +4,7 @@
 23.6
 -----
 - [Internal] Improve WebView experience by using Authenticated WebView for more scenarios [https://github.com/woocommerce/woocommerce-android/pull/14826]
+- [Internal] Update In-Person Payments setup flow to use Authenticated WebView [https://github.com/woocommerce/woocommerce-android/pull/14827]
 
 23.5
 -----
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/compose/component/web/WCWebChromeClient.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/compose/component/web/WCWebChromeClient.kt
@@ -1,11 +1,14 @@
 package com.woocommerce.android.ui.compose.component.web
 
 import android.net.Uri
+import android.os.Message
 import android.webkit.ValueCallback
 import android.webkit.WebChromeClient
 import android.webkit.WebView
+import android.widget.FrameLayout
 import androidx.activity.ComponentActivity
 import androidx.activity.result.contract.ActivityResultContracts
+import androidx.core.view.isVisible
 import com.woocommerce.android.extensions.findActivity
 
 open class WCWebChromeClient : WebChromeClient() {
@@ -48,4 +51,42 @@ open class WCWebChromeClient : WebChromeClient() {
     override fun onProgressChanged(view: WebView?, newProgress: Int) {
         onProgressChanged(newProgress)
     }
+
+    override fun onCreateWindow(
+        view: WebView,
+        isDialog: Boolean,
+        isUserGesture: Boolean,
+        resultMsg: Message
+    ): Boolean {
+        require(view.parent is FrameLayout) {
+            "Ensure the WebView is added to a FrameLayout to support popups. Check WCWebView implementation."
+        }
+
+        val popupContainer = view.parent as FrameLayout
+
+        val popupWebView = WebView(view.context).apply {
+            settings.useWideViewPort = view.settings.useWideViewPort
+            settings.loadWithOverviewMode = view.settings.loadWithOverviewMode
+            settings.javaScriptEnabled = view.settings.javaScriptEnabled
+            settings.domStorageEnabled = view.settings.domStorageEnabled
+            settings.setSupportMultipleWindows(true)
+        }
+
+        popupWebView.webViewClient = view.webViewClient
+        popupWebView.webChromeClient = object : WebChromeClient() {
+            override fun onCloseWindow(window: WebView) {
+                popupContainer.removeView(popupWebView)
+                view.isVisible = true
+            }
+        }
+
+        popupContainer.layoutParams = view.layoutParams
+        popupContainer.addView(popupWebView)
+        view.isVisible = false
+
+        (resultMsg.obj as WebView.WebViewTransport).webView = popupWebView
+        resultMsg.sendToTarget()
+
+        return true
+    }
 }
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/compose/component/web/WCWebView.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/compose/component/web/WCWebView.kt
@@ -3,6 +3,7 @@ package com.woocommerce.android.ui.compose.component.web
 import android.annotation.SuppressLint
 import android.view.ViewGroup
 import android.webkit.WebView
+import android.widget.FrameLayout
 import androidx.activity.compose.BackHandler
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
@@ -104,6 +105,7 @@ fun WCWebView(
             webView.settings.loadWithOverviewMode = settings.loadWithOverviewMode
             webView.settings.javaScriptEnabled = settings.isJavaScriptEnabled
             webView.settings.domStorageEnabled = settings.isDomStorageEnabled
+            webView.settings.setSupportMultipleWindows(true)
         }
     }
 
@@ -127,7 +129,7 @@ fun WCWebView(
 
         AndroidView(
             factory = { context ->
-                WebView(context).apply {
+                val webView = WebView(context).apply {
                     layoutParams = ViewGroup.LayoutParams(
                         ViewGroup.LayoutParams.MATCH_PARENT,
                         ViewGroup.LayoutParams.MATCH_PARENT
@@ -140,6 +142,10 @@ fun WCWebView(
 
                     this.settings.userAgentString = userAgent.webViewUserAgent
                 }.also { webView = it }
+
+                FrameLayout(context).apply {
+                    addView(webView)
+                }
             },
             modifier = Modifier
                 .alpha(webViewAlpha)
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingEvent.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingEvent.kt
@@ -4,9 +4,6 @@ import com.woocommerce.android.viewmodel.MultiLiveEvent
 
 sealed class CardReaderOnboardingEvent : MultiLiveEvent.Event() {
     object NavigateToSupport : MultiLiveEvent.Event()
-
-    data class NavigateToUrlInBrowser(val url: String) : MultiLiveEvent.Event()
-
     data class ContinueToHub(val cardReaderFlowParam: CardReaderFlowParam) : MultiLiveEvent.Event()
     data class ContinueToConnection(
         val cardReaderFlowParam: CardReaderFlowParam,
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingFragment.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingFragment.kt
@@ -28,6 +28,7 @@ import com.woocommerce.android.extensions.startHelpActivity
 import com.woocommerce.android.support.help.HelpOrigin
 import com.woocommerce.android.ui.base.BaseFragment
 import com.woocommerce.android.ui.base.UIMessageResolver
+import com.woocommerce.android.ui.common.webview.AuthenticatedWebViewLauncher
 import com.woocommerce.android.ui.main.AppBarStatus
 import com.woocommerce.android.util.ChromeCustomTabUtils
 import com.woocommerce.android.util.UiHelpers
@@ -43,6 +44,9 @@ class CardReaderOnboardingFragment : BaseFragment(R.layout.fragment_card_reader_
     @Inject
     lateinit var uiMessageResolver: UIMessageResolver
 
+    @Inject
+    lateinit var authenticatedWebViewLauncher: AuthenticatedWebViewLauncher
+
     val viewModel: CardReaderOnboardingViewModel by viewModels()
 
     override val activityAppBarStatus: AppBarStatus
@@ -92,9 +96,7 @@ class CardReaderOnboardingFragment : BaseFragment(R.layout.fragment_card_reader_
                 is CardReaderOnboardingEvent.NavigateToSupport -> {
                     requireActivity().startHelpActivity(HelpOrigin.CARD_READER_ONBOARDING)
                 }
-                is CardReaderOnboardingEvent.NavigateToUrlInBrowser -> {
-                    ChromeCustomTabUtils.launchUrl(requireContext(), event.url)
-                }
+
                 is CardReaderOnboardingEvent.ContinueToHub -> {
                     findNavController().navigate(
                         CardReaderOnboardingFragmentDirections
@@ -103,6 +105,7 @@ class CardReaderOnboardingFragment : BaseFragment(R.layout.fragment_card_reader_
                             )
                     )
                 }
+
                 is CardReaderOnboardingEvent.ContinueToConnection -> {
                     findNavController().navigate(
                         CardReaderOnboardingFragmentDirections
@@ -112,6 +115,15 @@ class CardReaderOnboardingFragment : BaseFragment(R.layout.fragment_card_reader_
                             )
                     )
                 }
+
+                is MultiLiveEvent.Event.LaunchUrlInAuthenticatedWebView -> {
+                    authenticatedWebViewLauncher.showAuthenticatedWebView(event)
+                }
+
+                is MultiLiveEvent.Event.LaunchUrlInChromeTab -> {
+                    ChromeCustomTabUtils.launchUrl(requireContext(), event.url)
+                }
+
                 is MultiLiveEvent.Event.ShowUiStringSnackbar -> uiMessageResolver.showSnack(event.message)
                 is MultiLiveEvent.Event.Exit -> findNavController().popBackStack()
                 else -> event.isHandled = false
@@ -148,20 +160,28 @@ class CardReaderOnboardingFragment : BaseFragment(R.layout.fragment_card_reader_
         when (state) {
             is CardReaderOnboardingViewState.GenericErrorState ->
                 showGenericErrorState(layout, state)
+
             is CardReaderOnboardingViewState.NoConnectionErrorState ->
                 showNetworkErrorState(layout, state)
+
             is CardReaderOnboardingViewState.LoadingState ->
                 showLoadingState(layout, state)
+
             is CardReaderOnboardingViewState.UnsupportedErrorState ->
                 showCountryNotSupportedState(layout, state)
+
             is CardReaderOnboardingViewState.WCPayError ->
                 showWCPayErrorState(layout, state)
+
             is CardReaderOnboardingViewState.StripeAccountError ->
                 showStripeAccountError(layout, state)
+
             is CardReaderOnboardingViewState.StripeExtensionError ->
                 showStripeExtensionErrorState(layout, state)
+
             is CardReaderOnboardingViewState.SelectPaymentPluginState ->
                 showPaymentPluginSelectionState(layout, state)
+
             is CardReaderOnboardingViewState.CashOnDeliveryDisabledState ->
                 showCashOnDeliveryDisabledState(layout, state)
         }
@@ -195,6 +215,7 @@ class CardReaderOnboardingFragment : BaseFragment(R.layout.fragment_card_reader_
                         R.string.card_reader_onboarding_cash_on_delivery_enable_failure
                     )
                 }
+
                 null -> {}
             }
         }
diff --git a/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingViewModel.kt b/WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingViewModel.kt
@@ -12,7 +12,6 @@ import com.woocommerce.android.model.UiString
 import com.woocommerce.android.tools.SelectedSite
 import com.woocommerce.android.ui.payments.cardreader.LearnMoreUrlProvider
 import com.woocommerce.android.ui.payments.cardreader.LearnMoreUrlProvider.LearnMoreUrlType.IN_PERSON_PAYMENTS
-import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingEvent.NavigateToUrlInBrowser
 import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingParams.Check
 import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingParams.Failed
 import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingState.ChoosePaymentGatewayProvider
@@ -134,7 +133,7 @@ class CardReaderOnboardingViewModel @Inject constructor(
                 }
 
                 is CardReaderOnboardingErrorCtaClickHandler.Reaction.OpenBrowser -> {
-                    triggerEvent(NavigateToUrlInBrowser(reaction.url))
+                    triggerEvent(Event.LaunchUrlInAuthenticatedWebView(reaction.url))
                     viewState.value = prevState!!
                 }
             }
@@ -438,7 +437,7 @@ class CardReaderOnboardingViewModel @Inject constructor(
 
     private fun onLearnMoreClicked() {
         paymentsFlowTracker.trackOnboardingLearnMoreTapped()
-        triggerEvent(NavigateToUrlInBrowser(learnMoreUrlProvider.provideLearnMoreUrlFor(IN_PERSON_PAYMENTS)))
+        triggerEvent(Event.LaunchUrlInChromeTab(learnMoreUrlProvider.provideLearnMoreUrlFor(IN_PERSON_PAYMENTS)))
     }
 
     private fun onSkipPendingRequirementsClicked() {
diff --git a/WooCommerce/src/test/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingViewModelTest.kt b/WooCommerce/src/test/kotlin/com/woocommerce/android/ui/payments/cardreader/onboarding/CardReaderOnboardingViewModelTest.kt
@@ -308,7 +308,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
         }
 
     @Test
-    fun `given handler returned OpenWpComWebView, when clicked on wcpay not setup, then open wp webview`() =
+    fun `given handler returned OpenBrowser, when clicked on wcpay not setup, then open authenticated webview`() =
         testBlocking {
             val url = "url"
             whenever(errorClickHandler.invoke(CardReaderOnboardingCTAErrorType.WC_PAY_NOT_SETUP))
@@ -328,63 +328,12 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
                 .actionButtonActionPrimary.invoke()
 
             assertThat(viewModel.event.value).isEqualTo(
-                CardReaderOnboardingEvent.NavigateToUrlInBrowser(url)
+                MultiLiveEvent.Event.LaunchUrlInAuthenticatedWebView(url)
             )
         }
 
     @Test
-    fun `given handler returned OpenGenericWebView, when clicked on wcpay not setup, then open generic webview`() =
-        testBlocking {
-            val url = "url"
-            whenever(errorClickHandler.invoke(CardReaderOnboardingCTAErrorType.WC_PAY_NOT_SETUP))
-                .thenReturn(CardReaderOnboardingErrorCtaClickHandler.Reaction.OpenBrowser(url))
-
-            val viewModel = createVM(
-                CardReaderOnboardingFragmentArgs(
-                    CardReaderOnboardingParams.Failed(
-                        cardReaderFlowParam = CardReaderFlowParam.PaymentOrRefund.Payment(1L, ORDER),
-                        onboardingState = SetupNotCompleted(WOOCOMMERCE_PAYMENTS),
-                    ),
-                    cardReaderType = CardReaderType.EXTERNAL
-                ).toSavedStateHandle()
-            )
-
-            (viewModel.viewStateData.value as WCPayError.WCPayNotSetupState)
-                .actionButtonActionPrimary.invoke()
-
-            assertThat(viewModel.event.value).isEqualTo(
-                CardReaderOnboardingEvent.NavigateToUrlInBrowser(url)
-            )
-        }
-
-    @Test
-    fun `given handler returned OpenWpComWebView, when clicked on stripe req overdue, then open wpcom webview`() =
-        testBlocking {
-            val url = "url"
-            whenever(errorClickHandler.invoke(CardReaderOnboardingCTAErrorType.STRIPE_ACCOUNT_OVERDUE_REQUIREMENTS))
-                .thenReturn(CardReaderOnboardingErrorCtaClickHandler.Reaction.OpenBrowser(url))
-
-            val viewModel = createVM(
-                CardReaderOnboardingFragmentArgs(
-                    CardReaderOnboardingParams.Failed(
-                        cardReaderFlowParam =
-                        CardReaderFlowParam.PaymentOrRefund.Payment(1L, ORDER),
-                        onboardingState = StripeAccountOverdueRequirement(WOOCOMMERCE_PAYMENTS),
-                    ),
-                    cardReaderType = CardReaderType.EXTERNAL
-                ).toSavedStateHandle()
-            )
-
-            (viewModel.viewStateData.value as StripeAccountError.StripeAccountOverdueRequirementsState)
-                .actionButtonPrimary!!.action.invoke()
-
-            assertThat(viewModel.event.value).isEqualTo(
-                CardReaderOnboardingEvent.NavigateToUrlInBrowser(url)
-            )
-        }
-
-    @Test
-    fun `given handler returned OpenGenericWebView, when clicked on stripe req overdue, then open generic webview`() =
+    fun `given handler returned OpenBrowser, when clicked on stripe req overdue, then open authenticated webview`() =
         testBlocking {
             val url = "url"
             whenever(errorClickHandler.invoke(CardReaderOnboardingCTAErrorType.STRIPE_ACCOUNT_OVERDUE_REQUIREMENTS))
@@ -404,7 +353,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
                 .actionButtonPrimary!!.action.invoke()
 
             assertThat(viewModel.event.value).isEqualTo(
-                CardReaderOnboardingEvent.NavigateToUrlInBrowser(url)
+                MultiLiveEvent.Event.LaunchUrlInAuthenticatedWebView(url)
             )
         }
 
@@ -623,7 +572,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
             (viewModel.viewStateData.value as UnsupportedErrorState.WcPayInCountry)
                 .onLearnMoreActionClicked.invoke()
 
-            val event = viewModel.event.value as CardReaderOnboardingEvent.NavigateToUrlInBrowser
+            val event = viewModel.event.value as MultiLiveEvent.Event.LaunchUrlInChromeTab
             assertThat(event.url).isEqualTo(AppUrls.WOOCOMMERCE_LEARN_MORE_ABOUT_PAYMENTS)
         }
 
@@ -637,7 +586,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
             (viewModel.viewStateData.value as UnsupportedErrorState.Country)
                 .onLearnMoreActionClicked.invoke()
 
-            val event = viewModel.event.value as CardReaderOnboardingEvent.NavigateToUrlInBrowser
+            val event = viewModel.event.value as MultiLiveEvent.Event.LaunchUrlInChromeTab
             assertThat(event.url).isEqualTo(AppUrls.WOOCOMMERCE_LEARN_MORE_ABOUT_PAYMENTS)
         }
 
@@ -690,7 +639,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
 
             (viewModel.viewStateData.value as UnsupportedErrorState.Country).onLearnMoreActionClicked.invoke()
 
-            val event = viewModel.event.value as CardReaderOnboardingEvent.NavigateToUrlInBrowser
+            val event = viewModel.event.value as MultiLiveEvent.Event.LaunchUrlInChromeTab
             assertThat(event.url).isEqualTo(AppUrls.STRIPE_LEARN_MORE_ABOUT_PAYMENTS)
         }
 
@@ -706,7 +655,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
 
             (viewModel.viewStateData.value as UnsupportedErrorState.Country).onLearnMoreActionClicked.invoke()
 
-            val event = viewModel.event.value as CardReaderOnboardingEvent.NavigateToUrlInBrowser
+            val event = viewModel.event.value as MultiLiveEvent.Event.LaunchUrlInChromeTab
             assertThat(event.url).isEqualTo(AppUrls.WOOCOMMERCE_LEARN_MORE_ABOUT_PAYMENTS)
         }
 
@@ -720,7 +669,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
             (viewModel.viewStateData.value as UnsupportedErrorState.StripeAccountInUnsupportedCountry)
                 .onLearnMoreActionClicked.invoke()
 
-            val event = viewModel.event.value as CardReaderOnboardingEvent.NavigateToUrlInBrowser
+            val event = viewModel.event.value as MultiLiveEvent.Event.LaunchUrlInChromeTab
             assertThat(event.url).isEqualTo(AppUrls.WOOCOMMERCE_LEARN_MORE_ABOUT_PAYMENTS)
         }
 
@@ -1113,7 +1062,7 @@ class CardReaderOnboardingViewModelTest : BaseUnitTest() {
             (viewModel.viewStateData.value as CashOnDeliveryDisabledState)
                 .onLearnMoreActionClicked.invoke()
 
-            val event = viewModel.event.value as CardReaderOnboardingEvent.NavigateToUrlInBrowser
+            val event = viewModel.event.value as MultiLiveEvent.Event.LaunchUrlInChromeTab
             assertThat(event.url).isEqualTo(AppUrls.WOOCOMMERCE_LEARN_MORE_ABOUT_PAYMENTS)
         }
 

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ import com.woocommerce.android.model.UiString`
`12`	`12`	`import com.woocommerce.android.tools.SelectedSite`
`13`	`13`	`import com.woocommerce.android.ui.payments.cardreader.LearnMoreUrlProvider`
`14`	`14`	`import com.woocommerce.android.ui.payments.cardreader.LearnMoreUrlProvider.LearnMoreUrlType.IN_PERSON_PAYMENTS`
`15`		`-import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingEvent.NavigateToUrlInBrowser`
`16`	`15`	`import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingParams.Check`
`17`	`16`	`import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingParams.Failed`
`18`	`17`	`import com.woocommerce.android.ui.payments.cardreader.onboarding.CardReaderOnboardingState.ChoosePaymentGatewayProvider`
`@@ -134,7 +133,7 @@ class CardReaderOnboardingViewModel @Inject constructor(`
`134`	`133`	`}`
`135`	`134`
`136`	`135`	`is CardReaderOnboardingErrorCtaClickHandler.Reaction.OpenBrowser -> {`
`137`		`- triggerEvent(NavigateToUrlInBrowser(reaction.url))`
	`136`	`+ triggerEvent(Event.LaunchUrlInAuthenticatedWebView(reaction.url))`
`138`	`137`	`viewState.value = prevState!!`
`139`	`138`	`}`
`140`	`139`	`}`
`@@ -438,7 +437,7 @@ class CardReaderOnboardingViewModel @Inject constructor(`
`438`	`437`
`439`	`438`	`private fun onLearnMoreClicked() {`
`440`	`439`	`paymentsFlowTracker.trackOnboardingLearnMoreTapped()`
`441`		`- triggerEvent(NavigateToUrlInBrowser(learnMoreUrlProvider.provideLearnMoreUrlFor(IN_PERSON_PAYMENTS)))`
	`440`	`+ triggerEvent(Event.LaunchUrlInChromeTab(learnMoreUrlProvider.provideLearnMoreUrlFor(IN_PERSON_PAYMENTS)))`
`442`	`441`	`}`
`443`	`442`
`444`	`443`	`private fun onSkipPendingRequirementsClicked() {`