Add data reporting settings

.github/workflows/build.yml

@@ -83,6 +83,7 @@ jobs:
       - name: Build Android App (skipping benchmark variant)
         run: |
           ./gradlew \
+            testDebugUnitTest \
             :android-app:app:bundle \
             :android-app:app:build \
             lint \

android-app/app/src/main/AndroidManifest.xml

@@ -85,6 +85,10 @@
             android:name="google_analytics_adid_collection_enabled"
             android:value="false" />
 
+        <meta-data
+            android:name="firebase_crashlytics_collection_enabled"
+            android:value="false" />
+
     </application>
 
     <queries>

api/tmdb/src/commonMain/kotlin/app/tivi/tmdb/TmdbInitializer.kt

@@ -4,20 +4,17 @@
 package app.tivi.tmdb
 
 import app.tivi.appinitializers.AppInitializer
-import app.tivi.util.AppCoroutineDispatchers
-import kotlinx.coroutines.DelicateCoroutinesApi
-import kotlinx.coroutines.GlobalScope
+import app.tivi.inject.ApplicationCoroutineScope
 import kotlinx.coroutines.launch
 import me.tatarka.inject.annotations.Inject
 
 @Inject
 class TmdbInitializer(
     private val tmdbManager: TmdbManager,
-    private val dispatchers: AppCoroutineDispatchers,
+    private val scope: ApplicationCoroutineScope,
 ) : AppInitializer {
     override fun initialize() {
-        @OptIn(DelicateCoroutinesApi::class)
-        GlobalScope.launch(dispatchers.main) {
+        scope.launch {
             tmdbManager.refreshConfiguration()
         }
     }

api/tmdb/src/commonMain/kotlin/app/tivi/tmdb/TmdbManager.kt

@@ -6,21 +6,26 @@ package app.tivi.tmdb
 import app.moviebase.tmdb.Tmdb3
 import app.moviebase.tmdb.model.TmdbConfiguration
 import app.tivi.inject.ApplicationScope
+import app.tivi.util.AppCoroutineDispatchers
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.withContext
 import me.tatarka.inject.annotations.Inject
 
 @ApplicationScope
 @Inject
 class TmdbManager(
     private val tmdbClient: Tmdb3,
+    private val dispatchers: AppCoroutineDispatchers,
 ) {
     private val imageProvider = MutableStateFlow(TmdbImageUrlProvider())
 
     fun getLatestImageProvider() = imageProvider.value
 
     suspend fun refreshConfiguration() {
-        val response = runCatching {
-            tmdbClient.configuration.getApiConfiguration()
+        val response = withContext(dispatchers.io) {
+            runCatching {
+                tmdbClient.configuration.getApiConfiguration()
+            }
         }
 
         if (response.isSuccess) {

common/imageloading/src/androidMain/kotlin/app/tivi/common/imageloading/CoilCleanupInitializer.kt

@@ -5,27 +5,23 @@ package app.tivi.common.imageloading
 
 import android.app.Application
 import app.tivi.appinitializers.AppInitializer
+import app.tivi.inject.ApplicationCoroutineScope
 import app.tivi.util.AppCoroutineDispatchers
-import kotlinx.coroutines.DelicateCoroutinesApi
-import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
-import kotlinx.coroutines.withContext
 import me.tatarka.inject.annotations.Inject
 
 @Inject
 class CoilCleanupInitializer(
     private val application: Application,
+    private val scope: ApplicationCoroutineScope,
     private val dispatchers: AppCoroutineDispatchers,
 ) : AppInitializer {
-    @OptIn(DelicateCoroutinesApi::class)
     override fun initialize() {
-        GlobalScope.launch {
-            withContext(dispatchers.io) {
-                // We delete Coil's image_cache folder to claim back space for the user
-                val coilCache = application.cacheDir.resolve("image_cache")
-                if (coilCache.exists()) {
-                    coilCache.deleteRecursively()
-                }
+        scope.launch(dispatchers.io) {
+            // We delete Coil's image_cache folder to claim back space for the user
+            val coilCache = application.cacheDir.resolve("image_cache")
+            if (coilCache.exists()) {
+                coilCache.deleteRecursively()
             }
         }
     }

common/ui/resources/strings/src/commonMain/kotlin/app/tivi/common/ui/resources/EnTiviStrings.kt

@@ -147,6 +147,10 @@ val EnTiviStrings = TiviStrings(
     settingsAboutCategoryTitle = "About Tivi",
     settingsAppVersion = "Version",
     settingsAppVersionSummary = { p0, p1 -> "v%s (%d)".fmt(p0, p1) },
+    settingsAnalyticsDataCollectionTitle = "Report app usage",
+    settingsAnalyticsDataCollectionSummary = "Send anonymous details about how you use the application.",
+    settingsCrashDataCollectionTitle = "Report app crashes",
+    settingsCrashDataCollectionSummary = "Send anonymous reports about application crashes and other issues.",
     settingsDataSaverSummaryOn = "Fetch data less often and display lower quality images",
     settingsDataSaverSummaryOff = "Automatically enabled due to system setting",
     settingsDataSaverTitle = "Data saver",
@@ -156,6 +160,7 @@ val EnTiviStrings = TiviStrings(
     settingsIgnoreSpecialsSummary = "Automatically ignore specials",
     settingsOpenSource = "Open source licenses",
     settingsOpenSourceSummary = "Tivi 💞 open source",
+    settingsPrivacyCategoryTitle = "Privacy",
     settingsThemeTitle = "Theme",
     settingsTitle = "Settings",
     settingsUiCategoryTitle = "User Interface",

common/ui/resources/strings/src/commonMain/kotlin/app/tivi/common/ui/resources/TiviStrings.kt

@@ -136,6 +136,10 @@ data class TiviStrings(
     val settingsAboutCategoryTitle: String,
     val settingsAppVersion: String,
     val settingsAppVersionSummary: (String, Int) -> String,
+    val settingsAnalyticsDataCollectionTitle: String,
+    val settingsAnalyticsDataCollectionSummary: String,
+    val settingsCrashDataCollectionTitle: String,
+    val settingsCrashDataCollectionSummary: String,
     val settingsDataSaverSummaryOn: String,
     val settingsDataSaverSummaryOff: String,
     val settingsDataSaverTitle: String,
@@ -145,6 +149,7 @@ data class TiviStrings(
     val settingsIgnoreSpecialsSummary: String,
     val settingsOpenSource: String,
     val settingsOpenSourceSummary: String,
+    val settingsPrivacyCategoryTitle: String,
     val settingsThemeTitle: String,
     val settingsTitle: String,
     val settingsUiCategoryTitle: String,

core/analytics/build.gradle.kts

@@ -12,6 +12,7 @@ kotlin {
         val commonMain by getting {
             dependencies {
                 implementation(projects.core.base)
+                api(projects.core.preferences)
             }
         }
 

core/analytics/src/androidMain/kotlin/app/tivi/core/analytics/AnalyticsComponent.kt → core/analytics/src/androidMain/kotlin/app/tivi/core/analytics/AnalyticsPlatformComponent.kt

@@ -8,7 +8,7 @@ import me.tatarka.inject.annotations.Provides
 
 @OptIn(ExperimentalMultiplatform::class)
 @AllowDifferentMembersInActual
-actual interface AnalyticsComponent {
+actual interface AnalyticsPlatformComponent {
     @ApplicationScope
     @Provides
     fun provideTiviFirebaseAnalytics(bind: TiviFirebaseAnalytics): Analytics = bind

core/analytics/src/androidMain/kotlin/app/tivi/core/analytics/TiviFirebaseAnalytics.kt

@@ -37,4 +37,8 @@ class TiviFirebaseAnalytics(
             // Ignore, Firebase might not be setup for this project
         }
     }
+
+    override fun setEnabled(enabled: Boolean) {
+        firebaseAnalytics.setAnalyticsCollectionEnabled(enabled)
+    }
 }

core/analytics/src/commonMain/kotlin/app/tivi/core/analytics/Analytics.kt

@@ -13,4 +13,6 @@ interface Analytics {
         name: String,
         arguments: Map<String, *>? = null,
     )
+
+    fun setEnabled(enabled: Boolean)
 }

core/analytics/src/commonMain/kotlin/app/tivi/core/analytics/AnalyticsComponent.kt

@@ -3,4 +3,14 @@
 
 package app.tivi.core.analytics
 
-expect interface AnalyticsComponent
+import app.tivi.appinitializers.AppInitializer
+import me.tatarka.inject.annotations.IntoSet
+import me.tatarka.inject.annotations.Provides
+
+expect interface AnalyticsPlatformComponent
+
+interface AnalyticsComponent : AnalyticsPlatformComponent {
+    @Provides
+    @IntoSet
+    fun provideAnalyticsInitializer(impl: AnalyticsInitializer): AppInitializer = impl
+}

core/analytics/src/commonMain/kotlin/app/tivi/core/analytics/AnalyticsInitializer.kt

@@ -0,0 +1,25 @@
+// Copyright 2023, Christopher Banes and the Tivi project contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package app.tivi.core.analytics
+
+import app.tivi.appinitializers.AppInitializer
+import app.tivi.inject.ApplicationCoroutineScope
+import app.tivi.settings.TiviPreferences
+import kotlinx.coroutines.launch
+import me.tatarka.inject.annotations.Inject
+
+@Inject
+class AnalyticsInitializer(
+    private val preferences: TiviPreferences,
+    private val scope: ApplicationCoroutineScope,
+    private val analytics: Analytics,
+) : AppInitializer {
+    override fun initialize() {
+        scope.launch {
+            preferences.observeReportAnalytics().collect { enabled ->
+                analytics.setEnabled(enabled)
+            }
+        }
+    }
+}

core/analytics/src/iosMain/kotlin/app/tivi/core/analytics/AnalyticsComponent.kt → core/analytics/src/iosMain/kotlin/app/tivi/core/analytics/AnalyticsPlatformComponent.kt

@@ -8,10 +8,8 @@ import me.tatarka.inject.annotations.Provides
 
 @OptIn(ExperimentalMultiplatform::class)
 @AllowDifferentMembersInActual
-actual interface AnalyticsComponent {
-    val analyticsProvider: () -> Analytics
-
-    @Provides
-    @ApplicationScope
-    fun provideAnalytics(): Analytics = analyticsProvider()
+actual interface AnalyticsPlatformComponent {
+    @get:Provides
+    @get:ApplicationScope
+    val analytics: Analytics
 }

core/analytics/src/jvmMain/kotlin/app/tivi/core/analytics/AnalyticsComponent.kt → core/analytics/src/jvmMain/kotlin/app/tivi/core/analytics/AnalyticsPlatformComponent.kt

@@ -8,10 +8,11 @@ import me.tatarka.inject.annotations.Provides
 
 @OptIn(ExperimentalMultiplatform::class)
 @AllowDifferentMembersInActual
-actual interface AnalyticsComponent {
+actual interface AnalyticsPlatformComponent {
     @Provides
     @ApplicationScope
     fun provideAnalytics(): Analytics = object : Analytics {
         override fun trackScreenView(name: String, arguments: Map<String, *>?) = Unit
+        override fun setEnabled(enabled: Boolean) = Unit
     }
 }

core/base/src/commonMain/kotlin/app/tivi/inject/Scopes.kt

@@ -3,10 +3,13 @@
 
 package app.tivi.inject
 
+import kotlinx.coroutines.CoroutineScope
 import me.tatarka.inject.annotations.Scope
 
 @Scope
 annotation class ApplicationScope
 
 @Scope
 annotation class ActivityScope
+
+typealias ApplicationCoroutineScope = CoroutineScope

core/logging/implementation/build.gradle.kts

@@ -13,6 +13,7 @@ kotlin {
             dependencies {
                 api(projects.core.base)
                 api(projects.core.logging.api)
+                api(projects.core.preferences)
                 api(libs.kotlin.coroutines.core)
                 implementation(libs.kermit.kermit)
                 implementation(libs.kotlininject.runtime)
@@ -22,6 +23,7 @@ kotlin {
         val androidMain by getting {
             dependencies {
                 implementation(libs.crashkios.crashlytics)
+                implementation(libs.google.firebase.crashlytics)
                 implementation(libs.timber)
             }
         }

core/logging/implementation/src/androidMain/kotlin/app/tivi/util/AndroidSetCrashReportingEnabledAction.kt

@@ -0,0 +1,12 @@
+// Copyright 2023, Christopher Banes and the Tivi project contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package app.tivi.util
+
+import com.google.firebase.crashlytics.FirebaseCrashlytics
+
+internal object AndroidSetCrashReportingEnabledAction : SetCrashReportingEnabledAction {
+    override fun invoke(enabled: Boolean) {
+        FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(enabled)
+    }
+}

core/logging/implementation/src/androidMain/kotlin/app/tivi/util/LoggerPlatformComponent.kt

@@ -21,4 +21,9 @@ actual interface LoggerPlatformComponent {
     @Provides
     @IntoSet
     fun provideCrashKiOSInitializer(): AppInitializer = AndroidCrashKiOSInitializer
+
+    @Provides
+    fun bindSetCrashReportingEnabledAction(): SetCrashReportingEnabledAction {
+        return AndroidSetCrashReportingEnabledAction
+    }
 }

core/logging/implementation/src/commonMain/kotlin/app/tivi/util/CrashReportingInitializer.kt

@@ -0,0 +1,25 @@
+// Copyright 2023, Christopher Banes and the Tivi project contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package app.tivi.util
+
+import app.tivi.appinitializers.AppInitializer
+import app.tivi.inject.ApplicationCoroutineScope
+import app.tivi.settings.TiviPreferences
+import kotlinx.coroutines.launch
+import me.tatarka.inject.annotations.Inject
+
+@Inject
+class CrashReportingInitializer(
+    private val preferences: TiviPreferences,
+    private val scope: ApplicationCoroutineScope,
+    private val action: SetCrashReportingEnabledAction,
+) : AppInitializer {
+    override fun initialize() {
+        scope.launch {
+            preferences.observeReportAppCrashes().collect { enabled ->
+                action(enabled)
+            }
+        }
+    }
+}

core/logging/implementation/src/commonMain/kotlin/app/tivi/util/LoggerComponent.kt

@@ -5,7 +5,9 @@ package app.tivi.util
 
 import app.tivi.app.ApplicationInfo
 import app.tivi.app.Flavor
+import app.tivi.appinitializers.AppInitializer
 import app.tivi.inject.ApplicationScope
+import me.tatarka.inject.annotations.IntoSet
 import me.tatarka.inject.annotations.Provides
 
 expect interface LoggerPlatformComponent
@@ -20,4 +22,8 @@ interface LoggerComponent : LoggerPlatformComponent {
         applicationInfo.flavor == Flavor.Qa -> RecordingLoggerImpl()
         else -> NoopRecordingLogger
     }
+
+    @Provides
+    @IntoSet
+    fun provideCrashReportingInitializer(impl: CrashReportingInitializer): AppInitializer = impl
 }

core/logging/implementation/src/commonMain/kotlin/app/tivi/util/SetCrashReportingEnabledAction.kt

@@ -0,0 +1,8 @@
+// Copyright 2023, Christopher Banes and the Tivi project contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package app.tivi.util
+
+fun interface SetCrashReportingEnabledAction {
+    operator fun invoke(enabled: Boolean)
+}

core/logging/implementation/src/iosMain/kotlin/app/tivi/util/LoggerPlatformComponent.kt

@@ -11,6 +11,10 @@ import me.tatarka.inject.annotations.Provides
 @OptIn(ExperimentalMultiplatform::class)
 @AllowDifferentMembersInActual
 actual interface LoggerPlatformComponent {
+
+    @get:Provides
+    val setCrashReportingEnabledAction: SetCrashReportingEnabledAction
+
     @Provides
     @ApplicationScope
     fun provideLogger(

core/logging/implementation/src/jvmMain/kotlin/app/tivi/util/LoggerPlatformComponent.kt

@@ -15,4 +15,13 @@ actual interface LoggerPlatformComponent {
         kermitLogger: KermitLogger,
         recordingLogger: RecordingLogger,
     ): Logger = CompositeLogger(kermitLogger, recordingLogger)
+
+    @Provides
+    fun bindSetCrashReportingEnabledAction(): SetCrashReportingEnabledAction {
+        return NoopSetCrashReportingEnabledAction
+    }
+}
+
+private object NoopSetCrashReportingEnabledAction : SetCrashReportingEnabledAction {
+    override fun invoke(enabled: Boolean) {}
 }

core/preferences/src/commonMain/kotlin/app/tivi/settings/TiviPreferences.kt

@@ -29,6 +29,12 @@ interface TiviPreferences {
     var ignoreSpecials: Boolean
     fun observeIgnoreSpecials(): Flow<Boolean>
 
+    var reportAppCrashes: Boolean
+    fun observeReportAppCrashes(): Flow<Boolean>
+
+    var reportAnalytics: Boolean
+    fun observeReportAnalytics(): Flow<Boolean>
+
     var developerHideArtwork: Boolean
     fun observeDeveloperHideArtwork(): Flow<Boolean>