Merge pull request #387 from elimu-ai/375-export-to-csv

feat: export to csv

Author: jo-elimu

app/src/main/java/ai/elimu/analytics/dao/NumberAssessmentEventDao.kt

@@ -10,6 +10,12 @@ interface NumberAssessmentEventDao {
     @Insert
     fun insert(numberAssessmentEvent: NumberAssessmentEvent)
 
+    @Query("SELECT * FROM NumberAssessmentEvent ORDER BY " +
+            "CASE WHEN :isAsc = 1 THEN time END ASC," +
+            "CASE WHEN :isAsc = 0 THEN time END DESC"
+    )
+    fun loadAllOrderedByTimestamp(isAsc: Boolean): List<NumberAssessmentEvent>
+
     @Query("SELECT COUNT(*) FROM NumberAssessmentEvent")
     fun getCount(): Int
 }

app/src/main/java/ai/elimu/analytics/task/ExportEventsToCsvWorker.kt

@@ -1,11 +1,14 @@
 package ai.elimu.analytics.task
 
+import ai.elimu.analytics.BuildConfig
+import ai.elimu.analytics.db.RoomDb
 import ai.elimu.analytics.db.getAllEvents
 import ai.elimu.analytics.enum.EventType
 import ai.elimu.analytics.entity.AssessmentEvent
 import ai.elimu.analytics.entity.LearningEvent
 import ai.elimu.analytics.enum.getCSVHeaders
 import ai.elimu.analytics.enum.getUploadCsvFile
+import ai.elimu.analytics.util.SharedPreferencesHelper
 import ai.elimu.analytics.util.VersionHelper.getAppVersionCode
 import android.content.Context
 import androidx.work.Worker
@@ -14,6 +17,7 @@ import org.apache.commons.csv.CSVFormat
 import org.apache.commons.csv.CSVPrinter
 import org.apache.commons.io.FileUtils
 import timber.log.Timber
+import java.io.File
 import java.io.IOException
 import java.io.StringWriter
 import java.text.SimpleDateFormat
@@ -34,6 +38,7 @@ class ExportEventsToCsvWorker(context: Context, workerParams: WorkerParameters)
         for (eventType in EventType.entries) {
             exportAnalyticsEventsToCsv(eventType = eventType)
         }
+        exportNumberAssessmentEvents()
 
         return Result.success()
     }
@@ -88,4 +93,69 @@ class ExportEventsToCsvWorker(context: Context, workerParams: WorkerParameters)
             Timber.e(e)
         }
     }
+
+    private fun exportNumberAssessmentEvents() {
+        Timber.i("exportNumberAssessmentEvents")
+
+        // Read all the events from the database
+        val roomDb = RoomDb.getDatabase(applicationContext)
+        val numberAssessmentEventDao = roomDb.numberAssessmentEventDao()
+        val events = numberAssessmentEventDao.loadAllOrderedByTimestamp(isAsc = true)
+        Timber.i("events.size: ${events.size}")
+
+        // Generate one CSV file per day of events, e.g:
+        //   lang-THA/number-assessment-events/5b7c682a12ecbe2e_4000021_number-assessment-events_2025-06-29.csv
+        //   lang-THA/number-assessment-events/5b7c682a12ecbe2e_4000021_number-assessment-events_2025-06-30.csv
+        var stringWriter: StringWriter? = null
+        var csvPrinter: CSVPrinter? = null
+        var dateOfPreviousEvent: String? = null
+        for (event in events) {
+            // Get the event's date in ISO format, e.g. "2025-06-29"
+            val date: String = eventDateFormat.format(event.time.time)
+
+            // Prepare the CSV file path
+            val languageDir = File(applicationContext.filesDir, "lang-${SharedPreferencesHelper.getLanguage(applicationContext)}")
+            val eventsDir = File(languageDir, "number-assessment-events")
+            val csvFile = File(eventsDir, "${event.androidId}_${BuildConfig.VERSION_CODE}_number-assessment-events_${date}.csv")
+
+            if (date != dateOfPreviousEvent) {
+                // Reset file content, and prepare the headers for a new CSV file
+                Timber.i("csvFile: ${csvFile}")
+                stringWriter = StringWriter()
+                csvPrinter = CSVPrinter(stringWriter, CSVFormat.DEFAULT.builder().setHeader(
+                    "id",
+                    "timestamp",
+                    "package_name",
+                    "mastery_score",
+                    "time_spent_ms",
+                    "additional_data",
+                    "research_experiment",
+                    "experiment_group",
+                    "number_value",
+                    "number_id"
+                ).get())
+            }
+            csvPrinter?.printRecord(
+                event.id,
+                event.time.timeInMillis / 1_000,
+                event.packageName,
+                event.masteryScore,
+                event.timeSpentMs,
+                event.additionalData,
+                event.researchExperiment?.ordinal,
+                event.experimentGroup?.ordinal,
+                event.numberValue,
+                event.numberId
+            )
+            csvPrinter?.flush()
+
+            // Write the content to the CSV file
+            val csvFileContent = stringWriter.toString()
+            FileUtils.writeStringToFile(csvFile, csvFileContent, "UTF-8")
+
+            dateOfPreviousEvent = date
+        }
+
+        Timber.i("exportNumberAssessmentEvents complete!")
+    }
 }

app/src/main/java/ai/elimu/analytics/task/TaskInitializer.kt

@@ -14,9 +14,8 @@ object TaskInitializer {
         Timber.i("initializePeriodicWork")
 
         // Periodically export events to CSV files
-        val exportEventsToCsvWorkRequest = PeriodicWorkRequest.Builder(
-            ExportEventsToCsvWorker::class.java, 15, TimeUnit.MINUTES
-        )
+        val exportEventsToCsvWorkRequest = PeriodicWorkRequest
+            .Builder(ExportEventsToCsvWorker::class.java, 15, TimeUnit.MINUTES)
             .build()
         WorkManager.getInstance(context).enqueueUniquePeriodicWork(
             "export_events_to_csv",
@@ -25,12 +24,12 @@ object TaskInitializer {
         )
 
         // Periodically upload events (CSV files) to the server
-        val uploadEventsConstraints = Constraints.Builder()
+        val uploadEventsConstraints = Constraints
+            .Builder()
             .setRequiredNetworkType(NetworkType.CONNECTED)
             .build()
-        val uploadEventsWorkRequest = PeriodicWorkRequest.Builder(
-            UploadEventsWorker::class.java, 3, TimeUnit.HOURS
-        )
+        val uploadEventsWorkRequest = PeriodicWorkRequest
+            .Builder(UploadEventsWorker::class.java, 3, TimeUnit.HOURS)
             .setConstraints(uploadEventsConstraints)
             .build()
         WorkManager.getInstance(context).enqueueUniquePeriodicWork(

app/src/main/java/ai/elimu/analytics/util/SharedPreferencesHelper.kt

@@ -21,7 +21,6 @@ object SharedPreferencesHelper {
 
     @JvmStatic
     fun getAppVersionCode(context: Context): Int {
-        Timber.i("getAppVersionCode")
         val sharedPreferences = context.getSharedPreferences(SHARED_PREFS, Context.MODE_PRIVATE)
         return sharedPreferences.getInt(PREF_APP_VERSION_CODE, 0)
     }
@@ -36,7 +35,6 @@ object SharedPreferencesHelper {
 
     @JvmStatic
     fun getLanguage(context: Context): Language? {
-        Timber.i("getLanguage")
         val sharedPreferences = context.getSharedPreferences(SHARED_PREFS, Context.MODE_PRIVATE)
         val languageAsString = sharedPreferences.getString(PREF_LANGUAGE, null)
         return if (TextUtils.isEmpty(languageAsString)) {

utils/src/main/java/ai/elimu/analytics/utils/enum/SortOrder.kt

@@ -0,0 +1,9 @@
+package ai.elimu.analytics.utils.enum
+
+/**
+ * Used for ordering data when querying DAOs and Content Providers.
+ */
+enum class SortOrder {
+    ASC, // Ascending
+    DESC // Descending
+}