Use incubating cache 0.0.8 and show errors in cache viewer (#6439)

Author: BoD

gradle/libraries.toml

@@ -17,7 +17,7 @@ androidx-sqlite = "2.3.1"
 # This is used by the gradle integration tests to get the artifacts locally
 apollo = "4.1.2-SNAPSHOT"
 apollo-execution = "0.1.0"
-apollo-normalizedcache-incubating = "0.0.7"
+apollo-normalizedcache-incubating = "0.0.8"
 # Used by the apollo-tooling project which uses a published version of Apollo
 apollo-published = "4.0.1"
 atomicfu = "0.26.0"

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/normalizedcache/NormalizedCache.kt

@@ -24,6 +24,7 @@ data class NormalizedCache(
     data class CompositeValue(val value: List<Field>) : FieldValue
     data object Null : FieldValue
     data class Reference(val key: String) : FieldValue
+    data class ErrorValue(val message: String) : FieldValue
   }
 
   fun sorted() = NormalizedCache(

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/normalizedcache/provider/ApolloDebugNormalizedCacheProvider.kt

@@ -1,13 +1,13 @@
 package com.apollographql.ijplugin.normalizedcache.provider
 
 import com.apollographql.apollo.api.json.JsonNumber
-import com.apollographql.apollo.cache.normalized.api.CacheKey
 import com.apollographql.ijplugin.apollodebugserver.GetNormalizedCacheQuery
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.Field
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.BooleanValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.CompositeValue
+import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.ErrorValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.ListValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.Null
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.NumberValue
@@ -44,10 +44,18 @@ private fun Any.toFields(): List<Field> {
 private fun Any?.toFieldValue(): FieldValue {
   return when (this) {
     null -> Null
-    is String -> if (CacheKey.canDeserialize(this)) {
-      Reference(CacheKey.deserialize(this).key)
-    } else {
-      StringValue(this)
+    is String -> when {
+      this.startsWith(APOLLO_CACHE_REFERENCE_PREFIX) -> {
+        Reference(this.removePrefix(APOLLO_CACHE_REFERENCE_PREFIX).removeSuffix("}"))
+      }
+
+      this.startsWith(APOLLO_CACHE_ERROR_PREFIX) -> {
+        ErrorValue(this.removePrefix(APOLLO_CACHE_ERROR_PREFIX).removeSuffix("}"))
+      }
+
+      else -> {
+        StringValue(this)
+      }
     }
 
     is Number -> NumberValue(this.toString())
@@ -58,3 +66,6 @@ private fun Any?.toFieldValue(): FieldValue {
     else -> error("Unsupported type ${this::class}")
   }
 }
+
+private const val APOLLO_CACHE_REFERENCE_PREFIX = "ApolloCacheReference{"
+private const val APOLLO_CACHE_ERROR_PREFIX = "ApolloCacheError{"

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/normalizedcache/provider/DatabaseNormalizedCacheProvider.kt

@@ -1,11 +1,14 @@
 package com.apollographql.ijplugin.normalizedcache.provider
 
+import com.apollographql.apollo.api.Error
 import com.apollographql.apollo.api.json.JsonNumber
+import com.apollographql.cache.normalized.api.CacheKey
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.Field
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.BooleanValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.CompositeValue
+import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.ErrorValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.ListValue
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.Null
 import com.apollographql.ijplugin.normalizedcache.NormalizedCache.FieldValue.NumberValue
@@ -25,16 +28,16 @@ import com.apollographql.cache.normalized.sql.SqlNormalizedCacheFactory as Apoll
 class DatabaseNormalizedCacheProvider : NormalizedCacheProvider<File> {
   private enum class DbFormat {
     /**
-     * Classic normalized cache format with records containing JSON text, implemented in
+     * Classic format with records containing JSON text, implemented in
      * `com.apollographql.apollo:apollo-normalized-cache-sqlite`.
      */
-    JSON,
+    CLASSIC,
 
     /**
-     * Experimental blob format with records containing a binary format, implemented in
+     * Modern format with records containing a binary format, implemented in
      * `com.apollographql.cache:normalized-cache-sqlite-incubating`.
      */
-    BLOB,
+    MODERN,
 
     UNKNOWN_OR_ERROR,
   }
@@ -46,14 +49,14 @@ class DatabaseNormalizedCacheProvider : NormalizedCacheProvider<File> {
       runCatching {
         connection.createStatement().executeQuery("SELECT key, record FROM records").use { resultSet ->
           if (resultSet.next()) {
-            return DbFormat.JSON
+            return DbFormat.CLASSIC
           }
         }
       }
       runCatching {
-        connection.createStatement().executeQuery("SELECT key, blob FROM blobs").use { resultSet ->
+        connection.createStatement().executeQuery("SELECT key, record FROM record").use { resultSet ->
           if (resultSet.next()) {
-            return DbFormat.BLOB
+            return DbFormat.MODERN
           }
         }
       }
@@ -66,14 +69,14 @@ class DatabaseNormalizedCacheProvider : NormalizedCacheProvider<File> {
     return runCatching {
       val format = checkDatabase(url)
       when (format) {
-        DbFormat.JSON -> readJsonDb(url)
-        DbFormat.BLOB -> readBlobDb(url)
+        DbFormat.CLASSIC -> readClassicDb(url)
+        DbFormat.MODERN -> readModernDb(url)
         DbFormat.UNKNOWN_OR_ERROR -> error("Empty cache: no records were found")
       }
     }
   }
 
-  private fun readJsonDb(url: String): NormalizedCache {
+  private fun readClassicDb(url: String): NormalizedCache {
     val apolloNormalizedCache: ApolloClassicNormalizedCache = ApolloClassicSqlNormalizedCacheFactory(url).create()
     val apolloRecords: Map<String, ApolloClassicRecord> = apolloNormalizedCache.dump().values.first()
     return NormalizedCache(
@@ -89,13 +92,13 @@ class DatabaseNormalizedCacheProvider : NormalizedCacheProvider<File> {
     )
   }
 
-  private fun readBlobDb(url: String): NormalizedCache {
+  private fun readModernDb(url: String): NormalizedCache {
     val apolloNormalizedCache: ApolloModernNormalizedCache = ApolloModernSqlNormalizedCacheFactory(url).create()
-    val apolloRecords: Map<String, ApolloModernRecord> = apolloNormalizedCache.dump().values.first()
+    val apolloRecords: Map<CacheKey, ApolloModernRecord> = apolloNormalizedCache.dump().values.first()
     return NormalizedCache(
         apolloRecords.map { (key, apolloRecord) ->
           NormalizedCache.Record(
-              key = key,
+              key = key.key,
               fields = apolloRecord.map { (fieldKey, fieldValue) ->
                 Field(fieldKey, fieldValue.toFieldValue())
               },
@@ -117,6 +120,7 @@ private fun Any?.toFieldValue(): FieldValue {
     is Map<*, *> -> CompositeValue(map { Field(it.key as String, it.value.toFieldValue()) })
     is ApolloClassicCacheKey -> Reference(this.key)
     is ApolloModernCacheKey -> Reference(this.key)
+    is Error -> ErrorValue(this.message)
     else -> error("Unsupported type ${this::class}")
   }
 }

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/normalizedcache/ui/FieldTreeTable.kt

@@ -55,6 +55,9 @@ class FieldTreeTable(selectRecord: (String) -> Unit) : JBTreeTable(FieldTreeTabl
                 append("→ ", SimpleTextAttributes.GRAY_ITALIC_ATTRIBUTES)
                 append(v.key, SimpleTextAttributes.LINK_PLAIN_ATTRIBUTES)
               }
+              is NormalizedCache.FieldValue.ErrorValue -> {
+                append("Error: '${v.message}'", SimpleTextAttributes.ERROR_ATTRIBUTES)
+              }
             }
           }
         }