fix(#270): review round 1 - atomic toggles, no stale editor write, shared per-view filter

This commit is contained in:
makiolaj committed 2026-11-13 18:54:10 +01:00
1 parent e3e9865d3f
commit 91fdaba6a2
12 files changed
+104 -55

No files matched your search

@@ -274,8 +274,14 @@ class SettingsPrefs @Inject constructor(
/** Hide [calendarId] in [views] only (#270); an empty set shows it everywhere again. */
suspend fun setCalendarHiddenViews(calendarId: Long, views: Set<CalendarView>) {
prefs.update(SettingsKeys.perCalendarHiddenViews) { current -> current.withHiddenViews(calendarId, views) }
}
/** Hide or show [calendarId] in one [view], against the stored set rather than a snapshot of it. */
suspend fun setCalendarHiddenIn(calendarId: Long, view: CalendarView, hidden: Boolean) {
prefs.update(SettingsKeys.perCalendarHiddenViews) { current ->
if (views.isEmpty()) current - calendarId else current + (calendarId to views)
val views = current[calendarId].orEmpty()
current.withHiddenViews(calendarId, if (hidden) views + view else views - view)
}
}
@@ -834,9 +840,11 @@ private fun parseFormFields(stored: String?): Set<EventFormField> = when (stored
private fun parseViewOrder(stored: String?): List<CalendarView> =
completeViewOrder(
stored?.split(',').orEmpty()
.mapNotNull { name -> CalendarView.entries.firstOrNull { it.name == name.trim() } },
.mapNotNull { it.trim().toCalendarViewOrNull() },
)
private fun String.toCalendarViewOrNull(): CalendarView? = CalendarView.entries.firstOrNull { it.name == this }
/** Parse the quick-switch config; "!"-prefixed names are disabled. */
private fun parseQuickSwitch(stored: String?): QuickSwitchConfig {
if (stored == null) return QuickSwitchConfig.Default
@@ -844,7 +852,7 @@ private fun parseQuickSwitch(stored: String?): QuickSwitchConfig {
val token = raw.trim()
val disabled = token.startsWith("!")
val name = if (disabled) token.drop(1) else token
CalendarView.entries.firstOrNull { it.name == name }?.let { it to disabled }
name.toCalendarViewOrNull()?.let { it to disabled }
}
val order = completeViewOrder(parsed.map { it.first })
// Only views explicitly stored disabled are excluded; anything appended
@@ -1005,10 +1013,15 @@ internal fun parseHiddenViews(stored: String?): Map<Long, Set<CalendarView>> =
if (parts.size != 2) return@mapNotNull null
val calendarId = parts[0].trim().toLongOrNull() ?: return@mapNotNull null
val views = parts[1].split(LIST_SEP)
.mapNotNullTo(mutableSetOf()) { name -> CalendarView.entries.firstOrNull { it.name == name.trim() } }
.mapNotNullTo(mutableSetOf()) { it.trim().toCalendarViewOrNull() }
if (views.isEmpty()) null else calendarId to views
}.toMap()
private fun Map<Long, Set<CalendarView>>.withHiddenViews(
calendarId: Long,
views: Set<CalendarView>,
): Map<Long, Set<CalendarView>> = if (views.isEmpty()) this - calendarId else this + (calendarId to views)
internal fun Map<Long, Set<CalendarView>>.toStoredHiddenViews(): String? =
entries.filter { it.value.isNotEmpty() }.sortedBy { it.key }
.joinToString(ENTRY_SEP) { (id, views) ->
@@ -1,8 +1,6 @@
package de.jeanlucmakiola.calendula.ui.agenda
import de.jeanlucmakiola.calendula.ui.common.dayRange
import de.jeanlucmakiola.calendula.ui.common.CalendarView
import de.jeanlucmakiola.calendula.ui.common.instancesIn
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import dagger.hilt.android.lifecycle.HiltViewModel
@@ -17,6 +15,9 @@ import de.jeanlucmakiola.calendula.domain.CalendarSource
import de.jeanlucmakiola.calendula.domain.EventInstance
import de.jeanlucmakiola.calendula.domain.FailureReason
import de.jeanlucmakiola.calendula.domain.calendarListFailure
import de.jeanlucmakiola.calendula.ui.common.CalendarView
import de.jeanlucmakiola.calendula.ui.common.calendarsHiddenIn
import de.jeanlucmakiola.calendula.ui.common.instancesWithout
import de.jeanlucmakiola.floret.android.stateWhileSubscribed
import de.jeanlucmakiola.floret.di.IoDispatcher
import kotlinx.coroutines.CoroutineDispatcher
@@ -48,6 +49,8 @@ class AgendaViewModel @Inject constructor(
@IoDispatcher private val io: CoroutineDispatcher,
) : ViewModel() {
private val hiddenHere = settingsPrefs.perCalendarHiddenViews.calendarsHiddenIn(CalendarView.Agenda, viewModelScope)
// The saved agenda range plus the range-bar visibility toggle.
private val agendaSettings = combine(
settingsPrefs.agendaScreenRange,
@@ -140,7 +143,7 @@ class AgendaViewModel @Inject constructor(
)
combine(
repository.calendars(),
repository.instancesIn(CalendarView.Agenda, window, settingsPrefs.perCalendarHiddenViews),
repository.instancesWithout(window, hiddenHere),
today,
) { calendars, instances, today ->
buildState(params, calendars, instances, today)
@@ -3,6 +3,7 @@ package de.jeanlucmakiola.calendula.ui.calendars
import android.accounts.AccountManager
import android.content.Context
import android.content.Intent
import android.icu.text.ListFormatter
import android.provider.Settings
import androidx.compose.animation.AnimatedVisibility
import androidx.compose.foundation.background
@@ -54,6 +55,7 @@ import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.alpha
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.vector.ImageVector
import androidx.compose.ui.platform.LocalConfiguration
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.semantics.contentDescription
@@ -189,17 +191,14 @@ fun CalendarsScreen(
)
hidingId?.let { id ->
val calendar = calendars.firstOrNull { it.id == id }
if (calendar == null) {
// Gone (deleted or account removed) while the picker was up.
// Gone while the picker was up; an empty list is one still loading, not a deletion.
if (calendar == null && calendars.isNotEmpty()) {
LaunchedEffect(id) { hidingId = null }
} else {
val hidden = hiddenViews[id].orEmpty()
} else if (calendar != null) {
HiddenViewsPicker(
calendarName = calendar.displayName.orUnnamed(),
hidden = hidden,
onToggle = { view, hide ->
viewModel.setHiddenViews(id, if (hide) hidden + view else hidden - view)
},
hidden = hiddenViews[id].orEmpty(),
onToggle = { view, hide -> viewModel.setHiddenIn(id, view, hide) },
onDismiss = { hidingId = null },
)
}
@@ -373,7 +372,7 @@ internal fun CalendarEditor(
initialName: String,
initialColor: Int,
initialDescription: String,
onSave: (name: String, color: Int, description: String?, hiddenViews: Set<CalendarView>) -> Unit,
onSave: (name: String, color: Int, description: String?, hiddenViews: Set<CalendarView>?) -> Unit,
onDelete: () -> Unit,
onClose: () -> Unit,
deleteLocked: Boolean = false,
@@ -381,7 +380,9 @@ internal fun CalendarEditor(
initialHiddenViews: Set<CalendarView> = emptySet(),
) {
var name by rememberSaveable(sessionKey) { mutableStateOf(initialName) }
var hiddenViews by rememberSaveable(sessionKey) { mutableStateOf(initialHiddenViews.toList()) }
var hiddenViews by rememberSaveable(sessionKey) { mutableStateOf(initialHiddenViews) }
// Only a set the user touched is written back, so a save never resets one read before it loaded.
var hiddenViewsEdited by rememberSaveable(sessionKey) { mutableStateOf(false) }
var pickHiddenViews by rememberSaveable(sessionKey) { mutableStateOf(false) }
var color by rememberSaveable(sessionKey) { mutableStateOf(initialColor) }
var description by rememberSaveable(sessionKey) { mutableStateOf(initialDescription) }
@@ -390,7 +391,9 @@ internal fun CalendarEditor(
val valid = name.isNotBlank()
val commit = {
if (valid) onSave(name.trim(), color, description.trim().ifEmpty { null }, hiddenViews.toSet())
if (valid) {
onSave(name.trim(), color, description.trim().ifEmpty { null }, hiddenViews.takeIf { hiddenViewsEdited })
}
}
FullScreenPicker(
@@ -447,7 +450,7 @@ internal fun CalendarEditor(
Spacer(Modifier.height(20.dp))
GroupedRow(
title = stringResource(R.string.calendars_hide_in_views),
summary = hiddenViewsSummary(hiddenViews.toSet()),
summary = hiddenViewsSummary(hiddenViews),
position = Position.Alone,
onClick = { pickHiddenViews = true },
)
@@ -463,9 +466,10 @@ internal fun CalendarEditor(
if (pickHiddenViews) {
HiddenViewsPicker(
calendarName = name.trim().orUnnamed(),
hidden = hiddenViews.toSet(),
hidden = hiddenViews,
onToggle = { view, hide ->
hiddenViews = if (hide) (hiddenViews + view).distinct() else hiddenViews - view
hiddenViews = if (hide) hiddenViews + view else hiddenViews - view
hiddenViewsEdited = true
},
onDismiss = { pickHiddenViews = false },
)
@@ -786,7 +790,8 @@ private fun HiddenViewsPicker(
private fun hiddenViewsSummary(hidden: Set<CalendarView>): String {
if (hidden.isEmpty()) return stringResource(R.string.calendars_hide_in_views_none)
val names = IMPLEMENTED_VIEWS.filter { it in hidden }.map { it.label() }
return stringResource(R.string.calendars_hidden_in, names.joinToString(", "))
val locale = LocalConfiguration.current.locales[0]
return stringResource(R.string.calendars_hidden_in, ListFormatter.getInstance(locale).format(names))
}
/** Fade a leading element to the M3 disabled emphasis when [disabled]. */
@@ -114,8 +114,8 @@ class CalendarsViewModel @Inject constructor(
initialValue = emptyMap(),
)
fun setHiddenViews(id: Long, views: Set<CalendarView>) {
viewModelScope.launch { settingsPrefs.setCalendarHiddenViews(id, views) }
fun setHiddenIn(id: Long, view: CalendarView, hidden: Boolean) = write {
settingsPrefs.setCalendarHiddenIn(id, view, hidden)
}
private val _error = MutableStateFlow(false)
@@ -157,10 +157,10 @@ class CalendarsViewModel @Inject constructor(
displayName: String,
color: Int,
description: String?,
hiddenViews: Set<CalendarView> = emptySet(),
hiddenViews: Set<CalendarView>?,
) = write {
val id = repository.createLocalCalendar(displayName, color, description)
if (hiddenViews.isNotEmpty()) settingsPrefs.setCalendarHiddenViews(id, hiddenViews)
if (!hiddenViews.isNullOrEmpty()) settingsPrefs.setCalendarHiddenViews(id, hiddenViews)
}
fun updateCalendar(
@@ -168,10 +168,10 @@ class CalendarsViewModel @Inject constructor(
displayName: String,
color: Int,
description: String?,
hiddenViews: Set<CalendarView>,
hiddenViews: Set<CalendarView>?,
) = write {
repository.updateCalendar(id, displayName, color, description)
settingsPrefs.setCalendarHiddenViews(id, hiddenViews)
if (hiddenViews != null) settingsPrefs.setCalendarHiddenViews(id, hiddenViews)
}
fun deleteCalendar(id: Long) = write {
@@ -2,32 +2,43 @@ package de.jeanlucmakiola.calendula.ui.common
import de.jeanlucmakiola.calendula.data.calendar.CalendarRepository
import de.jeanlucmakiola.calendula.domain.EventInstance
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.flow.distinctUntilChanged
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.flow.shareIn
import kotlin.time.Instant
/** The calendars hidden in [view] under a per-calendar hidden-views map (#270). */
fun Map<Long, Set<CalendarView>>.calendarsHiddenIn(view: CalendarView): Set<Long> =
filterValues { view in it }.keys
/**
* The calendars hidden in [view], shared across one view model's pages so the
* setting is read once rather than per page.
*/
fun Flow<Map<Long, Set<CalendarView>>>.calendarsHiddenIn(
view: CalendarView,
scope: CoroutineScope,
): Flow<Set<Long>> =
map { it.calendarsHiddenIn(view) }
.distinctUntilChanged()
.shareIn(scope, SharingStarted.WhileSubscribed(), replay = 1)
/** [this] without the events of [hidden] calendars. */
fun List<EventInstance>.withoutCalendars(hidden: Set<Long>): List<EventInstance> =
if (hidden.isEmpty()) this else filterNot { it.calendarId in hidden }
/**
* [CalendarRepository.instances] as [view] shows them: also without the
* calendars the user hid in that view. Display only — reminders and search
* read the repository directly.
* [CalendarRepository.instances] as one view shows them: also without the
* [hidden] calendars the user keeps out of it. Display only — reminders, search
* and widgets read the repository directly.
*/
fun CalendarRepository.instancesIn(
view: CalendarView,
fun CalendarRepository.instancesWithout(
range: ClosedRange<Instant>,
hiddenViews: Flow<Map<Long, Set<CalendarView>>>,
hidden: Flow<Set<Long>>,
): Flow<List<EventInstance>> =
combine(
instances(range),
hiddenViews.map { it.calendarsHiddenIn(view) }.distinctUntilChanged(),
) { instances, hidden -> instances.withoutCalendars(hidden) }
combine(instances(range), hidden) { instances, ids -> instances.withoutCalendars(ids) }
.distinctUntilChanged()
@@ -1,8 +1,6 @@
package de.jeanlucmakiola.calendula.ui.month
import de.jeanlucmakiola.calendula.ui.common.startOfWeek
import de.jeanlucmakiola.calendula.ui.common.CalendarView
import de.jeanlucmakiola.calendula.ui.common.instancesIn
import de.jeanlucmakiola.calendula.ui.common.dayRange
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
@@ -21,7 +19,10 @@ import de.jeanlucmakiola.calendula.domain.calendarListFailure
import de.jeanlucmakiola.calendula.ui.agenda.AgendaDay
import de.jeanlucmakiola.calendula.ui.agenda.anchorTodayIfMissing
import de.jeanlucmakiola.calendula.ui.common.CalendarSpan
import de.jeanlucmakiola.calendula.ui.common.CalendarView
import de.jeanlucmakiola.calendula.ui.common.PageStateCache
import de.jeanlucmakiola.calendula.ui.common.calendarsHiddenIn
import de.jeanlucmakiola.calendula.ui.common.instancesWithout
import de.jeanlucmakiola.calendula.domain.isCrossedOut
import de.jeanlucmakiola.calendula.domain.sortedForDisplay
import de.jeanlucmakiola.calendula.ui.week.coversDay
@@ -70,7 +71,7 @@ class MonthViewModel @Inject constructor(
private val zone = TimeZone.currentSystemDefault()
private val hiddenViews = settingsPrefs.perCalendarHiddenViews
private val hiddenHere = settingsPrefs.perCalendarHiddenViews.calendarsHiddenIn(CalendarView.Month, viewModelScope)
/** First day of the week, from the Settings preference (AUTO → locale). */
val weekStart: StateFlow<DayOfWeek> = settingsPrefs.firstDayOfWeek(viewModelScope)
@@ -156,7 +157,7 @@ class MonthViewModel @Inject constructor(
) { (ym, ws) ->
combine(
repository.calendars(),
repository.instancesIn(CalendarView.Month, monthGridRange(ym, ws, zone), hiddenViews),
repository.instancesWithout(monthGridRange(ym, ws, zone), hiddenHere),
today,
) { calendars, instances, today ->
buildState(ym, ws, calendars, instances, today)
@@ -228,7 +229,7 @@ class MonthViewModel @Inject constructor(
val range = dayRange(first, last, zone)
combine(
repository.calendars(),
repository.instancesIn(CalendarView.Month, range, hiddenViews),
repository.instancesWithout(range, hiddenHere),
today,
) { calendars, instances, today ->
buildContinuousState(window, ws, style, calendars, instances, today)
@@ -21,7 +21,8 @@ import de.jeanlucmakiola.calendula.domain.FailureReason
import de.jeanlucmakiola.calendula.domain.calendarListFailure
import de.jeanlucmakiola.calendula.ui.common.CalendarView
import de.jeanlucmakiola.calendula.ui.common.PageStateCache
import de.jeanlucmakiola.calendula.ui.common.instancesIn
import de.jeanlucmakiola.calendula.ui.common.calendarsHiddenIn
import de.jeanlucmakiola.calendula.ui.common.instancesWithout
import de.jeanlucmakiola.floret.android.stateWhileSubscribed
import de.jeanlucmakiola.floret.di.IoDispatcher
import kotlinx.coroutines.CoroutineDispatcher
@@ -91,10 +92,10 @@ abstract class PagedTimelineViewModel(
private val io: CoroutineDispatcher,
gridRule: Flow<(LocalDate) -> DaysGrid>,
initialRule: (LocalDate) -> DaysGrid,
private val view: CalendarView,
view: CalendarView,
) : ViewModel() {
private val hiddenViews = settingsPrefs.perCalendarHiddenViews
private val hiddenHere = settingsPrefs.perCalendarHiddenViews.calendarsHiddenIn(view, viewModelScope)
/**
* The zone every page is laid out in; drags and drops resolve in it too, and
@@ -172,7 +173,7 @@ abstract class PagedTimelineViewModel(
zone.flatMapLatest { zone ->
combine(
repository.calendars(),
repository.instancesIn(view, spanRange(span.start, span.count, zone), hiddenViews),
repository.instancesWithout(spanRange(span.start, span.count, zone), hiddenHere),
today,
) { calendars, instances, today ->
buildState(span, calendars, instances, today, zone)
@@ -1,6 +1,5 @@
package de.jeanlucmakiola.calendula.widget
import de.jeanlucmakiola.calendula.ui.common.withoutCalendars
import android.Manifest
import android.content.Context
import android.content.pm.PackageManager
@@ -20,6 +19,7 @@ import de.jeanlucmakiola.calendula.ui.agenda.AgendaRange
import de.jeanlucmakiola.calendula.ui.agenda.agendaRange
import de.jeanlucmakiola.calendula.ui.agenda.dayCount
import de.jeanlucmakiola.calendula.ui.agenda.groupAgendaDays
import de.jeanlucmakiola.calendula.ui.common.withoutCalendars
import de.jeanlucmakiola.floret.prefs.ThemeMode
import de.jeanlucmakiola.floret.prefs.get
import kotlinx.coroutines.flow.Flow
+1 -1
View File
@@ -849,7 +849,7 @@
<string name="calendars_state_managed">Filled from your contacts</string>
<string name="calendars_managed_delete_locked">This calendar is filled from your contacts, so Calendula would create it again on the next sync. Turn special dates off under Settings → Special dates to delete it.</string>
<string name="calendars_synced_header">Synced calendars</string>
<string name="calendars_synced_hint">These come from accounts on your device. Create and edit them in their own app.</string>
<string name="calendars_synced_hint">These come from accounts on your device. Create and edit them in their own app; tap one here to hide it in some views.</string>
<string name="calendars_manage_in_app">Manage in app</string>
<!-- Account header when two accounts share a name: %1$s is the account, %2$s the app it comes from. -->
<string name="calendars_account_from_source">%1$s (%2$s)</string>
@@ -632,6 +632,20 @@ class SettingsPrefsTest {
assertThat(prefs.perCalendarHiddenViews.first()).containsExactly(9L, setOf(CalendarView.MultiDay))
}
@Test
fun `toggling one hidden view keeps the others and clears the entry when empty`(
@TempDir tempDir: Path,
) = runTest {
val prefs = testSettings(tempDir)
prefs.setCalendarHiddenIn(7L, CalendarView.Month, hidden = true)
prefs.setCalendarHiddenIn(7L, CalendarView.Week, hidden = true)
assertThat(prefs.perCalendarHiddenViews.first())
.containsExactly(7L, setOf(CalendarView.Month, CalendarView.Week))
prefs.setCalendarHiddenIn(7L, CalendarView.Month, hidden = false)
prefs.setCalendarHiddenIn(7L, CalendarView.Week, hidden = false)
assertThat(prefs.perCalendarHiddenViews.first()).isEmpty()
}
@Test
fun `garbage hidden-views entries are dropped, the rest survive`(
@TempDir tempDir: Path,
@@ -55,9 +55,9 @@ class ViewHiddenCalendarsTest {
settings.setCalendarHiddenViews(2L, setOf(CalendarView.Month))
val hidden = settings.perCalendarHiddenViews
assertThat(repo.instancesIn(CalendarView.Month, range, hidden).first().map { it.eventId })
assertThat(repo.instancesWithout(range, hidden.calendarsHiddenIn(CalendarView.Month, backgroundScope)).first().map { it.eventId })
.containsExactly(10L)
assertThat(repo.instancesIn(CalendarView.Week, range, hidden).first().map { it.eventId })
assertThat(repo.instancesWithout(range, hidden.calendarsHiddenIn(CalendarView.Week, backgroundScope)).first().map { it.eventId })
.containsExactly(10L, 20L)
// The repository itself, which reminders and search build on, is untouched.
assertThat(repo.instances(range).first().map { it.eventId }).containsExactly(10L, 20L)
@@ -72,11 +72,12 @@ class ViewHiddenCalendarsTest {
val settings = testSettings(tempDir)
val repo = testRepository(fake, tempDir, UnconfinedTestDispatcher(testScheduler), settings = settings)
repo.instancesIn(CalendarView.Agenda, range, settings.perCalendarHiddenViews).test {
val hidden = settings.perCalendarHiddenViews.calendarsHiddenIn(CalendarView.Agenda, backgroundScope)
repo.instancesWithout(range, hidden).test {
assertThat(awaitItem().map { it.eventId }).containsExactly(10L, 20L)
settings.setCalendarHiddenViews(1L, setOf(CalendarView.Agenda))
settings.setCalendarHiddenIn(1L, CalendarView.Agenda, hidden = true)
assertThat(awaitItem().map { it.eventId }).containsExactly(20L)
settings.setCalendarHiddenViews(1L, emptySet())
settings.setCalendarHiddenIn(1L, CalendarView.Agenda, hidden = false)
assertThat(awaitItem().map { it.eventId }).containsExactly(10L, 20L)
cancelAndIgnoreRemainingEvents()
}