Fix json formatting, add transaction endpoints

azavea · moradology · Sep 26, 2022 · May 11, 2022 · May 12, 2022 · May 11, 2022
commit 6d18c1a78ce7d7fd96d9b350842c119e209be32f
diff --git a/application/src/main/scala/com/azavea/franklin/api/FranklinJsonPrinter.scala b/application/src/main/scala/com/azavea/franklin/api/FranklinJsonPrinter.scala
@@ -0,0 +1,13 @@
+package com.azavea.franklin.api
+
+import sttp.tapir.json.circe._
+import io.circe.Printer
+
+
+  // This custom json printing implementation for tapir is based
+  //  on https://tapir.softwaremill.com/en/latest/endpoint/json.html#circe
+object FranklinJsonPrinter extends TapirJsonCirce {
+  // NOTE: the contents of this object should be imported for *tapir endpoints* rather than
+  //  http4s services e.g. SearchEndpoints.scala but not SearchService.scala
+  override def jsonPrinter: Printer = Printer.spaces2.copy(dropNullValues = true)
+}
diff --git a/application/src/main/scala/com/azavea/franklin/api/endpoints/CollectionEndpoints.scala b/application/src/main/scala/com/azavea/franklin/api/endpoints/CollectionEndpoints.scala
@@ -1,18 +1,18 @@
 package com.azavea.franklin.api.endpoints
 
-import cats.effect.Concurrent
+import com.azavea.franklin.api.FranklinJsonPrinter._
 import com.azavea.franklin.api.schemas._
 import com.azavea.franklin.datamodel.{CollectionsResponse, MosaicDefinition}
 import com.azavea.franklin.datamodel.stactypes.{Collection}
 import com.azavea.franklin.error.NotFound
-import com.azavea.stac4s.StacCollection
+
+import cats.effect.Concurrent
 import io.circe._
 import sttp.capabilities.fs2.Fs2Streams
 import sttp.model.StatusCode
 import sttp.model.StatusCode.{NotFound => NF}
 import sttp.tapir._
 import sttp.tapir.generic.auto._
-import sttp.tapir.json.circe._
 
 import java.util.UUID
 
@@ -25,6 +25,14 @@ class CollectionEndpoints[F[_]: Concurrent](
 
   val base = endpoint.in(basePath)
 
+  val collectionUnique: Endpoint[String, NotFound, Collection, Fs2Streams[F]] =
+    base.get
+      .in(path[String])
+      .out(jsonBody[Collection])
+      .errorOut(oneOf(statusMapping(NF, jsonBody[NotFound].description("not found"))))
+      .description("A single collection")
+      .name("collectionUnique")
+
   val collectionsList: Endpoint[Unit, Unit, CollectionsResponse, Fs2Streams[F]] =
     base.get
       .out(jsonBody[CollectionsResponse])
@@ -54,19 +62,11 @@ class CollectionEndpoints[F[_]: Concurrent](
       .name("putCollection")
 
   val deleteCollection: Endpoint[String, NotFound, Unit, Fs2Streams[F]] =
-    base.get
+    base.delete
       .in(path[String])
       .errorOut(oneOf(statusMapping(NF, jsonBody[NotFound].description("not found"))))
       .name("collectionDelete")
 
-  val collectionUnique: Endpoint[String, NotFound, Collection, Fs2Streams[F]] =
-    base.get
-      .in(path[String])
-      .out(jsonBody[Collection])
-      .errorOut(oneOf(statusMapping(NF, jsonBody[NotFound].description("not found"))))
-      .description("A single collection")
-      .name("collectionUnique")
-
   val endpoints = List(collectionsList, collectionUnique) ++ {
     if (enableTransactions) List(postCollection, putCollection, deleteCollection) else Nil
   }

diff --git a/application/src/main/scala/com/azavea/franklin/api/endpoints/ItemEndpoints.scala b/application/src/main/scala/com/azavea/franklin/api/endpoints/ItemEndpoints.scala
@@ -1,6 +1,6 @@
 package com.azavea.franklin.api.endpoints
 
-import cats.effect.Concurrent
+import com.azavea.franklin.api.FranklinJsonPrinter._
 import com.azavea.franklin.api.schemas._
 import com.azavea.franklin.datamodel.IfMatchMode
 import com.azavea.franklin.datamodel.PaginationToken
@@ -11,7 +11,9 @@ import com.azavea.franklin.error.{
   NotFound,
   ValidationError
 }
+
 import com.azavea.stac4s.StacItem
+import cats.effect.Concurrent
 import eu.timepit.refined.types.numeric.NonNegInt
 import io.circe.{Codec => _, _}
 import sttp.capabilities.fs2.Fs2Streams
@@ -20,7 +22,7 @@ import sttp.model.StatusCode.{NotFound => NF, BadRequest, PreconditionFailed}
 import sttp.tapir._
 import sttp.tapir.codec.refined._
 import sttp.tapir.generic.auto._
-import sttp.tapir.json.circe._
+
 
 class ItemEndpoints[F[_]: Concurrent](
     defaultLimit: NonNegInt,

diff --git a/application/src/main/scala/com/azavea/franklin/api/endpoints/SearchEndpoints.scala b/application/src/main/scala/com/azavea/franklin/api/endpoints/SearchEndpoints.scala
@@ -1,11 +1,12 @@
 package com.azavea.franklin.api.endpoints
 
+import com.azavea.franklin.api.FranklinJsonPrinter._
 import com.azavea.franklin.api.schemas._
 import com.azavea.franklin.database._
-import com.azavea.franklin.datamodel.{PaginationToken, SearchParameters}
+import com.azavea.franklin.datamodel.{PaginationToken, SearchParameters, StacSearchCollection}
 import com.azavea.franklin.commands.ApiConfig
-import com.azavea.stac4s.{Bbox, TemporalExtent}
 
+import com.azavea.stac4s.{Bbox, TemporalExtent}
 import cats.effect._
 import eu.timepit.refined.types.numeric.NonNegInt
 import geotrellis.vector.Geometry
@@ -16,7 +17,6 @@ import sttp.capabilities.fs2.Fs2Streams
 import sttp.tapir._
 import sttp.tapir.codec.refined._
 import sttp.tapir.generic.auto._
-import sttp.tapir.json.circe._
 
 class SearchEndpoints[F[_]: Concurrent](apiConfig: ApiConfig) {
 
@@ -97,19 +97,19 @@ class SearchEndpoints[F[_]: Concurrent](apiConfig: ApiConfig) {
   val searchPostInput: EndpointInput[SearchParameters] =
     jsonBody[SearchParameters]
 
-  val searchGet: Endpoint[SearchParameters, Unit, Json, Fs2Streams[F]] =
+  val searchGet: Endpoint[SearchParameters, Unit, StacSearchCollection, Fs2Streams[F]] =
     base
       .get
       .in(searchParameters)
-      .out(jsonBody[Json])
+      .out(jsonBody[StacSearchCollection])
       .description("Search endpoint for all collections")
       .name("search-get")
 
-  val searchPost: Endpoint[SearchParameters, Unit, Json, Fs2Streams[F]] =
+  val searchPost: Endpoint[SearchParameters, Unit, StacSearchCollection, Fs2Streams[F]] =
     base
       .post
       .in(searchPostInput)
-      .out(jsonBody[Json])
+      .out(jsonBody[StacSearchCollection])
       .description("Search endpoint using POST for all collections")
       .name("search-post")
 

diff --git a/application/src/main/scala/com/azavea/franklin/api/implicits/package.scala b/application/src/main/scala/com/azavea/franklin/api/implicits/package.scala
diff --git a/application/src/main/scala/com/azavea/franklin/api/services/CollectionsService.scala b/application/src/main/scala/com/azavea/franklin/api/services/CollectionsService.scala
@@ -1,18 +1,18 @@
 package com.azavea.franklin.api.services
 
-import cats.data.EitherT
-import cats.effect._
-import cats.effect.concurrent.Ref
-import cats.syntax.all._
 import com.azavea.franklin.commands.ApiConfig
 import com.azavea.franklin.api.endpoints.CollectionEndpoints
-import com.azavea.franklin.api.implicits._
 import com.azavea.franklin.database.PGStacQueries
-import com.azavea.franklin.datamodel.{CollectionsResponse, MosaicDefinition, TileInfo}
+import com.azavea.franklin.datamodel.{CollectionsResponse, MosaicDefinition, TileInfo, Link}
 import com.azavea.franklin.datamodel.stactypes.Collection
 import com.azavea.franklin.error.{NotFound => NF}
 import com.azavea.franklin.extensions.validation._
 import com.azavea.stac4s._
+
+import cats.data.EitherT
+import cats.effect._
+import cats.effect.concurrent.Ref
+import cats.syntax.all._
 import doobie._
 import doobie.implicits._
 import doobie.util.transactor.Transactor
@@ -31,12 +31,13 @@ import java.net.{URLDecoder, URLEncoder}
 import java.nio.charset.StandardCharsets
 import java.util.UUID
 
+
 case class AddCollectionLinks(apiConfig: ApiConfig) {
 
   val _collectionId = root.id.string
 
-  def createSelfLink(collection: Collection): StacLink = {
-    StacLink(
+  def createSelfLink(collection: Collection): Link = {
+    Link(
       s"${apiConfig.apiHost}/collections/${collection.id}",
       StacLinkType.Self,
       Some(`application/json`),
@@ -70,8 +71,8 @@ class CollectionsService[F[_]: Concurrent](
       collections <- PGStacQueries.listCollections().transact(xa)
       collectionsWithLinks = collections.map(addCollectionLinks(_))
     } yield {
-      val childLinks: List[StacLink] = collectionsWithLinks.map({ coll: Collection =>
-        StacLink(
+      val childLinks: List[Link] = collectionsWithLinks.map({ coll: Collection =>
+        Link(
           s"${apiConfig.apiHost}/collections/${coll.id}",
           StacLinkType.Child,
           Some(`application/json`),
@@ -114,50 +115,17 @@ class CollectionsService[F[_]: Concurrent](
       Right(collection)
     }
   }
-  // {
-  //   val newCollection = collection.copy(links =
-  //     collection.links.filter({ link =>
-  //       !Set[StacLinkType](StacLinkType.Item, StacLinkType.StacRoot, StacLinkType.Self)
-  //         .contains(link.rel)
-  //     }) ++
-  //       List(
-  //         StacLink(
-  //           s"$apiHost/collections/${collection.id}",
-  //           StacLinkType.Self,
-  //           Some(`application/json`),
-  //           collection.title
-  //         ),
-  //         StacLink(
-  //           s"$apiHost",
-  //           StacLinkType.StacRoot,
-  //           Some(`application/json`),
-  //           None
-  //         )
-  //       )
-  //   )
-  //   for {
-  //     inserted  <- StacCollectionDao.insertStacCollection(newCollection, None).transact(xa)
-  //     validator <- makeCollectionValidator(inserted.stacExtensions, collectionExtensionsRef)
-  //   } yield Right(validator(inserted).asJson.dropNullValues)
-  // }
-
-  def deleteCollection(rawCollectionId: String): F[Either[NF, Unit]] = ???
-  // {
-  //   val collectionId = URLDecoder.decode(rawCollectionId, StandardCharsets.UTF_8.toString)
-  //   for {
-  //     collectionOption <- StacCollectionDao
-  //       .getCollection(collectionId)
-  //       .transact(xa)
-  //     deleted <- collectionOption traverse { _ =>
-  //       StacCollectionDao.query.filter(fr"id = $collectionId").delete.transact(xa).void
-  //     }
-  //   } yield {
-  //     Either.fromOption(
-  //       deleted,
-  //       NF(s"Collection $collectionId not found")
-  //     )
-  //   }
-  // }
+
+  def deleteCollection(rawCollectionId: String): F[Either[NF, Unit]] = {
+    val collectionId = URLDecoder.decode(rawCollectionId, StandardCharsets.UTF_8.toString)
+    try {
+      for {
+        queryResult <- PGStacQueries.deleteCollection(collectionId).attempt.transact(xa)
+      } yield {
+        queryResult.leftMap { _ => NF(s"Collection ID $collectionId not found") }
+      }
+    }
+  }
 
   val collectionEndpoints =
     new CollectionEndpoints[F](enableTransactions, apiConfig.path)