Handle json nulls in Update and Create (#23)

* Fix Create and Update request models

* Handle json nulls in Update and Create

* Minor changes

Author: KapStorm

spra-api/shared/src/main/scala/net/wiringbits/spra/api/models/AdminCreateTable.scala

@@ -8,7 +8,10 @@ object AdminCreateTable {
   case class Response(id: String)
 
   implicit val adminCreateTableRequestFormat: Format[Request] = Format[Request](
-    fjs = implicitly[Reads[Map[String, String]]].map(Request.apply),
+    // We have to handle null as Options
+    fjs = implicitly[Reads[Map[String, Option[String]]]]
+      .map(handleMapWithOptionalValue)
+      .map(Request.apply),
     tjs = Writes[Request](x => Json.toJson(x.data))
   )
 

spra-api/shared/src/main/scala/net/wiringbits/spra/api/models/AdminUpdateTable.scala

@@ -7,7 +7,10 @@ object AdminUpdateTable {
   case class Response(id: String)
 
   implicit val adminUpdateTableRequestFormat: Format[Request] = Format[Request](
-    fjs = implicitly[Reads[Map[String, String]]].map(Request.apply),
+    // We have to handle null as Options
+    fjs = implicitly[Reads[Map[String, Option[String]]]]
+      .map(handleMapWithOptionalValue)
+      .map(Request.apply),
     tjs = Writes[Request](x => Json.toJson(x.data))
   )
 

spra-api/shared/src/main/scala/net/wiringbits/spra/api/models/package.scala

@@ -3,6 +3,7 @@ package net.wiringbits.spra.api
 import play.api.libs.json.*
 
 import java.time.Instant
+import scala.language.implicitConversions
 
 package object models {
 
@@ -18,4 +19,15 @@ package object models {
 
   case class ErrorResponse(error: String)
   implicit val errorResponseFormat: Format[ErrorResponse] = Json.format[ErrorResponse]
+
+  implicit def optionFormat[T](using formatter: Format[T]): Format[Option[T]] = Format[Option[T]](
+    fjs = Reads[Option[T]](_.validateOpt[T]),
+    tjs = Writes[Option[T]] {
+      case Some(value) => Json.toJson(value)
+      case None => Json.toJson("")
+    }
+  )
+
+  def handleMapWithOptionalValue(map: Map[String, Option[String]]): Map[String, String] =
+    map.collect { case (key, Some(value)) => key -> value }
 }

spra-play-server/src/test/scala/controllers/AdminControllerSpec.scala

@@ -669,6 +669,18 @@ class AdminControllerSpec extends PlayPostgresSpec with AdminUtils {
       }
     }
 
+    "don't fail if we send a null in an optional parameter" in withApiClient { client =>
+      val json = """{"name":"wiringbits","email":null,"password":"wiringbits"}"""
+      val path = s"/admin/tables/${usersSettings.tableName}"
+      val response = POST(path, json).futureValue
+      response.header.status mustBe 200
+
+      val responseMetadata =
+        client.getTableMetadata(usersSettings.tableName, List("name", "ASC"), List(0, 9), "{}").futureValue
+
+      responseMetadata.head.nonEmpty mustBe true
+    }
+    
     "return new user id" in withApiClient { implicit client =>
       val user = createUser.futureValue
       val response = client.getTableMetadata(usersSettings.tableName, List("name", "ASC"), List(0, 9), "{}").futureValue
@@ -788,6 +800,27 @@ class AdminControllerSpec extends PlayPostgresSpec with AdminUtils {
       }
     }
 
+    "don't fail if we send a null in an optional parameter" in withApiClient { client =>
+      val name = "wiringbits"
+      val email = "[email protected]"
+      val password = "wiringbits"
+      val request = AdminCreateTable.Request(Map("name" -> name, "email" -> email, "password" -> password))
+      client.createItem("users", request).futureValue
+      val responseMetadata1 =
+        client.getTableMetadata(usersSettings.tableName, List("name", "ASC"), List(0, 9), "{}").futureValue
+      val id = responseMetadata1.head("id")
+
+      val json = """{"email":null}"""
+      val path = s"/admin/tables/${usersSettings.tableName}/$id"
+      val response = PUT(path, json).futureValue
+      response.header.status mustBe 200
+
+      val responseMetadata2 =
+        client.getTableMetadata(usersSettings.tableName, List("name", "ASC"), List(0, 9), "{}").futureValue
+
+      responseMetadata2.head("email") mustBe ""
+    }
+
     "fail if the field in body doesn't exists" in withApiClient { client =>
       val request = AdminCreateTable.Request(
         Map("name" -> "wiringbits", "email" -> "[email protected]", "password" -> "wiringbits")