feat: database logger [WPB-14608] (#3798)

wireapp · Jan 15, 2025 · b0aa25c · b0aa25c
1 parent 8d45505
commit b0aa25c
Show file tree

Hide file tree

Showing 11 changed files with 160 additions and 275 deletions.
diff --git a/app/src/androidTest/kotlin/com/wire/android/ui/debug/DebugScreenComposeTest.kt b/app/src/androidTest/kotlin/com/wire/android/ui/debug/DebugScreenComposeTest.kt
@@ -38,7 +38,8 @@ class DebugScreenComposeTest {
                         onManualMigrationPressed = {},
                         state = UserDebugState(logPath = "logPath"),
                         onLoggingEnabledChange = {},
-                        onDeleteLogs = {}
+                        onDeleteLogs = {},
+                        onDatabaseLoggerEnabledChanged = {},
                     )
             }
         }

diff --git a/app/src/main/kotlin/com/wire/android/WireApplication.kt b/app/src/main/kotlin/com/wire/android/WireApplication.kt
@@ -29,7 +29,6 @@ import co.touchlab.kermit.platformLogWriter
 import com.wire.android.analytics.ObserveCurrentSessionAnalyticsUseCase
 import com.wire.android.datastore.GlobalDataStore
 import com.wire.android.datastore.UserDataStoreProvider
-import com.wire.android.debug.DatabaseProfilingManager
 import com.wire.android.di.ApplicationScope
 import com.wire.android.di.KaliumCoreLogic
 import com.wire.android.feature.analytics.AnonymousAnalyticsManager
@@ -94,9 +93,6 @@ class WireApplication : BaseApp() {
     @Inject
     lateinit var currentScreenManager: CurrentScreenManager
 
-    @Inject
-    lateinit var databaseProfilingManager: DatabaseProfilingManager
-
     @Inject
     lateinit var analyticsManager: Lazy<AnonymousAnalyticsManager>
 
@@ -207,10 +203,6 @@ class WireApplication : BaseApp() {
         logDeviceInformation()
         // 5. Verify if we can initialize Anonymous Analytics
         initializeAnonymousAnalytics()
-        // 6. Observe and update profiling when needed
-        globalAppScope.launch {
-            databaseProfilingManager.observeAndUpdateProfiling()
-        }
     }
 
     private fun initializeAnonymousAnalytics() {

diff --git a/app/src/main/kotlin/com/wire/android/debug/DatabaseProfilingManager.kt b/app/src/main/kotlin/com/wire/android/debug/DatabaseProfilingManager.kt
diff --git a/app/src/main/kotlin/com/wire/android/di/CoreLogicModule.kt b/app/src/main/kotlin/com/wire/android/di/CoreLogicModule.kt
@@ -36,7 +36,6 @@ import com.wire.kalium.logic.feature.connection.BlockUserUseCase
 import com.wire.kalium.logic.feature.connection.UnblockUserUseCase
 import com.wire.kalium.logic.feature.conversation.ObserveOtherUserSecurityClassificationLabelUseCase
 import com.wire.kalium.logic.feature.conversation.ObserveSecurityClassificationLabelUseCase
-import com.wire.kalium.logic.feature.debug.BreakSessionUseCase
 import com.wire.kalium.logic.feature.e2ei.usecase.FetchConversationMLSVerificationStatusUseCase
 import com.wire.kalium.logic.feature.featureConfig.ObserveIsAppLockEditableUseCase
 import com.wire.kalium.logic.feature.selfDeletingMessages.ObserveSelfDeletionTimerSettingsForConversationUseCase
@@ -214,11 +213,6 @@ class UseCaseModule {
     fun provideUpdateApiVersionsUseCase(@KaliumCoreLogic coreLogic: CoreLogic) =
         coreLogic.getGlobalScope().updateApiVersions
 
-    @ViewModelScoped
-    @Provides
-    fun provideDisableEventProcessing(@KaliumCoreLogic coreLogic: CoreLogic, @CurrentAccount currentAccount: UserId) =
-        coreLogic.getSessionScope(currentAccount).debug.disableEventProcessing
-
     @ViewModelScoped
     @Provides
     fun provideCurrentSessionFlowUseCase(@KaliumCoreLogic coreLogic: CoreLogic) =
@@ -483,16 +477,6 @@ class UseCaseModule {
         @CurrentAccount currentAccount: UserId
     ): GetCurrentAnalyticsTrackingIdentifierUseCase = coreLogic.getSessionScope(currentAccount).getCurrentAnalyticsTrackingIdentifier
 
-    @ViewModelScoped
-    @Provides
-    fun provideBreakSessionUseCase(@KaliumCoreLogic coreLogic: CoreLogic, @CurrentAccount currentAccount: UserId): BreakSessionUseCase =
-        coreLogic.getSessionScope(currentAccount).debug.breakSession
-
-    @ViewModelScoped
-    @Provides
-    fun provideSendFCMTokenToAPIUseCase(@KaliumCoreLogic coreLogic: CoreLogic, @CurrentAccount currentAccount: UserId) =
-        coreLogic.getSessionScope(currentAccount).debug.sendFCMTokenToServer
-
     @ViewModelScoped
     @Provides
     fun provideMigrateFromPersonalToTeamUseCase(

diff --git a/app/src/main/kotlin/com/wire/android/di/accountScoped/DebugModule.kt b/app/src/main/kotlin/com/wire/android/di/accountScoped/DebugModule.kt
@@ -0,0 +1,67 @@
+/*
+ * Wire
+ * Copyright (C) 2025 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+package com.wire.android.di.accountScoped
+
+import com.wire.android.di.CurrentAccount
+import com.wire.android.di.KaliumCoreLogic
+import com.wire.kalium.logic.CoreLogic
+import com.wire.kalium.logic.data.user.UserId
+import com.wire.kalium.logic.feature.debug.BreakSessionUseCase
+import com.wire.kalium.logic.feature.debug.DebugScope
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.android.components.ViewModelComponent
+import dagger.hilt.android.scopes.ViewModelScoped
+
+@Module
+@InstallIn(ViewModelComponent::class)
+class DebugModule {
+
+    @ViewModelScoped
+    @Provides
+    fun providesDebugScope(
+        @KaliumCoreLogic coreLogic: CoreLogic,
+        @CurrentAccount currentAccount: UserId
+    ): DebugScope = coreLogic.getSessionScope(currentAccount).debug
+
+    @ViewModelScoped
+    @Provides
+    fun provideDisableEventProcessing(debugScope: DebugScope) =
+        debugScope.disableEventProcessing
+
+    @ViewModelScoped
+    @Provides
+    fun provideBreakSessionUseCase(debugScope: DebugScope): BreakSessionUseCase =
+        debugScope.breakSession
+
+    @ViewModelScoped
+    @Provides
+    fun provideSendFCMTokenToAPIUseCase(debugScope: DebugScope) =
+        debugScope.sendFCMTokenToServer
+
+    @ViewModelScoped
+    @Provides
+    fun provideChangeProfilingUseCase(debugScope: DebugScope) =
+        debugScope.changeProfiling
+
+    @ViewModelScoped
+    @Provides
+    fun provideObserveDatabaseLoggerState(debugScope: DebugScope) =
+        debugScope.observeDatabaseLoggerState
+}
diff --git a/app/src/main/kotlin/com/wire/android/ui/debug/DebugScreen.kt b/app/src/main/kotlin/com/wire/android/ui/debug/DebugScreen.kt
@@ -73,7 +73,8 @@ fun DebugScreen(navigator: Navigator, userDebugViewModel: UserDebugViewModel = h
         },
         state = userDebugViewModel.state,
         onLoggingEnabledChange = userDebugViewModel::setLoggingEnabledState,
-        onDeleteLogs = userDebugViewModel::deleteLogs
+        onDeleteLogs = userDebugViewModel::deleteLogs,
+        onDatabaseLoggerEnabledChanged = userDebugViewModel::setDatabaseLoggerEnabledState
     )
 }
 
@@ -83,6 +84,7 @@ internal fun UserDebugContent(
     onNavigationPressed: () -> Unit,
     onManualMigrationPressed: (currentAccount: UserId) -> Unit,
     onLoggingEnabledChange: (Boolean) -> Unit,
+    onDatabaseLoggerEnabledChanged: (Boolean) -> Unit,
     onDeleteLogs: () -> Unit,
 ) {
     val debugContentState: DebugContentState = rememberDebugContentState(state.logPath)
@@ -109,6 +111,9 @@ internal fun UserDebugContent(
                     onLoggingEnabledChange = onLoggingEnabledChange,
                     onDeleteLogs = onDeleteLogs,
                     onShareLogs = debugContentState::shareLogs,
+                    isDBLoggerEnabled = state.isDBLoggingEnabled,
+                    onDBLoggerEnabledChange = onDatabaseLoggerEnabledChanged,
+                    isPrivateBuild = BuildConfig.PRIVATE_BUILD,
                 )
                 DebugDataOptions(
                     appVersion = AppNameUtil.createAppName(),
@@ -178,6 +183,7 @@ internal fun PreviewUserDebugContent() = WireTheme {
         onNavigationPressed = {},
         onManualMigrationPressed = {},
         onLoggingEnabledChange = {},
-        onDeleteLogs = {}
+        onDeleteLogs = {},
+        onDatabaseLoggerEnabledChanged = {}
     )
 }
diff --git a/app/src/main/kotlin/com/wire/android/ui/debug/LogOptions.kt b/app/src/main/kotlin/com/wire/android/ui/debug/LogOptions.kt
@@ -33,6 +33,7 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.stringResource
 import com.wire.android.R
 import com.wire.android.model.Clickable
+import com.wire.android.ui.common.RowItemTemplate
 import com.wire.android.ui.common.SurfaceBackgroundWrapper
 import com.wire.android.ui.common.WireSwitch
 import com.wire.android.ui.common.colorsScheme
@@ -49,16 +50,26 @@ import com.wire.android.util.ui.PreviewMultipleThemes
 fun LogOptions(
     isLoggingEnabled: Boolean,
     onLoggingEnabledChange: (Boolean) -> Unit,
+    isDBLoggerEnabled: Boolean,
+    onDBLoggerEnabledChange: (Boolean) -> Unit,
     onDeleteLogs: () -> Unit,
     onShareLogs: () -> Unit,
-    modifier: Modifier = Modifier,
+    isPrivateBuild: Boolean,
+    modifier: Modifier = Modifier
 ) {
     Column(modifier = modifier) {
         FolderHeader(stringResource(R.string.label_logs_option_title))
         EnableLoggingSwitch(
             isEnabled = isLoggingEnabled,
             onCheckedChange = onLoggingEnabledChange
         )
+
+        if (isPrivateBuild) {
+            UserDataBaseProfileSwitch(
+                isEnabled = isDBLoggerEnabled,
+                onCheckedChange = onDBLoggerEnabledChange
+            )
+        }
         if (isLoggingEnabled) {
             SettingsItem(
                 text = stringResource(R.string.label_share_logs),
@@ -123,13 +134,59 @@ private fun EnableLoggingSwitch(
     }
 }
 
+@Composable
+private fun UserDataBaseProfileSwitch(
+    isEnabled: Boolean,
+    onCheckedChange: ((Boolean) -> Unit),
+) {
+    RowItemTemplate(
+        title = {
+            Text(
+                style = MaterialTheme.wireTypography.body01,
+                color = MaterialTheme.wireColorScheme.onBackground,
+                text = stringResource(R.string.label_user_database_profile),
+                modifier = Modifier.padding(start = dimensions().spacing8x)
+            )
+        },
+        actions = {
+            WireSwitch(
+                checked = isEnabled,
+                onCheckedChange = onCheckedChange,
+                modifier = Modifier
+                    .padding(end = dimensions().spacing8x)
+                    .size(
+                        width = dimensions().buttonSmallMinSize.width,
+                        height = dimensions().buttonSmallMinSize.height
+                    )
+            )
+        }
+    )
+}
+
+@PreviewMultipleThemes
+@Composable
+fun PreviewLoggingOptionsPublicBuild() {
+    LogOptions(
+        isLoggingEnabled = true,
+        onLoggingEnabledChange = {},
+        isDBLoggerEnabled = true,
+        onDBLoggerEnabledChange = {},
+        onDeleteLogs = {},
+        onShareLogs = {},
+        isPrivateBuild = false,
+    )
+}
+
 @PreviewMultipleThemes
 @Composable
-fun PreviewLoggingOptions() {
+fun PreviewLoggingOptionsPrivateBuild() {
     LogOptions(
         isLoggingEnabled = true,
         onLoggingEnabledChange = {},
+        isDBLoggerEnabled = true,
+        onDBLoggerEnabledChange = {},
         onDeleteLogs = {},
-        onShareLogs = {}
+        onShareLogs = {},
+        isPrivateBuild = true,
     )
 }
diff --git a/app/src/main/kotlin/com/wire/android/ui/debug/UserDebugViewModel.kt b/app/src/main/kotlin/com/wire/android/ui/debug/UserDebugViewModel.kt
@@ -31,12 +31,15 @@ import com.wire.kalium.logger.KaliumLogLevel
 import com.wire.kalium.logic.CoreLogger
 import com.wire.kalium.logic.data.user.UserId
 import com.wire.kalium.logic.feature.client.ObserveCurrentClientIdUseCase
+import com.wire.kalium.logic.feature.debug.ChangeProfilingUseCase
+import com.wire.kalium.logic.feature.debug.ObserveDatabaseLoggerStateUseCase
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 data class UserDebugState(
     val isLoggingEnabled: Boolean = false,
+    val isDBLoggingEnabled: Boolean = false,
     val clientId: String = String.EMPTY,
     val commitish: String = String.EMPTY,
     val debugId: String = String.EMPTY,
@@ -50,7 +53,9 @@ class UserDebugViewModel
     @CurrentAccount val currentAccount: UserId,
     private val logFileWriter: LogFileWriter,
     private val currentClientIdUseCase: ObserveCurrentClientIdUseCase,
-    private val globalDataStore: GlobalDataStore
+    private val globalDataStore: GlobalDataStore,
+    private val changeProfilingUseCase: ChangeProfilingUseCase,
+    private val observeDatabaseLoggerState: ObserveDatabaseLoggerStateUseCase
 ) : ViewModel() {
 
     var state by mutableStateOf(
@@ -60,6 +65,21 @@ class UserDebugViewModel
     init {
         observeLoggingState()
         observeCurrentClientId()
+        observeDBLoggingState()
+    }
+
+    fun setDatabaseLoggerEnabledState(isEnabled: Boolean) {
+        viewModelScope.launch {
+            changeProfilingUseCase(isEnabled)
+        }
+    }
+
+    fun observeDBLoggingState() {
+        viewModelScope.launch {
+            observeDatabaseLoggerState().collect {
+                state = state.copy(isDBLoggingEnabled = it)
+            }
+        }
     }
 
     fun deleteLogs() {

diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -1678,6 +1678,7 @@ In group conversations, the group admin can overwrite this setting.</string>
     <string name="personal_to_team_migration_error_message_unknown_error">Wire could not complete your team creation due to an unknown error.</string>
     <string name="reaction_sender_self">You</string>
     <string name="emoji_picker_select_reaction">Select Reaction</string>
+    <string name="label_user_database_profile">Database Logger</string>
 
     <!-- Move to Folder -->
     <string name="move_to_folder_success">“%1$s” was moved to “%2$s”</string>