Handle SqlNormalizedCache merge APIs Exceptions with ApolloExceptionH…

…andler (#4002) Co-authored-by: OlivierG <[email protected]>
apollographql · Apr 11, 2022 · ce35e46 · ce35e46
1 parent 833d8d2
commit ce35e46
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 5 deletions.
diff --git a/...rc/commonMain/kotlin/com/apollographql/apollo3/cache/normalized/sql/SqlNormalizedCache.kt b/...rc/commonMain/kotlin/com/apollographql/apollo3/cache/normalized/sql/SqlNormalizedCache.kt
@@ -82,22 +82,36 @@ class SqlNormalizedCache internal constructor(
     return selfRemoved + chainRemoved
   }
 
+  @OptIn(ApolloExperimental::class)
   override fun merge(records: Collection<Record>, cacheHeaders: CacheHeaders): Set<String> {
     if (cacheHeaders.hasHeader(ApolloCacheHeaders.DO_NOT_STORE)) {
       return emptySet()
     }
-    return cacheQueries.updateRecords(
-        records = records,
-    )
+    return try {
+      cacheQueries.updateRecords(
+          records = records,
+      )
+    } catch (e: Exception) {
+      // Unable to merge the records in the database, it is possibly corrupted - treat this as a cache miss
+      apolloExceptionHandler(Exception("Unable to merge records from the database", e))
+      emptySet()
+    }
   }
 
+  @OptIn(ApolloExperimental::class)
   override fun merge(record: Record, cacheHeaders: CacheHeaders): Set<String> {
     if (cacheHeaders.hasHeader(ApolloCacheHeaders.DO_NOT_STORE)) {
       return emptySet()
     }
-    return cacheQueries.updateRecord(
+    return try {
+      cacheQueries.updateRecord(
         record = record,
-    )
+      )
+    } catch (e: Exception) {
+      // Unable to merge the record in the database, it is possibly corrupted - treat this as a cache miss
+      apolloExceptionHandler(Exception("Unable to merge a record from the database", e))
+      emptySet()
+    }
   }
 
   override fun dump(): Map<KClass<*>, Map<String, Record>> {

diff --git a/...ommonTest/kotlin/com/apollographql/apollo3/cache/normalized/sql/SqlNormalizedCacheTest.kt b/...ommonTest/kotlin/com/apollographql/apollo3/cache/normalized/sql/SqlNormalizedCacheTest.kt
@@ -216,9 +216,24 @@ class SqlNormalizedCacheTest {
     apolloExceptionHandler = {
       throwable = it
     }
+
     badCache.loadRecord(STANDARD_KEY, CacheHeaders.NONE)
     assertEquals("Unable to read a record from the database", throwable!!.message)
     assertEquals("bad cache", throwable!!.cause!!.message)
+
+    throwable = null
+    badCache.merge(
+        record = Record(
+            key = STANDARD_KEY,
+            fields = mapOf(
+                "fieldKey" to "valueUpdated",
+                "newFieldKey" to true,
+            ),
+        ),
+        cacheHeaders = CacheHeaders.NONE,
+    )
+    assertEquals("Unable to merge a record from the database", throwable!!.message)
+    assertEquals("bad cache", throwable!!.cause!!.message)
   }
 
   private class BadCacheQueries(goodCacheQueries: CacheQueries = ApolloDatabase(createDriver()).cacheQueries) : CacheQueries by goodCacheQueries {