fix: prevent payment success modal from getting stuck after back/forth navigation

jakubuid · claude · jakubuid · commit 62e9adc37119 · 2026-02-17T12:48:21.000+01:00
When navigating back and forth in the payment flow before completing a payment,
the success modal would not dismiss on "Got it" or X click. Root causes:

1. Missing launchSingleTop on payment navigation caused duplicate dialog entries
   to stack on the backstack
2. popBackStack(Route.Connections.path) could silently fail if the backstack was
   in an unexpected state, leaving the dialog visible
3. SharedFlow replay=1 leaked stale payment data to duplicate ViewModel instances

Fixes: WCP4-41

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/sample/wallet/src/main/kotlin/com/reown/sample/wallet/ui/WalletKitActivity.kt b/sample/wallet/src/main/kotlin/com/reown/sample/wallet/ui/WalletKitActivity.kt
@@ -187,7 +187,9 @@ class WalletKitActivity : AppCompatActivity() {
             .onEach { paymentLink ->
                 navigateWhenReady {
                     val encodedLink = URLEncoder.encode(paymentLink, "UTF-8")
-                    navController.navigate("${Route.Payment.path}/$encodedLink")
+                    navController.navigate("${Route.Payment.path}/$encodedLink") {
+                        launchSingleTop = true
+                    }
                 }
             }
             .launchIn(lifecycleScope)
@@ -209,7 +211,9 @@ class WalletKitActivity : AppCompatActivity() {
             lifecycleScope.launch {
                 navigateWhenReady {
                     val encodedLink = URLEncoder.encode(dataString, "UTF-8")
-                    navController.navigate("${Route.Payment.path}/$encodedLink")
+                    navController.navigate("${Route.Payment.path}/$encodedLink") {
+                        launchSingleTop = true
+                    }
                 }
             }
             return
diff --git a/sample/wallet/src/main/kotlin/com/reown/sample/wallet/ui/routes/dialog_routes/payment/PaymentRoute.kt b/sample/wallet/src/main/kotlin/com/reown/sample/wallet/ui/routes/dialog_routes/payment/PaymentRoute.kt
@@ -133,7 +133,7 @@ fun PaymentRoute(
                             onWhyInfoRequired = { viewModel.showWhyInfoRequired() },
                             onClose = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -148,7 +148,7 @@ fun PaymentRoute(
                             },
                             onClose = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -159,7 +159,7 @@ fun PaymentRoute(
                             onConfirm = { viewModel.confirmFromSummary() },
                             onClose = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -168,7 +168,7 @@ fun PaymentRoute(
                             onBack = { viewModel.dismissWhyInfoRequired() },
                             onClose = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -177,7 +177,7 @@ fun PaymentRoute(
                             message = state.message,
                             onClose = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -187,13 +187,13 @@ fun PaymentRoute(
                             onDone = {
                                 viewModel.cancel()
                                 onPaymentSuccess()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                                 Toast.makeText(context, "Payment successful!", Toast.LENGTH_SHORT).show()
                             },
                             onClose = {
                                 viewModel.cancel()
                                 onPaymentSuccess()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -202,11 +202,11 @@ fun PaymentRoute(
                             message = state.message,
                             onRetry = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             },
                             onClose = {
                                 viewModel.cancel()
-                                navController.popBackStack(Route.Connections.path, inclusive = false)
+                                dismissPaymentDialog(navController)
                             }
                         )
                     }
@@ -218,6 +218,12 @@ fun PaymentRoute(
     }
 }
 
+private fun dismissPaymentDialog(navController: NavHostController) {
+    if (!navController.popBackStack(Route.Connections.path, inclusive = false)) {
+        navController.popBackStack()
+    }
+}
+
 @Composable
 private fun LoadingContent() {
     Column(
diff --git a/sample/wallet/src/main/kotlin/com/reown/sample/wallet/ui/routes/dialog_routes/payment/PaymentViewModel.kt b/sample/wallet/src/main/kotlin/com/reown/sample/wallet/ui/routes/dialog_routes/payment/PaymentViewModel.kt
@@ -61,6 +61,8 @@ class PaymentViewModel : ViewModel() {
      * Always goes directly to Options state (no Intro screen).
      */
     private fun processPaymentOptionsResponse(response: Wallet.Model.PaymentOptionsResponse) {
+        // Clear replay cache immediately after consuming to prevent stale data leaking to other ViewModel instances
+        WalletKitDelegate.clearPaymentOptions()
         currentPaymentId = response.paymentId
         collectedValues.clear()
         currentFieldIndex = 0

Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,9 @@ class WalletKitActivity : AppCompatActivity() {`
`187`	`187`	`.onEach { paymentLink ->`
`188`	`188`	`navigateWhenReady {`
`189`	`189`	`val encodedLink = URLEncoder.encode(paymentLink, "UTF-8")`
`190`		`- navController.navigate("${Route.Payment.path}/$encodedLink")`
	`190`	`+ navController.navigate("${Route.Payment.path}/$encodedLink") {`
	`191`	`+ launchSingleTop = true`
	`192`	`+ }`
`191`	`193`	`}`
`192`	`194`	`}`
`193`	`195`	`.launchIn(lifecycleScope)`
`@@ -209,7 +211,9 @@ class WalletKitActivity : AppCompatActivity() {`
`209`	`211`	`lifecycleScope.launch {`
`210`	`212`	`navigateWhenReady {`
`211`	`213`	`val encodedLink = URLEncoder.encode(dataString, "UTF-8")`
`212`		`- navController.navigate("${Route.Payment.path}/$encodedLink")`
	`214`	`+ navController.navigate("${Route.Payment.path}/$encodedLink") {`
	`215`	`+ launchSingleTop = true`
	`216`	`+ }`
`213`	`217`	`}`
`214`	`218`	`}`
`215`	`219`	`return`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ fun PaymentRoute(`
`133`	`133`	`onWhyInfoRequired = { viewModel.showWhyInfoRequired() },`
`134`	`134`	`onClose = {`
`135`	`135`	`viewModel.cancel()`
`136`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`136`	`+ dismissPaymentDialog(navController)`
`137`	`137`	`}`
`138`	`138`	`)`
`139`	`139`	`}`
`@@ -148,7 +148,7 @@ fun PaymentRoute(`
`148`	`148`	`},`
`149`	`149`	`onClose = {`
`150`	`150`	`viewModel.cancel()`
`151`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`151`	`+ dismissPaymentDialog(navController)`
`152`	`152`	`}`
`153`	`153`	`)`
`154`	`154`	`}`
`@@ -159,7 +159,7 @@ fun PaymentRoute(`
`159`	`159`	`onConfirm = { viewModel.confirmFromSummary() },`
`160`	`160`	`onClose = {`
`161`	`161`	`viewModel.cancel()`
`162`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`162`	`+ dismissPaymentDialog(navController)`
`163`	`163`	`}`
`164`	`164`	`)`
`165`	`165`	`}`
`@@ -168,7 +168,7 @@ fun PaymentRoute(`
`168`	`168`	`onBack = { viewModel.dismissWhyInfoRequired() },`
`169`	`169`	`onClose = {`
`170`	`170`	`viewModel.cancel()`
`171`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`171`	`+ dismissPaymentDialog(navController)`
`172`	`172`	`}`
`173`	`173`	`)`
`174`	`174`	`}`
`@@ -177,7 +177,7 @@ fun PaymentRoute(`
`177`	`177`	`message = state.message,`
`178`	`178`	`onClose = {`
`179`	`179`	`viewModel.cancel()`
`180`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`180`	`+ dismissPaymentDialog(navController)`
`181`	`181`	`}`
`182`	`182`	`)`
`183`	`183`	`}`
`@@ -187,13 +187,13 @@ fun PaymentRoute(`
`187`	`187`	`onDone = {`
`188`	`188`	`viewModel.cancel()`
`189`	`189`	`onPaymentSuccess()`
`190`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`190`	`+ dismissPaymentDialog(navController)`
`191`	`191`	`Toast.makeText(context, "Payment successful!", Toast.LENGTH_SHORT).show()`
`192`	`192`	`},`
`193`	`193`	`onClose = {`
`194`	`194`	`viewModel.cancel()`
`195`	`195`	`onPaymentSuccess()`
`196`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`196`	`+ dismissPaymentDialog(navController)`
`197`	`197`	`}`
`198`	`198`	`)`
`199`	`199`	`}`
`@@ -202,11 +202,11 @@ fun PaymentRoute(`
`202`	`202`	`message = state.message,`
`203`	`203`	`onRetry = {`
`204`	`204`	`viewModel.cancel()`
`205`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`205`	`+ dismissPaymentDialog(navController)`
`206`	`206`	`},`
`207`	`207`	`onClose = {`
`208`	`208`	`viewModel.cancel()`
`209`		`- navController.popBackStack(Route.Connections.path, inclusive = false)`
	`209`	`+ dismissPaymentDialog(navController)`
`210`	`210`	`}`
`211`	`211`	`)`
`212`	`212`	`}`
`@@ -218,6 +218,12 @@ fun PaymentRoute(`
`218`	`218`	`}`
`219`	`219`	`}`
`220`	`220`
	`221`	`+private fun dismissPaymentDialog(navController: NavHostController) {`
	`222`	`+ if (!navController.popBackStack(Route.Connections.path, inclusive = false)) {`
	`223`	`+ navController.popBackStack()`
	`224`	`+ }`
	`225`	`+}`
	`226`	`+`
`221`	`227`	`@Composable`
`222`	`228`	`private fun LoadingContent() {`
`223`	`229`	`Column(`