Skip to content
New issue

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

#

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

Already on GitHub? # to your account

[IPP/POS] Automatically Cancel Payment Intents #13719

Draft
wants to merge 6 commits into
base: trunk
Choose a base branch
from
Draft

[IPP/POS] Automatically Cancel Payment Intents #13719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
012f04e
Add PaymentIntentStatus type explicitly
malinajirka Mar 11, 2025
f2463b5
Enable cancelling all non-final PI status except of requires_capture
malinajirka Mar 11, 2025
8c66c5c
Automatically cancel PI for incomplete non-retryable statuses
malinajirka Mar 11, 2025
1efe7c3
Add tests for automatic PI cancellation
malinajirka Mar 11, 2025
ef0bf4d
Pass PaymentIntent as a reference
malinajirka Mar 11, 2025
3cde3ca
Cancel PaymentIntents in retry flow
malinajirka Mar 11, 2025
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
70 changes: 53 additions & 17 deletions ...ader/src/main/java/com/woocommerce/android/cardreader/internal/payments/PaymentManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package com.woocommerce.android.cardreader.internal.payments

import com.stripe.stripeterminal.external.models.PaymentIntent
import com.stripe.stripeterminal.external.models.PaymentIntentStatus
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.CANCELED
import com.woocommerce.android.cardreader.CardReaderStore
import com.woocommerce.android.cardreader.CardReaderStore.CapturePaymentResponse
import com.woocommerce.android.cardreader.config.CardReaderConfigFactory
Expand All @@ -17,8 +16,15 @@ import com.woocommerce.android.cardreader.internal.payments.actions.ProcessPayme
import com.woocommerce.android.cardreader.internal.payments.actions.ProcessPaymentAction.ProcessPaymentStatus
import com.woocommerce.android.cardreader.internal.wrappers.TerminalWrapper
import com.woocommerce.android.cardreader.payments.CardPaymentStatus
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.*
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.CapturingPayment
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.CardPaymentStatusErrorType.Generic
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.CollectingPayment
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.InitializingPayment
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.PaymentCompleted
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.PaymentFailed
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.PaymentMethodType
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.ProcessingPayment
import com.woocommerce.android.cardreader.payments.CardPaymentStatus.ProcessingPaymentCompleted
import com.woocommerce.android.cardreader.payments.PaymentData
import com.woocommerce.android.cardreader.payments.PaymentInfo
import kotlinx.coroutines.flow.Flow
Expand All @@ -44,35 +50,62 @@ internal class PaymentManager(
if (paymentIntent?.status != PaymentIntentStatus.REQUIRES_PAYMENT_METHOD) {
return@flow
}
processPaymentIntent(paymentInfo.orderId, paymentIntent).collect { emit(it) }

processPayment(paymentInfo.orderId, paymentIntent)
}

fun retryPayment(orderId: Long, paymentData: PaymentData) =
processPaymentIntent(orderId, (paymentData as PaymentDataImpl).paymentIntent)
processPayment(orderId, (paymentData as PaymentDataImpl).paymentIntent)

fun cancelPayment(paymentData: PaymentData) {
val paymentIntent = (paymentData as PaymentDataImpl).paymentIntent
cancelOngoingPayment(paymentIntent)
}

private fun cancelOngoingPayment(paymentIntent: PaymentIntent) {
/* If the paymentIntent is in REQUIRES_CAPTURE state the app should not cancel the payment intent as it
doesn't know if it was already captured or not during one of the previous attempts to capture it. */
if (paymentIntent.status == PaymentIntentStatus.REQUIRES_PAYMENT_METHOD ||
paymentIntent.status == PaymentIntentStatus.REQUIRES_CONFIRMATION
if (paymentIntent.status != PaymentIntentStatus.SUCCEEDED &&
paymentIntent.status != PaymentIntentStatus.CANCELED &&
paymentIntent.status != PaymentIntentStatus.REQUIRES_CAPTURE
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📓 Previously, we were whitelisting statuses that should be cancelled. I believe this is not correct and we should attempt to cancel all nonfinal statuses. Ideally even Requires capture, however, this one is more tricky as mentioned in the description of this PR.

) {
cancelPaymentAction.cancelPayment(paymentIntent)
}
}

private fun processPaymentIntent(orderId: Long, data: PaymentIntent) = flow {
var paymentIntent = data
if (paymentIntent.status == null || paymentIntent.status == CANCELED) {
emit(errorMapper.mapError(errorMessage = "Cannot retry paymentIntent with status ${paymentIntent.status}"))
private fun processPayment(orderId: Long, paymentIntent: PaymentIntent) = flow {
val paymentIntentReference = PaymentIntentReference(paymentIntent)
var eligibleForRetry = false
try {
/* Passing PI as reference is a hack so we can access the updated PI in the finally block */
processPaymentIntent(orderId, paymentIntentReference).collect {
emit(it)
if (it is PaymentFailed && it.paymentDataForRetry != null) {
eligibleForRetry = true
}
}
} finally {
if (!eligibleForRetry) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea here is that if the PaymentIntent can be used for retries => we shouldn't cancel it as we'd break the retry logic, but we should cancel all other non-final payment intents.

cancelOngoingPayment(paymentIntentReference.value)
}
}
}

private fun processPaymentIntent(orderId: Long, paymentIntentRef: PaymentIntentReference) = flow {
if (paymentIntentRef.value.status == null || paymentIntentRef.value.status == PaymentIntentStatus.CANCELED) {
emit(
errorMapper.mapError(
errorMessage = "Cannot retry paymentIntent with status ${paymentIntentRef.value.status}"
)
)
return@flow
}

if (paymentIntent.status == PaymentIntentStatus.REQUIRES_PAYMENT_METHOD) {
paymentIntent = collectPayment(paymentIntent)
if (paymentIntentRef.value.status == PaymentIntentStatus.REQUIRES_PAYMENT_METHOD) {
paymentIntentRef.value = collectPayment(paymentIntentRef.value)
}
if (paymentIntent.status == PaymentIntentStatus.REQUIRES_CONFIRMATION) {
paymentIntent = processPayment(paymentIntent)
if (paymentIntentRef.value.status == PaymentIntentStatus.REQUIRES_CONFIRMATION) {
paymentIntentRef.value = processPayment(paymentIntentRef.value)
}

/*
Expand All @@ -88,9 +121,11 @@ internal class PaymentManager(
the success/failure of the actual payment.
*/

if (paymentIntent.status == PaymentIntentStatus.REQUIRES_CAPTURE || isInteracPaymentSuccessful(paymentIntent)) {
retrieveReceiptUrl(paymentIntent)?.let { receiptUrl ->
capturePayment(receiptUrl, orderId, cardReaderStore, paymentIntent)
if (paymentIntentRef.value.status == PaymentIntentStatus.REQUIRES_CAPTURE ||
isInteracPaymentSuccessful(paymentIntentRef.value)
) {
retrieveReceiptUrl(paymentIntentRef.value)?.let { receiptUrl ->
capturePayment(receiptUrl, orderId, cardReaderStore, paymentIntentRef.value)
}
}
}
Expand Down Expand Up @@ -199,3 +234,4 @@ internal class PaymentManager(
}

internal data class PaymentDataImpl(val paymentIntent: PaymentIntent) : PaymentData
internal data class PaymentIntentReference(var value: PaymentIntent)
95 changes: 95 additions & 0 deletions .../src/test/java/com/woocommerce/android/cardreader/internal/payments/PaymentManagerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import com.stripe.stripeterminal.external.models.Charge
import com.stripe.stripeterminal.external.models.PaymentIntent
import com.stripe.stripeterminal.external.models.PaymentIntentStatus
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.CANCELED
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.PROCESSING
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.REQUIRES_ACTION
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.REQUIRES_CAPTURE
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.REQUIRES_CONFIRMATION
import com.stripe.stripeterminal.external.models.PaymentIntentStatus.REQUIRES_PAYMENT_METHOD
Expand Down Expand Up @@ -598,6 +600,28 @@ class PaymentManagerTest : CardReaderBaseUnitTest() {
verify(cancelPaymentAction).cancelPayment(paymentIntent)
}

@Test
fun `given PaymentStatus PROCESSING, when canceling payment, then payment intent canceled`() =
testBlocking {
val paymentIntent = createPaymentIntent(PROCESSING)
val paymentData = PaymentDataImpl(paymentIntent)

manager.cancelPayment(paymentData)

verify(cancelPaymentAction).cancelPayment(paymentIntent)
}

@Test
fun `given PaymentStatus REQUIRES_ACTION, when canceling payment, then payment intent canceled`() =
testBlocking {
val paymentIntent = createPaymentIntent(REQUIRES_ACTION)
val paymentData = PaymentDataImpl(paymentIntent)

manager.cancelPayment(paymentData)

verify(cancelPaymentAction).cancelPayment(paymentIntent)
}

@Test
fun `given PaymentStatus REQUIRES_CAPTURE, when canceling payment, then payment intent NOT canceled`() =
testBlocking {
Expand All @@ -608,6 +632,77 @@ class PaymentManagerTest : CardReaderBaseUnitTest() {

verify(cancelPaymentAction, never()).cancelPayment(paymentIntent)
}

@Test
fun `given PaymentStatus SUCCEEDED, when canceling payment, then payment intent NOT canceled`() =
testBlocking {
val paymentIntent = createPaymentIntent(SUCCEEDED)
val paymentData = PaymentDataImpl(paymentIntent)

manager.cancelPayment(paymentData)

verify(cancelPaymentAction, never()).cancelPayment(paymentIntent)
}

@Test
fun `given PaymentStatus CANCELED, when canceling payment, then payment intent NOT canceled`() =
testBlocking {
val paymentIntent = createPaymentIntent(CANCELED)
val paymentData = PaymentDataImpl(paymentIntent)

manager.cancelPayment(paymentData)

verify(cancelPaymentAction, never()).cancelPayment(paymentIntent)
}

@Test
fun `given non-retryable error, when collecting payment intent fails, then payment automatically cancelled`() =
testBlocking {
whenever(collectPaymentAction.collectPayment(anyOrNull()))
.thenReturn(flow { emit(CollectPaymentStatus.Failure(mock())) })

manager.acceptPayment(createPaymentInfo()).toList()

verify(cancelPaymentAction).cancelPayment(any())
}

@Test
fun `given retryable error, when collecting payment intent fails, then payment NOT cancelled`() =
testBlocking {
whenever(collectPaymentAction.collectPayment(anyOrNull()))
.thenReturn(flow { emit(CollectPaymentStatus.Failure(mock())) })
val dataForRetry = mock<PaymentDataImpl>()
whenever(paymentErrorMapper.mapTerminalError(anyOrNull(), anyOrNull()))
.thenReturn(PaymentFailed(CardPaymentStatusErrorType.Generic, dataForRetry, ""))

manager.acceptPayment(createPaymentInfo()).toList()

verify(cancelPaymentAction, never()).cancelPayment(any())
}

@Test
fun `given non-retryable error, when processing payment fails, then payment automatically cancelled`() =
testBlocking {
whenever(processPaymentAction.processPayment(anyOrNull()))
.thenReturn(flow { emit(ProcessPaymentStatus.Failure(mock())) })

manager.acceptPayment(createPaymentInfo()).toList()

verify(cancelPaymentAction).cancelPayment(any())
}

@Test
fun `given retryable error, when processing payment fails, then payment NOT cancelled`() = testBlocking {
whenever(processPaymentAction.processPayment(anyOrNull()))
.thenReturn(flow { emit(ProcessPaymentStatus.Failure(mock())) })
val dataForRetry = mock<PaymentDataImpl>()
whenever(paymentErrorMapper.mapTerminalError(anyOrNull(), anyOrNull()))
.thenReturn(PaymentFailed(CardPaymentStatusErrorType.Generic, dataForRetry, ""))

manager.acceptPayment(createPaymentInfo()).toList()

verify(cancelPaymentAction, never()).cancelPayment(any())
}
// END - Cancel

private fun createPaymentIntent(
Expand Down