Merge pull request #48 from Trendyol/feature/add-success-failure-status

Add success failure status for events

Author: turkergoksu

README.md

@@ -127,6 +127,13 @@ AnalyticsLogger.report(
     value = "{\"category\": \"Cart\", \"data\": \"TestData\" }", // Should be Json string.
     platform = "EventPlatform",
 )
+// or
+AnalyticsLogger.report(
+    key = "eventKey",
+    value = "{\"category\": \"Cart\", \"data\": \"TestData\" }", // Should be Json string.
+    platform = "EventPlatform",
+    isSuccess = true, // send your event result
+)
 ```
 
 ### Setup

libraries/analytics-logger-no-op/src/main/java/com/trendyol/android/devtools/analyticslogger/AnalyticsLogger.kt

@@ -24,4 +24,13 @@ object AnalyticsLogger {
     fun report(key: String?, value: String?, platform: String?) {
         // no-op
     }
+
+    fun report(
+        key: String?,
+        value: String?,
+        platform: String?,
+        isSuccess: Boolean?,
+    ) {
+        // no-op
+    }
 }

libraries/analytics-logger/build.gradle

@@ -37,7 +37,7 @@ android {
 
 ext {
     PUBLISH_GROUP_ID = 'com.trendyol.android.devtools'
-    PUBLISH_VERSION = '0.3.0'
+    PUBLISH_VERSION = '0.4.0'
     PUBLISH_ARTIFACT_ID = 'analytics-logger'
     PUBLISH_DESCRIPTION = "Android Analytics Event Logger"
     PUBLISH_URL = "https://github.com/Trendyol/android-dev-tools"

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/AnalyticsLogger.kt

@@ -31,4 +31,21 @@ object AnalyticsLogger {
     fun report(key: String?, value: String?, platform: String?) {
         instance?.reportEvent(key, value, platform) ?: Log.w(TAG, INIT_ERROR_MESSAGE)
     }
+
+    /**
+     * Reports an event with the specified key, value, platform, and success status.
+     *
+     * @param key The key identifying the event. Can be null.
+     * @param value The value associated with the event. Can be null.
+     * @param platform The platform related to the event. Can be null.
+     * @param isSuccess Indicates whether the operation was successful. Can be null.
+     */
+    fun report(
+        key: String?,
+        value: String?,
+        platform: String?,
+        isSuccess: Boolean?,
+    ) {
+        instance?.reportEvent(key, value, platform, isSuccess) ?: Log.w(TAG, INIT_ERROR_MESSAGE)
+    }
 }

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/NotificationManager.kt

@@ -60,11 +60,13 @@ internal class NotificationManager constructor(private var showNotification: Boo
         key: String?,
         value: String?,
         platform: String?,
+        isSuccess: Boolean? = null,
     ) = scope.launch {
         analyticsContainer.eventManager.insert(
             key = key,
             value = value,
             platform = platform,
+            isSuccess = isSuccess,
         )
         lastEvent = key to platform
         updateNotification(

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/data/database/EventDatabase.kt

@@ -4,10 +4,12 @@ import android.content.Context
 import androidx.room.Database
 import androidx.room.Room
 import androidx.room.RoomDatabase
+import androidx.room.migration.Migration
+import androidx.sqlite.db.SupportSQLiteDatabase
 import com.trendyol.android.devtools.analyticslogger.internal.data.dao.EventDao
 import com.trendyol.android.devtools.analyticslogger.internal.data.model.EventEntity
 
-@Database(entities = [EventEntity::class], version = 1)
+@Database(entities = [EventEntity::class], version = 2)
 internal abstract class EventDatabase : RoomDatabase() {
 
     abstract fun eventDao(): EventDao
@@ -18,7 +20,17 @@ internal abstract class EventDatabase : RoomDatabase() {
                 context,
                 EventDatabase::class.java,
                 "analytics-logger-database-1",
-            ).build()
+            )
+                .addMigrations(*migrations)
+                .build()
         }
+
+        private val migrations = arrayOf(
+            object : Migration(1, 2) {
+                override fun migrate(db: SupportSQLiteDatabase) {
+                    db.execSQL("ALTER TABLE event_entities ADD COLUMN isSuccess INTEGER")
+                }
+            },
+        )
     }
 }

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/data/model/EventEntity.kt

@@ -11,4 +11,5 @@ internal data class EventEntity(
     @ColumnInfo(name = "value") val value: String?,
     @ColumnInfo(name = "platform") val platform: String?,
     @ColumnInfo(name = "date") val date: String?,
+    @ColumnInfo(name = "isSuccess") val isSuccess: Boolean?,
 )

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/domain/manager/EventManager.kt

@@ -6,7 +6,7 @@ internal interface EventManager {
 
     suspend fun find(query: String?, platform: String, page: Int, pageSize: Int): List<Event>
 
-    suspend fun insert(key: String?, value: String?, platform: String?)
+    suspend fun insert(key: String?, value: String?, platform: String?, isSuccess: Boolean? = null)
 
     suspend fun deleteAll()
 

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/domain/manager/EventManagerImpl.kt

@@ -28,6 +28,7 @@ internal class EventManagerImpl(
         key: String?,
         value: String?,
         platform: String?,
+        isSuccess: Boolean?,
     ) {
         val dateFormat = SimpleDateFormat("HH:mm:ss", Locale.getDefault())
         val date = dateFormat.format(Calendar.getInstance().time)
@@ -38,6 +39,7 @@ internal class EventManagerImpl(
                 value = value,
                 platform = platform,
                 date = date,
+                isSuccess = isSuccess,
             )
         )
     }
@@ -70,6 +72,7 @@ internal class EventManagerImpl(
                 json = eventEntity.value.beautify(moshi),
                 platform = eventEntity.platform,
                 date = eventEntity.date,
+                isSuccess = eventEntity.isSuccess,
             )
         }
 

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/domain/model/Event.kt

@@ -7,4 +7,5 @@ internal data class Event(
     val json: String?,
     val platform: String?,
     val date: String?,
+    val isSuccess: Boolean?,
 )

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/ui/EventAdapter.kt

@@ -1,12 +1,16 @@
 package com.trendyol.android.devtools.analyticslogger.internal.ui
 
+import android.content.Context
 import android.content.res.ColorStateList
+import android.graphics.drawable.Drawable
 import android.graphics.drawable.GradientDrawable
 import android.view.LayoutInflater
 import android.view.ViewGroup
+import androidx.core.content.ContextCompat
 import androidx.paging.PagingDataAdapter
 import androidx.recyclerview.widget.DiffUtil
 import androidx.recyclerview.widget.RecyclerView
+import com.trendyol.android.devtools.analyticslogger.R
 import com.trendyol.android.devtools.analyticslogger.databinding.AnalyticsLoggerItemEventBinding
 import com.trendyol.android.devtools.analyticslogger.internal.domain.model.Event
 import com.trendyol.android.devtools.analyticslogger.internal.factory.ColorFactory
@@ -59,6 +63,7 @@ internal class EventAdapter : PagingDataAdapter<Event, EventAdapter.EventViewHol
             textViewPlatform.text = event.platform
             textViewDate.text = event.date
             textViewPlatform.background = createPlatformBackground(event.platform)
+            root.background = createStatusBackground(root.context, event.isSuccess)
         }
 
         private fun createPlatformBackground(platform: String?): GradientDrawable {
@@ -69,5 +74,17 @@ internal class EventAdapter : PagingDataAdapter<Event, EventAdapter.EventViewHol
                 )
             }
         }
+
+        private fun createStatusBackground(context: Context, isSuccess: Boolean?): Drawable? {
+            if (isSuccess == null) return null
+
+            val background = if (isSuccess) {
+                R.drawable.analytics_logger_success_background
+            } else {
+                R.drawable.analytics_logger_failure_background
+            }
+
+            return ContextCompat.getDrawable(context, background)
+        }
     }
 }

libraries/analytics-logger/src/main/java/com/trendyol/android/devtools/analyticslogger/internal/ui/detail/DetailFragment.kt

@@ -13,6 +13,7 @@ import android.view.MenuItem
 import android.view.View
 import android.view.ViewGroup
 import android.widget.Toast
+import androidx.core.content.ContextCompat
 import androidx.fragment.app.Fragment
 import androidx.fragment.app.activityViewModels
 import androidx.lifecycle.lifecycleScope
@@ -21,7 +22,6 @@ import com.trendyol.android.devtools.analyticslogger.databinding.AnalyticsLogger
 import com.trendyol.android.devtools.analyticslogger.internal.di.ContextContainer
 import com.trendyol.android.devtools.analyticslogger.internal.factory.ColorFactory
 import com.trendyol.android.devtools.analyticslogger.internal.ui.MainViewModel
-import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.launch
 
 internal class DetailFragment : Fragment() {
@@ -64,6 +64,10 @@ internal class DetailFragment : Fragment() {
             textViewDate.text = state.event.date
             textViewPlatform.text = state.event.platform
             textViewPlatform.background = createPlatformBackground(state.event.platform)
+            horizontalScrollView.background = ContextCompat.getDrawable(
+                /* context = */ root.context,
+                /* id = */ getStatusBackgroundRes(state.event.isSuccess)
+            )
         }
     }
 
@@ -76,6 +80,14 @@ internal class DetailFragment : Fragment() {
         }
     }
 
+    private fun getStatusBackgroundRes(isSuccess: Boolean?): Int {
+        return when (isSuccess) {
+            true -> R.drawable.analytics_logger_success_background
+            false -> R.drawable.analytics_logger_failure_background
+            null -> R.drawable.analytics_logger_json_background
+        }
+    }
+
     private fun copyToClipboard() {
         val clipboard = context?.getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
         val data = (viewModel.detailState.value as? DetailState.Selected)?.event?.json.orEmpty()

libraries/analytics-logger/src/main/res/drawable/analytics_logger_failure_background.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<shape xmlns:android="http://schemas.android.com/apk/res/android">
+    <solid android:color="@color/analyticEventFailureColor"/>
+    <corners android:radius="4dp" />
+</shape>

libraries/analytics-logger/src/main/res/drawable/analytics_logger_success_background.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<shape xmlns:android="http://schemas.android.com/apk/res/android">
+    <solid android:color="@color/analyticEventSuccessColor"/>
+    <corners android:radius="4dp" />
+</shape>

libraries/analytics-logger/src/main/res/layout/analytics_logger_fragment_detail.xml

@@ -3,6 +3,7 @@
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
     android:orientation="vertical">
 
     <androidx.constraintlayout.widget.ConstraintLayout
@@ -47,13 +48,14 @@
             app:layout_constraintEnd_toEndOf="parent" />
 
         <HorizontalScrollView
+            android:id="@+id/horizontalScrollView"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:layout_marginTop="16dp"
-            android:background="@drawable/analytics_logger_json_background"
             app:layout_constraintTop_toBottomOf="@id/textViewDate"
             app:layout_constraintBottom_toBottomOf="parent"
-            app:layout_constraintVertical_bias="0">
+            app:layout_constraintVertical_bias="0"
+            tools:background="@drawable/analytics_logger_json_background">
 
             <TextView
                 android:id="@+id/textViewValue"

libraries/analytics-logger/src/main/res/values/colors.xml

@@ -7,4 +7,6 @@
     <color name="colorAccent">#9b59b6</color>
 
     <color name="analyticGridBackgroundColor">#e3e3e3</color>
+    <color name="analyticEventSuccessColor">#C4F0D8</color>
+    <color name="analyticEventFailureColor">#f6dde1</color>
 </resources>

sample/src/main/java/com/trendyol/android/devtools/ui/main/MainFragment.kt

@@ -75,6 +75,12 @@ class MainFragment : Fragment() {
             key = "OnMainFragmentSeenEvent",
             value = "{\"category\": \"Cart\", \"data\": \"TestData\" }",
             platform = "Firebase",
+            isSuccess = true,
+        )
+        AnalyticsLogger.report(
+            key = "OnMainFragmentSeenFailEvent",
+            value = "{\"category\": \"Cart\", \"data\": \"TestData\" }",
+            platform = "Firebase",
         )
     }