Merge pull request #118 from ankur141295/inject_analytics_helper_v1

Inject AnalyticsHelper with Hilt

app/src/main/java/com/waseefakhtar/doseapp/DoseApp.kt

@@ -54,7 +54,9 @@ import com.waseefakhtar.doseapp.ui.theme.DoseAppTheme
 import com.waseefakhtar.doseapp.util.SnackbarUtil
 
 @Composable
-fun DoseApp() {
+fun DoseApp(
+    analyticsHelper: AnalyticsHelper
+) {
     DoseAppTheme {
         // A surface container using the 'background' color from the theme
         Surface(
@@ -73,9 +75,6 @@ fun DoseApp() {
             val bottomBarVisibility = rememberSaveable { (mutableStateOf(true)) }
             val fabVisibility = rememberSaveable { (mutableStateOf(true)) }
 
-            val context = LocalContext.current
-            val analyticsHelper = AnalyticsHelper.getInstance(context)
-
             Scaffold(
                 modifier = Modifier.padding(16.dp, 0.dp),
                 containerColor = Color.Transparent,
@@ -216,7 +215,8 @@ fun DoseFAB(navController: NavController, analyticsHelper: AnalyticsHelper) {
 @Preview(showBackground = true)
 @Composable
 fun DefaultPreview() {
+    val context = LocalContext.current
     DoseAppTheme {
-        DoseApp()
+        DoseApp(analyticsHelper = AnalyticsHelper(context = context))
     }
 }

app/src/main/java/com/waseefakhtar/doseapp/MainActivity.kt

@@ -7,21 +7,26 @@ import androidx.activity.compose.setContent
 import com.waseefakhtar.doseapp.analytics.AnalyticsEvents
 import com.waseefakhtar.doseapp.analytics.AnalyticsHelper
 import dagger.hilt.android.AndroidEntryPoint
+import javax.inject.Inject
 
 @AndroidEntryPoint
 class MainActivity : ComponentActivity() {
+
+    @Inject
+    lateinit var analyticsHelper: AnalyticsHelper
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContent {
-            DoseApp()
+            DoseApp(analyticsHelper = analyticsHelper)
         }
         parseIntent(intent)
     }
 
     private fun parseIntent(intent: Intent?) {
         val isMedicationNotification = intent?.getBooleanExtra(MEDICATION_NOTIFICATION, false) ?: false
         if (isMedicationNotification) {
-            AnalyticsHelper.getInstance(this).logEvent(AnalyticsEvents.REMINDER_NOTIFICATION_CLICKED)
+            analyticsHelper.logEvent(AnalyticsEvents.REMINDER_NOTIFICATION_CLICKED)
         }
     }
 }

app/src/main/java/com/waseefakhtar/doseapp/MedicationNotificationReceiver.kt

@@ -9,11 +9,18 @@ import android.os.Build
 import androidx.core.app.NotificationCompat
 import com.waseefakhtar.doseapp.analytics.AnalyticsHelper
 import com.waseefakhtar.doseapp.domain.model.Medication
+import dagger.hilt.android.AndroidEntryPoint
+import javax.inject.Inject
 
 const val MEDICATION_INTENT = "medication_intent"
 const val MEDICATION_NOTIFICATION = "medication_notification"
+
+@AndroidEntryPoint
 class MedicationNotificationReceiver : BroadcastReceiver() {
 
+    @Inject
+    lateinit var analyticsHelper: AnalyticsHelper
+
     override fun onReceive(context: Context?, intent: Intent?) {
         context?.let {
             intent?.getParcelableExtra<Medication>(MEDICATION_INTENT)?.let { medication ->
@@ -59,6 +66,6 @@ class MedicationNotificationReceiver : BroadcastReceiver() {
         val notificationManager = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
         notificationManager.notify(medication.hashCode(), notification)
 
-        AnalyticsHelper.getInstance(context).trackNotificationShown(medication)
+        analyticsHelper.trackNotificationShown(medication)
     }
 }

app/src/main/java/com/waseefakhtar/doseapp/MedicationNotificationService.kt

@@ -13,7 +13,7 @@ class MedicationNotificationService(
     private val context: Context
 ) {
 
-    fun scheduleNotification(medication: Medication) {
+    fun scheduleNotification(medication: Medication, analyticsHelper: AnalyticsHelper) {
         val intent = Intent(context, MedicationNotificationReceiver::class.java)
         intent.putExtra(MEDICATION_INTENT, medication)
 
@@ -40,7 +40,7 @@ class MedicationNotificationService(
             }
         }
 
-        AnalyticsHelper.getInstance(context).trackNotificationScheduled(medication)
+        analyticsHelper.trackNotificationScheduled(medication)
     }
 
     companion object {

app/src/main/java/com/waseefakhtar/doseapp/analytics/AnalyticsHelper.kt

@@ -2,43 +2,40 @@ package com.waseefakhtar.doseapp.analytics
 
 import android.content.Context
 import android.os.Bundle
+import androidx.core.os.bundleOf
 import com.google.firebase.analytics.FirebaseAnalytics
 import com.waseefakhtar.doseapp.domain.model.Medication
 import com.waseefakhtar.doseapp.extension.toFormattedDateString
 import java.util.Date
 
-class AnalyticsHelper private constructor(context: Context) {
+private const val MEDICATION_TIME = "medication_time"
+private const val MEDICATION_END_DATE = "medication_end_date"
+private const val NOTIFICATION_TIME = "notification_time"
 
+class AnalyticsHelper(
+    context: Context
+) {
     private val firebaseAnalytics = FirebaseAnalytics.getInstance(context)
 
-    companion object {
-        @Volatile
-        private var instance: AnalyticsHelper? = null
-
-        fun getInstance(context: Context): AnalyticsHelper {
-            return instance ?: synchronized(this) {
-                instance ?: AnalyticsHelper(context).also { instance = it }
-            }
-        }
-    }
-
-    fun logEvent(eventName: String, params: Bundle? = null) {
-        firebaseAnalytics.logEvent(eventName, params)
-    }
-
     fun trackNotificationShown(medication: Medication) {
-        val params = Bundle()
-        params.putString("medication_time", medication.medicationTime.toFormattedDateString())
-        params.putString("medication_end_date", medication.endDate.toFormattedDateString())
-        params.putString("notification_time", Date().toFormattedDateString())
+        val params = bundleOf(
+            MEDICATION_TIME to medication.medicationTime.toFormattedDateString(),
+            MEDICATION_END_DATE to medication.endDate.toFormattedDateString(),
+            NOTIFICATION_TIME to Date().toFormattedDateString()
+        )
         logEvent(AnalyticsEvents.MEDICATION_NOTIFICATION_SHOWN, params)
     }
 
     fun trackNotificationScheduled(medication: Medication) {
-        val params = Bundle()
-        params.putString("medication_time", medication.medicationTime.toFormattedDateString())
-        params.putString("medication_end_date", medication.endDate.toFormattedDateString())
-        params.putString("notification_time", Date().toFormattedDateString())
+        val params = bundleOf(
+            MEDICATION_TIME to medication.medicationTime.toFormattedDateString(),
+            MEDICATION_END_DATE to medication.endDate.toFormattedDateString(),
+            NOTIFICATION_TIME to Date().toFormattedDateString()
+        )
         logEvent(AnalyticsEvents.MEDICATION_NOTIFICATION_SCHEDULED, params)
     }
+
+    fun logEvent(eventName: String, params: Bundle? = null) {
+        firebaseAnalytics.logEvent(eventName, params)
+    }
 }

app/src/main/java/com/waseefakhtar/doseapp/di/AnalyticsHelperModule.kt

@@ -0,0 +1,23 @@
+package com.waseefakhtar.doseapp.di
+
+import android.content.Context
+import com.waseefakhtar.doseapp.analytics.AnalyticsHelper
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.android.qualifiers.ApplicationContext
+import dagger.hilt.components.SingletonComponent
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+object AnalyticsHelperModule {
+
+    @Provides
+    @Singleton
+    fun provideAnalyticsHelper(
+        @ApplicationContext context: Context,
+    ): AnalyticsHelper {
+        return AnalyticsHelper(context = context)
+    }
+}

app/src/main/java/com/waseefakhtar/doseapp/feature/addmedication/AddMedicationRoute.kt

@@ -56,7 +56,6 @@ import androidx.compose.ui.unit.dp
 import androidx.hilt.navigation.compose.hiltViewModel
 import com.waseefakhtar.doseapp.R
 import com.waseefakhtar.doseapp.analytics.AnalyticsEvents
-import com.waseefakhtar.doseapp.analytics.AnalyticsHelper
 import com.waseefakhtar.doseapp.domain.model.Medication
 import com.waseefakhtar.doseapp.extension.toFormattedDateString
 import com.waseefakhtar.doseapp.feature.addmedication.model.CalendarInformation
@@ -80,16 +79,14 @@ fun AddMedicationRoute(
     navigateToMedicationConfirm: (List<Medication>) -> Unit,
     viewModel: AddMedicationViewModel = hiltViewModel()
 ) {
-    val analyticsHelper = AnalyticsHelper.getInstance(LocalContext.current)
-    AddMedicationScreen(onBackClicked, viewModel, analyticsHelper, navigateToMedicationConfirm)
+    AddMedicationScreen(onBackClicked, viewModel, navigateToMedicationConfirm)
 }
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
 fun AddMedicationScreen(
     onBackClicked: () -> Unit,
     viewModel: AddMedicationViewModel,
-    analyticsHelper: AnalyticsHelper,
     navigateToMedicationConfirm: (List<Medication>) -> Unit,
 ) {
     var medicationName by rememberSaveable { mutableStateOf("") }
@@ -101,12 +98,12 @@ fun AddMedicationScreen(
 
     fun addTime(time: CalendarInformation) {
         selectedTimes.add(time)
-        analyticsHelper.logEvent(AnalyticsEvents.ADD_MEDICATION_ADD_TIME_CLICKED)
+        viewModel.logEvent(eventName = AnalyticsEvents.ADD_MEDICATION_ADD_TIME_CLICKED)
     }
 
     fun removeTime(time: CalendarInformation) {
         selectedTimes.remove(time)
-        analyticsHelper.logEvent(AnalyticsEvents.ADD_MEDICATION_DELETE_TIME_CLICKED)
+        viewModel.logEvent(eventName = AnalyticsEvents.ADD_MEDICATION_DELETE_TIME_CLICKED)
     }
 
     Scaffold(
@@ -117,7 +114,7 @@ fun AddMedicationScreen(
                 navigationIcon = {
                     FloatingActionButton(
                         onClick = {
-                            analyticsHelper.logEvent(AnalyticsEvents.ADD_MEDICATION_ON_BACK_CLICKED)
+                            viewModel.logEvent(eventName = AnalyticsEvents.ADD_MEDICATION_ON_BACK_CLICKED)
                             onBackClicked()
                         },
                         elevation = FloatingActionButtonDefaults.elevation(0.dp, 0.dp)
@@ -164,11 +161,11 @@ fun AddMedicationScreen(
                                 AnalyticsEvents.ADD_MEDICATION_MEDICATION_VALUE_INVALIDATED,
                                 invalidatedValue
                             )
-                            analyticsHelper.logEvent(event)
+                            viewModel.logEvent(eventName = event)
                         },
                         onValidate = {
                             navigateToMedicationConfirm(it)
-                            analyticsHelper.logEvent(AnalyticsEvents.ADD_MEDICATION_NAVIGATING_TO_MEDICATION_CONFIRM)
+                            viewModel.logEvent(eventName = AnalyticsEvents.ADD_MEDICATION_NAVIGATING_TO_MEDICATION_CONFIRM)
                         },
                         viewModel = viewModel
                     )
@@ -277,7 +274,9 @@ fun AddMedicationScreen(
                         selectedTimes[index] = it
                     },
                     onDeleteClick = { removeTime(selectedTimes[index]) },
-                    analyticsHelper = analyticsHelper
+                    logEvent = {
+                        viewModel.logEvent(AnalyticsEvents.ADD_MEDICATION_NEW_TIME_SELECTED)
+                    },
                 )
             }
 
@@ -471,7 +470,7 @@ fun TimerTextField(
     isOnlyItem: Boolean,
     time: (CalendarInformation) -> Unit,
     onDeleteClick: () -> Unit,
-    analyticsHelper: AnalyticsHelper
+    logEvent: () -> Unit
 ) {
     val interactionSource = remember { MutableInteractionSource() }
     val isPressed: Boolean by interactionSource.collectIsPressedAsState()
@@ -484,7 +483,7 @@ fun TimerTextField(
         showDialog = isPressed,
         selectedDate = selectedTime,
         onSelectedTime = {
-            analyticsHelper.logEvent(AnalyticsEvents.ADD_MEDICATION_NEW_TIME_SELECTED)
+            logEvent.invoke()
             selectedTime = it
             time(it)
         }

app/src/main/java/com/waseefakhtar/doseapp/feature/addmedication/viewmodel/AddMedicationViewModel.kt

@@ -1,12 +1,18 @@
 package com.waseefakhtar.doseapp.feature.addmedication.viewmodel
 
 import androidx.lifecycle.ViewModel
+import com.waseefakhtar.doseapp.analytics.AnalyticsHelper
 import com.waseefakhtar.doseapp.domain.model.Medication
 import com.waseefakhtar.doseapp.feature.addmedication.model.CalendarInformation
+import dagger.hilt.android.lifecycle.HiltViewModel
 import java.util.Calendar
 import java.util.Date
+import javax.inject.Inject
 
-class AddMedicationViewModel : ViewModel() {
+@HiltViewModel
+class AddMedicationViewModel @Inject constructor(
+    private val analyticsHelper: AnalyticsHelper
+) : ViewModel() {
 
     fun createMedications(
         name: String,
@@ -59,4 +65,8 @@ class AddMedicationViewModel : ViewModel() {
         calendar.set(Calendar.MINUTE, medicationTime.dateInformation.minute)
         return calendar.time
     }
+
+    fun logEvent(eventName: String) {
+        analyticsHelper.logEvent(eventName = eventName)
+    }
 }

app/src/main/java/com/waseefakhtar/doseapp/feature/history/HistoryScreen.kt

@@ -16,14 +16,12 @@ import androidx.compose.material3.TopAppBar
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
-import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.font.FontWeight
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.unit.dp
 import androidx.hilt.navigation.compose.hiltViewModel
 import com.waseefakhtar.doseapp.R
-import com.waseefakhtar.doseapp.analytics.AnalyticsHelper
 import com.waseefakhtar.doseapp.domain.model.Medication
 import com.waseefakhtar.doseapp.extension.hasPassed
 import com.waseefakhtar.doseapp.feature.history.viewmodel.HistoryState
@@ -36,14 +34,19 @@ fun HistoryRoute(
     navigateToMedicationDetail: (Medication) -> Unit,
     viewModel: HistoryViewModel = hiltViewModel()
 ) {
-    val analyticsHelper = AnalyticsHelper.getInstance(LocalContext.current)
     val state = viewModel.state
-    HistoryScreen(analyticsHelper, state, navigateToMedicationDetail)
+    HistoryScreen(
+        state = state,
+        navigateToMedicationDetail = navigateToMedicationDetail
+    )
 }
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-fun HistoryScreen(analyticsHelper: AnalyticsHelper, state: HistoryState, navigateToMedicationDetail: (Medication) -> Unit) {
+fun HistoryScreen(
+    state: HistoryState,
+    navigateToMedicationDetail: (Medication) -> Unit
+) {
     Scaffold(
         topBar = {
             TopAppBar(
@@ -64,13 +67,19 @@ fun HistoryScreen(analyticsHelper: AnalyticsHelper, state: HistoryState, navigat
             modifier = Modifier.padding(innerPadding),
             verticalArrangement = Arrangement.spacedBy(8.dp)
         ) {
-            MedicationList(analyticsHelper, state, navigateToMedicationDetail)
+            MedicationList(
+                state = state,
+                navigateToMedicationDetail = navigateToMedicationDetail
+            )
         }
     }
 }
 
 @Composable
-fun MedicationList(analyticsHelper: AnalyticsHelper, state: HistoryState, navigateToMedicationDetail: (Medication) -> Unit) {
+fun MedicationList(
+    state: HistoryState,
+    navigateToMedicationDetail: (Medication) -> Unit
+) {
 
     val filteredMedicationList = state.medications.filter { it.medicationTime.hasPassed() }
     val sortedMedicationList: List<MedicationListItem> = filteredMedicationList.sortedBy { it.medicationTime }.map { MedicationListItem.MedicationItem(it) }