SyncOutcomeReason.kt

1package com.peachpasswords.sync23import kotlinx.serialization.Serializable45/**6 * Why a sync attempt ended, in the same vocabulary the browser uses7 * (`src/shared/sync-outcome.ts`). June runs both clients side by side, so the8 * names, the state machine and the user-facing wording are deliberately kept9 * identical; only the Kotlin spelling differs.10 *11 * Before this existed Android had [SyncOutcomeSummary]'s ancestor `SyncStatus`,12 * whose `LastSynced` was set the instant the sync *service* was asked to start13 * — a claim of success it had not earned. Every real failure below it was14 * swallowed by the reconnect loop's `runCatching`, so "synced fine", "the peer15 * refused us" and "the vault was locked" were one indistinguishable state.16 *17 * One browser outcome is deliberately absent, because on Android it names a18 * state that cannot occur: `runner_unavailable` — the browser injects its19 * per-device sync runner and can find it missing. Android's runner is20 * [PeachSyncService], which is always present; the only way it fails to run is21 * a locked vault, which is [VAULT_LOCKED].22 *23 * [FOREGROUND_START_BLOCKED] is the other way round — Android-only, with no24 * browser counterpart, because only Android can refuse to start the runner at25 * all (background foreground-service restrictions, API 31+).26 *27 * `no_eligible_host` is kept but means something narrower than the browser's:28 * the browser rejects peers it cannot dial, whereas this phone usually *waits*29 * and can talk to any peer type. What it cannot talk to is a peer with no30 * rendezvous secret, which the reconnect loop skips in silence. See31 * [weDialPeer] for why the roles differ.32 */33enum class SyncOutcomeReason {34    COMPLETED_CHANGES,35    COMPLETED_NO_CHANGES,36    NO_PAIRED_DEVICES,37    NO_ELIGIBLE_HOST,38    SYNC_DISABLED,39    PRIVATE_RELAY_UNSET,40    VAULT_LOCKED,41    FOREGROUND_START_BLOCKED,42    RELAY_UNREACHABLE,43    HANDSHAKE_FAILED,44    VAULT_ID_MISMATCH,45    SYNC_TIMEOUT,46    CONNECTION_LOST,47    RUN_FAILED,48    ;4950    /** The browser's snake_case spelling, for the screens that carry a code. */51    fun wire(): String = name.lowercase()5253    /** Outcomes where sync did not do what was asked, so the light goes red. */54    val isFailure: Boolean55        get() = when (this) {56            NO_ELIGIBLE_HOST,57            PRIVATE_RELAY_UNSET,58            FOREGROUND_START_BLOCKED,59            VAULT_ID_MISMATCH,60            RUN_FAILED,61            -> true6263            COMPLETED_CHANGES,64            COMPLETED_NO_CHANGES,65            NO_PAIRED_DEVICES,66            SYNC_DISABLED,67            VAULT_LOCKED,68            RELAY_UNREACHABLE,69            HANDSHAKE_FAILED,70            SYNC_TIMEOUT,71            CONNECTION_LOST,72            -> false73        }7475    /**76     * Network-class outcomes — the dial did not reach the peer this attempt.77     * The background reconnect loop keeps trying, so the light goes amber78     * rather than red. Mirrors the browser's WARN tier.79     */80    val isWarning: Boolean81        get() = when (this) {82            RELAY_UNREACHABLE,83            HANDSHAKE_FAILED,84            SYNC_TIMEOUT,85            CONNECTION_LOST,86            VAULT_LOCKED,87            -> true8889            else -> false90        }91}9293/**94 * The last sync attempt, whatever happened. Persisted by [SyncOutcomeStore] so95 * a failure that happened before the process was killed is still explicable —96 * a reason that vanishes is useless for diagnosing real hardware.97 */98@Serializable99data class SyncOutcomeSummary(100    val reason: SyncOutcomeReason? = null,101    /** Raw internal code, or the peer inventory behind [SyncOutcomeReason.NO_ELIGIBLE_HOST]. */102    val detail: String? = null,103    val entriesSent: Int = 0,104    val entriesReceived: Int = 0,105    /** When the attempt ended, success or not. */106    val finishedAt: Long? = null,107    /** In flight right now. Transient by definition, so never persisted. */108    val syncing: Boolean = false,109)110111/**112 * The one indicator light. [BUSY] pulses green, [OK] is solid green, [WARN] is113 * amber (a transient network miss — the background loop retries), [ERROR] is114 * red (the app is actually broken), [IDLE] is unlit. Nothing that is actually115 * broken may resolve to [OK] — a paired-but-unsyncable device is red, not116 * green.117 */118enum class SyncIndicator { BUSY, OK, WARN, ERROR, IDLE }119120fun syncIndicator(summary: SyncOutcomeSummary, pairedCount: Int): SyncIndicator {121    if (summary.syncing) return SyncIndicator.BUSY122    val reason = summary.reason123    if (reason != null && reason.isWarning) return SyncIndicator.WARN124    if (reason != null && reason.isFailure) return SyncIndicator.ERROR125    if (reason == SyncOutcomeReason.COMPLETED_CHANGES ||126        reason == SyncOutcomeReason.COMPLETED_NO_CHANGES127    ) {128        return SyncIndicator.OK129    }130    // Paired with a healthy history but nothing attempted since launch: still a131    // successful pair, which is what the light is claiming.132    if (pairedCount > 0 && reason == null) return SyncIndicator.OK133    return SyncIndicator.IDLE134}135136private fun indicatorHeadline(indicator: SyncIndicator): String = when (indicator) {137    SyncIndicator.BUSY -> "Syncing"138    SyncIndicator.OK -> "Sync healthy"139    SyncIndicator.WARN -> "Last sync attempt missed — will retry"140    SyncIndicator.ERROR -> "Sync problem"141    SyncIndicator.IDLE -> "Not syncing"142}143144/** Colour alone is never the signal — this is the same claim in words. */145fun syncIndicatorLabel(indicator: SyncIndicator, summary: SyncOutcomeSummary): String =146    "${indicatorHeadline(indicator)} — ${describeSyncOutcome(summary)}"147148/**149 * One plain-English line for a sync outcome, word for word the browser's copy.150 * [SyncOutcomeSummary.detail] is appended rather than hidden: on a real handset151 * it is the whole diagnostic, and there is no devtools to fall back on.152 */153fun describeSyncOutcome(summary: SyncOutcomeSummary): String {154    val reason = summary.reason ?: return "Not synced yet"155    val base = when (reason) {156        SyncOutcomeReason.COMPLETED_CHANGES -> "Synced"157        SyncOutcomeReason.COMPLETED_NO_CHANGES -> "Up to date — nothing to send or receive"158        SyncOutcomeReason.NO_PAIRED_DEVICES -> "No devices paired yet"159        SyncOutcomeReason.NO_ELIGIBLE_HOST -> "Paired, but no device here can accept a sync"160        SyncOutcomeReason.SYNC_DISABLED -> "Sync is switched off"161        SyncOutcomeReason.PRIVATE_RELAY_UNSET -> "Private relay chosen but no address set"162        SyncOutcomeReason.VAULT_LOCKED -> "Vault was locked — unlock and sync again"163        SyncOutcomeReason.FOREGROUND_START_BLOCKED ->164            "Android blocked Peach from starting sync in the background — open Peach and sync again"165        SyncOutcomeReason.RELAY_UNREACHABLE -> "Couldn't reach the relay"166        SyncOutcomeReason.HANDSHAKE_FAILED -> "Reached the relay, but the device didn't answer"167        SyncOutcomeReason.VAULT_ID_MISMATCH -> "That device holds a different vault"168        SyncOutcomeReason.SYNC_TIMEOUT -> "The device stopped responding mid-sync"169        SyncOutcomeReason.CONNECTION_LOST -> "The connection dropped mid-sync — will retry"170        SyncOutcomeReason.RUN_FAILED -> "Sync failed"171    }172    if (reason == SyncOutcomeReason.COMPLETED_CHANGES) {173        val moved = listOfNotNull(174            "${summary.entriesSent} sent".takeIf { summary.entriesSent > 0 },175            "${summary.entriesReceived} received".takeIf { summary.entriesReceived > 0 },176        )177        return if (moved.isEmpty()) base else "$base — ${moved.joinToString(", ")}"178    }179    return summary.detail?.let { "$base ($it)" } ?: base180}181182/**183 * Session errors reach us as opaque strings by contract ([SyncOutcome.error]184 * and any throw out of the relay socket). Classifying them in one place is what185 * lets the copy above key off something stable.186 */187internal fun classifySyncError(error: String): SyncOutcomeReason = when {188    error.contains("VAULT_LOCKED") -> SyncOutcomeReason.VAULT_LOCKED189    error.contains("vault_id_mismatch") -> SyncOutcomeReason.VAULT_ID_MISMATCH190    error.contains("timed out") || error.contains("sync_timeout") -> SyncOutcomeReason.SYNC_TIMEOUT191    // A KK failure, a mismatched PAIR_IDENTITY or a wrong room all mean the192    // relay was fine and the peer was not who we expected.193    Regex("handshake|PAIR_IDENTITY|identity does not match|capability does not match|clock-skew")194        .containsMatchIn(error) -> SyncOutcomeReason.HANDSHAKE_FAILED195    // A hang-up after a successful dial is a connection-lost, not a relay196    // problem — checked before the broad relay/websocket regex below so it197    // doesn't get swallowed into RELAY_UNREACHABLE. The browser does the same198    // narrow check.199    isConnectionClosedError(error) -> SyncOutcomeReason.CONNECTION_LOST200    Regex("relay_|websocket|Connection|connect|socket|Unable to resolve host", RegexOption.IGNORE_CASE)201        .containsMatchIn(error) -> SyncOutcomeReason.RELAY_UNREACHABLE202    else -> SyncOutcomeReason.RUN_FAILED203}204205/**206 * A transport that hung up, as opposed to a protocol or vault problem.207 * Mirrors `isConnectionClosedError` in the browser's sync-outcome.ts; the two208 * must stay in lockstep so a close on either side maps to the same outcome.209 */210internal fun isConnectionClosedError(error: String): Boolean =211    Regex("websocket closed|connection closed|Socket closed", RegexOption.IGNORE_CASE)212        .containsMatchIn(error)213214/**215 * Translate one finished session ([SyncCoordinator]'s per-round result) into the216 * user-facing vocabulary. Tombstones count as changes: a deletion that crossed217 * the wire is not "nothing to send or receive".218 */219internal fun SyncOutcome.toSummary(): SyncOutcomeSummary = when (status) {220    SyncOutcomeStatus.COMPLETED -> SyncOutcomeSummary(221        reason = if (entriesSent + entriesReceived + tombstonesSent + tombstonesReceived > 0) {222            SyncOutcomeReason.COMPLETED_CHANGES223        } else {224            SyncOutcomeReason.COMPLETED_NO_CHANGES225        },226        entriesSent = entriesSent,227        entriesReceived = entriesReceived,228    )229230    SyncOutcomeStatus.VAULT_MISMATCH ->231        SyncOutcomeSummary(reason = SyncOutcomeReason.VAULT_ID_MISMATCH, detail = error)232233    SyncOutcomeStatus.TIMEOUT ->234        SyncOutcomeSummary(reason = SyncOutcomeReason.SYNC_TIMEOUT, detail = error)235236    SyncOutcomeStatus.ERRORED -> SyncOutcomeSummary(237        reason = classifySyncError(error ?: "sync_failed"),238        detail = error,239    )240}