Use Moshi instead of KotlinX Serialization (#574)

* Use Moshi instead of KotlinX Serialization

* Adjust snapshot for testing

* Reset version number

Author: runningcode

gradle/libs.versions.toml

@@ -23,6 +23,7 @@ junit = "1.2.1"
 benchmark-junit4 = "1.3.4"
 mockito = "5.17.0"
 mockito-kotlin = "5.4.0"
+moshi = "1.15.2"
 material3-android = "1.3.2"
 runtime-android = "1.7.6"
 foundation-layout-android = "1.7.6"
@@ -91,6 +92,10 @@ detekt-formatting = { module = "io.gitlab.arturbosch.detekt:detekt-formatting",
 
 google-truth = "com.google.truth:truth:1.4.4"
 
+moshi = { module = "com.squareup.moshi:moshi", version.ref = "moshi" }
+moshi-adapters = { module = "com.squareup.moshi:moshi-adapters", version.ref = "moshi" }
+moshi-kotlin = { module = "com.squareup.moshi:moshi-kotlin", version.ref = "moshi" }
+
 junit4 = "junit:junit:4.13.2"
 junit5-bom = { module = "org.junit:junit-bom", version.ref = "junit-jupiter" }
 junit5-jupiter = { module = "org.junit.jupiter:junit-jupiter" }

snapshots/snapshots/build.gradle.kts

@@ -3,7 +3,6 @@ plugins {
   alias(libs.plugins.compose.compiler)
   alias(libs.plugins.grgit)
   alias(libs.plugins.kotlin.android)
-  alias(libs.plugins.kotlin.serialization)
   `maven-publish`
   signing
 }
@@ -49,7 +48,9 @@ android {
 dependencies {
 
   implementation(libs.junit4)
-  implementation(libs.kotlinx.serialization)
+  implementation(libs.moshi)
+  implementation(libs.moshi.kotlin)
+  implementation(libs.moshi.adapters)
 
   implementation(platform(libs.compose.bom))
   implementation(libs.compose.runtime)

snapshots/snapshots/src/main/kotlin/com/emergetools/snapshots/SnapshotImageMetadata.kt

@@ -1,25 +1,18 @@
 package com.emergetools.snapshots
 
 import com.emergetools.snapshots.models.ComposePreviewSnapshotConfig
-import kotlinx.serialization.ExperimentalSerializationApi
-import kotlinx.serialization.Serializable
-import kotlinx.serialization.json.JsonClassDiscriminator
 
 enum class SnapshotErrorType {
   EMPTY_SNAPSHOT,
   GENERAL,
 }
 
-@OptIn(ExperimentalSerializationApi::class)
-@Serializable
-@JsonClassDiscriminator("metadataType")
 sealed class SnapshotMetadata {
   abstract val name: String
   abstract val displayName: String?
   abstract val fqn: String
   abstract val composePreviewSnapshotConfig: ComposePreviewSnapshotConfig
 
-  @Serializable
   internal class SuccessMetadata(
     // Used as the primary key
     override val name: String,
@@ -33,7 +26,6 @@ sealed class SnapshotMetadata {
     override val composePreviewSnapshotConfig: ComposePreviewSnapshotConfig,
   ) : SnapshotMetadata()
 
-  @Serializable
   internal class ErrorMetadata(
     // Used as the primary key
     override val name: String,

snapshots/snapshots/src/main/kotlin/com/emergetools/snapshots/SnapshotSaver.kt

@@ -7,7 +7,10 @@ import android.util.Log
 import androidx.test.platform.app.InstrumentationRegistry
 import com.emergetools.snapshots.models.ComposePreviewSnapshotConfig
 import com.emergetools.snapshots.util.Profiler
-import kotlinx.serialization.json.Json
+import com.squareup.moshi.Moshi
+import com.squareup.moshi.adapter
+import com.squareup.moshi.adapters.PolymorphicJsonAdapterFactory
+import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
 import java.io.File
 import java.io.FileOutputStream
 import java.nio.charset.Charset
@@ -19,6 +22,23 @@ internal object SnapshotSaver {
   private const val ARG_KEY_SAVE_METADATA = "save_metadata"
   private const val TAG = "SnapshotSaver"
 
+  @OptIn(ExperimentalStdlibApi::class)
+  private val moshiAdapter = Moshi.Builder()
+    .add(
+      PolymorphicJsonAdapterFactory.of(SnapshotMetadata::class.java, "metadataType")
+        .withSubtype(
+          SnapshotMetadata.SuccessMetadata::class.java,
+          "com.emergetools.snapshots.SnapshotMetadata.SuccessMetadata"
+        )
+        .withSubtype(
+          SnapshotMetadata.ErrorMetadata::class.java,
+          "com.emergetools.snapshots.SnapshotMetadata.ErrorMetadata"
+        )
+    )
+    .add(KotlinJsonAdapterFactory())
+    .build()
+    .adapter<SnapshotMetadata>()
+
   private val targetContext: Context
     get() = InstrumentationRegistry.getInstrumentation().targetContext
 
@@ -102,6 +122,7 @@ internal object SnapshotSaver {
     Profiler.endSpan()
   }
 
+  @OptIn(ExperimentalStdlibApi::class)
   private fun saveMetadata(
     snapshotsDir: File,
     keyName: String,
@@ -119,7 +140,7 @@ internal object SnapshotSaver {
     )
 
     Log.d(TAG, "Saving metadata for $keyName")
-    val jsonString = Json.encodeToString(metadata)
+    val jsonString = moshiAdapter.toJson(metadata)
 
     saveFile(snapshotsDir, "$keyName$JSON_EXTENSION") {
       write(jsonString.toByteArray(Charset.defaultCharset()))
@@ -145,7 +166,8 @@ internal object SnapshotSaver {
     )
 
     Log.d(TAG, "Saving error metadata for $keyName")
-    val jsonString = Json.encodeToString(metadata)
+
+    val jsonString = moshiAdapter.toJson(metadata)
 
     saveFile(snapshotsDir, "$keyName$JSON_EXTENSION") {
       write(jsonString.toByteArray(Charset.defaultCharset()))

snapshots/snapshots/src/main/kotlin/com/emergetools/snapshots/compose/EmergeComposeSnapshotReflectiveParameterizedInvoker.kt

@@ -9,7 +9,9 @@ import com.emergetools.snapshots.EmergeSnapshots
 import com.emergetools.snapshots.models.ComposePreviewSnapshotConfig
 import com.emergetools.snapshots.models.ComposeSnapshots
 import com.emergetools.snapshots.util.Profiler
-import kotlinx.serialization.json.Json
+import com.squareup.moshi.Moshi
+import com.squareup.moshi.adapter
+import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -49,6 +51,7 @@ class EmergeComposeSnapshotReflectiveParameterizedInvoker(
     const val ELLIPSIS_SIZE = 3
     const val MAX_PARAM_NAME_LENGTH = 40
 
+    @OptIn(ExperimentalStdlibApi::class)
     @JvmStatic
     @Parameterized.Parameters(name = "{index}_{0}")
     fun data(): Iterable<EmergeComposeSnapshotReflectiveParameters> {
@@ -64,21 +67,22 @@ class EmergeComposeSnapshotReflectiveParameterizedInvoker(
         error("Unable to find file at $invokeDataPath")
       }
 
-      val json = Json {
-        ignoreUnknownKeys = true
-      }
+      val moshi = Moshi.Builder()
+        .add(KotlinJsonAdapterFactory())
+        .build()
+      val adapter = moshi.adapter<List<ComposePreviewSnapshotConfig>>()
 
       val fileContent = invokeDataFile.readText()
       @Suppress("TooGenericExceptionCaught")
       return try {
         // First try to parse directly as List<ComposePreviewSnapshotConfig>
-        json.decodeFromString<List<ComposePreviewSnapshotConfig>>(fileContent).map {
+        adapter.fromJson(invokeDataFile.readText())!!.map {
           EmergeComposeSnapshotReflectiveParameters(it)
         }
       } catch (e: Exception) {
         // Fallback to parsing as ComposeSnapshots
         Log.d(TAG, "Failed to parse as List<ComposePreviewSnapshotConfig>, falling back to ComposeSnapshots", e)
-        json.decodeFromString<ComposeSnapshots>(fileContent).snapshots.map {
+        moshi.adapter<ComposeSnapshots>().fromJson(fileContent)!!.snapshots.map {
           EmergeComposeSnapshotReflectiveParameters(it)
         }
       }

snapshots/snapshots/src/main/kotlin/com/emergetools/snapshots/models/ComposePreviewSnapshotConfig.kt

@@ -1,10 +1,7 @@
 package com.emergetools.snapshots.models
 
-import kotlinx.serialization.Serializable
-
 // Keep parity with
 // https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:compose/ui/ui-tooling-preview/src/androidMain/kotlin/androidx/compose/ui/tooling/preview/Preview.kt
-@Serializable
 data class ComposePreviewSnapshotConfig(
   val fullyQualifiedClassName: String,
   val originalFqn: String,
@@ -75,7 +72,6 @@ data class ComposePreviewSnapshotConfig(
   }
 }
 
-@Serializable
 data class PreviewParameter(
   val parameterName: String,
   val providerClassFqn: String,

snapshots/snapshots/src/main/kotlin/com/emergetools/snapshots/models/ComposeSnapshots.kt

@@ -1,8 +1,5 @@
 package com.emergetools.snapshots.models
 
-import kotlinx.serialization.Serializable
-
-@Serializable
 data class ComposeSnapshots(
   val snapshots: List<ComposePreviewSnapshotConfig>,
 )