Skip to content

Make SQL cache more robust #152

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.

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

Merged
merged 2 commits into from
May 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,27 @@ class SqlNormalizedCache internal constructor(
}

override fun clearAll() {
recordDatabase.deleteAllRecords()
try {
recordDatabase.deleteAllRecords()
} catch (e: Exception) {
// Unable to clear the records from the database, it is possibly corrupted
apolloExceptionHandler(Exception("Unable to clear records from the database", e))
}
}

override fun remove(cacheKey: CacheKey, cascade: Boolean): Boolean {
return remove(cacheKeys = listOf(cacheKey), cascade = cascade) > 0
}

override fun remove(cacheKeys: Collection<CacheKey>, cascade: Boolean): Int {
return recordDatabase.transaction {
internalDeleteRecords(cacheKeys.map { it.key }, cascade)
return try {
recordDatabase.transaction {
internalDeleteRecords(cacheKeys.map { it.key }, cascade)
}
} catch (e: Exception) {
// Unable to delete the records from the database, it is possibly corrupted
apolloExceptionHandler(Exception("Unable to delete records from the database", e))
0
}
}

Expand Down Expand Up @@ -133,14 +144,20 @@ class SqlNormalizedCache internal constructor(
}

override fun trim(maxSizeBytes: Long, trimFactor: Float): Long {
val size = recordDatabase.databaseSize()
return if (size >= maxSizeBytes) {
val count = recordDatabase.count().executeAsOne()
recordDatabase.trimByUpdatedDate((count * trimFactor).toLong())
recordDatabase.vacuum()
recordDatabase.databaseSize()
} else {
size
try {
val size = recordDatabase.databaseSize()
return if (size >= maxSizeBytes) {
val count = recordDatabase.count().executeAsOne()
recordDatabase.trimByUpdatedDate((count * trimFactor).toLong())
recordDatabase.vacuum()
recordDatabase.databaseSize()
} else {
size
}
} catch (e: Exception) {
// Unable to trim the records from the database, it is possibly corrupted
apolloExceptionHandler(Exception("Unable to trim records from the database", e))
return -1
}
}
}
5 changes: 3 additions & 2 deletions normalized-cache/api/normalized-cache.api
Original file line number Diff line number Diff line change
Expand Up @@ -500,14 +500,15 @@ public abstract interface class com/apollographql/cache/normalized/api/Normalize
public abstract fun clearAll ()V
public abstract fun merge (Lcom/apollographql/cache/normalized/api/Record;Lcom/apollographql/cache/normalized/api/CacheHeaders;Lcom/apollographql/cache/normalized/api/RecordMerger;)Ljava/util/Set;
public abstract fun merge (Ljava/util/Collection;Lcom/apollographql/cache/normalized/api/CacheHeaders;Lcom/apollographql/cache/normalized/api/RecordMerger;)Ljava/util/Set;
public static fun prettifyDump (Ljava/util/Map;)Ljava/lang/String;
public static fun prettifyDump (Ljava/util/Map;Z)Ljava/lang/String;
public abstract fun remove (Ljava/util/Collection;Z)I
public abstract fun remove-eNSUWrY (Ljava/lang/String;Z)Z
public abstract fun trim (JF)J
}

public final class com/apollographql/cache/normalized/api/NormalizedCache$Companion {
public final fun prettifyDump (Ljava/util/Map;)Ljava/lang/String;
public final fun prettifyDump (Ljava/util/Map;Z)Ljava/lang/String;
public static synthetic fun prettifyDump$default (Lcom/apollographql/cache/normalized/api/NormalizedCache$Companion;Ljava/util/Map;ZILjava/lang/Object;)Ljava/lang/String;
}

public final class com/apollographql/cache/normalized/api/NormalizedCache$DefaultImpls {
Expand Down
2 changes: 1 addition & 1 deletion normalized-cache/api/normalized-cache.klib.api
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ abstract interface com.apollographql.cache.normalized.api/NormalizedCache : com.
open fun trim(kotlin/Long, kotlin/Float = ...): kotlin/Long // com.apollographql.cache.normalized.api/NormalizedCache.trim|trim(kotlin.Long;kotlin.Float){}[0]

final object Companion { // com.apollographql.cache.normalized.api/NormalizedCache.Companion|null[0]
final fun prettifyDump(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin.collections/Map<com.apollographql.cache.normalized.api/CacheKey, com.apollographql.cache.normalized.api/Record>>): kotlin/String // com.apollographql.cache.normalized.api/NormalizedCache.Companion.prettifyDump|prettifyDump(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.collections.Map<com.apollographql.cache.normalized.api.CacheKey,com.apollographql.cache.normalized.api.Record>>){}[0]
final fun prettifyDump(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin.collections/Map<com.apollographql.cache.normalized.api/CacheKey, com.apollographql.cache.normalized.api/Record>>, kotlin/Boolean = ...): kotlin/String // com.apollographql.cache.normalized.api/NormalizedCache.Companion.prettifyDump|prettifyDump(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.collections.Map<com.apollographql.cache.normalized.api.CacheKey,com.apollographql.cache.normalized.api.Record>>;kotlin.Boolean){}[0]
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,23 +86,28 @@ interface NormalizedCache : ReadOnlyNormalizedCache {

companion object {
@JvmStatic
fun prettifyDump(dump: Map<@JvmSuppressWildcards KClass<*>, Map<CacheKey, Record>>): String = dump.prettifyDump()
fun prettifyDump(dump: Map<@JvmSuppressWildcards KClass<*>, Map<CacheKey, Record>>, showMetadata: Boolean = false): String =
dump.prettifyDump(showMetadata = showMetadata)

private fun Any?.prettifyDump(level: Int = 0): String {
private fun Any?.prettifyDump(level: Int = 0, showMetadata: Boolean): String {
return buildString {
when (this@prettifyDump) {
is Record -> {
append("{\n")
indent(level + 1)
append("fields: ")
append(fields.prettifyDump(level + 1))
append("\n")
indent(level + 1)
append("metadata: ")
append(metadata.prettifyDump(level + 1))
append("\n")
indent(level)
append("}")
if (showMetadata) {
append("{\n")
indent(level + 1)
append("fields: ")
append(fields.prettifyDump(level + 1, showMetadata))
append("\n")
indent(level + 1)
append("metadata: ")
append(metadata.prettifyDump(level + 1, showMetadata))
append("\n")
indent(level)
append("}")
} else {
append(fields.prettifyDump(level, showMetadata))
}
}

is List<*> -> {
Expand All @@ -111,7 +116,7 @@ interface NormalizedCache : ReadOnlyNormalizedCache {
append("\n")
for (value in this@prettifyDump) {
indent(level + 1)
append(value.prettifyDump(level + 1))
append(value.prettifyDump(level + 1, showMetadata))
append("\n")
}
indent(level)
Expand All @@ -132,7 +137,7 @@ interface NormalizedCache : ReadOnlyNormalizedCache {
}
)
append(": ")
append(value.prettifyDump(level + 1))
append(value.prettifyDump(level + 1, showMetadata))
append("\n")
}
indent(level)
Expand Down