feat: analytics

PavloNetrebchuk · PavloNetrebchuk · commit de38264ca98c · 2025-08-05T12:09:35.000+03:00
diff --git a/app/src/main/java/org/openedx/app/di/ScreenModule.kt b/app/src/main/java/org/openedx/app/di/ScreenModule.kt
@@ -20,6 +20,7 @@ import org.openedx.course.data.repository.CourseRepository
 import org.openedx.course.domain.interactor.CourseInteractor
 import org.openedx.course.presentation.assignments.CourseAssignmentViewModel
 import org.openedx.course.presentation.container.CourseContainerViewModel
+import org.openedx.course.presentation.contenttab.ContentTabViewModel
 import org.openedx.course.presentation.dates.CourseDatesViewModel
 import org.openedx.course.presentation.handouts.HandoutsViewModel
 import org.openedx.course.presentation.offline.CourseOfflineViewModel
@@ -300,6 +301,13 @@ val screenModule = module {
             get(),
         )
     }
+    viewModel { (courseId: String, courseTitle: String) ->
+        ContentTabViewModel(
+            courseId,
+            courseTitle,
+            get(),
+        )
+    }
     viewModel { (courseId: String) ->
         CourseSectionViewModel(
             courseId,
@@ -337,6 +345,7 @@ val screenModule = module {
             get(),
             get(),
             get(),
+            get(),
         )
     }
     viewModel { (courseId: String) -> BaseVideoViewModel(courseId, get()) }
@@ -537,6 +546,7 @@ val screenModule = module {
             interactor = get(),
             courseRouter = get(),
             courseNotifier = get(),
+            analytics = get()
         )
     }
 }
diff --git a/course/src/main/java/org/openedx/course/presentation/CourseAnalytics.kt b/course/src/main/java/org/openedx/course/presentation/CourseAnalytics.kt
@@ -66,6 +66,14 @@ enum class CourseAnalyticsEvent(val eventName: String, val biValue: String) {
         "Course:Handouts Tab",
         "edx.bi.app.course.handouts_tab"
     ),
+    OFFLINE_TAB(
+        "Course:Offline Tab",
+        "edx.bi.app.course.offline_tab"
+    ),
+    CONTENT_TAB(
+        "Course:Content Tab",
+        "edx.bi.app.course.content_tab"
+    ),
     ANNOUNCEMENTS(
         "Course:Announcements",
         "edx.bi.app.course.announcements"
@@ -78,6 +86,10 @@ enum class CourseAnalyticsEvent(val eventName: String, val biValue: String) {
         "Course:Unit Detail",
         "edx.bi.app.course.unit_detail"
     ),
+    COURSE_CONTENT_TAB_CLICK(
+        "Content Page:Section Click",
+        "edx.bi.app.course.content.section.clicked"
+    ),
     VIEW_CERTIFICATE(
         "Course:View Certificate Clicked",
         "edx.bi.app.course.view_certificate.clicked"
@@ -110,6 +122,18 @@ enum class CourseAnalyticsEvent(val eventName: String, val biValue: String) {
         "Video:Completed",
         "edx.bi.app.videos.completed"
     ),
+    VIDEO_SHOW_COMPLETED(
+        "Content Page:Show Completed Subsection Click",
+        "edx.bi.app.course.content.show_completed_subsection.clicked"
+    ),
+    COURSE_CONTENT_VIDEO_CLICK(
+        "Course:Video click",
+        "edx.bi.app.course.content.video.clicked"
+    ),
+    COURSE_CONTENT_ASSIGNMENT_CLICK(
+        "Course:Assignment click",
+        "edx.bi.app.course.content.assignment.clicked"
+    ),
     CAST_CONNECTED(
         "Cast:Connected",
         "edx.bi.app.cast.connected"
@@ -168,6 +192,7 @@ enum class CourseAnalyticsKey(val key: String) {
     LINK("link"),
     SUPPORTED("supported"),
     BLOCK_ID("block_id"),
+    TAB_NAME("tab_name"),
     BLOCK_NAME("block_name"),
     BLOCK_TYPE("block_type"),
     PLAY_MEDIUM("play_medium"),
diff --git a/course/src/main/java/org/openedx/course/presentation/assignments/CourseAssignmentViewModel.kt b/course/src/main/java/org/openedx/course/presentation/assignments/CourseAssignmentViewModel.kt
@@ -14,13 +14,17 @@ import org.openedx.core.domain.model.Progress
 import org.openedx.core.system.notifier.CourseNotifier
 import org.openedx.core.system.notifier.CourseStructureUpdated
 import org.openedx.course.domain.interactor.CourseInteractor
+import org.openedx.course.presentation.CourseAnalytics
+import org.openedx.course.presentation.CourseAnalyticsEvent
+import org.openedx.course.presentation.CourseAnalyticsKey
 import org.openedx.course.presentation.CourseRouter
 
 class CourseAssignmentViewModel(
     val courseId: String,
     val courseRouter: CourseRouter,
     private val interactor: CourseInteractor,
     private val courseNotifier: CourseNotifier,
+    private val analytics: CourseAnalytics,
 ) : ViewModel() {
     private val _uiState =
         MutableStateFlow<CourseAssignmentUIState>(CourseAssignmentUIState.Loading)
@@ -94,4 +98,18 @@ class CourseAssignmentViewModel(
             }
         }
     }
+
+    fun logAssignmentClick(blockId: String) {
+        analytics.logEvent(
+            CourseAnalyticsEvent.COURSE_CONTENT_ASSIGNMENT_CLICK.eventName,
+            buildMap {
+                put(
+                    CourseAnalyticsKey.NAME.key,
+                    CourseAnalyticsEvent.COURSE_CONTENT_ASSIGNMENT_CLICK.biValue
+                )
+                put(CourseAnalyticsKey.COURSE_ID.key, courseId)
+                put(CourseAnalyticsKey.BLOCK_ID.key, blockId)
+            }
+        )
+    }
 }
diff --git a/course/src/main/java/org/openedx/course/presentation/assignments/CourseContentAssignmentScreen.kt b/course/src/main/java/org/openedx/course/presentation/assignments/CourseContentAssignmentScreen.kt
@@ -99,6 +99,7 @@ fun CourseContentAssignmentScreen(
                 subSectionId = subSectionBlock.id,
                 mode = CourseViewMode.FULL
             )
+            viewModel.logAssignmentClick(subSectionBlock.id)
         },
     )
 }
diff --git a/course/src/main/java/org/openedx/course/presentation/container/CourseContainerFragment.kt b/course/src/main/java/org/openedx/course/presentation/container/CourseContainerFragment.kt
@@ -532,6 +532,9 @@ private fun DashboardPager(
 
             CourseContainerTab.CONTENT -> {
                 ContentTabScreen(
+                    viewModel = koinViewModel(
+                        parameters = { parametersOf(viewModel.courseId, viewModel.courseName) }
+                    ),
                     windowSize = windowSize,
                     fragmentManager = fragmentManager,
                     courseId = viewModel.courseId,
diff --git a/course/src/main/java/org/openedx/course/presentation/container/CourseContainerViewModel.kt b/course/src/main/java/org/openedx/course/presentation/container/CourseContainerViewModel.kt
@@ -328,7 +328,8 @@ class CourseContainerViewModel(
             CourseContainerTab.DISCUSSIONS -> discussionTabClickedEvent()
             CourseContainerTab.DATES -> datesTabClickedEvent()
             CourseContainerTab.MORE -> moreTabClickedEvent()
-            CourseContainerTab.OFFLINE, CourseContainerTab.CONTENT -> {}
+            CourseContainerTab.OFFLINE -> offlineTabClickedEvent()
+            CourseContainerTab.CONTENT -> contentTabClickedEvent()
         }
     }
 
@@ -376,6 +377,15 @@ class CourseContainerViewModel(
         logCourseContainerEvent(CourseAnalyticsEvent.MORE_TAB)
     }
 
+    private fun offlineTabClickedEvent() {
+        logCourseContainerEvent(CourseAnalyticsEvent.OFFLINE_TAB)
+    }
+
+    private fun contentTabClickedEvent() {
+        logCourseContainerEvent(CourseAnalyticsEvent.CONTENT_TAB)
+    }
+
+
     private fun logCourseContainerEvent(event: CourseAnalyticsEvent) {
         courseAnalytics.logScreenEvent(
             screenName = event.eventName,
diff --git a/course/src/main/java/org/openedx/course/presentation/contenttab/ContentTabScreen.kt b/course/src/main/java/org/openedx/course/presentation/contenttab/ContentTabScreen.kt
@@ -47,6 +47,7 @@ import org.openedx.foundation.presentation.windowSizeValue
 
 @Composable
 fun ContentTabScreen(
+    viewModel: ContentTabViewModel,
     windowSize: WindowSize,
     fragmentManager: FragmentManager,
     courseId: String,
@@ -110,6 +111,7 @@ fun ContentTabScreen(
                                 scope.launch {
                                     pagerState.scrollToPage(index)
                                 }
+                                viewModel.logTabClickEvent(CourseContentTab.entries[index])
                             },
                         contentAlignment = Alignment.Center
                     ) {
diff --git a/course/src/main/java/org/openedx/course/presentation/contenttab/ContentTabViewModel.kt b/course/src/main/java/org/openedx/course/presentation/contenttab/ContentTabViewModel.kt
@@ -0,0 +1,29 @@
+package org.openedx.course.presentation.contenttab
+
+import org.openedx.course.presentation.CourseAnalytics
+import org.openedx.course.presentation.CourseAnalyticsEvent
+import org.openedx.course.presentation.CourseAnalyticsKey
+import org.openedx.course.presentation.container.CourseContentTab
+import org.openedx.foundation.presentation.BaseViewModel
+
+class ContentTabViewModel(
+    val courseId: String,
+    private val courseTitle: String,
+    private val analytics: CourseAnalytics,
+) : BaseViewModel() {
+
+    fun logTabClickEvent(contentTab: CourseContentTab) {
+        analytics.logEvent(
+            CourseAnalyticsEvent.COURSE_CONTENT_TAB_CLICK.eventName,
+            buildMap {
+                put(
+                    CourseAnalyticsKey.NAME.key,
+                    CourseAnalyticsEvent.COURSE_CONTENT_TAB_CLICK.biValue
+                )
+                put(CourseAnalyticsKey.COURSE_ID.key, courseId)
+                put(CourseAnalyticsKey.COURSE_NAME.key, courseTitle)
+                put(CourseAnalyticsKey.TAB_NAME.key, contentTab.name)
+            }
+        )
+    }
+}
diff --git a/course/src/main/java/org/openedx/course/presentation/videos/CourseContentVideoScreen.kt b/course/src/main/java/org/openedx/course/presentation/videos/CourseContentVideoScreen.kt
@@ -72,6 +72,7 @@ fun CourseContentVideoScreen(
                 unitId = viewModel.getBlockParent(videoBlock.id)?.id ?: return@CourseVideosUI,
                 mode = CourseViewMode.VIDEOS
             )
+            viewModel.logVideoClick(videoBlock.id)
         },
         onDownloadClick = { blocksIds ->
             viewModel.downloadBlocks(
@@ -81,7 +82,7 @@ fun CourseContentVideoScreen(
         },
         onCompletedSectionVisibilityChange = {
             viewModel.onCompletedSectionVisibilityChange()
-        }
+        },
     )
 }
 
diff --git a/course/src/main/java/org/openedx/course/presentation/videos/CourseVideoViewModel.kt b/course/src/main/java/org/openedx/course/presentation/videos/CourseVideoViewModel.kt
@@ -1,5 +1,6 @@
 package org.openedx.course.presentation.videos
 
+import android.annotation.SuppressLint
 import android.content.Context
 import androidx.fragment.app.FragmentManager
 import androidx.lifecycle.viewModelScope
@@ -29,13 +30,18 @@ import org.openedx.core.system.notifier.CourseNotifier
 import org.openedx.core.system.notifier.CourseStructureUpdated
 import org.openedx.course.R
 import org.openedx.course.domain.interactor.CourseInteractor
+import org.openedx.course.presentation.CourseAnalytics
+import org.openedx.course.presentation.CourseAnalyticsEvent
+import org.openedx.course.presentation.CourseAnalyticsKey
 import org.openedx.course.presentation.CourseRouter
 import org.openedx.foundation.presentation.UIMessage
 import org.openedx.foundation.system.ResourceManager
 import org.openedx.foundation.utils.FileUtil
 
+@SuppressLint("StaticFieldLeak")
 class CourseVideoViewModel(
     val courseId: String,
+    private val context: Context,
     private val config: Config,
     private val interactor: CourseInteractor,
     private val resourceManager: ResourceManager,
@@ -44,8 +50,8 @@ class CourseVideoViewModel(
     private val courseNotifier: CourseNotifier,
     private val downloadDialogManager: DownloadDialogManager,
     private val fileUtil: FileUtil,
-    private val context: Context,
     val courseRouter: CourseRouter,
+    private val analytics: CourseAnalytics,
     coreAnalytics: CoreAnalytics,
     downloadDao: DownloadDao,
     workerController: DownloadWorkerController,
@@ -289,8 +295,36 @@ class CourseVideoViewModel(
     fun onCompletedSectionVisibilityChange() {
         if (_uiState.value is CourseVideoUIState.CourseData) {
             val state = _uiState.value as CourseVideoUIState.CourseData
+            _uiState.value = state.copy(isCompletedSectionsShown = !state.isCompletedSectionsShown)
+
+            analytics.logEvent(
+                CourseAnalyticsEvent.VIDEO_SHOW_COMPLETED.eventName,
+                buildMap {
+                    put(
+                        CourseAnalyticsKey.NAME.key,
+                        CourseAnalyticsEvent.VIDEO_SHOW_COMPLETED.biValue
+                    )
+                    put(CourseAnalyticsKey.COURSE_ID.key, courseId)
+                }
+            )
+        }
+    }
 
+    fun logVideoClick(blockId: String) {
+        if (_uiState.value is CourseVideoUIState.CourseData) {
+            val state = _uiState.value as CourseVideoUIState.CourseData
             _uiState.value = state.copy(isCompletedSectionsShown = !state.isCompletedSectionsShown)
+            analytics.logEvent(
+                CourseAnalyticsEvent.COURSE_CONTENT_VIDEO_CLICK.eventName,
+                buildMap {
+                    put(
+                        CourseAnalyticsKey.NAME.key,
+                        CourseAnalyticsEvent.COURSE_CONTENT_VIDEO_CLICK.biValue
+                    )
+                    put(CourseAnalyticsKey.COURSE_ID.key, courseId)
+                    put(CourseAnalyticsKey.BLOCK_ID.key, blockId)
+                }
+            )
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ import org.openedx.course.data.repository.CourseRepository`
`20`	`20`	`import org.openedx.course.domain.interactor.CourseInteractor`
`21`	`21`	`import org.openedx.course.presentation.assignments.CourseAssignmentViewModel`
`22`	`22`	`import org.openedx.course.presentation.container.CourseContainerViewModel`
	`23`	`+import org.openedx.course.presentation.contenttab.ContentTabViewModel`
`23`	`24`	`import org.openedx.course.presentation.dates.CourseDatesViewModel`
`24`	`25`	`import org.openedx.course.presentation.handouts.HandoutsViewModel`
`25`	`26`	`import org.openedx.course.presentation.offline.CourseOfflineViewModel`
`@@ -300,6 +301,13 @@ val screenModule = module {`
`300`	`301`	`get(),`
`301`	`302`	`)`
`302`	`303`	`}`
	`304`	`+ viewModel { (courseId: String, courseTitle: String) ->`
	`305`	`+ ContentTabViewModel(`
	`306`	`+ courseId,`
	`307`	`+ courseTitle,`
	`308`	`+ get(),`
	`309`	`+ )`
	`310`	`+ }`
`303`	`311`	`viewModel { (courseId: String) ->`
`304`	`312`	`CourseSectionViewModel(`
`305`	`313`	`courseId,`
`@@ -337,6 +345,7 @@ val screenModule = module {`
`337`	`345`	`get(),`
`338`	`346`	`get(),`
`339`	`347`	`get(),`
	`348`	`+ get(),`
`340`	`349`	`)`
`341`	`350`	`}`
`342`	`351`	`viewModel { (courseId: String) -> BaseVideoViewModel(courseId, get()) }`
`@@ -537,6 +546,7 @@ val screenModule = module {`
`537`	`546`	`interactor = get(),`
`538`	`547`	`courseRouter = get(),`
`539`	`548`	`courseNotifier = get(),`
	`549`	`+ analytics = get()`
`540`	`550`	`)`
`541`	`551`	`}`
`542`	`552`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ fun CourseContentAssignmentScreen(`
`99`	`99`	`subSectionId = subSectionBlock.id,`
`100`	`100`	`mode = CourseViewMode.FULL`
`101`	`101`	`)`
	`102`	`+ viewModel.logAssignmentClick(subSectionBlock.id)`
`102`	`103`	`},`
`103`	`104`	`)`
`104`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,7 @@ fun CourseContentVideoScreen(`
`72`	`72`	`unitId = viewModel.getBlockParent(videoBlock.id)?.id ?: return@CourseVideosUI,`
`73`	`73`	`mode = CourseViewMode.VIDEOS`
`74`	`74`	`)`
	`75`	`+ viewModel.logVideoClick(videoBlock.id)`
`75`	`76`	`},`
`76`	`77`	`onDownloadClick = { blocksIds ->`
`77`	`78`	`viewModel.downloadBlocks(`
`@@ -81,7 +82,7 @@ fun CourseContentVideoScreen(`
`81`	`82`	`},`
`82`	`83`	`onCompletedSectionVisibilityChange = {`
`83`	`84`	`viewModel.onCompletedSectionVisibilityChange()`
`84`		`- }`
	`85`	`+ },`
`85`	`86`	`)`
`86`	`87`	`}`
`87`	`88`