Skip to content

Clear CheckoutController state after completion #13804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jaynewstrom-stripe wants to merge 1 commit into from
+9 −6
Draft

Clear CheckoutController state after completion #13804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion paymentsheet/src/main/java/com/stripe/android/checkout/CheckoutConfirmationResultHandler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ internal class CheckoutConfirmationResultHandler @Inject constructor(
onSucceeded: suspend (CheckoutSessionResponse?) -> Unit,
) {
// Synchronous confirmation carries the latest response. Next-action confirmation does not,
// so the controller retrieves the completed Checkout Session before delivering the result.
// so the controller retrieves the completed Checkout Session before clearing its state.
onSucceeded(result.metadata[CheckoutSessionResponseKey])
resultCallback.onResult(CheckoutController.Result.Completed())
}
Expand Down
7 changes: 5 additions & 2 deletions paymentsheet/src/main/java/com/stripe/android/checkout/CheckoutController.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ class CheckoutController @Inject internal constructor(
}

/**
* The latest [Session] data, or `null` until [configure] has completed successfully.
* The latest [Session] data, or `null` until [configure] completes successfully and after a
* payment flow completes.
*/
val session: StateFlow<Session?>
get() = stateHolder.session
Expand Down Expand Up @@ -303,6 +304,7 @@ class CheckoutController @Inject internal constructor(
) {
runSerialized {
confirmationStateUpdater.update(checkoutSessionResponse)
stateHolder.state = null
kotlin.Result.success(Unit)
}
}
Expand Down Expand Up @@ -1006,7 +1008,8 @@ class CheckoutController @Inject internal constructor(
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
sealed interface Result {
/**
* The customer completed the payment flow.
* The customer completed the payment flow. The controller's loaded [session] is cleared
* before this result is delivered.
*/
@CheckoutSessionPreview
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
Expand Down
6 changes: 3 additions & 3 deletions paymentsheet/src/test/java/com/stripe/android/checkout/CheckoutControllerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,7 +1024,7 @@ internal class CheckoutControllerTest {
}

@Test
fun `successful confirmation waits for an in-flight mutation then refreshes state`() =
fun `successful confirmation waits for an in-flight mutation then clears state`() =
runMutationScenario(assertLoadingConsumed = true) {
val holdMutation = CountDownLatch(1)
networkRule.checkoutUpdate(
Expand Down Expand Up @@ -1056,8 +1056,8 @@ internal class CheckoutControllerTest {
confirmation.await()

assertThat(isUpdatingTurbine.awaitItem()).isFalse()
assertThat(committedState().checkoutSessionResponse).isEqualTo(confirmedResponse)
assertThat(controller.session.value).isNotNull()
assertThat(committedStateOrNull()).isNull()
assertThat(controller.session.value).isNull()
}

@Test
Expand Down