Merge 854b99d into c4864bb

CHANGELOG

@@ -1,3 +1,11 @@
+Version 3.3.0 (2023-05-30)
+--------------------------
+Embedded and in-memory lookups should be common across http modules (#244)
+Take superseding schema into account during validation (#231)
+Apps should explicitly import java.net.http.HttpClient instances of RegistryLookup (#241)
+Resolver caches suffers from races and http server overload during the cold start (#227)
+Ignore `$ref` keyword referencing HTTP resources (#238)
+
 Version 2.2.1 (2023-01-24)
 --------------------------
 Update links in Readme (#205)

README.md

@@ -11,12 +11,12 @@ Iglu Scala Client is used extensively in **[Snowplow][snowplow-repo]** to valida
 
 ## Installation
 
-The latest version of Iglu Scala Client is 2.2.1, which works with Scala 2.12, 2.13, and 3.
+The latest version of Iglu Scala Client is 3.0.0, which works with Scala 2.12, 2.13, and 3.
 
 If you're using SBT, add the following lines to your build file:
 
 ```scala
-val igluClient = "com.snowplowanalytics" %% "iglu-scala-client" % "2.2.1"
+val igluClient = "com.snowplowanalytics" %% "iglu-scala-client" % "3.0.0"
 ```
 
 ## API
@@ -65,8 +65,7 @@ import cats.syntax.show._
 
 import com.snowplowanalytics.iglu.client.Client
 import com.snowplowanalytics.iglu.core.{SchemaKey, SchemaVer, SelfDescribingData}
-
-implicit val clockIoInstance: Clock[IO] = Clock.create[IO] // Usually provided by IOApp
+import com.snowplowanalytics.iglu.client.resolver.registries.JavaNetRegistryLookup._
 
 val resolverConfig: Json = json"""{
   "schema": "iglu:com.snowplowanalytics.iglu/resolver-config/jsonschema/1-0-1",

modules/core/src/main/scala/com.snowplowanalytics.iglu/client/Client.scala

@@ -17,7 +17,7 @@ import cats.data.EitherT
 import cats.effect.{Clock, IO}
 import io.circe.{DecodingFailure, Json}
 import com.snowplowanalytics.iglu.core.SelfDescribingData
-import resolver.{InitListCache, InitSchemaCache}
+import resolver.CreateResolverCache
 import resolver.registries.{Registry, RegistryLookup}
 
 /**
@@ -39,9 +39,9 @@ final case class Client[F[_], A](resolver: Resolver[F], validator: Validator[A])
     for {
       schema <- EitherT(resolver.lookupSchema(instance.schema))
       schemaValidation = validator.validateSchema(schema)
-      _ <- EitherT.fromEither[F](schemaValidation).leftMap(_.toClientError)
+      _ <- EitherT.fromEither[F](schemaValidation).leftMap(_.toClientError(None))
       validation = validator.validate(instance.data, schema)
-      _ <- EitherT.fromEither[F](validation).leftMap(_.toClientError)
+      _ <- EitherT.fromEither[F](validation).leftMap(_.toClientError(None))
     } yield ()
 }
 
@@ -51,7 +51,7 @@ object Client {
   val IgluCentral: Client[IO, Json] =
     Client[IO, Json](Resolver(List(Registry.IgluCentral), None), CirceValidator)
 
-  def parseDefault[F[_]: Monad: InitSchemaCache: InitListCache](
+  def parseDefault[F[_]: Monad: CreateResolverCache](
     json: Json
   ): EitherT[F, DecodingFailure, Client[F, Json]] =
     EitherT(Resolver.parse[F](json)).map { resolver =>

modules/core/src/main/scala/com.snowplowanalytics.iglu/client/IgluCirceClient.scala

@@ -17,7 +17,8 @@ import cats.data.EitherT
 import cats.effect.Clock
 import cats.implicits._
 import com.snowplowanalytics.iglu.client.resolver.registries.RegistryLookup
-import com.snowplowanalytics.iglu.client.resolver.{InitListCache, InitSchemaCache}
+import com.snowplowanalytics.iglu.client.resolver.CreateResolverCache
+import com.snowplowanalytics.iglu.client.resolver.Resolver.SupersededBy
 import com.snowplowanalytics.iglu.client.validator.CirceValidator.WithCaching.{
   InitValidatorCache,
   SchemaEvaluationCache,
@@ -43,18 +44,24 @@ final class IgluCirceClient[F[_]] private (
     M: Monad[F],
     L: RegistryLookup[F],
     C: Clock[F]
-  ): EitherT[F, ClientError, Unit] =
+  ): EitherT[F, ClientError, SupersededBy] =
     for {
-      resolverResult <- EitherT(resolver.lookupSchemaResult(instance.schema))
+      resolverResult <- EitherT(
+        resolver.lookupSchemaResult(instance.schema, resolveSupersedingSchema = true)
+      )
       validation =
         CirceValidator.WithCaching.validate(schemaEvaluationCache)(instance.data, resolverResult)
-      _ <- EitherT(validation).leftMap(_.toClientError)
-    } yield ()
+      _ <- EitherT(validation).leftMap(e =>
+        e.toClientError(resolverResult.value.supersededBy.map(_.asString))
+      )
+      // Returning superseding schema info as well since we want to inform caller that sdj is validated
+      // against superseding schema if it is superseded by another schema.
+    } yield resolverResult.value.supersededBy
 }
 
 object IgluCirceClient {
 
-  def parseDefault[F[_]: Monad: InitSchemaCache: InitListCache: InitValidatorCache](
+  def parseDefault[F[_]: Monad: CreateResolverCache: InitValidatorCache](
     json: Json
   ): EitherT[F, DecodingFailure, IgluCirceClient[F]] =
     for {

modules/core/src/main/scala/com.snowplowanalytics.iglu/client/resolver/CreateResolverCache.scala

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2018-2023 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+package com.snowplowanalytics.iglu.client.resolver
+
+import cats.Id
+import cats.effect.Async
+import cats.effect.std.Mutex
+import cats.implicits._
+import com.snowplowanalytics.lrumap.{CreateLruMap, LruMap}
+import com.snowplowanalytics.iglu.core.SchemaKey
+
+trait CreateResolverCache[F[_]] {
+
+  def createSchemaCache(size: Int): F[LruMap[F, SchemaKey, SchemaCacheEntry]]
+
+  def createSchemaListCache(size: Int): F[LruMap[F, ListCacheKey, ListCacheEntry]]
+
+  def createMutex[K]: F[ResolverMutex[F, K]]
+
+}
+
+object CreateResolverCache {
+
+  def apply[F[_]](implicit instance: CreateResolverCache[F]): CreateResolverCache[F] = instance
+
+  private trait SimpleCreateResolverCache[F[_]] extends CreateResolverCache[F] {
+
+    def createLruMap[K, V](size: Int): F[LruMap[F, K, V]]
+
+    override def createSchemaCache(size: Int): F[LruMap[F, SchemaKey, SchemaCacheEntry]] =
+      createLruMap(size)
+
+    override def createSchemaListCache(size: Int): F[LruMap[F, ListCacheKey, ListCacheEntry]] =
+      createLruMap(size)
+
+  }
+
+  implicit def idCreateResolverCache: CreateResolverCache[Id] =
+    new SimpleCreateResolverCache[Id] {
+      def createLruMap[K, V](size: Int): LruMap[Id, K, V] =
+        CreateLruMap[Id, K, V].create(size)
+
+      def createMutex[K]: ResolverMutex[Id, K] =
+        ResolverMutex.idResolverMutex(new Object, createLruMap[K, Object](1000))
+    }
+
+  implicit def asyncCreateResolverCache[F[_]: Async]: CreateResolverCache[F] =
+    new SimpleCreateResolverCache[F] {
+
+      def createLruMap[K, V](size: Int): F[LruMap[F, K, V]] =
+        CreateLruMap[F, K, V].create(size)
+
+      def createMutex[K]: F[ResolverMutex[F, K]] =
+        for {
+          mutex  <- Mutex[F]
+          lrumap <- createLruMap[K, Mutex[F]](1000)
+        } yield ResolverMutex.asyncResolverMutex(mutex, lrumap)
+    }
+}