refactor: improve JSON conversion with error handling

- Added `toObjectRaw` and `toObjectOption` methods to handle errors during JSON decoding with `Either` and `Option`.
- Introduced `shouldLogAsError` flag in `JsonConverter` for customizable logging on decode errors.

Author: QuadStingray

build.sbt

@@ -22,7 +22,7 @@ licenses += ("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0.html
 
 crossScalaVersions := Seq("3.7.0", "2.13.16")
 
-scalaVersion := crossScalaVersions.value.head
+scalaVersion := crossScalaVersions.value.last
 
 scalacOptions ++= Seq("-deprecation")
 //scalacOptions ++= Seq("--Xmax-inlines", "128")

package.json

@@ -1,7 +1,7 @@
 {
   "name" : "mongodb-driver",
   "organization" : "dev.mongocamp",
-  "version" : "3.0.6.snapshot",
+  "version" : "3.0.6",
   "author" : "info@mongocamp.dev",
   "license" : "Apache-2.0",
   "type" : "module",

src/main/scala/dev/mongocamp/driver/mongodb/json/JsonConverter.scala

@@ -7,7 +7,7 @@ import io.circe.syntax._
 import io.circe.Decoder
 import io.circe.Encoder
 
-class JsonConverter(dropNullValues: Boolean = false) extends CirceSchema with LazyLogging {
+class JsonConverter(dropNullValues: Boolean = false, shouldLogAsError: Boolean = false) extends CirceSchema with LazyLogging {
 
   def toJson[A <: Any](s: A)(implicit encoder: Encoder[A]): String = {
     if (dropNullValues) {
@@ -28,12 +28,25 @@ class JsonConverter(dropNullValues: Boolean = false) extends CirceSchema with La
     readJsonMap(fileContent)
   }
 
-  def toObject[A](jsonString: String)(implicit decoder: Decoder[A]): A = {
+  def toObjectRaw[A](jsonString: String)(implicit decoder: Decoder[A]): Either[io.circe.Error, A] = {
     val decodeResponse = decode[A](jsonString)
     if (decodeResponse.isLeft) {
-      logger.warn(s"Error while decoding json: ${decodeResponse.left.get}")
+      if (shouldLogAsError) {
+        logger.error(s"Error while decoding json: ${decodeResponse.left}")
+      }
+      else {
+        logger.debug(s"Error while decoding json: ${decodeResponse.left}")
+      }
     }
-    decodeResponse.getOrElse(null.asInstanceOf[A])
+    decodeResponse
+  }
+
+  def toObject[A](jsonString: String)(implicit decoder: Decoder[A]): A = {
+    toObjectRaw[A](jsonString).getOrElse(null.asInstanceOf[A])
+  }
+
+  def toObjectOption[A](jsonString: String)(implicit decoder: Decoder[A]): Option[A] = {
+    toObjectRaw[A](jsonString).toOption
   }
 
 }

src/test/scala/dev/mongocamp/driver/mongodb/json/JsonConversionSuite.scala

@@ -1,4 +1,8 @@
 package dev.mongocamp.driver.mongodb.json
+import io.circe.ACursor
+import io.circe.DecodingFailure
+import io.circe.ParsingFailure
+import org.typelevel.jawn.IncompleteParseException
 
 case class HelloWorld(greetings: String, name: String)
 case class HelloWorld2(greetings: String, name: String, option: Option[HelloWorld], subClass: List[Long])
@@ -32,6 +36,16 @@ class JsonConversionSuite extends munit.FunSuite {
     assertEquals(jsonConverter.toObject[Array[Int]]("[1,2]").last, Array(1, 2).last)
   }
 
+  test("Try to convert invalid strings") {
+    assertEquals(jsonConverter.toObjectOption[List[String]](""), None)
+    assertEquals(jsonConverter.toObjectOption[List[String]]("{}"), None)
+    assertEquals(
+      jsonConverter.toObjectRaw[List[String]](""),
+      Left(value = ParsingFailure(message = "exhausted input", underlying = IncompleteParseException(msg = "exhausted input")))
+    )
+    assertEquals(jsonConverter.toObjectRaw[List[String]]("{}").left.get.getMessage, "DecodingFailure at : Got value '{}' with wrong type, expecting array")
+  }
+
   test("Convert Json to Case Class") {
     assertEquals(jsonConverter.toObject[HelloWorld]("{\"name\":\"world\", \"greetings\":\"hello\"}"), HelloWorld("hello", "world"))
   }