Skip to content

Commit b99a0e7

Browse files
jaynewstrom-stripejaynewstrom-stripe
authored
Refactor mandates to be a part of the interactor state. (#10118)
1 parent d85f8cc commit b99a0e7

11 files changed

+181
-147
lines changed

‎paymentsheet/src/main/java/com/stripe/android/paymentelement/embedded/content/EmbeddedContent.kt

+7-30
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,18 @@ import androidx.compose.material.MaterialTheme
88
import androidx.compose.runtime.Composable
99
import androidx.compose.runtime.Immutable
1010
import androidx.compose.ui.Modifier
11-
import androidx.compose.ui.platform.testTag
1211
import androidx.compose.ui.unit.dp
13-
import com.stripe.android.core.strings.ResolvableString
1412
import com.stripe.android.paymentelement.ExperimentalEmbeddedPaymentElementApi
1513
import com.stripe.android.paymentsheet.PaymentSheet.Appearance.Embedded
16-
import com.stripe.android.paymentsheet.ui.Mandate
1714
import com.stripe.android.paymentsheet.verticalmode.PaymentMethodEmbeddedLayoutUI
1815
import com.stripe.android.paymentsheet.verticalmode.PaymentMethodVerticalLayoutInteractor
1916
import com.stripe.android.uicore.StripeTheme
20-
import com.stripe.android.uicore.strings.resolve
2117

2218
@Immutable
2319
@OptIn(ExperimentalEmbeddedPaymentElementApi::class)
2420
internal data class EmbeddedContent(
2521
private val interactor: PaymentMethodVerticalLayoutInteractor,
26-
val mandate: ResolvableString? = null,
22+
private val embeddedViewDisplaysMandateText: Boolean,
2723
private val rowStyle: Embedded.RowStyle
2824
) {
2925
@Composable
@@ -35,32 +31,13 @@ internal data class EmbeddedContent(
3531
.padding(top = 8.dp)
3632
.animateContentSize()
3733
) {
38-
EmbeddedVerticalList()
39-
EmbeddedMandate()
34+
PaymentMethodEmbeddedLayoutUI(
35+
interactor = interactor,
36+
embeddedViewDisplaysMandateText = embeddedViewDisplaysMandateText,
37+
modifier = Modifier.padding(bottom = 8.dp),
38+
rowStyle = rowStyle
39+
)
4040
}
4141
}
4242
}
43-
44-
@Composable
45-
private fun EmbeddedVerticalList() {
46-
PaymentMethodEmbeddedLayoutUI(
47-
interactor = interactor,
48-
modifier = Modifier.padding(bottom = 8.dp),
49-
rowStyle = rowStyle
50-
)
51-
}
52-
53-
@Composable
54-
private fun EmbeddedMandate() {
55-
Mandate(
56-
mandateText = mandate?.resolve(),
57-
modifier = Modifier
58-
.padding(bottom = 8.dp)
59-
.testTag(EMBEDDED_MANDATE_TEXT_TEST_TAG),
60-
)
61-
}
62-
63-
companion object {
64-
const val EMBEDDED_MANDATE_TEXT_TEST_TAG = "EMBEDDED_MANDATE"
65-
}
6643
}

‎paymentsheet/src/main/java/com/stripe/android/paymentelement/embedded/content/EmbeddedContentHelper.kt

+2-24
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import android.os.Parcelable
44
import androidx.lifecycle.SavedStateHandle
55
import com.stripe.android.core.injection.IOContext
66
import com.stripe.android.core.injection.ViewModelScope
7-
import com.stripe.android.core.strings.ResolvableString
87
import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodMetadata
98
import com.stripe.android.paymentelement.ExperimentalEmbeddedPaymentElementApi
109
import com.stripe.android.paymentelement.confirmation.ConfirmationHandler
@@ -27,7 +26,6 @@ import kotlinx.coroutines.CoroutineScope
2726
import kotlinx.coroutines.flow.MutableStateFlow
2827
import kotlinx.coroutines.flow.StateFlow
2928
import kotlinx.coroutines.flow.asStateFlow
30-
import kotlinx.coroutines.flow.update
3129
import kotlinx.coroutines.launch
3230
import kotlinx.parcelize.Parcelize
3331
import javax.inject.Inject
@@ -65,11 +63,6 @@ internal class DefaultEmbeddedContentHelper @Inject constructor(
6563
private val confirmationStateHolder: EmbeddedConfirmationStateHolder,
6664
) : EmbeddedContentHelper {
6765

68-
private val mandate: StateFlow<ResolvableString?> = savedStateHandle.getStateFlow(
69-
key = MANDATE_KEY_EMBEDDED_CONTENT,
70-
initialValue = null,
71-
)
72-
7366
private val state: StateFlow<State?> = savedStateHandle.getStateFlow(
7467
key = STATE_KEY_EMBEDDED_CONTENT,
7568
initialValue = null
@@ -92,20 +85,12 @@ internal class DefaultEmbeddedContentHelper @Inject constructor(
9285
paymentMethodMetadata = state.paymentMethodMetadata,
9386
walletsState = embeddedWalletsHelper.walletsState(state.paymentMethodMetadata),
9487
),
95-
rowStyle = state.rowStyle
88+
embeddedViewDisplaysMandateText = state.embeddedViewDisplaysMandateText,
89+
rowStyle = state.rowStyle,
9690
)
9791
}
9892
}
9993
}
100-
coroutineScope.launch {
101-
mandate.collect { mandate ->
102-
if (state.value?.embeddedViewDisplaysMandateText == true) {
103-
_embeddedContent.update { originalEmbeddedContent ->
104-
originalEmbeddedContent?.copy(mandate = mandate)
105-
}
106-
}
107-
}
108-
}
10994
}
11095

11196
override fun dataLoaded(
@@ -189,9 +174,6 @@ internal class DefaultEmbeddedContentHelper @Inject constructor(
189174
walletsState = walletsState,
190175
canShowWalletsInline = true,
191176
canShowWalletButtons = false,
192-
onMandateTextUpdated = { updatedMandate ->
193-
savedStateHandle[MANDATE_KEY_EMBEDDED_CONTENT] = updatedMandate
194-
},
195177
updateSelection = { updatedSelection ->
196178
setSelection(updatedSelection)
197179
},
@@ -235,9 +217,6 @@ internal class DefaultEmbeddedContentHelper @Inject constructor(
235217
}
236218

237219
private fun setSelection(paymentSelection: PaymentSelection?) {
238-
if (paymentSelection != selectionHolder.selection.value) {
239-
savedStateHandle[MANDATE_KEY_EMBEDDED_CONTENT] = null
240-
}
241220
selectionHolder.set(paymentSelection)
242221
}
243222

@@ -249,7 +228,6 @@ internal class DefaultEmbeddedContentHelper @Inject constructor(
249228
) : Parcelable
250229

251230
companion object {
252-
const val MANDATE_KEY_EMBEDDED_CONTENT = "MANDATE_KEY_EMBEDDED_CONTENT"
253231
const val STATE_KEY_EMBEDDED_CONTENT = "STATE_KEY_EMBEDDED_CONTENT"
254232
}
255233
}

‎paymentsheet/src/main/java/com/stripe/android/paymentsheet/verticalmode/PaymentMethodEmbeddedLayoutUI.kt

+27-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package com.stripe.android.paymentsheet.verticalmode
22

33
import androidx.compose.foundation.layout.Arrangement
44
import androidx.compose.foundation.layout.Column
5+
import androidx.compose.foundation.layout.ColumnScope
56
import androidx.compose.foundation.layout.padding
67
import androidx.compose.material.Divider
78
import androidx.compose.runtime.Composable
@@ -13,19 +14,24 @@ import androidx.compose.ui.platform.LocalContext
1314
import androidx.compose.ui.platform.testTag
1415
import androidx.compose.ui.unit.Dp
1516
import androidx.compose.ui.unit.dp
17+
import com.stripe.android.core.strings.ResolvableString
1618
import com.stripe.android.paymentelement.ExperimentalEmbeddedPaymentElementApi
1719
import com.stripe.android.paymentsheet.DisplayableSavedPaymentMethod
1820
import com.stripe.android.paymentsheet.PaymentSheet.Appearance.Embedded
21+
import com.stripe.android.paymentsheet.ui.Mandate
1922
import com.stripe.android.uicore.image.StripeImageLoader
23+
import com.stripe.android.uicore.strings.resolve
2024
import com.stripe.android.uicore.utils.collectAsState
2125
import org.jetbrains.annotations.VisibleForTesting
2226

2327
internal const val TEST_TAG_PAYMENT_METHOD_EMBEDDED_LAYOUT = "TEST_TAG_PAYMENT_METHOD_EMBEDDED_LAYOUT"
28+
internal const val EMBEDDED_MANDATE_TEXT_TEST_TAG = "EMBEDDED_MANDATE"
2429

2530
@OptIn(ExperimentalEmbeddedPaymentElementApi::class)
2631
@Composable
27-
internal fun PaymentMethodEmbeddedLayoutUI(
32+
internal fun ColumnScope.PaymentMethodEmbeddedLayoutUI(
2833
interactor: PaymentMethodVerticalLayoutInteractor,
34+
embeddedViewDisplaysMandateText: Boolean,
2935
modifier: Modifier = Modifier,
3036
rowStyle: Embedded.RowStyle
3137
) {
@@ -62,6 +68,11 @@ internal fun PaymentMethodEmbeddedLayoutUI(
6268
.testTag(TEST_TAG_PAYMENT_METHOD_EMBEDDED_LAYOUT),
6369
rowStyle = rowStyle
6470
)
71+
72+
EmbeddedMandate(
73+
embeddedViewDisplaysMandateText = embeddedViewDisplaysMandateText,
74+
mandate = state.mandate,
75+
)
6576
}
6677

6778
@OptIn(ExperimentalEmbeddedPaymentElementApi::class)
@@ -149,6 +160,21 @@ private fun OptionalEmbeddedDivider(rowStyle: Embedded.RowStyle) {
149160
}
150161
}
151162

163+
@Composable
164+
private fun EmbeddedMandate(
165+
embeddedViewDisplaysMandateText: Boolean,
166+
mandate: ResolvableString?,
167+
) {
168+
if (embeddedViewDisplaysMandateText) {
169+
Mandate(
170+
mandateText = mandate?.resolve(),
171+
modifier = Modifier
172+
.padding(bottom = 8.dp)
173+
.testTag(EMBEDDED_MANDATE_TEXT_TEST_TAG),
174+
)
175+
}
176+
}
177+
152178
@OptIn(ExperimentalEmbeddedPaymentElementApi::class)
153179
private fun Embedded.RowStyle.bottomSeparatorEnabled(): Boolean {
154180
return when (this) {

‎paymentsheet/src/main/java/com/stripe/android/paymentsheet/verticalmode/PaymentMethodVerticalLayoutInteractor.kt

+25-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.stripe.android.paymentsheet.verticalmode
22

3+
import androidx.lifecycle.viewModelScope
34
import com.stripe.android.core.strings.ResolvableString
45
import com.stripe.android.core.strings.resolvableString
56
import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodMetadata
@@ -46,6 +47,7 @@ internal interface PaymentMethodVerticalLayoutInteractor {
4647
val selection: Selection?,
4748
val displayedSavedPaymentMethod: DisplayableSavedPaymentMethod?,
4849
val availableSavedPaymentMethodAction: SavedPaymentMethodAction,
50+
val mandate: ResolvableString?,
4951
)
5052

5153
sealed interface Selection {
@@ -88,7 +90,6 @@ internal class DefaultPaymentMethodVerticalLayoutInteractor(
8890
private val walletsState: StateFlow<WalletsState?>,
8991
private val canShowWalletsInline: Boolean,
9092
private val canShowWalletButtons: Boolean,
91-
private val onMandateTextUpdated: (ResolvableString?) -> Unit,
9293
private val updateSelection: (PaymentSelection?) -> Unit,
9394
private val isCurrentScreen: StateFlow<Boolean>,
9495
private val reportPaymentMethodTypeSelected: (PaymentMethodCode) -> Unit,
@@ -151,12 +152,24 @@ internal class DefaultPaymentMethodVerticalLayoutInteractor(
151152
isCurrentScreen = viewModel.navigationHandler.currentScreen.mapAsStateFlow {
152153
it is PaymentSheetScreen.VerticalMode
153154
},
154-
onMandateTextUpdated = {
155-
viewModel.mandateHandler.updateMandateText(mandateText = it, showAbove = true)
156-
},
157155
reportPaymentMethodTypeSelected = viewModel.eventReporter::onSelectPaymentMethod,
158156
reportFormShown = viewModel.eventReporter::onPaymentMethodFormShown,
159-
)
157+
).also { interactor ->
158+
viewModel.viewModelScope.launch {
159+
interactor.state.collect { state ->
160+
val newSelection = state.selection as? PaymentMethodVerticalLayoutInteractor.Selection.New
161+
newSelection?.code?.let { code ->
162+
val formType = formHelper.formTypeForCode(code)
163+
if (formType is FormType.MandateOnly) {
164+
viewModel.mandateHandler.updateMandateText(
165+
mandateText = formType.mandate,
166+
showAbove = true,
167+
)
168+
}
169+
}
170+
}
171+
}
172+
}
160173
}
161174
}
162175

@@ -214,12 +227,19 @@ internal class DefaultPaymentMethodVerticalLayoutInteractor(
214227
} else {
215228
null
216229
}
230+
val selectionCode = temporarySelectionCode ?: (mostRecentSelection as? PaymentSelection.New).code()
231+
val mandate = if (selectionCode != null) {
232+
(formTypeForCode(selectionCode) as? FormType.MandateOnly)?.mandate
233+
} else {
234+
null
235+
}
217236
PaymentMethodVerticalLayoutInteractor.State(
218237
displayablePaymentMethods = displayablePaymentMethods,
219238
isProcessing = isProcessing,
220239
selection = temporarySelection ?: mostRecentSelection?.asVerticalSelection(),
221240
displayedSavedPaymentMethod = displayedSavedPaymentMethod,
222241
availableSavedPaymentMethodAction = action,
242+
mandate = mandate,
223243
)
224244
}
225245

@@ -380,10 +400,6 @@ internal class DefaultPaymentMethodVerticalLayoutInteractor(
380400
transitionToFormScreen(viewAction.selectedPaymentMethodCode)
381401
} else {
382402
updateSelectedPaymentMethod(viewAction.selectedPaymentMethodCode)
383-
384-
if (formType is FormType.MandateOnly) {
385-
onMandateTextUpdated(formType.mandate)
386-
}
387403
}
388404
}
389405
is ViewAction.SavedPaymentMethodSelected -> {

‎paymentsheet/src/test/java/com/stripe/android/paymentelement/embedded/content/DefaultEmbeddedContentHelperTest.kt

-63
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@ package com.stripe.android.paymentelement.embedded.content
33
import androidx.lifecycle.SavedStateHandle
44
import app.cash.turbine.test
55
import com.google.common.truth.Truth.assertThat
6-
import com.stripe.android.core.strings.resolvableString
76
import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodMetadata
87
import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodMetadataFactory
98
import com.stripe.android.paymentelement.ExperimentalEmbeddedPaymentElementApi
109
import com.stripe.android.paymentelement.confirmation.FakeConfirmationHandler
1110
import com.stripe.android.paymentelement.embedded.EmbeddedFormHelperFactory
1211
import com.stripe.android.paymentelement.embedded.EmbeddedSelectionHolder
13-
import com.stripe.android.paymentelement.embedded.content.DefaultEmbeddedContentHelper.Companion.MANDATE_KEY_EMBEDDED_CONTENT
1412
import com.stripe.android.paymentelement.embedded.content.DefaultEmbeddedContentHelper.Companion.STATE_KEY_EMBEDDED_CONTENT
1513
import com.stripe.android.paymentsheet.CustomerStateHolder
1614
import com.stripe.android.paymentsheet.PaymentSheet.Appearance.Embedded
@@ -51,45 +49,6 @@ internal class DefaultEmbeddedContentHelperTest {
5149
}
5250
}
5351

54-
@Test
55-
fun `setting mandate emits embeddedContent event`() = testScenario {
56-
embeddedContentHelper.embeddedContent.test {
57-
assertThat(awaitItem()).isNull()
58-
embeddedContentHelper.dataLoaded(
59-
PaymentMethodMetadataFactory.create(),
60-
Embedded.RowStyle.FlatWithRadio.defaultLight,
61-
embeddedViewDisplaysMandateText = true,
62-
)
63-
awaitItem().run {
64-
assertThat(this).isNotNull()
65-
assertThat(this?.mandate).isNull()
66-
}
67-
savedStateHandle[MANDATE_KEY_EMBEDDED_CONTENT] = "Hi".resolvableString
68-
awaitItem().run {
69-
assertThat(this).isNotNull()
70-
assertThat(this?.mandate).isEqualTo("Hi".resolvableString)
71-
}
72-
}
73-
}
74-
75-
@Test
76-
fun `setting mandate when embeddedViewDisplaysMandateText does not emit event with mandate`() = testScenario {
77-
embeddedContentHelper.embeddedContent.test {
78-
assertThat(awaitItem()).isNull()
79-
embeddedContentHelper.dataLoaded(
80-
PaymentMethodMetadataFactory.create(),
81-
Embedded.RowStyle.FlatWithRadio.defaultLight,
82-
embeddedViewDisplaysMandateText = false,
83-
)
84-
awaitItem().run {
85-
assertThat(this).isNotNull()
86-
assertThat(this?.mandate).isNull()
87-
}
88-
savedStateHandle[MANDATE_KEY_EMBEDDED_CONTENT] = "Hi".resolvableString
89-
ensureAllEventsConsumed() // Updating the mandate shouldn't emit any more events.
90-
}
91-
}
92-
9352
@Test
9453
fun `initializing embeddedContentHelper with paymentMethodMetadata emits correct initial event`() = testScenario(
9554
setup = {
@@ -108,28 +67,6 @@ internal class DefaultEmbeddedContentHelperTest {
10867
}
10968
}
11069

111-
@Test
112-
fun `initializing embeddedContentHelper with mandate emits correct initial event`() = testScenario(
113-
setup = {
114-
set(
115-
STATE_KEY_EMBEDDED_CONTENT,
116-
DefaultEmbeddedContentHelper.State(
117-
PaymentMethodMetadataFactory.create(),
118-
Embedded.RowStyle.FloatingButton.default,
119-
embeddedViewDisplaysMandateText = true
120-
)
121-
)
122-
set(MANDATE_KEY_EMBEDDED_CONTENT, "Hi".resolvableString)
123-
}
124-
) {
125-
embeddedContentHelper.embeddedContent.test {
126-
awaitItem().run {
127-
assertThat(this).isNotNull()
128-
assertThat(this?.mandate).isEqualTo("Hi".resolvableString)
129-
}
130-
}
131-
}
132-
13370
private class Scenario(
13471
val embeddedContentHelper: DefaultEmbeddedContentHelper,
13572
val savedStateHandle: SavedStateHandle,

0 commit comments

Comments
 (0)