fix: In App Purchases(IAP) Improvements (#17)

* chore: add value prop screen event * fix: remove value_prop_enabled check for IAP * fix: put restore button behind the iap enable config * fix: Make IAP error dialog Non-Cancellable * fix: Improve IAP full screen dialog UI * fix: hide upgrade button for collapsed toolbar in course dashboard
edx · Jul 25, 2024 · ae34c4c · ae34c4c
1 parent 12056d2
commit ae34c4c
Show file tree

Hide file tree

Showing 23 changed files with 166 additions and 131 deletions.
diff --git a/app/build.gradle b/app/build.gradle
@@ -82,13 +82,13 @@ android {
 
     sourceSets {
         prod {
-            res.srcDirs = ["src/$themeDirectory/res"]
+            res.srcDirs += ["src/$themeDirectory/res"]
         }
         develop {
-            res.srcDirs = ["src/$themeDirectory/res"]
+            res.srcDirs += ["src/$themeDirectory/res"]
         }
         stage {
-            res.srcDirs = ["src/$themeDirectory/res"]
+            res.srcDirs += ["src/$themeDirectory/res"]
         }
     }
 

diff --git a/core/build.gradle b/core/build.gradle
@@ -51,15 +51,15 @@ android {
     sourceSets {
         prod {
             java.srcDirs = ["src/$themeDirectory"]
-            res.srcDirs = ["src/$themeDirectory/res"]
+            res.srcDirs += ["src/$themeDirectory/res"]
         }
         develop {
             java.srcDirs = ["src/$themeDirectory"]
-            res.srcDirs = ["src/$themeDirectory/res"]
+            res.srcDirs += ["src/$themeDirectory/res"]
         }
         stage {
             java.srcDirs = ["src/$themeDirectory"]
-            res.srcDirs = ["src/$themeDirectory/res"]
+            res.srcDirs += ["src/$themeDirectory/res"]
         }
         main {
             assets {

diff --git a/core/src/main/java/org/openedx/core/data/model/AppConfig.kt b/core/src/main/java/org/openedx/core/data/model/AppConfig.kt
@@ -7,16 +7,12 @@ data class AppConfig(
     @SerializedName("course_dates_calendar_sync")
     val calendarSyncConfig: CalendarSyncConfig = CalendarSyncConfig(),
 
-    @SerializedName("value_prop_enabled")
-    val isValuePropEnabled: Boolean = false,
-
     @SerializedName("iap_config")
     val iapConfig: IAPConfig = IAPConfig(),
 ) {
     fun mapToDomain(): DomainAppConfig {
         return DomainAppConfig(
             courseDatesCalendarSync = calendarSyncConfig.mapToDomain(),
-            isValuePropEnabled = isValuePropEnabled,
             iapConfig = iapConfig.mapToDomain(),
         )
     }

diff --git a/core/src/main/java/org/openedx/core/domain/model/AppConfig.kt b/core/src/main/java/org/openedx/core/domain/model/AppConfig.kt
@@ -4,7 +4,6 @@ import java.io.Serializable
 
 data class AppConfig(
     val courseDatesCalendarSync: CourseDatesCalendarSync,
-    val isValuePropEnabled: Boolean = false,
     val iapConfig: IAPConfig = IAPConfig(),
 ) : Serializable
 

diff --git a/core/src/main/java/org/openedx/core/extension/ViewExt.kt b/core/src/main/java/org/openedx/core/extension/ViewExt.kt
@@ -50,15 +50,6 @@ fun DialogFragment.setWidthPercent(percentage: Int) {
     dialog?.window?.setLayout(percentWidth.toInt(), ViewGroup.LayoutParams.WRAP_CONTENT)
 }
 
-fun DialogFragment.setFullScreen(percentage: Int) {
-    val percent = percentage.toFloat() / 100
-    val dm = Resources.getSystem().displayMetrics
-    val rect = dm.run { Rect(0, 0, widthPixels, heightPixels) }
-    val percentWidth = rect.width() * percent
-    val percentHeight = rect.height() * percent
-    dialog?.window?.setLayout(percentWidth.toInt(), percentHeight.toInt())
-}
-
 fun Context.toastMessage(message: String) {
     Toast.makeText(this, message, Toast.LENGTH_SHORT).show()
 }

diff --git a/core/src/main/java/org/openedx/core/presentation/IAPAnalytics.kt b/core/src/main/java/org/openedx/core/presentation/IAPAnalytics.kt
@@ -6,6 +6,8 @@ interface IAPAnalytics {
         params: MutableMap<String, Any?> = mutableMapOf(),
         screenName: String,
     )
+
+    fun logScreenEvent(screenName: String, params: Map<String, Any?>)
 }
 
 enum class IAPAnalyticsEvent(val eventName: String, val biValue: String) {
@@ -45,6 +47,10 @@ enum class IAPAnalyticsEvent(val eventName: String, val biValue: String) {
     IAP_RESTORE_PURCHASE_CLICKED(
         "Payments: Restore Purchases Clicked",
         "edx.bi.app.payments.restore_purchases.clicked"
+    ),
+    IAP_VALUE_PROP_VIEWED(
+        "Payments: Value Prop Viewed",
+        "edx.bi.app.payments.value_prop.viewed"
     )
 }
 

diff --git a/core/src/main/java/org/openedx/core/presentation/dialog/IAPDialogFragment.kt b/core/src/main/java/org/openedx/core/presentation/dialog/IAPDialogFragment.kt
@@ -1,7 +1,5 @@
 package org.openedx.core.presentation.dialog
 
-import android.graphics.Color
-import android.graphics.drawable.ColorDrawable
 import android.os.Bundle
 import android.text.TextUtils
 import android.view.LayoutInflater
@@ -38,7 +36,6 @@ import org.openedx.core.domain.model.iap.ProductInfo
 import org.openedx.core.domain.model.iap.PurchaseFlowData
 import org.openedx.core.extension.parcelable
 import org.openedx.core.extension.serializable
-import org.openedx.core.extension.setFullScreen
 import org.openedx.core.presentation.iap.IAPAction
 import org.openedx.core.presentation.iap.IAPFlow
 import org.openedx.core.presentation.iap.IAPLoaderType
@@ -67,7 +64,6 @@ class IAPDialogFragment : DialogFragment() {
         container: ViewGroup?,
         savedInstanceState: Bundle?,
     ) = ComposeView(requireContext()).apply {
-        dialog?.window?.setBackgroundDrawable(ColorDrawable(Color.TRANSPARENT))
         setViewCompositionStrategy(ViewCompositionStrategy.DisposeOnViewTreeLifecycleDestroyed)
         setContent {
             OpenEdXTheme {
@@ -77,7 +73,7 @@ class IAPDialogFragment : DialogFragment() {
 
                 val isFullScreenLoader =
                     (iapState as? IAPUIState.Loading)?.loaderType == IAPLoaderType.FULL_SCREEN
-
+                isCancelable = !isFullScreenLoader
                 Scaffold(
                     modifier = Modifier.fillMaxSize(),
                     backgroundColor = MaterialTheme.appColors.background,
@@ -228,9 +224,8 @@ class IAPDialogFragment : DialogFragment() {
         }
     }
 
-    override fun onStart() {
-        super.onStart()
-        setFullScreen(100)
+    override fun getTheme(): Int {
+        return R.style.Theme_OpenEdX_IAPDialog
     }
 
     private fun onDismiss() {

diff --git a/core/src/main/java/org/openedx/core/presentation/iap/IAPViewModel.kt b/core/src/main/java/org/openedx/core/presentation/iap/IAPViewModel.kt
@@ -99,6 +99,7 @@ class IAPViewModel(
 
         when (iapFlow) {
             IAPFlow.USER_INITIATED -> {
+                loadIAPScreenEvent()
                 loadPrice()
             }
 
@@ -337,39 +338,58 @@ class IAPViewModel(
         }.toMutableMap())
     }
 
+    private fun getIAPEventParams(): MutableMap<String, Any?> {
+        return buildMap {
+            purchaseFlowData.takeIf { it.courseId.isNullOrBlank().not() }?.let {
+                put(IAPAnalyticsKeys.COURSE_ID.key, purchaseFlowData.courseId)
+                put(
+                    IAPAnalyticsKeys.PACING.key,
+                    if (purchaseFlowData.isSelfPaced == true) IAPAnalyticsKeys.SELF.key else IAPAnalyticsKeys.INSTRUCTOR.key
+                )
+            }
+            purchaseFlowData.productInfo?.lmsUSDPrice?.nonZero()?.let { lmsUSDPrice ->
+                put(IAPAnalyticsKeys.LMS_USD_PRICE.key, lmsUSDPrice)
+            }
+            purchaseFlowData.price.nonZero()?.let { localizedPrice ->
+                put(IAPAnalyticsKeys.LOCALIZED_PRICE.key, localizedPrice)
+            }
+            purchaseFlowData.currencyCode.takeIfNotEmpty()?.let { currencyCode ->
+                put(IAPAnalyticsKeys.CURRENCY_CODE.key, currencyCode)
+            }
+            purchaseFlowData.componentId?.takeIf { it.isNotBlank() }?.let { componentId ->
+                put(IAPAnalyticsKeys.COMPONENT_ID.key, componentId)
+            }
+            put(IAPAnalyticsKeys.CATEGORY.key, IAPAnalyticsKeys.IN_APP_PURCHASES.key)
+        }.toMutableMap()
+    }
+
     private fun logIAPEvent(
         event: IAPAnalyticsEvent,
         params: MutableMap<String, Any?> = mutableMapOf(),
     ) {
+        params.apply {
+            put(IAPAnalyticsKeys.NAME.key, event.biValue)
+            putAll(getIAPEventParams())
+        }
         analytics.logIAPEvent(
             event = event,
-            params = params.apply {
-                put(IAPAnalyticsKeys.NAME.key, event.biValue)
-                purchaseFlowData.takeIf { it.courseId.isNullOrBlank().not() }?.let {
-                    put(IAPAnalyticsKeys.COURSE_ID.key, purchaseFlowData.courseId)
-                    put(
-                        IAPAnalyticsKeys.PACING.key,
-                        if (purchaseFlowData.isSelfPaced == true) IAPAnalyticsKeys.SELF.key else IAPAnalyticsKeys.INSTRUCTOR.key
-                    )
-                }
-                purchaseFlowData.productInfo?.lmsUSDPrice?.nonZero()?.let { lmsUSDPrice ->
-                    put(IAPAnalyticsKeys.LMS_USD_PRICE.key, lmsUSDPrice)
-                }
-                purchaseFlowData.price.nonZero()?.let { localizedPrice ->
-                    put(IAPAnalyticsKeys.LOCALIZED_PRICE.key, localizedPrice)
-                }
-                purchaseFlowData.currencyCode.takeIfNotEmpty()?.let { currencyCode ->
-                    put(IAPAnalyticsKeys.CURRENCY_CODE.key, currencyCode)
-                }
-                purchaseFlowData.componentId?.takeIf { it.isNotBlank() }?.let { componentId ->
-                    put(IAPAnalyticsKeys.COMPONENT_ID.key, componentId)
-                }
-                put(IAPAnalyticsKeys.CATEGORY.key, IAPAnalyticsKeys.IN_APP_PURCHASES.key)
-            },
+            params = params,
             screenName = purchaseFlowData.screenName.orEmpty()
         )
     }
 
+    private fun loadIAPScreenEvent() {
+        val event = IAPAnalyticsEvent.IAP_VALUE_PROP_VIEWED
+        val params = buildMap {
+            put(IAPAnalyticsKeys.NAME.key, event.biValue)
+            purchaseFlowData.screenName?.takeIfNotEmpty()?.let { screenName ->
+                put(IAPAnalyticsKeys.SCREEN_NAME.key, screenName)
+            }
+            putAll(getIAPEventParams())
+        }
+        analytics.logScreenEvent(screenName = event.eventName, params = params)
+    }
+
     fun clearIAPFLow() {
         _uiState.value = IAPUIState.Clear
         purchaseFlowData.reset()

diff --git a/core/src/main/java/org/openedx/core/ui/IAPUI.kt b/core/src/main/java/org/openedx/core/ui/IAPUI.kt
@@ -23,6 +23,7 @@ import androidx.compose.ui.text.style.TextOverflow
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.window.Dialog
+import androidx.compose.ui.window.DialogProperties
 import org.openedx.core.R
 import org.openedx.core.exception.iap.IAPException
 import org.openedx.core.presentation.iap.IAPAction
@@ -183,7 +184,8 @@ fun NoSkuErrorDialog(
                 onClick = onConfirm
             )
         },
-        onDismissRequest = onConfirm
+        properties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false),
+        onDismissRequest = {}
     )
 }
 
@@ -252,6 +254,7 @@ fun CourseAlreadyPurchasedExecuteErrorDialog(
                 )
             }
         },
+        properties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false),
         onDismissRequest = {}
     )
 }
@@ -302,13 +305,17 @@ fun UpgradeErrorDialog(
                 onClick = onDismiss
             )
         },
-        onDismissRequest = onConfirm
+        properties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false),
+        onDismissRequest = {}
     )
 }
 
 @Composable
 fun CheckingPurchasesDialog() {
-    Dialog(onDismissRequest = { }) {
+    Dialog(
+        properties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false),
+        onDismissRequest = {}
+    ) {
         Column(
             Modifier
                 .padding(16.dp)
@@ -372,7 +379,8 @@ fun FakePurchasesFulfillmentCompleted(onCancel: () -> Unit, onGetHelp: () -> Uni
                 onClick = onGetHelp
             )
         },
-        onDismissRequest = onCancel
+        properties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false),
+        onDismissRequest = {}
     )
 }
 
@@ -415,7 +423,8 @@ fun PurchasesFulfillmentCompletedDialog(onConfirm: () -> Unit, onDismiss: () ->
                 onClick = onDismiss
             )
         },
-        onDismissRequest = onDismiss
+        properties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false),
+        onDismissRequest = {}
     )
 }
 

diff --git a/core/src/main/res/values-night/themes.xml b/core/src/main/res/values-night/themes.xml
@@ -0,0 +1,7 @@
+<resources>
+
+    <style name="Theme.OpenEdX.IAPDialog" parent="Theme.OpenEdX.Dialog.FullScreen">
+        <item name="android:windowLightStatusBar">false</item>
+    </style>
+
+</resources>
diff --git a/core/src/main/res/values/themes.xml b/core/src/main/res/values/themes.xml
@@ -1,14 +1,14 @@
-<resources xmlns:tools="http://schemas.android.com/tools">
+<resources>
     <!-- Base application theme. -->
     <style name="Theme.OpenEdX" parent="Theme.MaterialComponents.DayNight.DarkActionBar">
         <!-- Primary brand color. -->
         <item name="colorPrimary">@color/primary</item>
-<!--        <item name="colorPrimaryVariant">@color/primaryVariant</item>-->
-<!--        <item name="colorOnPrimary">@color/white</item>-->
-<!--        &lt;!&ndash; Secondary brand color. &ndash;&gt;-->
-<!--        <item name="colorSecondary">@color/secondary</item>-->
-<!--        <item name="colorSecondaryVariant">@color/secondaryVariant</item>-->
-<!--        <item name="colorOnSecondary">@color/black</item>-->
+        <!--        <item name="colorPrimaryVariant">@color/primaryVariant</item>-->
+        <!--        <item name="colorOnPrimary">@color/white</item>-->
+        <!--        &lt;!&ndash; Secondary brand color. &ndash;&gt;-->
+        <!--        <item name="colorSecondary">@color/secondary</item>-->
+        <!--        <item name="colorSecondaryVariant">@color/secondaryVariant</item>-->
+        <!--        <item name="colorOnSecondary">@color/black</item>-->
         <!-- Status bar color. -->
         <item name="android:statusBarColor">?attr/colorPrimaryVariant</item>
         <!-- Customize your theme here. -->
@@ -23,4 +23,16 @@
     <style name="Theme.OpenEdX.AppBarOverlay" parent="ThemeOverlay.AppCompat.Dark.ActionBar" />
 
     <style name="Theme.OpenEdX.PopupOverlay" parent="ThemeOverlay.AppCompat.Light" />
-</resources>
+
+    <style name="Theme.OpenEdX.Dialog.FullScreen" parent="Theme.OpenEdX">
+        <item name="android:windowNoTitle">true</item>
+        <item name="android:windowFullscreen">false</item>
+        <item name="android:windowIsFloating">false</item>
+        <item name="android:statusBarColor">@color/background</item>
+    </style>
+
+    <style name="Theme.OpenEdX.IAPDialog" parent="Theme.OpenEdX.Dialog.FullScreen">
+        <item name="android:windowLightStatusBar">true</item>
+    </style>
+
+</resources>
diff --git a/core/src/main/res/values-night/colors.xml → core/src/openedx/res/values-night/colors.xml b/core/src/main/res/values-night/colors.xml → core/src/openedx/res/values-night/colors.xml
diff --git a/core/src/main/res/values/colors.xml → core/src/openedx/res/values/colors.xml b/core/src/main/res/values/colors.xml → core/src/openedx/res/values/colors.xml