Files
pluriwave/openspec/changes/alarm-live-countdown/specs/alarm-pre-notice-l10n/spec.md
T
FreeTLab bccc5c48b8
Build & Deploy PluriWave / Análisis de código (push) Successful in 38s
Build & Deploy PluriWave / Build APK + AAB release (push) Successful in 2m30s
docs(openspec): add SDD artifact trail for recent alarm and EQ changes
Persist the exploration, proposal, spec, design, tasks, and
verify/archive reports produced during the multi-device EQ,
alarm-countdown, and notification-visual-polish SDD cycles.
2026-07-04 12:42:11 +02:00

105 lines
3.9 KiB
Markdown

# Alarm Pre-Notice L10n Specification
## Purpose
Define the required behavior for the pre-notice notification text when an alarm is
approaching. The notification MUST display computed remaining minutes in the device
locale rather than hardcoded Spanish text.
## Requirements
### Requirement: Computed Remaining Minutes
The system MUST compute the number of minutes remaining until alarm fire time at the
moment the pre-notice `BroadcastReceiver` fires and MUST use that value as the
displayed countdown, NOT a hardcoded string.
Remaining minutes MUST be floored (integer division). If the computed value is less
than 1 minute, the system MUST clamp to 1 and display "1 min".
#### Scenario: Normal pre-notice (alarm is ~30 min away)
- GIVEN an alarm is scheduled 30 minutes in the future
- WHEN the pre-notice `BroadcastReceiver` fires at `triggerAtMillis - PRE_NOTICE_MILLIS`
- THEN the notification body displays the remaining minutes derived from
`(triggerAtMillis - currentTimeMillis) / 60_000`
- AND the displayed value is a positive integer (e.g. "30 min")
#### Scenario: Alarm scheduled with less than 30 min remaining
- GIVEN an alarm is scheduled with fewer than 30 minutes from now
- WHEN the pre-notice fires immediately (or is already past)
- THEN the computed remaining minutes MAY be 0 or negative
- AND the system clamps the displayed value to a minimum of 1 minute
#### Scenario: System clock drift
- GIVEN the device clock drifts so `currentTimeMillis` exceeds `triggerAtMillis`
- WHEN the receiver fires and computes remaining minutes
- THEN the system clamps to 1 and displays "1 min"
- AND does NOT display a negative number or crash
---
### Requirement: L10n-Ready Notification Text
The system MUST NOT hardcode any natural-language string in the notification content.
The pre-notice message MUST be produced via a localized string resource that accepts
a `{minutes}` placeholder.
A new ARB key `preNoticeCountdown` MUST be added to all 13 locale ARB files. The
string template MUST follow the same pattern as the existing `durationMinutesOnly`
key.
#### Scenario: Device locale is Spanish
- GIVEN the device locale is `es`
- WHEN the pre-notice notification is posted
- THEN the notification body uses the Spanish translation of `preNoticeCountdown`
with the computed minutes substituted
#### Scenario: Device locale is English
- GIVEN the device locale is `en`
- WHEN the pre-notice notification is posted
- THEN the notification body uses the English translation of `preNoticeCountdown`
with the computed minutes substituted
#### Scenario: Missing locale translation (fallback)
- GIVEN the device locale has no translation for `preNoticeCountdown`
- WHEN the pre-notice notification is posted
- THEN the system falls back to the default locale translation (English)
- AND does NOT display an untranslated key name or crash
---
### Requirement: Notification ID Stability
The pre-notice notification MUST be posted with the same stable notification ID
derived from `alarmId` that the system currently uses (`notificationIdForAlarm(alarmId)`).
#### Scenario: Pre-notice posted
- GIVEN an alarm with `alarmId = X`
- WHEN the pre-notice fires
- THEN `NotificationManagerCompat.notify()` is called with ID `notificationIdForAlarm(X)`
- AND calling `notify()` again with the same ID updates the existing notification
rather than creating a duplicate
---
### Requirement: No Additional Infrastructure
The pre-notice notification MUST be a single, static notification posted once at
fire time. The system MUST NOT schedule per-minute update chains (AlarmManager
repeat), WorkManager periodic tasks, or new foreground services to update the
countdown text after posting.
#### Scenario: Notification posted
- GIVEN the pre-notice fires
- WHEN the notification is posted
- THEN exactly one `notify()` call is made
- AND no new AlarmManager intents, WorkManager jobs, or foreground services are started