feat(prism-agent): implement pagination with navigation for schema-re…

…gistry (#195)

prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/RequestContext.scala

@@ -0,0 +1,5 @@
+package io.iohk.atala.api.http
+
+import sttp.tapir.model.ServerRequest
+
+case class RequestContext(request: ServerRequest)

prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/model/CollectionStats.scala

@@ -0,0 +1,3 @@
+package io.iohk.atala.api.http.model
+
+case class CollectionStats(totalCount: Int, filteredCount: Int)

prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/model/PaginationInput.scala

@@ -0,0 +1,27 @@
+package io.iohk.atala.api.http.model
+
+import sttp.tapir.Codec.PlainCodec
+import sttp.tapir.generic.auto.*
+import sttp.tapir.{Codec, DecodeResult, Schema}
+import zio.json.{DeriveJsonDecoder, DeriveJsonEncoder}
+
+import java.time.ZonedDateTime
+import java.util.{Base64, UUID}
+import scala.util.Try
+
+case class PaginationInput(
+    offset: Option[Int] = None,
+    limit: Option[Int] = None
+) {
+  def toPagination = Pagination.apply(this)
+}
+
+case class Pagination(offset: Int, limit: Int) {
+  def next = copy(offset = offset + limit)
+  def prev = copy(offset = Math.max(offset - limit, 0))
+}
+
+object Pagination {
+  def apply(in: PaginationInput): Pagination =
+    Pagination(in.offset.getOrElse(0), in.limit.getOrElse(100))
+}

prism-agent/service/server/src/main/scala/io/iohk/atala/pollux/schema/SchemaRegistryEndpoints.scala

@@ -1,14 +1,15 @@
 package io.iohk.atala.pollux.schema
 
-import io.iohk.atala.api.http.model.{Order, Pagination}
-import io.iohk.atala.api.http.{BadRequest, FailureResponse, InternalServerError, NotFoundResponse}
+import io.iohk.atala.api.http.model.{Order, PaginationInput}
+import io.iohk.atala.api.http.{BadRequest, FailureResponse, InternalServerError, NotFoundResponse, RequestContext}
 import io.iohk.atala.pollux.schema.model.{
   VerifiableCredentialSchema,
-  VerificationCredentialSchemaInput,
-  VerifiableCredentialSchemaPage
+  VerifiableCredentialSchemaPage,
+  VerifiableCredentialSchemaInput
 }
-import io.iohk.atala.api.http.codec.OrderCodec._
+import io.iohk.atala.api.http.codec.OrderCodec.*
 import sttp.tapir.EndpointIO.Info
+import sttp.tapir.extractFromRequest
 import sttp.tapir.json.zio.jsonBody
 import sttp.tapir.{
   Endpoint,
@@ -31,15 +32,16 @@ import java.util.UUID
 object SchemaRegistryEndpoints {
 
   val createSchemaEndpoint: PublicEndpoint[
-    VerificationCredentialSchemaInput,
+    (RequestContext, VerifiableCredentialSchemaInput),
     FailureResponse,
     VerifiableCredentialSchema,
     Any
   ] =
     endpoint.post
+      .in(extractFromRequest[RequestContext](RequestContext.apply))
       .in("schema-registry" / "schemas")
       .in(
-        jsonBody[VerificationCredentialSchemaInput]
+        jsonBody[VerifiableCredentialSchemaInput]
           .copy(info =
             Info.empty.description(
               "Create schema input object with the metadata and attributes"
@@ -64,12 +66,13 @@ object SchemaRegistryEndpoints {
       .tag("Schema Registry")
 
   val getSchemaByIdEndpoint: PublicEndpoint[
-    UUID,
+    (RequestContext, UUID),
     FailureResponse,
     VerifiableCredentialSchema,
     Any
   ] =
     endpoint.get
+      .in(extractFromRequest[RequestContext](RequestContext.apply))
       .in(
         "schema-registry" / "schemas" / path[UUID]("id")
           .copy(info = Info.empty.description("Get the schema by id"))
@@ -88,12 +91,18 @@ object SchemaRegistryEndpoints {
       .tag("Schema Registry")
 
   val lookupSchemasByQueryEndpoint: PublicEndpoint[
-    (VerifiableCredentialSchema.Filter, Pagination, Option[Order]),
+    (
+        RequestContext,
+        VerifiableCredentialSchema.Filter,
+        PaginationInput,
+        Option[Order]
+    ),
     FailureResponse,
     VerifiableCredentialSchemaPage,
     Any
   ] =
     endpoint.get
+      .in(extractFromRequest[RequestContext](RequestContext.apply))
       .in("schema-registry" / "schemas".description("Lookup schemas by query"))
       .in(
         query[Option[String]]("author")
@@ -108,7 +117,7 @@ object SchemaRegistryEndpoints {
       .in(
         query[Option[Int]]("offset")
           .and(query[Option[Int]]("limit"))
-          .mapTo[Pagination]
+          .mapTo[PaginationInput]
       )
       .in(query[Option[Order]]("order"))
       .out(jsonBody[VerifiableCredentialSchemaPage])
@@ -126,4 +135,25 @@ object SchemaRegistryEndpoints {
         "Lookup schemas by `author`, `name`, `tags` parameters and control the pagination by `offset` and `limit` parameters "
       )
       .tag("Schema Registry")
+
+  val testEndpoint: PublicEndpoint[
+    RequestContext,
+    Unit,
+    String,
+    Any
+  ] =
+    endpoint.get
+      .in(
+        "schema-registry" / "test"
+          .copy(info = Info.empty.description("Debug endpoint"))
+      )
+      .in(extractFromRequest[RequestContext](RequestContext.apply))
+      .out(jsonBody[String])
+      .name("test")
+      .summary("Trace the request input from the point of view of the server")
+      .description(
+        "Trace the request input from the point of view of the server"
+      )
+      .tag("Schema Registry")
+
 }

prism-agent/service/server/src/main/scala/io/iohk/atala/pollux/schema/SchemaRegistryServerEndpoints.scala

@@ -1,13 +1,18 @@
 package io.iohk.atala.pollux.schema
 
-import io.iohk.atala.api.http.model.{Order, Pagination}
-import io.iohk.atala.api.http.{FailureResponse, InternalServerError, NotFoundResponse}
+import io.iohk.atala.api.http.model.{CollectionStats, Order, Pagination, PaginationInput}
+import io.iohk.atala.api.http.{FailureResponse, InternalServerError, NotFoundResponse, RequestContext}
 import io.iohk.atala.pollux.schema.SchemaRegistryEndpoints.{
   createSchemaEndpoint,
   getSchemaByIdEndpoint,
-  lookupSchemasByQueryEndpoint
+  lookupSchemasByQueryEndpoint,
+  testEndpoint
+}
+import io.iohk.atala.pollux.schema.model.{
+  VerifiableCredentialSchema,
+  VerifiableCredentialSchemaInput,
+  VerifiableCredentialSchemaPage
 }
-import io.iohk.atala.pollux.schema.model.VerifiableCredentialSchema
 import io.iohk.atala.pollux.service.SchemaRegistryService
 import io.iohk.atala.pollux.service.SchemaRegistryService.{createSchema, getSchemaById, lookupSchemas}
 import sttp.tapir.redoc.RedocUIOptions
@@ -16,6 +21,7 @@ import sttp.tapir.server.ServerEndpoint
 import sttp.tapir.swagger.bundle.SwaggerInterpreter
 import sttp.tapir.ztapir.*
 import zio.{Task, URIO, ZIO, ZLayer}
+import io.iohk.atala.pollux.schema.controller.SchemaRegistryController
 
 import java.util.UUID
 
@@ -27,48 +33,77 @@ class SchemaRegistryServerEndpoints(
 
   // TODO: make the endpoint typed ZServerEndpoint[SchemaRegistryService, Any]
   val createSchemaServerEndpoint: ZServerEndpoint[Any, Any] =
-    createSchemaEndpoint.zServerLogic(schemaInput =>
-      schemaRegistryService
-        .createSchema(schemaInput)
-        .foldZIO(throwableToInternalServerError, schema => ZIO.succeed(schema))
-    )
+    createSchemaEndpoint.zServerLogic {
+      case (
+            ctx: RequestContext,
+            schemaInput: VerifiableCredentialSchemaInput
+          ) =>
+        schemaRegistryService
+          .createSchema(schemaInput)
+          .foldZIO(
+            throwableToInternalServerError,
+            schema =>
+              ZIO.succeed(
+                schema.withBaseUri(ctx.request.uri)
+              )
+          )
+    }
 
   val getSchemaByIdServerEndpoint: ZServerEndpoint[Any, Any] =
-    getSchemaByIdEndpoint.zServerLogic(id =>
+    getSchemaByIdEndpoint.zServerLogic { case (ctx: RequestContext, id: UUID) =>
       schemaRegistryService
         .getSchemaById(id)
         .foldZIO(
           throwableToInternalServerError,
           {
-            case Some(schema) => ZIO.succeed(schema)
+            case Some(schema) =>
+              ZIO.succeed(schema.withSelf(ctx.request.uri.toString))
             case None =>
               ZIO.fail[FailureResponse](
                 NotFoundResponse(s"Schema is not found by $id")
               )
           }
         )
-    )
+    }
 
   val lookupSchemasByQueryServerEndpoint: ZServerEndpoint[Any, Any] =
     lookupSchemasByQueryEndpoint.zServerLogic {
       case (
+            ctx: RequestContext,
             filter: VerifiableCredentialSchema.Filter,
-            page: Pagination,
+            paginationInput: PaginationInput,
             order: Option[Order]
           ) =>
         schemaRegistryService
-          .lookupSchemas(filter, page, order)
+          .lookupSchemas(filter, paginationInput.toPagination, order)
           .foldZIO(
             throwableToInternalServerError,
-            pageOfVCS => ZIO.succeed(pageOfVCS)
+            {
+              case (
+                    page: VerifiableCredentialSchemaPage,
+                    stats: CollectionStats
+                  ) =>
+                ZIO.succeed(
+                  SchemaRegistryController(
+                    ctx,
+                    paginationInput.toPagination,
+                    page,
+                    stats
+                  ).result
+                )
+            }
           )
     }
 
+  val testServerEndpoint: ZServerEndpoint[Any, Any] =
+    testEndpoint.zServerLogic(requestContext => ZIO.succeed(requestContext.request.toString))
+
   val all: List[ZServerEndpoint[Any, Any]] =
     List(
       createSchemaServerEndpoint,
       getSchemaByIdServerEndpoint,
-      lookupSchemasByQueryServerEndpoint
+      lookupSchemasByQueryServerEndpoint,
+      testServerEndpoint
     )
 }
 

prism-agent/service/server/src/main/scala/io/iohk/atala/pollux/schema/VerificationPolicyEndpoints.scala

@@ -1,11 +1,11 @@
 package io.iohk.atala.pollux.schema
 
 import io.iohk.atala.api.http.codec.OrderCodec.*
-import io.iohk.atala.api.http.model.{Order, Pagination}
+import io.iohk.atala.api.http.model.{Order, PaginationInput}
 import io.iohk.atala.api.http.{BadRequest, FailureResponse, InternalServerError, NotFoundResponse}
 import io.iohk.atala.pollux.schema.model.{
   VerifiableCredentialSchema,
-  VerificationCredentialSchemaInput,
+  VerifiableCredentialSchemaInput,
   VerifiableCredentialSchemaPage
 }
 import io.iohk.atala.pollux.schema.model.{
@@ -143,7 +143,7 @@ object VerificationPolicyEndpoints {
       .tag("Verification")
 
   val lookupVerificationPoliciesByQueryEndpoint: PublicEndpoint[
-    (VerificationPolicy.Filter, Pagination, Option[Order]),
+    (VerificationPolicy.Filter, PaginationInput, Option[Order]),
     FailureResponse,
     VerificationPolicyPage,
     Any
@@ -169,7 +169,7 @@ object VerificationPolicyEndpoints {
       .in(
         query[Option[Int]]("offset")
           .and(query[Option[Int]]("limit"))
-          .mapTo[Pagination]
+          .mapTo[PaginationInput]
       )
       .in(query[Option[Order]]("order"))
       .out(jsonBody[VerificationPolicyPage])

prism-agent/service/server/src/main/scala/io/iohk/atala/pollux/schema/VerificationPolicyServerEndpoints.scala

@@ -1,6 +1,6 @@
 package io.iohk.atala.pollux.schema
 
-import io.iohk.atala.api.http.model.{Order, Pagination}
+import io.iohk.atala.api.http.model.{Order, PaginationInput}
 import io.iohk.atala.api.http.{FailureResponse, InternalServerError, NotFoundResponse}
 import io.iohk.atala.pollux.schema.VerificationPolicyEndpoints.*
 import io.iohk.atala.pollux.schema.model.{VerificationPolicy, VerificationPolicyInput}
@@ -81,7 +81,7 @@ class VerificationPolicyServerEndpoints(
     lookupVerificationPoliciesByQueryEndpoint.zServerLogic {
       case (
             filter: VerificationPolicy.Filter,
-            page: Pagination,
+            page: PaginationInput,
             order: Option[Order]
           ) =>
         service