Cache data as interface

apollographql · Jul 19, 2023 · 946c7d2 · 946c7d2
1 parent 1a3b7f8
commit 946c7d2
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 65 deletions.
diff --git a/...ubating/src/commonMain/kotlin/com/apollographql/apollo3/cache/normalized/api/CacheData.kt b/...ubating/src/commonMain/kotlin/com/apollographql/apollo3/cache/normalized/api/CacheData.kt
@@ -0,0 +1,10 @@
+package com.apollographql.apollo3.cache.normalized.api
+
+/**
+ * Data read from the cache that can be represented as a JSON map.
+ *
+ * @see [toData]
+ */
+interface CacheData {
+  fun toMap(): Map<String, Any?>
+}
diff --git a/...monMain/kotlin/com/apollographql/apollo3/cache/normalized/api/OperationCacheExtensions.kt b/...monMain/kotlin/com/apollographql/apollo3/cache/normalized/api/OperationCacheExtensions.kt
@@ -1,6 +1,7 @@
 package com.apollographql.apollo3.cache.normalized.api
 
 import com.apollographql.apollo3.annotations.ApolloExperimental
+import com.apollographql.apollo3.api.CompositeAdapter
 import com.apollographql.apollo3.api.CustomScalarAdapters
 import com.apollographql.apollo3.api.Executable
 import com.apollographql.apollo3.api.Operation
@@ -10,7 +11,6 @@ import com.apollographql.apollo3.api.json.MapJsonWriter
 import com.apollographql.apollo3.api.toJson
 import com.apollographql.apollo3.api.variables
 import com.apollographql.apollo3.cache.normalized.api.internal.CacheBatchReader
-import com.apollographql.apollo3.cache.normalized.api.internal.CacheDataTransformer
 import com.apollographql.apollo3.cache.normalized.api.internal.Normalizer
 
 fun <D : Operation.Data> Operation<D>.normalize(
@@ -106,7 +106,7 @@ private fun <D : Executable.Data> Executable<D>.readInternal(
     cache: ReadOnlyNormalizedCache,
     cacheResolver: Any,
     cacheHeaders: CacheHeaders,
-): CacheDataTransformer<D> {
+): CacheData {
   return CacheBatchReader(
       cache = cache,
       cacheHeaders = cacheHeaders,
@@ -115,11 +115,21 @@ private fun <D : Executable.Data> Executable<D>.readInternal(
       rootKey = cacheKey.key,
       rootSelections = rootField().selections,
       rootTypename = rootField().type.rawType().name
-  ).collectData(adapter())
+  ).collectData()
 }
 
 fun Collection<Record>?.dependentKeys(): Set<String> {
   return this?.flatMap {
     it.fieldKeys()
   }?.toSet() ?: emptySet()
 }
+
+fun <D: Executable.Data> CacheData.toData(
+    adapter: CompositeAdapter<D>,
+    customScalarAdapters: CustomScalarAdapters,
+): D {
+  val reader = MapJsonReader(
+      root = toMap(),
+  )
+  return adapter.fromJson(reader, customScalarAdapters)
+}
diff --git a/...onMain/kotlin/com/apollographql/apollo3/cache/normalized/api/internal/CacheBatchReader.kt b/...onMain/kotlin/com/apollographql/apollo3/cache/normalized/api/internal/CacheBatchReader.kt
@@ -3,9 +3,9 @@ package com.apollographql.apollo3.cache.normalized.api.internal
 import com.apollographql.apollo3.api.CompiledField
 import com.apollographql.apollo3.api.CompiledFragment
 import com.apollographql.apollo3.api.CompiledSelection
-import com.apollographql.apollo3.api.CompositeAdapter
 import com.apollographql.apollo3.api.Executable
 import com.apollographql.apollo3.cache.normalized.api.ApolloResolver
+import com.apollographql.apollo3.cache.normalized.api.CacheData
 import com.apollographql.apollo3.cache.normalized.api.CacheHeaders
 import com.apollographql.apollo3.cache.normalized.api.CacheKey
 import com.apollographql.apollo3.cache.normalized.api.CacheResolver
@@ -83,7 +83,7 @@ internal class CacheBatchReader(
     }
   }
 
-  fun <D: Executable.Data> collectData(adapter: CompositeAdapter<D>): CacheDataTransformer<D> {
+  fun collectData(): CacheData {
     pendingReferences.add(
         PendingReference(
             key = rootKey,
@@ -132,7 +132,7 @@ internal class CacheBatchReader(
       }
     }
 
-    return CacheDataTransformer(adapter, data)
+    return CacheBatchReaderData(data)
   }
 
   /**
@@ -178,4 +178,36 @@ internal class CacheBatchReader(
       }
     }
   }
+
+  private data class CacheBatchReaderData(
+      private val data: MutableMap<List<Any>, Map<String, Any?>>,
+  ): CacheData {
+    @Suppress("UNCHECKED_CAST")
+    override fun toMap(): Map<String, Any?> {
+      return data[emptyList()].replaceCacheKeys(emptyList()) as Map<String, Any?>
+    }
+
+    private fun Any?.replaceCacheKeys(path: List<Any>): Any? {
+      return when (this) {
+        is CacheKey -> {
+          data[path].replaceCacheKeys(path)
+        }
+        is List<*> -> {
+          mapIndexed { index, src ->
+            src.replaceCacheKeys(path + index)
+          }
+        }
+        is Map<*, *> -> {
+          // This will traverse Map custom scalars but this is ok as it shouldn't contain any CacheKey
+          mapValues {
+            it.value.replaceCacheKeys(path + (it.key as String))
+          }
+        }
+        else -> {
+          // Scalar value
+          this
+        }
+      }
+    }
+  }
 }
diff --git a/...in/kotlin/com/apollographql/apollo3/cache/normalized/api/internal/CacheDataTransformer.kt b/...in/kotlin/com/apollographql/apollo3/cache/normalized/api/internal/CacheDataTransformer.kt
diff --git a/...mmonMain/kotlin/com/apollographql/apollo3/cache/normalized/internal/DefaultApolloStore.kt b/...mmonMain/kotlin/com/apollographql/apollo3/cache/normalized/internal/DefaultApolloStore.kt
@@ -16,10 +16,11 @@ import com.apollographql.apollo3.cache.normalized.api.NormalizedCacheFactory
 import com.apollographql.apollo3.cache.normalized.api.ReadOnlyNormalizedCache
 import com.apollographql.apollo3.cache.normalized.api.Record
 import com.apollographql.apollo3.cache.normalized.api.RecordMerger
-import com.apollographql.apollo3.cache.normalized.api.internal.CacheDataTransformer
+import com.apollographql.apollo3.cache.normalized.api.CacheData
 import com.apollographql.apollo3.cache.normalized.api.internal.OptimisticCache
 import com.apollographql.apollo3.cache.normalized.api.normalize
 import com.apollographql.apollo3.cache.normalized.api.readDataFromCache
+import com.apollographql.apollo3.cache.normalized.api.toData
 import com.benasher44.uuid.Uuid
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.flow.MutableSharedFlow
@@ -116,7 +117,7 @@ internal class DefaultApolloStore(
           cacheHeaders = cacheHeaders,
           cacheKey = CacheKey.rootKey()
       )
-    }.toData(customScalarAdapters)
+    }.toData(operation.adapter(), customScalarAdapters)
   }
 
   override suspend fun <D : Fragment.Data> readFragment(
@@ -133,7 +134,7 @@ internal class DefaultApolloStore(
           cacheHeaders = cacheHeaders,
           cacheKey = cacheKey
       )
-    }.toData(customScalarAdapters)
+    }.toData(fragment.adapter(), customScalarAdapters)
   }
 
 
@@ -283,7 +284,7 @@ internal class DefaultApolloStore(
         cache: ReadOnlyNormalizedCache,
         cacheResolver: Any,
         cacheHeaders: CacheHeaders,
-    ): CacheDataTransformer<D> {
+    ): CacheData {
       return when (cacheResolver) {
         is CacheResolver -> readDataFromCache(
             cacheKey,