Skip to content

feat(core): add BibleHighlightsRepository #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bmanquen wants to merge 13 commits into
base: feat/add-highlights
Choose a base branch
from
Open

feat(core): add BibleHighlightsRepository #143

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fa14fc6
fix(core): send updateHighlight PUT to the highlights URL YPE-1187
bmanquen Jun 24, 2026
cf784ef
feat(core): make BibleHighlightCache observable via StateFlow YPE-1187
bmanquen Jun 24, 2026
f25f225
feat(core): add BibleHighlightsRepository for highlight sync YPE-1187
bmanquen Jun 24, 2026
b83386b
fix(core): harden BibleHighlightsRepository sync edge cases YPE-1187
bmanquen Jun 25, 2026
1d8ed48
fix(core): make markChapterAsLoading atomic to prevent duplicate loads
bmanquen Jun 25, 2026
7207982
feat(core): bind highlight sync to account and add queue controls YPE…
bmanquen Jun 26, 2026
1fe41f8
feat(core): port highlight queue results API and harden processing
bmanquen Jul 2, 2026
44e37ca
refactor(core): make highlight color type-safe and cover UPDATE/REMOV…
bmanquen Jul 2, 2026
7ba643e
fix(core): correct highlight sync and make color type-safe YPE-1187
bmanquen Jul 2, 2026
788059c
fix(core): correct highlight sync and make color type-safe YPE-1187
bmanquen Jul 2, 2026
96de3c5
fix(core): correct highlight sync and make color type-safe
bmanquen Jul 2, 2026
118c084
fix(core): reconcile in-flight local writes on server highlight merge…
bmanquen Jul 2, 2026
054d03b
fix(core): clean up re-added highlight after a synced delete YPE-1187
bmanquen Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions ...orm-core/src/main/java/com/youversion/platform/core/highlights/api/HighlightsEndpoints.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,7 @@ object HighlightsEndpoints : HighlightsApi {
color: String,
): Boolean =
httpClient
.put {
highlightsUrl()
.put(highlightsUrl()) {
contentType(ContentType.Application.Json)
buildJsonObject {
put("version_id", versionId)
Expand Down
156 changes: 88 additions & 68 deletions ...-core/src/main/java/com/youversion/platform/core/highlights/domain/BibleHighlightCache.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ package com.youversion.platform.core.highlights.domain

import com.youversion.platform.core.bibles.domain.BibleReference
import com.youversion.platform.core.highlights.models.BibleHighlight
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.update
import java.util.Date
import java.util.UUID
import kotlin.time.Duration
Expand All @@ -24,25 +28,24 @@ object BibleHighlightCache {
)

// ----- Observable State
private val cachedHighlights = mutableListOf<CachedHighlight>()
val highlights: List<CachedHighlight>
get() = cachedHighlights.toList()
private val _highlights = MutableStateFlow<List<CachedHighlight>>(emptyList())
val highlights: StateFlow<List<CachedHighlight>> = _highlights.asStateFlow()

// ----- Throttling and Loading
private var recentChapterFetches = mutableMapOf<BibleReference, Date>()
private var currentlyLoadingChapters = mutableSetOf<BibleReference>()
private val recentChapterFetches = mutableMapOf<BibleReference, Date>()
private val currentlyLoadingChapters = mutableSetOf<BibleReference>()
Comment thread
greptile-apps[bot] marked this conversation as resolved.
Outdated
private val throttlingInterval: Duration = 5.minutes

// ----- Public API - State Management
fun clear() {
cachedHighlights.clear()
_highlights.value = emptyList()
recentChapterFetches.clear()
currentlyLoadingChapters.clear()
}

// ----- Public API - Queries
fun highlights(overlapping: BibleReference): List<BibleHighlight> =
cachedHighlights
_highlights.value
.filter { it.highlight.bibleReference.overlaps(otherReference = overlapping) }
.map { it.highlight }

Expand Down Expand Up @@ -77,65 +80,78 @@ object BibleHighlightCache {

// ----- Public API - Mutations (write APIs preserved)
fun addHighlights(highlights: List<BibleHighlight>) {
for (highlight in highlights) {
// Remove any existing for same exact reference; then append as pending create
cachedHighlights.removeAll { it.highlight.bibleReference == highlight.bibleReference }
cachedHighlights.add(
CachedHighlight(highlight = highlight, state = CachedHighlightState.LOCAL_PENDING_CREATE),
)
_highlights.update { current ->
current.toMutableList().apply {
for (highlight in highlights) {
// Remove any existing for same exact reference; then append as pending create
removeAll { it.highlight.bibleReference == highlight.bibleReference }
add(
CachedHighlight(highlight = highlight, state = CachedHighlightState.LOCAL_PENDING_CREATE),
)
}
}
}
}

fun removeHighlights(references: List<BibleReference>) {
for (reference in references) {
// If there is a pending create for this reference, just drop it; otherwise mark pending delete
val pendingCreateIdx =
cachedHighlights.indexOfFirst {
it.highlight.bibleReference == reference && it.state == CachedHighlightState.LOCAL_PENDING_CREATE
}
if (pendingCreateIdx != -1) {
cachedHighlights.removeAt(pendingCreateIdx)
} else {
val idx = cachedHighlights.indexOfFirst { it.highlight.bibleReference == reference }
if (idx != -1) {
cachedHighlights[idx] =
cachedHighlights[idx].copy(
state = CachedHighlightState.LOCAL_PENDING_DELETE,
lastModifiedAt = Date(),
)
_highlights.update { current ->
current.toMutableList().apply {
for (reference in references) {
// If there is a pending create for this reference, just drop it; otherwise mark pending delete
val pendingCreateIndex =
indexOfFirst {
it.highlight.bibleReference == reference &&
it.state == CachedHighlightState.LOCAL_PENDING_CREATE
}
if (pendingCreateIndex != -1) {
removeAt(pendingCreateIndex)
} else {
val index = indexOfFirst { it.highlight.bibleReference == reference }
if (index != -1) {
this[index] =
this[index].copy(
state = CachedHighlightState.LOCAL_PENDING_DELETE,
lastModifiedAt = Date(),
)
}
}
}
// Physically remove deletes so the visible list hides them
removeAll { it.state == CachedHighlightState.LOCAL_PENDING_DELETE }
}
}
// Optionally, physically remove localPendingDelete from visible list here if UI should hide deletes
cachedHighlights.removeAll { it.state == CachedHighlightState.LOCAL_PENDING_DELETE }
}

fun updateHighlightColors(
references: List<BibleReference>,
newColor: String,
) {
for (reference in references) {
val idx = cachedHighlights.indexOfFirst { it.highlight.bibleReference == reference }
if (idx != -1) {
cachedHighlights[idx] =
cachedHighlights[idx].copy(
highlight = BibleHighlight(bibleReference = reference, hexColor = newColor),
state =
if (cachedHighlights[idx].state != CachedHighlightState.LOCAL_PENDING_CREATE) {
CachedHighlightState.LOCAL_PENDING_UPDATE
} else {
cachedHighlights[idx].state
},
lastModifiedAt = Date(),
)
} else {
// Create if not exists, pending create
cachedHighlights.add(
CachedHighlight(
highlight = BibleHighlight(bibleReference = reference, hexColor = newColor),
state = CachedHighlightState.LOCAL_PENDING_CREATE,
),
)
_highlights.update { current ->
current.toMutableList().apply {
for (reference in references) {
val index = indexOfFirst { it.highlight.bibleReference == reference }
if (index != -1) {
this[index] =
this[index].copy(
highlight = BibleHighlight(bibleReference = reference, hexColor = newColor),
state =
if (this[index].state != CachedHighlightState.LOCAL_PENDING_CREATE) {
CachedHighlightState.LOCAL_PENDING_UPDATE
} else {
this[index].state
},
lastModifiedAt = Date(),
)
} else {
// Create if not exists, pending create
add(
CachedHighlight(
highlight = BibleHighlight(bibleReference = reference, hexColor = newColor),
state = CachedHighlightState.LOCAL_PENDING_CREATE,
),
)
}
}
}
}
}
Expand All @@ -147,22 +163,26 @@ object BibleHighlightCache {
) {
val chapterRef = normalizeToChapter(chapter)

// Remove existing remote-synced highlights for this chapter
cachedHighlights.removeAll { ch ->
ch.state == CachedHighlightState.REMOTE_SYNCED &&
ch.highlight.bibleReference.bookUSFM == chapterRef.bookUSFM &&
ch.highlight.bibleReference.chapter == chapterRef.chapter &&
ch.highlight.bibleReference.versionId == chapterRef.versionId
}
_highlights.update { current ->
current.toMutableList().apply {
// Remove existing remote-synced highlights for this chapter
removeAll { cached ->
cached.state == CachedHighlightState.REMOTE_SYNCED &&
cached.highlight.bibleReference.bookUSFM == chapterRef.bookUSFM &&
cached.highlight.bibleReference.chapter == chapterRef.chapter &&
cached.highlight.bibleReference.versionId == chapterRef.versionId
}

// Append server highlights as remoteSynced
for (h in highlights) {
cachedHighlights.add(
CachedHighlight(
highlight = h,
state = CachedHighlightState.REMOTE_SYNCED,
),
)
// Append server highlights as remoteSynced
for (highlight in highlights) {
add(
CachedHighlight(
highlight = highlight,
state = CachedHighlightState.REMOTE_SYNCED,
),
)
}
Comment thread
greptile-apps[bot] marked this conversation as resolved.
Outdated
}
}
}

Expand Down
Loading
Loading