feat: junit tests and analytics

Author: PavloNetrebchuk

app/src/main/java/org/openedx/app/AnalyticsManager.kt

@@ -5,6 +5,7 @@ import org.openedx.core.presentation.CoreAnalytics
 import org.openedx.core.presentation.dialog.appreview.AppReviewAnalytics
 import org.openedx.course.presentation.CourseAnalytics
 import org.openedx.dashboard.presentation.DashboardAnalytics
+import org.openedx.dates.presentation.DatesAnalytics
 import org.openedx.discovery.presentation.DiscoveryAnalytics
 import org.openedx.discussion.presentation.DiscussionAnalytics
 import org.openedx.foundation.interfaces.Analytics
@@ -21,7 +22,8 @@ class AnalyticsManager :
     DiscoveryAnalytics,
     DiscussionAnalytics,
     ProfileAnalytics,
-    WhatsNewAnalytics {
+    WhatsNewAnalytics,
+    DatesAnalytics {
 
     private val analytics: MutableList<Analytics> = mutableListOf()
 

app/src/main/java/org/openedx/app/di/AppModule.kt

@@ -63,6 +63,7 @@ import org.openedx.course.utils.ImageProcessor
 import org.openedx.course.worker.OfflineProgressSyncScheduler
 import org.openedx.dashboard.presentation.DashboardAnalytics
 import org.openedx.dashboard.presentation.DashboardRouter
+import org.openedx.dates.presentation.DatesAnalytics
 import org.openedx.dates.presentation.DatesRouter
 import org.openedx.discovery.presentation.DiscoveryAnalytics
 import org.openedx.discovery.presentation.DiscoveryRouter
@@ -212,6 +213,7 @@ val appModule = module {
     single<DiscussionAnalytics> { get<AnalyticsManager>() }
     single<ProfileAnalytics> { get<AnalyticsManager>() }
     single<WhatsNewAnalytics> { get<AnalyticsManager>() }
+    single<DatesAnalytics> { get<AnalyticsManager>() }
 
     factory { AgreementProvider(get(), get()) }
     factory { FacebookAuthHelper() }

app/src/main/java/org/openedx/app/di/ScreenModule.kt

@@ -513,7 +513,8 @@ val screenModule = module {
             networkConnection = get(),
             resourceManager = get(),
             datesInteractor = get(),
-            corePreferences = get()
+            corePreferences = get(),
+            analytics = get()
         )
     }
 }

dates/src/main/java/org/openedx/dates/presentation/DatesAnalytics.kt

@@ -0,0 +1,20 @@
+package org.openedx.dates.presentation
+
+interface DatesAnalytics {
+    fun logEvent(event: String, params: Map<String, Any?>)
+}
+
+enum class DatesAnalyticsEvent(val eventName: String, val biValue: String) {
+    ASSIGNMENT_CLICK(
+        "Dates:Assignment click",
+        "edx.bi.app.dates.assignment_click"
+    ),
+    SHIFT_DUE_DATE_CLICK(
+        "Dates:Shift due date click",
+        "edx.bi.app.dates.shift_due_date_click"
+    ),
+}
+
+enum class DatesAnalyticsKey(val key: String) {
+    NAME("name"),
+}

dates/src/main/java/org/openedx/dates/presentation/dates/DatesViewModel.kt

@@ -19,6 +19,9 @@ import org.openedx.core.system.connection.NetworkConnection
 import org.openedx.core.utils.isToday
 import org.openedx.core.utils.toCalendar
 import org.openedx.dates.domain.interactor.DatesInteractor
+import org.openedx.dates.presentation.DatesAnalytics
+import org.openedx.dates.presentation.DatesAnalyticsEvent
+import org.openedx.dates.presentation.DatesAnalyticsKey
 import org.openedx.dates.presentation.DatesRouter
 import org.openedx.foundation.extension.isInternetError
 import org.openedx.foundation.presentation.BaseViewModel
@@ -32,6 +35,7 @@ class DatesViewModel(
     private val networkConnection: NetworkConnection,
     private val resourceManager: ResourceManager,
     private val datesInteractor: DatesInteractor,
+    private val analytics: DatesAnalytics,
     corePreferences: CorePreferences,
 ) : BaseViewModel() {
 
@@ -116,6 +120,7 @@ class DatesViewModel(
     }
 
     fun shiftDueDate() {
+        logEvent(DatesAnalyticsEvent.SHIFT_DUE_DATE_CLICK)
         viewModelScope.launch {
             try {
                 _uiState.update { state ->
@@ -167,6 +172,7 @@ class DatesViewModel(
         fragmentManager: FragmentManager,
         courseDate: CourseDate,
     ) {
+        logEvent(DatesAnalyticsEvent.ASSIGNMENT_CLICK)
         datesRouter.navigateToCourseOutline(
             fm = fragmentManager,
             courseId = courseDate.courseId,
@@ -201,6 +207,19 @@ class DatesViewModel(
 
         return grouped
     }
+
+    private fun logEvent(
+        event: DatesAnalyticsEvent,
+        params: Map<String, Any?> = emptyMap(),
+    ) {
+        analytics.logEvent(
+            event = event.eventName,
+            params = buildMap {
+                put(DatesAnalyticsKey.NAME.key, event.biValue)
+                putAll(params)
+            }
+        )
+    }
 }
 
 interface DatesViewActions {

dates/src/test/java/org/openedx/dates/DatesViewModelTest.kt

@@ -31,6 +31,7 @@ import org.openedx.core.domain.model.CourseDate
 import org.openedx.core.domain.model.CourseDatesResponse
 import org.openedx.core.system.connection.NetworkConnection
 import org.openedx.dates.domain.interactor.DatesInteractor
+import org.openedx.dates.presentation.DatesAnalytics
 import org.openedx.dates.presentation.DatesRouter
 import org.openedx.dates.presentation.dates.DatesViewModel
 import org.openedx.foundation.presentation.UIMessage
@@ -51,6 +52,7 @@ class DatesViewModelTest {
     private val resourceManager = mockk<ResourceManager>()
     private val datesInteractor = mockk<DatesInteractor>()
     private val corePreferences = mockk<CorePreferences>()
+    private val analytics = mockk<DatesAnalytics>()
 
     private val noInternet = "Slow or no internet connection"
     private val somethingWrong = "Something went wrong"
@@ -63,6 +65,7 @@ class DatesViewModelTest {
         // By default, assume we have an internet connection
         every { networkConnection.isOnline() } returns true
         every { corePreferences.isRelativeDatesEnabled } returns true
+        every { analytics.logEvent(any(), any()) } returns Unit
     }
 
     @After
@@ -88,7 +91,8 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
-            corePreferences
+            analytics,
+            corePreferences,
         )
         advanceUntilIdle()
 
@@ -109,6 +113,7 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
+            analytics,
             corePreferences
         )
         advanceUntilIdle()
@@ -131,6 +136,7 @@ class DatesViewModelTest {
                 networkConnection,
                 resourceManager,
                 datesInteractor,
+                analytics,
                 corePreferences
             )
             val message = async {
@@ -155,6 +161,7 @@ class DatesViewModelTest {
                 networkConnection,
                 resourceManager,
                 datesInteractor,
+                analytics,
                 corePreferences
             )
             val message = async {
@@ -193,6 +200,7 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
+            analytics,
             corePreferences
         )
         advanceUntilIdle()
@@ -228,6 +236,7 @@ class DatesViewModelTest {
                 networkConnection,
                 resourceManager,
                 datesInteractor,
+                analytics,
                 corePreferences
             )
             advanceUntilIdle()
@@ -251,6 +260,7 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
+            analytics,
             corePreferences
         )
         val fragmentManager = mockk<FragmentManager>(relaxed = true)
@@ -266,6 +276,7 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
+            analytics,
             corePreferences
         )
         val fragmentManager = mockk<FragmentManager>(relaxed = true)
@@ -308,6 +319,7 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
+            analytics,
             corePreferences
         )
         advanceUntilIdle()
@@ -339,6 +351,7 @@ class DatesViewModelTest {
             networkConnection,
             resourceManager,
             datesInteractor,
+            analytics,
             corePreferences
         )
         advanceUntilIdle()