Fix FlowController bug with registered callbacks (#10374)

Author: samer-stripe

paymentsheet/src/main/java/com/stripe/android/paymentsheet/PaymentSheet.kt

@@ -2202,7 +2202,7 @@ class PaymentSheet internal constructor(
             }
 
             private fun initializeCallbacks() {
-                setPaymentSheetCallbacks(
+                setFlowControllerCallbacks(
                     createIntentCallback = createIntentCallback,
                     externalPaymentMethodConfirmHandler = externalPaymentMethodConfirmHandler,
                 )

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

@@ -4,6 +4,8 @@ import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.testing.TestLifecycleOwner
 import com.google.common.truth.Truth.assertThat
+import com.stripe.android.paymentelement.callbacks.PaymentElementCallbackReferences
+import com.stripe.android.paymentelement.callbacks.PaymentElementCallbacks
 import com.stripe.android.paymentelement.embedded.FakeEmbeddedSheetLauncher
 import com.stripe.android.paymentsheet.analytics.FakeEventReporter
 import com.stripe.android.testing.CoroutineTestRule
@@ -32,19 +34,57 @@ internal class EmbeddedPaymentElementInitializerTest {
         eventReporter.cannotProperlyReturnFromLinkAndOtherLPMsCalls.ensureAllEventsConsumed()
     }
 
+    @Test
+    fun `when lifecycle is destroyed, should un-initialize callbacks`() {
+        val owner = TestLifecycleOwner()
+        val callbacks = PaymentElementCallbacks(
+            createIntentCallback = { _, _ ->
+                error("Not implemented")
+            },
+            externalPaymentMethodConfirmHandler = { _, _ ->
+                error("Not implemented")
+            }
+        )
+
+        PaymentElementCallbackReferences[PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER] = callbacks
+
+        testScenario(owner, PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER) {
+            lifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_CREATE)
+
+            assertThat(PaymentElementCallbackReferences[PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER])
+                .isEqualTo(callbacks)
+
+            lifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
+
+            assertThat(PaymentElementCallbackReferences[PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER])
+                .isEqualTo(callbacks)
+
+            lifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_PAUSE)
+
+            assertThat(PaymentElementCallbackReferences[PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER])
+                .isEqualTo(callbacks)
+
+            lifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
+
+            assertThat(PaymentElementCallbackReferences[PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER])
+                .isNotNull()
+        }
+    }
+
     private fun testScenario(
+        lifecycleOwner: TestLifecycleOwner = TestLifecycleOwner(),
+        paymentElementCallbackIdentifier: String = PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER,
         block: suspend Scenario.() -> Unit,
     ) = runTest {
         val contentHelper = FakeEmbeddedContentHelper()
-        val lifecycleOwner = TestLifecycleOwner()
         val eventReporter = FakeEventReporter()
         val initializer = EmbeddedPaymentElementInitializer(
             sheetLauncher = FakeEmbeddedSheetLauncher(),
             contentHelper = contentHelper,
             lifecycleOwner = lifecycleOwner,
             savedStateHandle = SavedStateHandle(),
             eventReporter = eventReporter,
-            paymentElementCallbackIdentifier = "EmbeddedPaymentElementTestIdentifier",
+            paymentElementCallbackIdentifier = paymentElementCallbackIdentifier,
         )
         Scenario(
             initializer = initializer,
@@ -61,4 +101,8 @@ internal class EmbeddedPaymentElementInitializerTest {
         val lifecycleOwner: TestLifecycleOwner,
         val eventReporter: FakeEventReporter,
     )
+
+    private companion object {
+        private const val PAYMENT_ELEMENT_CALLBACK_TEST_IDENTIFIER = "EmbeddedPaymentElementTestIdentifier"
+    }
 }