Support CSAT forms

Author: angelix

green/src/main/java/com/blockstream/green/data/Countly.kt

@@ -6,6 +6,7 @@ import android.content.SharedPreferences
 import android.content.res.Configuration
 import android.os.Parcelable
 import androidx.core.content.edit
+import androidx.fragment.app.FragmentManager
 import androidx.lifecycle.MutableLiveData
 import com.android.installreferrer.api.InstallReferrerClient
 import com.android.installreferrer.api.InstallReferrerStateListener
@@ -24,11 +25,15 @@ import com.blockstream.green.gdk.SessionManager
 import com.blockstream.green.settings.ApplicationSettings
 import com.blockstream.green.settings.SettingsManager
 import com.blockstream.green.ui.AppActivity
+import com.blockstream.green.ui.dialogs.CountlyNpsDialogFragment
+import com.blockstream.green.ui.dialogs.CountlySurveyDialogFragment
 import com.blockstream.green.utils.isDevelopmentFlavor
 import com.blockstream.green.utils.isDevelopmentOrDebug
 import com.blockstream.green.utils.isProductionFlavor
 import com.blockstream.green.utils.toList
 import com.blockstream.green.views.GreenAlertView
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.parcelize.Parcelize
@@ -39,6 +44,8 @@ import kotlinx.serialization.json.buildJsonObject
 import kotlinx.serialization.json.put
 import ly.count.android.sdk.Countly
 import ly.count.android.sdk.CountlyConfig
+import ly.count.android.sdk.ModuleFeedback
+import ly.count.android.sdk.ModuleFeedback.CountlyFeedbackWidget
 import ly.count.android.sdk.RemoteConfigCallback
 import mu.NamedKLogging
 import java.net.URLDecoder
@@ -113,6 +120,7 @@ class Countly constructor(
     private val userProfile = countly.userProfile()
     private val remoteConfig = countly.remoteConfig()
     private val attribution = countly.attribution()
+    private val feedback = countly.feedback()
 
     private var analyticsConsent : Boolean by Delegates.observable(settingsManager.getApplicationSettings().analytics) { _, oldValue, newValue ->
         if(oldValue != newValue){
@@ -180,6 +188,40 @@ class Countly constructor(
                 }
             }
         }
+        updateFeedbackWidget()
+    }
+
+    private val _feedbackWidgetStateFlow = MutableStateFlow<CountlyFeedbackWidget?>(null)
+    val feedbackWidgetStateFlow get() = _feedbackWidgetStateFlow.asStateFlow()
+    val feedbackWidget get() = _feedbackWidgetStateFlow.value
+
+    fun sendFeedbackWidgetData(widget: CountlyFeedbackWidget, data: Map<String, Any>?){
+        feedback.reportFeedbackWidgetManually(widget, null, data)
+        // can't use updateFeedback() as the data are sent async
+        _feedbackWidgetStateFlow.value = null
+    }
+
+    fun getFeedbackWidgetData(widget: CountlyFeedbackWidget, callback: (CountlyWidget?) -> Unit){
+        countly.feedback().getFeedbackWidgetData(widget) { data, _ ->
+            try{
+                callback.invoke(GreenWallet.JsonDeserializer.decodeFromString<CountlyWidget>(data.toString()).also{
+                    it.widget = widget
+                })
+
+                // Set it to null to hide it from UI, this way user can know that this is a temporary FAB
+                _feedbackWidgetStateFlow.value = null
+            }catch (e: Exception){
+                logger.info { data.toString() }
+                e.printStackTrace()
+                callback.invoke(null)
+            }
+        }
+    }
+
+    private fun updateFeedbackWidget(){
+        countly.feedback().getAvailableFeedbackWidgets { countlyFeedbackWidgets, _ ->
+            _feedbackWidgetStateFlow.value = countlyFeedbackWidgets?.firstOrNull()
+        }
     }
 
     fun handleReferrer(onComplete: (referrer: String) -> Unit) {

green/src/main/java/com/blockstream/green/data/CountlyWidget.kt

@@ -0,0 +1,88 @@
+package com.blockstream.green.data
+
+import com.blockstream.gdk.GAJson
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+import ly.count.android.sdk.ModuleFeedback
+
+@Serializable
+data class CountlyWidget(
+    @SerialName("_id") val id: String,
+    @SerialName("app_id") val appId: String,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("name") val name: String,
+    @SerialName("questions") val questions: List<Question>? = null,
+    @SerialName("type") val type: SurveyType,
+    @SerialName("msg") val msg: Messages,
+    @SerialName("appearance") val appearance: Appearance,
+    @SerialName("followUpType") val followUpType: FollowUpType? = null,
+) : GAJson<CountlyWidget>() {
+    override val keepJsonElement: Boolean = true
+
+    override fun kSerializer() = serializer()
+
+    @kotlinx.serialization.Transient
+    lateinit var widget : ModuleFeedback.CountlyFeedbackWidget
+
+    val text: Question? get() = questions?.find { it.type == "text" }
+    val rating: Question? get() = questions?.find { it.type == "rating" }
+}
+
+
+@Serializable
+enum class FollowUpType{
+    @SerialName("score") Score, @SerialName("one") One, @SerialName("none") None
+}
+
+@Serializable
+enum class SurveyType{
+    @SerialName("nps") NPS, @SerialName("survey") Survey
+}
+
+@Serializable
+data class Messages(
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("thanks") val thanks: String,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("mainQuestion") val mainQuestion: String = "",
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("followUpAll") val followUpAll: String = "",
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("followUpPromoter") val followUpPromoter: String = "",
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("followUpPassive") val followUpPassive: String = "",
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("followUpDetractor") val followUpDetractor: String = "",
+) : GAJson<Messages>() {
+    override fun kSerializer() = serializer()
+}
+
+@Serializable
+data class Appearance(
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("followUpInput") val followUpInput: String? = null,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("notLikely") val notLikely: String? = null,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("likely") val likely: String? = null,
+) : GAJson<Appearance>() {
+    override fun kSerializer() = serializer()
+}
+
+@Serializable
+data class Question(
+    @SerialName("id") val id: String,
+    @SerialName("type") val type: String,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("question") val question: String,
+    @SerialName("required") val required: Boolean = false,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("followUpInput") val followUpInput: String? = null,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("notLikely") val notLikely: String? = null,
+    @Serializable(with = StringHtmlSerializer::class)
+    @SerialName("likely") val likely: String? = null,
+) : GAJson<Question>() {
+    override fun kSerializer() = serializer()
+}
+

green/src/main/java/com/blockstream/green/data/StringHtmlSerializer.kt

@@ -0,0 +1,17 @@
+package com.blockstream.green.data
+
+import androidx.core.text.TextUtilsCompat
+import com.blockstream.green.utils.fromHtml
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+object StringHtmlSerializer : KSerializer<String> {
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("StringHtml", PrimitiveKind.STRING)
+    override fun serialize(encoder: Encoder, value: String) = encoder.encodeString(TextUtilsCompat.htmlEncode(value))
+    override fun deserialize(decoder: Decoder): String = decoder.decodeString().fromHtml().toString()
+}
+

green/src/main/java/com/blockstream/green/ui/MainActivity.kt

@@ -34,17 +34,33 @@ import com.blockstream.green.database.WalletRepository
 import com.blockstream.green.databinding.MainActivityBinding
 import com.blockstream.green.gdk.SessionManager
 import com.blockstream.green.ui.devices.DeviceInfoBottomSheetDialogFragment
+import com.blockstream.green.ui.dialogs.CountlyNpsDialogFragment
+import com.blockstream.green.ui.dialogs.CountlySurveyDialogFragment
 import com.blockstream.green.ui.wallet.LoginFragment
-import com.blockstream.green.utils.*
+import com.blockstream.green.utils.AppKeystore
+import com.blockstream.green.utils.AuthenticationCallback
+import com.blockstream.green.utils.ConsumableEvent
+import com.blockstream.green.utils.getVersionName
+import com.blockstream.green.utils.handleException
+import com.blockstream.green.utils.isDevelopmentFlavor
+import com.blockstream.green.utils.navigate
 import com.blockstream.green.views.GreenToolbar
 import com.google.android.material.snackbar.Snackbar
 import dagger.hilt.android.AndroidEntryPoint
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.combine
+import kotlinx.coroutines.flow.distinctUntilChanged
+import kotlinx.coroutines.flow.launchIn
+import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.launch
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.json.jsonPrimitive
+import ly.count.android.sdk.ModuleFeedback
 import mu.KLogging
 import javax.inject.Inject
+import kotlin.time.DurationUnit
+import kotlin.time.toDuration
 
 
 @AndroidEntryPoint
@@ -210,6 +226,25 @@ class MainActivity : AppActivity() {
             showUnlockPrompt()
         }
 
+        combine(countly.feedbackWidgetStateFlow, navController.currentBackStackEntryFlow) { feedback, currentBackStackEntry ->
+             (feedback != null && currentBackStackEntry.destination.id == R.id.overviewFragment)
+        }.distinctUntilChanged().onEach {showDialog ->
+            if(showDialog) {
+                lifecycleScope.launchWhenResumed {
+                    // Delay a bit
+                    delay(1.toDuration(DurationUnit.SECONDS))
+
+                    countly.feedbackWidget?.type.also { type ->
+                        if(type == ModuleFeedback.FeedbackWidgetType.nps){
+                            CountlyNpsDialogFragment.show(supportFragmentManager)
+                        }else if(type == ModuleFeedback.FeedbackWidgetType.survey){
+                            CountlySurveyDialogFragment.show(supportFragmentManager)
+                        }
+                    }
+                }
+            }
+        }.launchIn(lifecycleScope)
+
         navController.addOnDestinationChangedListener { _, destination, _ ->
 
             getVisibleFragment()?.let {

green/src/main/java/com/blockstream/green/ui/dialogs/AbstractDialogFragment.kt

@@ -0,0 +1,83 @@
+package com.blockstream.green.ui.dialogs
+
+import android.app.Dialog
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import android.view.WindowManager
+import androidx.databinding.ViewDataBinding
+import androidx.fragment.app.DialogFragment
+import androidx.fragment.app.FragmentManager
+import com.blockstream.green.data.Countly
+import com.blockstream.green.data.ScreenView
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import mu.KLogging
+import javax.inject.Inject
+
+// Based on https://dev.to/bhullnatik/how-to-use-material-dialogs-with-dialogfragment-28i1
+abstract class AbstractDialogFragment<T : ViewDataBinding> : DialogFragment(), ScreenView{
+    @Inject
+    lateinit var countly: Countly
+
+    private var bindingOrNull: T? = null
+    protected val binding: T get() = bindingOrNull!!
+
+    override var screenIsRecorded = false
+    override val segmentation: HashMap<String, Any>? = null
+
+    open val isFullWidth: Boolean = false
+
+    abstract fun inflate(layoutInflater: LayoutInflater): T
+
+    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
+        return MaterialAlertDialogBuilder(requireContext())
+            .setView(onCreateView(layoutInflater, null, savedInstanceState))
+            .create()
+    }
+
+    // Warning: onCreateView can be called multiple times
+    final override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?
+    ): View {
+        return bindingOrNull?.root ?: inflate(inflater).also {
+            bindingOrNull = it
+            // binding.lifecycleOwner = viewLifecycleOwner
+            // viewLifecycleOwner is unavailable for MaterialAlertDialogBuilder based dialogs
+            binding.lifecycleOwner = parentFragment?.viewLifecycleOwner ?: activity
+        }.root
+    }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+
+        if(isFullWidth){
+            dialog?.window?.apply {
+                setLayout(WindowManager.LayoutParams.MATCH_PARENT, WindowManager.LayoutParams.WRAP_CONTENT)
+            }
+        }
+    }
+
+    override fun onResume() {
+        super.onResume()
+        countly.screenView(this)
+    }
+
+    companion object : KLogging() {
+        fun show(instance: AbstractDialogFragment<*>, fragmentManager: FragmentManager){
+            instance.show(fragmentManager, instance.javaClass.simpleName)
+        }
+
+        // Open a single instance
+        fun showSingle(instance: AbstractDialogFragment<*>, fragmentManager: FragmentManager){
+            val tag = instance.javaClass.simpleName
+            if (fragmentManager.findFragmentByTag(tag) == null) {
+                show(instance, fragmentManager)
+            } else {
+                logger.info { "There is already an open instance of ${instance.javaClass.simpleName}" }
+            }
+        }
+    }
+}