2.8.4

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 The changelog for `Superwall`. Also see the [releases](https://github.com/superwall/Superwall-Android/releases) on GitHub.
 
+## 2.8.4
+
+## Fixes
+- Fix bug where experiment ID would be stale among paywalls sharing experiments
+- Fix `presentation_id` changing mid-presentation when `getPaywall()` is called for a paywall that is already on screen. The id now rotates when a cached paywall is presented again, so every event between one `paywall_open` and the next carries the same id.
+- Fix trial reminder notifications being scheduled after a paywall purchase that did not start a free trial (for example a user who already used their trial and was charged immediately). Reminders are now only scheduled when a trial actually started, and the paywall receives the `freeTrial_start` message for every started trial, even when it has no trial reminders configured.
+
+
 ## 2.8.3
 
 ## Fixes

superwall/src/androidTest/java/com/superwall/sdk/paywall/view/PaywallViewDismissTest.kt

@@ -113,7 +113,7 @@ class PaywallViewDismissTest {
             val request = makeRequest()
             Given("a paywall view configured with a dismissal callback") {
                 withContext(Dispatchers.Main) {
-                    view.set(request, publisher, null)
+                    view.set(request, publisher, null, null)
                     view.onViewCreated()
                 }
 
@@ -182,7 +182,7 @@ class PaywallViewDismissTest {
             val request = makeRequest()
             Given("an embedded paywall showing the purchase spinner") {
                 withContext(Dispatchers.Main) {
-                    view.set(request, publisher, null)
+                    view.set(request, publisher, null, null)
                     view.onViewCreated()
                     // Buy tap sets this in production (Superwall.kt InitiatePurchase).
                     view.updateState(
@@ -232,7 +232,7 @@ class PaywallViewDismissTest {
             val request = makeRequest()
             Given("a paywall view configured to continue to the next paywall") {
                 withContext(Dispatchers.Main) {
-                    view.set(request, publisher, null)
+                    view.set(request, publisher, null, null)
                     view.onViewCreated()
                 }
 

superwall/src/androidTest/java/com/superwall/sdk/store/transactions/TransactionManagerTest.kt

@@ -208,7 +208,7 @@ class TransactionManagerTest {
             dismiss = { i, e -> dismiss(i, e) },
             showAlert = { showAlert(it) },
             updateState = { cacheKey, update -> updateState(cacheKey, update) },
-            notifyOfTransactionComplete = { cacheKey, trialEndDate, id -> notifyOfTransactionComplete(cacheKey, trialEndDate) },
+            notifyOfTransactionComplete = { cacheKey, trialEndDate, id, _ -> notifyOfTransactionComplete(cacheKey, trialEndDate) },
             eventsQueue = eventsQueue,
             factory = trManagerFactory,
             ioScope = IOScope(backgroundScope.coroutineContext),

superwall/src/main/java/com/superwall/sdk/dependencies/DependencyContainer.kt

@@ -62,7 +62,6 @@ import com.superwall.sdk.models.entitlements.TransactionReceipt
 import com.superwall.sdk.models.events.EventData
 import com.superwall.sdk.models.internal.VendorId
 import com.superwall.sdk.models.paywall.LocalNotification
-import com.superwall.sdk.models.paywall.LocalNotificationType
 import com.superwall.sdk.models.paywall.Paywall
 import com.superwall.sdk.models.product.ProductVariable
 import com.superwall.sdk.network.Api
@@ -128,6 +127,7 @@ import com.superwall.sdk.store.abstractions.transactions.StoreTransaction
 import com.superwall.sdk.store.testmode.TestMode
 import com.superwall.sdk.store.testmode.TestModeTransactionHandler
 import com.superwall.sdk.store.transactions.TransactionManager
+import com.superwall.sdk.store.transactions.notifications.TrialReminderLogic
 import com.superwall.sdk.utilities.DateUtils
 import com.superwall.sdk.utilities.ErrorTracker
 import com.superwall.sdk.utilities.dateFormat
@@ -642,7 +642,7 @@ class DependencyContainer(
                     }
                     paywallView.webView.messageHandler.handle(PaywallMessage.TransactionAbandon)
                 },
-                notifyOfTransactionComplete = { key, trialEndDate, id ->
+                notifyOfTransactionComplete = { key, trialEndDate, id, didStartFreeTrial ->
                     val paywallView =
                         resolvePaywallViewForKey(
                             makeViewStore(),
@@ -663,14 +663,13 @@ class DependencyContainer(
                     // hasn't been updated to send the ScheduleNotification message dynamically.
                     // If the paywall sends a ScheduleNotification message, it will cancel and
                     // replace this notification.
+                    // Nothing is scheduled when the purchase did not start a free trial.
                     val paywallInfo = paywallView.state.info
                     val trialNotifications =
-                        paywallInfo.localNotifications
-                            .filter {
-                                it.type == LocalNotificationType.TrialStarted
-                            }.map {
-                                it.copy("${paywallInfo.identifier}_${it.type.raw}")
-                            }
+                        TrialReminderLogic.fallbackTrialNotifications(
+                            paywallInfo = paywallInfo,
+                            didStartFreeTrial = didStartFreeTrial,
+                        )
 
                     if (trialNotifications.isNotEmpty()) {
 
@@ -694,12 +693,18 @@ class DependencyContainer(
                                 "No paywall activity available to schedule fallback notifications",
                             )
                         }
+                    }
+
+                    // Tell the paywall a trial started whenever one did, independent of whether
+                    // it has trial reminders configured. This only forwards into the webview, so
+                    // it does not double-track the freeTrial_start placement.
+                    if (didStartFreeTrial) {
                         // Await message delivery to ensure webview has time to process before dismiss
                         paywallView.webView.messageHandler.handle(
                             PaywallMessage.TrialStarted(
                                 trialEndDate,
-                                id
-                            )
+                                id,
+                            ),
                         )
                     }
                 },

superwall/src/main/java/com/superwall/sdk/paywall/manager/PaywallManager.kt

@@ -90,6 +90,9 @@ class PaywallManager(
                             // isForPresentation because getPresentationResult() (a pure query API)
                             // also fetches through here — a result check while this paywall is
                             // on screen mid-purchase must not wipe its live spinner or prepare flags.
+                            // A getPaywall() for a paywall that is currently on screen also lands
+                            // here: it takes the view over (prepareToDisplay() detaches it from
+                            // its current parent), so it is a new presentation like any other.
                             if (isForPresentation) {
                                 view.resetTransientPresentationState()
                             }

superwall/src/main/java/com/superwall/sdk/paywall/presentation/get_paywall/InternalGetPaywall.kt

@@ -3,6 +3,7 @@ package com.superwall.sdk.paywall.presentation.get_paywall
 import android.app.Activity
 import com.superwall.sdk.Superwall
 import com.superwall.sdk.misc.Either
+import com.superwall.sdk.models.triggers.Experiment
 import com.superwall.sdk.paywall.presentation.internal.PresentationRequest
 import com.superwall.sdk.paywall.presentation.internal.getPaywallComponents
 import com.superwall.sdk.paywall.presentation.internal.operators.logErrors
@@ -19,6 +20,8 @@ data class PaywallComponents(
     val presenter: Activity?,
     val rulesOutcome: RuleEvaluationOutcome,
     val debugInfo: Map<String, Any>,
+    /** The experiment the request resolved to. Bound to the view together with the request. */
+    val experiment: Experiment?,
 )
 
 /**
@@ -39,6 +42,7 @@ internal suspend fun Superwall.getPaywall(
             request = request,
             paywallStatePublisher = publisher,
             unsavedOccurrence = it.rulesOutcome.unsavedOccurrence,
+            experiment = it.experiment,
         )
         Either.Success(it.view)
     }, onFailure = {

superwall/src/main/java/com/superwall/sdk/paywall/presentation/internal/GetPaywallComponents.kt

@@ -4,6 +4,7 @@ import com.superwall.sdk.Superwall
 import com.superwall.sdk.misc.Either
 import com.superwall.sdk.misc.toResult
 import com.superwall.sdk.models.assignment.ConfirmedAssignment
+import com.superwall.sdk.models.triggers.InternalTriggerResult
 import com.superwall.sdk.paywall.presentation.get_paywall.PaywallComponents
 import com.superwall.sdk.paywall.presentation.internal.state.PaywallState
 import com.superwall.sdk.utilities.withErrorTracking
@@ -59,6 +60,7 @@ internal suspend fun runGetPaywallComponents(
             presenter = presenter,
             rulesOutcome = outcome,
             debugInfo = debugInfo,
+            experiment = (outcome.triggerResult as? InternalTriggerResult.Paywall)?.experiment,
         )
     }.toResult()
 

superwall/src/main/java/com/superwall/sdk/paywall/presentation/internal/InternalPresentation.kt

@@ -48,6 +48,7 @@ internal suspend fun Superwall.internallyPresent(
             debugInfo = paywallComponents.debugInfo,
             request = request,
             paywallStatePublisher = publisher,
+            experiment = paywallComponents.experiment,
         )
     } catch (e: Throwable) {
         logErrors(request, e)

superwall/src/main/java/com/superwall/sdk/paywall/presentation/internal/operators/PresentPaywall.kt

@@ -7,6 +7,7 @@ import com.superwall.sdk.analytics.internal.trackable.InternalSuperwallEvent
 import com.superwall.sdk.logger.LogLevel
 import com.superwall.sdk.logger.LogScope
 import com.superwall.sdk.logger.Logger
+import com.superwall.sdk.models.triggers.Experiment
 import com.superwall.sdk.models.triggers.TriggerRuleOccurrence
 import com.superwall.sdk.paywall.presentation.internal.InternalPresentationLogic
 import com.superwall.sdk.paywall.presentation.internal.PaywallPresentationRequestStatus
@@ -31,6 +32,7 @@ import kotlinx.coroutines.withContext
  * @param debugInfo Information to help with debugging.
  * @param request The request to present the paywall.
  * @param paywallStatePublisher A `MutableStateFlow` that gets sent `PaywallState` objects.
+ * @param experiment The experiment the request resolved to, bound to the view with the request.
  *
  * @return A publisher that contains info for the next pipeline operator.
  */
@@ -41,6 +43,7 @@ suspend fun Superwall.presentPaywallView(
     debugInfo: Map<String, Any>,
     request: PresentationRequest,
     paywallStatePublisher: MutableSharedFlow<PaywallState>,
+    experiment: Experiment?,
 ) {
     val trackedEvent =
         InternalSuperwallEvent.PresentationRequest(
@@ -64,6 +67,7 @@ suspend fun Superwall.presentPaywallView(
                 unsavedOccurrence = unsavedOccurrence,
                 presentationStyleOverride = request.paywallOverrides?.presentationStyle,
                 paywallStatePublisher = paywallStatePublisher,
+                experiment = experiment,
             ) { isPresented ->
                 if (isPresented) {
                     val state = PaywallState.Presented(paywallView.info)
@@ -112,6 +116,7 @@ fun Superwall.presentPaywallViewSync(
     unsavedOccurrence: TriggerRuleOccurrence?,
     debugInfo: Map<String, Any>,
     request: PresentationRequest,
+    experiment: Experiment?,
     onStateChanged: (PaywallState) -> Unit,
 ) {
     mainScope.launch {
@@ -128,6 +133,7 @@ fun Superwall.presentPaywallViewSync(
             debugInfo = debugInfo,
             request = request,
             paywallStatePublisher = publisher,
+            experiment = experiment,
         )
     }
 }

superwall/src/main/java/com/superwall/sdk/paywall/view/PaywallView.kt

@@ -46,6 +46,7 @@ import com.superwall.sdk.misc.IOScope
 import com.superwall.sdk.misc.MainScope
 import com.superwall.sdk.misc.toResult
 import com.superwall.sdk.models.paywall.PaywallPresentationStyle
+import com.superwall.sdk.models.triggers.Experiment
 import com.superwall.sdk.models.triggers.TriggerRuleOccurrence
 import com.superwall.sdk.network.device.DeviceHelper
 import com.superwall.sdk.paywall.manager.PaywallViewCache
@@ -261,12 +262,14 @@ class PaywallView(
         request: PresentationRequest,
         paywallStatePublisher: MutableSharedFlow<PaywallState>,
         unsavedOccurrence: TriggerRuleOccurrence?,
+        experiment: Experiment?,
     ) {
         controller.updateState(
             SetRequest(
                 request,
                 paywallStatePublisher,
                 unsavedOccurrence,
+                experiment,
             ),
         )
     }
@@ -303,6 +306,7 @@ class PaywallView(
         unsavedOccurrence: TriggerRuleOccurrence?,
         presentationStyleOverride: PaywallPresentationStyle?,
         paywallStatePublisher: MutableSharedFlow<PaywallState>,
+        experiment: Experiment?,
         completion: (Boolean) -> Unit,
     ) {
         webView.attach(this)
@@ -351,7 +355,7 @@ class PaywallView(
         cache?.acquireShimmerView()?.let {
             setupShimmer(it)
         }
-        set(request, paywallStatePublisher, unsavedOccurrence)
+        set(request, paywallStatePublisher, unsavedOccurrence, experiment)
         controller.updateState(
             SetPresentationConfig(
                 presentationStyleOverride,
@@ -415,6 +419,11 @@ class PaywallView(
             return
         }
         controller.updateState(PresentationWillBegin)
+        // A new presentation is being prepared on this view (the guard above excludes one that
+        // already finished preparing), so mint its id now: willPresentPaywall(info),
+        // didPresentPaywall(info) and the paywall_open that follows must all report the same id.
+        // onViewCreated() runs the same idempotent update for hosts that skip beforeViewCreated().
+        controller.updateState(PaywallViewState.Updates.BeginPresentation)
 
         factory
             .delegate()
@@ -519,6 +528,15 @@ class PaywallView(
     // Safe because that branch only runs for a genuinely new presentation request - never on
     // resume-same-instance (that goes through onResume -> onViewCreated) nor during an in-flight
     // purchase.
+    //
+    // This also runs when the view is still presented and attached: the only request that reaches
+    // the cache-hit branch while a paywall is on screen is a getPaywall() for that same paywall
+    // (register() is rejected earlier by checkNoPaywallAlreadyPresented), and that call always
+    // takes the view over - prepareToDisplay() removes it from its current parent in the same
+    // call. The view cannot tell that apart from an embedded host re-presenting a detached view,
+    // and it does not need to: both are the next presentation of this view, so both get a clean
+    // slate and a new presentation id (minted in beforeViewCreated()/onViewCreated()). The
+    // presentation being taken over ends here without a paywall_close of its own.
     internal fun resetTransientPresentationState() {
         if (loadingState is PaywallLoadingState.LoadingPurchase ||
             loadingState is PaywallLoadingState.ManualLoading
@@ -669,10 +687,16 @@ class PaywallView(
     // Lets the view know that presentation has finished.
 // Only called once per presentation.
     fun onViewCreated() {
+        val isNewPresentation = !state.presentationDidFinishPrepare
+        if (isNewPresentation) {
+            // Before the completion below emits PaywallState.Presented(info): a new presentation
+            // on a view whose current id was already consumed by a paywall_open gets a fresh one.
+            controller.updateState(PaywallViewState.Updates.BeginPresentation)
+        }
         state.viewCreatedCompletion?.invoke(true)
         controller.updateState(ClearViewCreatedCompletion)
 
-        if (state.presentationDidFinishPrepare) {
+        if (!isNewPresentation) {
             if (state.closedForBackground) {
                 controller.updateState(SetClosedForBackground(false))
                 ioScope.launch {