meshtastic/Meshtastic-Android
1
0
Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-04-20 22:23:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: add retention period to meshLog. Defaults to 7 days, with a settings dropdown to change (#4078)

Browse source
This commit is contained in:
Mac DeCourcy 2026-01-02 10:14:16 -08:00 • committed by GitHub
parent dc9e51f18f
commit 6f338c4cde
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 396 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

1
feature/settings/src/main/kotlin/org/meshtastic/feature/settings/SettingsScreen.kt
View file

@ -364,6 +364,7 @@ fun SettingsScreen(
onItemSelected = { selected -> settingsViewModel.setDbCacheLimit(selected.toInt()) },
summary = stringResource(Res.string.device_db_cache_limit_summary),
)
val timestamp = SimpleDateFormat("yyyyMMdd_HHmmss", Locale.US).format(Date())
val nodeName = ourNode?.user?.shortName ?: ""

20
feature/settings/src/main/kotlin/org/meshtastic/feature/settings/SettingsViewModel.kt
View file

@ -48,6 +48,7 @@ import org.meshtastic.core.database.model.Node
import org.meshtastic.core.datastore.UiPreferencesDataSource
import org.meshtastic.core.model.Position
import org.meshtastic.core.model.util.positionToMeter
import org.meshtastic.core.prefs.meshlog.MeshLogPrefs
import org.meshtastic.core.prefs.radio.RadioPrefs
import org.meshtastic.core.prefs.radio.isBle
import org.meshtastic.core.prefs.radio.isSerial
@ -82,6 +83,7 @@ constructor(
private val databaseManager: DatabaseManager,
private val deviceHardwareRepository: DeviceHardwareRepository,
private val radioPrefs: RadioPrefs,
private val meshLogPrefs: MeshLogPrefs,
) : ViewModel() {
val myNodeInfo: StateFlow<MyNodeEntity?> = nodeRepository.myNodeInfo
@ -140,6 +142,24 @@ constructor(
databaseManager.setCacheLimit(clamped)
}
// MeshLog retention period (bounded by MeshLogPrefsImpl constants)
private val _meshLogRetentionDays = MutableStateFlow(meshLogPrefs.retentionDays)
val meshLogRetentionDays: StateFlow<Int> = _meshLogRetentionDays.asStateFlow()
private val _meshLogLoggingEnabled = MutableStateFlow(meshLogPrefs.loggingEnabled)
val meshLogLoggingEnabled: StateFlow<Boolean> = _meshLogLoggingEnabled.asStateFlow()
fun setMeshLogRetentionDays(days: Int) {
val clamped = days.coerceIn(MeshLogPrefs.MIN_RETENTION_DAYS, MeshLogPrefs.MAX_RETENTION_DAYS)
meshLogPrefs.retentionDays = clamped
_meshLogRetentionDays.value = clamped
}
fun setMeshLogLoggingEnabled(enabled: Boolean) {
meshLogPrefs.loggingEnabled = enabled
_meshLogLoggingEnabled.value = enabled
}
fun setProvideLocation(value: Boolean) {
myNodeNum?.let { uiPrefs.setShouldProvideNodeLocation(it, value) }
}

70
feature/settings/src/main/kotlin/org/meshtastic/feature/settings/debugging/Debug.kt
View file

@ -23,6 +23,7 @@ import androidx.activity.compose.rememberLauncherForActivityResult
import androidx.activity.result.contract.ActivityResultContracts
import androidx.compose.animation.core.animateFloatAsState
import androidx.compose.foundation.BorderStroke
import androidx.compose.foundation.background
import androidx.compose.foundation.clickable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
@ -38,6 +39,7 @@ import androidx.compose.foundation.text.selection.SelectionContainer
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Delete
import androidx.compose.material.icons.outlined.FileDownload
import androidx.compose.material.icons.rounded.Settings
import androidx.compose.material.icons.twotone.FilterAltOff
import androidx.compose.material3.Card
import androidx.compose.material3.CardDefaults
@ -80,6 +82,7 @@ import kotlinx.collections.immutable.toImmutableList
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import org.jetbrains.compose.resources.pluralStringResource
import org.jetbrains.compose.resources.stringResource
import org.meshtastic.core.strings.Res
import org.meshtastic.core.strings.debug_clear
@ -90,9 +93,16 @@ import org.meshtastic.core.strings.debug_export_success
import org.meshtastic.core.strings.debug_filters
import org.meshtastic.core.strings.debug_logs_export
import org.meshtastic.core.strings.debug_panel
import org.meshtastic.core.strings.log_retention_days
import org.meshtastic.core.strings.log_retention_days_quantity
import org.meshtastic.core.strings.log_retention_days_summary
import org.meshtastic.core.strings.log_retention_hours
import org.meshtastic.core.strings.log_retention_never
import org.meshtastic.core.ui.component.CopyIconButton
import org.meshtastic.core.ui.component.DropDownPreference
import org.meshtastic.core.ui.component.MainAppBar
import org.meshtastic.core.ui.component.SimpleAlertDialog
import org.meshtastic.core.ui.component.SwitchPreference
import org.meshtastic.core.ui.theme.AnnotationColor
import org.meshtastic.core.ui.theme.AppTheme
import org.meshtastic.core.ui.util.showToast
@ -148,10 +158,12 @@ fun DebugScreen(onNavigateUp: () -> Unit, viewModel: DebugViewModel = hiltViewMo
val exportLogsLauncher =
rememberLauncherForActivityResult(ActivityResultContracts.CreateDocument("text/plain")) { createdUri ->
if (createdUri != null) {
scope.launch { exportAllLogsToUri(context, createdUri, filteredLogs) }
scope.launch { exportAllLogsToUri(context, createdUri, viewModel.loadLogsForExport()) }
}
}
var showSettings by remember { mutableStateOf(false) }
Scaffold(
topBar = {
MainAppBar(
@ -160,7 +172,12 @@ fun DebugScreen(onNavigateUp: () -> Unit, viewModel: DebugViewModel = hiltViewMo
showNodeChip = false,
canNavigateUp = true,
onNavigateUp = onNavigateUp,
actions = { DebugMenuActions(deleteLogs = { viewModel.deleteAllLogs() }) },
actions = {
IconButton(onClick = { showSettings = !showSettings }) {
Icon(imageVector = Icons.Rounded.Settings, contentDescription = null)
}
DebugMenuActions(deleteLogs = { viewModel.deleteAllLogs() })
},
onClickChip = {},
)
},
@ -187,6 +204,9 @@ fun DebugScreen(onNavigateUp: () -> Unit, viewModel: DebugViewModel = hiltViewMo
exportLogsLauncher.launch(fileName)
},
)
if (showSettings) {
DebugLogSettings(viewModel = viewModel)
}
}
items(filteredLogs, key = { it.uuid }) { log ->
DebugItem(
@ -202,6 +222,44 @@ fun DebugScreen(onNavigateUp: () -> Unit, viewModel: DebugViewModel = hiltViewMo
}
}
@Composable
private fun DebugLogSettings(viewModel: DebugViewModel) {
val retentionDays = viewModel.retentionDays.collectAsStateWithLifecycle().value
val loggingEnabled = viewModel.loggingEnabled.collectAsStateWithLifecycle().value
Column(
modifier =
Modifier.fillMaxWidth()
.background(MaterialTheme.colorScheme.surface)
.padding(horizontal = 12.dp, vertical = 8.dp),
verticalArrangement = Arrangement.spacedBy(8.dp),
) {
@Suppress("MagicNumber")
val retentionItems =
listOf((-1L) to pluralStringResource(Res.plurals.log_retention_hours, 1, 1)) +
listOf(1, 3, 7, 14, 30, 60, 90, 180, 365).map { days ->
days.toLong() to pluralStringResource(Res.plurals.log_retention_days_quantity, days, days)
} +
listOf(0L to stringResource(Res.string.log_retention_never))
DropDownPreference(
title = stringResource(Res.string.log_retention_days),
enabled = loggingEnabled,
items = retentionItems,
selectedItem = retentionDays.toLong(),
onItemSelected = { selected: Long -> viewModel.setRetentionDays(selected.toInt()) },
summary = stringResource(Res.string.log_retention_days_summary),
)
SwitchPreference(
title = "Store mesh logs",
enabled = true,
checked = loggingEnabled,
onCheckedChange = { viewModel.setLoggingEnabled(it) },
summary = "Disable to skip writing mesh logs to disk",
)
}
}
@Composable
internal fun DebugItem(
log: UiMeshLog,
@ -374,6 +432,12 @@ fun DebugMenuActions(deleteLogs: () -> Unit, modifier: Modifier = Modifier) {
private suspend fun exportAllLogsToUri(context: Context, targetUri: Uri, logs: List<UiMeshLog>) =
withContext(Dispatchers.IO) {
try {
if (logs.isEmpty()) {
withContext(Dispatchers.Main) { context.showToast(Res.string.debug_export_failed, "No logs to export") }
Logger.w { "MeshLog export aborted: no logs available" }
return@withContext
}
context.contentResolver.openOutputStream(targetUri)?.use { os ->
OutputStreamWriter(os, StandardCharsets.UTF_8).use { writer ->
logs.forEach { log ->
@ -408,7 +472,7 @@ private suspend fun exportAllLogsToUri(context: Context, targetUri: Uri, logs: L
withContext(Dispatchers.Main) { context.showToast(Res.string.debug_export_success, logs.size) }
} catch (e: IOException) {
withContext(Dispatchers.Main) { context.showToast(Res.string.debug_export_failed, e.message ?: "") }
Logger.w(e) { "Error:IOException" }
Logger.w(e) { "MeshLog export failed" }
}
}

36
feature/settings/src/main/kotlin/org/meshtastic/feature/settings/debugging/DebugViewModel.kt
View file

@ -31,13 +31,17 @@ import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.flow.mapLatest
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import org.meshtastic.core.data.repository.MeshLogRepository
import org.meshtastic.core.data.repository.NodeRepository
import org.meshtastic.core.database.entity.MeshLog
import org.meshtastic.core.database.entity.Packet
import org.meshtastic.core.model.getTracerouteResponse
import org.meshtastic.core.prefs.meshlog.MeshLogPrefs
import org.meshtastic.core.ui.viewmodel.stateInWhileSubscribed
import org.meshtastic.proto.AdminProtos
import org.meshtastic.proto.MeshProtos
@ -204,10 +208,20 @@ class DebugViewModel
constructor(
private val meshLogRepository: MeshLogRepository,
private val nodeRepository: NodeRepository,
private val meshLogPrefs: MeshLogPrefs,
) : ViewModel() {
val meshLog: StateFlow<ImmutableList<UiMeshLog>> =
meshLogRepository.getAllLogs().map(::toUiState).stateInWhileSubscribed(initialValue = persistentListOf())
meshLogRepository
.getAllLogs()
.mapLatest { logs -> withContext(Dispatchers.Default) { toUiState(logs) } }
.stateInWhileSubscribed(initialValue = persistentListOf())
private val _retentionDays = MutableStateFlow(meshLogPrefs.retentionDays)
val retentionDays: StateFlow<Int> = _retentionDays.asStateFlow()
private val _loggingEnabled = MutableStateFlow(meshLogPrefs.loggingEnabled)
val loggingEnabled: StateFlow<Boolean> = _loggingEnabled.asStateFlow()
// --- Managers ---
val searchManager = LogSearchManager()
@ -236,6 +250,26 @@ constructor(
searchManager.updateMatches(searchManager.searchText.value, logs)
}
fun setRetentionDays(days: Int) {
val clamped = days.coerceIn(MeshLogPrefs.MIN_RETENTION_DAYS, MeshLogPrefs.MAX_RETENTION_DAYS)
meshLogPrefs.retentionDays = clamped
_retentionDays.value = clamped
}
fun setLoggingEnabled(enabled: Boolean) {
meshLogPrefs.loggingEnabled = enabled
_loggingEnabled.value = enabled
if (!enabled) {
viewModelScope.launch { meshLogRepository.deleteAll() }
}
}
suspend fun loadLogsForExport(): ImmutableList<UiMeshLog> = withContext(Dispatchers.IO) {
val unbounded = meshLogRepository.getAllLogsUnbounded().first()
val logs = if (unbounded.isEmpty()) meshLogRepository.getAllLogs().first() else unbounded
toUiState(logs)
}
init {
Logger.d { "DebugViewModel created" }
viewModelScope.launch {