refactor(stove-serde): arrow additions to the interface

build.gradle.kts

@@ -74,6 +74,7 @@ subprojects.of("lib", "spring", "examples", "ktor") {
     testImplementation(libs.kotest.runner.junit5)
     testImplementation(libs.kotest.framework.api)
     testImplementation(libs.kotest.property)
+    testImplementation(libs.kotest.arrow)
     detektPlugins(libs.detekt.formatting)
   }
 

gradle/libs.versions.toml

@@ -203,6 +203,7 @@ kotest-runner-junit5 = { module = "io.kotest:kotest-runner-junit5", version.ref
 kotest-property = { module = "io.kotest:kotest-property", version.ref = "kotest" }
 kotest-framework-api = { module = "io.kotest:kotest-framework-api", version.ref = "kotest" }
 ktor-server-tests-jvm = { module = "io.ktor:ktor-server-tests-jvm", version.ref = "ktor" }
+kotest-arrow = { module = "io.kotest.extensions:kotest-assertions-arrow", version = "1.4.0" }
 
 [bundles]
 arrow-stack = ["arrow-core",

lib/stove-testing-e2e/src/main/kotlin/com/trendyol/stove/testing/e2e/serialization/serialization.kt

@@ -1,5 +1,7 @@
 package com.trendyol.stove.testing.e2e.serialization
 
+import arrow.core.*
+
 /**
  * Generic interface for serialization and deserialization operations.
  *
@@ -25,6 +27,17 @@ interface StoveSerde<TIn : Any, TOut : Any> {
    */
   fun <T : TIn> deserialize(value: TOut, clazz: Class<T>): T
 
+  /**
+   * Deserializes data from the target format into the specified type.
+   * Returns an [Either] to indicate success or failure.
+   * @param value The serialized data to deserialize
+   * @param clazz The target class to deserialize into
+   * @return The deserialized object or a [StoveSerdeProblem]
+   */
+  fun <T : TIn> deserializeEither(value: TOut, clazz: Class<T>): Either<StoveSerdeProblem, T> = Either
+    .catch { deserialize(value, clazz) }
+    .mapLeft { StoveSerdeProblem.BecauseOfDeserialization(it.message ?: "Deserialization failed", it) }
+
   /**
    * Companion object containing default configurations and utility functions
    */
@@ -35,8 +48,36 @@ interface StoveSerde<TIn : Any, TOut : Any> {
 
     val kotlinx = StoveKotlinx
 
-    inline fun <TIn : Any, TOut : Any, reified T : TIn> StoveSerde<TIn, TOut>.deserialize(
-      value: TOut
-    ): T = deserialize(value, T::class.java)
+    /**
+     * Deserializes data from the target format into the specified type.
+     */
+    inline fun <reified T : Any> StoveSerde<Any, ByteArray>.deserialize(value: ByteArray): T = deserialize(value, T::class.java)
+
+    /**
+     * Deserializes data from the target format into the specified type.
+     * Returns a [None] if deserialization fails.
+     */
+    inline fun <reified T : Any> StoveSerde<Any, ByteArray>.deserializeOption(value: ByteArray): Option<T> =
+      deserializeEither(value, T::class.java).getOrNone()
+
+    /**
+     * Deserializes data from the target format into the specified type.
+     */
+    inline fun <reified T : Any> StoveSerde<Any, String>.deserialize(value: String): T = deserialize(value, T::class.java)
+
+    /**
+     * Deserializes data from the target format into the specified type.
+     * Returns a [None] if deserialization fails.
+     */
+    inline fun <reified T : Any> StoveSerde<Any, String>.deserializeOption(value: String): Option<T> =
+      deserializeEither(value, T::class.java).getOrNone()
+  }
+
+  sealed class StoveSerdeProblem(message: String, cause: Throwable? = null) : RuntimeException(message, cause) {
+    class BecauseOfSerialization(message: String, cause: Throwable? = null) : StoveSerdeProblem(message, cause)
+
+    class BecauseOfDeserialization(message: String, cause: Throwable? = null) : StoveSerdeProblem(message, cause)
+
+    class BecauseOfDeserializationButExpected(message: String, cause: Throwable? = null) : StoveSerdeProblem(message, cause)
   }
 }

lib/stove-testing-e2e/src/test/kotlin/com/trendyol/stove/testing/e2e/serialization/SerializationTests.kt

@@ -1,12 +1,18 @@
 package com.trendyol.stove.testing.e2e.serialization
 
+import arrow.core.None
 import com.fasterxml.jackson.core.JsonParseException
 import com.fasterxml.jackson.databind.MapperFeature
 import com.google.gson.JsonSyntaxException
+import com.trendyol.stove.testing.e2e.serialization.StoveSerde.Companion.deserialize
+import com.trendyol.stove.testing.e2e.serialization.StoveSerde.Companion.deserializeOption
+import com.trendyol.stove.testing.e2e.serialization.StoveSerde.StoveSerdeProblem
+import io.kotest.assertions.arrow.core.shouldBeLeft
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.*
+import io.kotest.matchers.types.shouldBeInstanceOf
 import kotlinx.serialization.*
 
 class SerializerTest : FunSpec({
@@ -53,6 +59,18 @@ class SerializerTest : FunSpec({
         serializer.deserialize("invalid json", TestData::class.java)
       }
     }
+
+    test("should return None when invalid JSON is deserialized") {
+      val a = serializer.deserializeOption<TestData>("invalid json")
+      a shouldBe None
+    }
+
+    test("should return Left when invalid JSON is deserialized") {
+      val op = serializer.deserializeEither("invalid json", TestData::class.java)
+      op.shouldBeLeft()
+      op.value.message shouldContain "Unrecognized token 'invalid': was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')"
+      op.value.shouldBeInstanceOf<StoveSerdeProblem.BecauseOfDeserialization>()
+    }
   }
 
   context("StoveGsonStringSerializer") {
@@ -89,8 +107,10 @@ class SerializerTest : FunSpec({
     test("should serialize and deserialize object correctly") {
       val serialized = serializer.serialize(testData)
       val deserialized = serializer.deserialize(serialized, TestData::class.java)
+      val deserializedTyped = serializer.deserialize<TestData>(serialized)
 
       deserialized shouldBe testData
+      deserializedTyped shouldBe testData
       serialized shouldContain "\"id\":1"
       serialized shouldContain "\"name\":\"Test Item\""
     }