Skip to content

Create new public method CirceValidator#compileJsonSchema #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
istreeter merged 3 commits into from
Dec 8, 2025
Merged

Create new public method CirceValidator#compileJsonSchema #269

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
928e787
Open up more methods for public usage
gleb-lobov Dec 4, 2025
11f1cf8
Address feedback
gleb-lobov Dec 8, 2025
4cc5020
Dont expose validate on ready
gleb-lobov Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 22 additions & 31 deletions modules/core/src/main/scala/com.snowplowanalytics.iglu/client/validator/CirceValidator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ object CirceValidator extends Validator[Json] {
}
}

/** Validate instance against schema and return same instance */
private def validateOnReadySchema(
schema: JsonSchema,
instance: Json,
Expand Down Expand Up @@ -190,6 +189,26 @@ object CirceValidator extends Validator[Json] {
)
}

/** Compile circe json to networknt schema */
def compileJsonSchema(
schema: Json,
maxJsonDepth: Int
): Either[ValidatorError.InvalidSchema, JsonSchema] = {
for {
schemaAsNode <- circeToJackson(schema, maxJsonDepth).leftMap(_.toInvalidSchema)
_ <- validateSchema(schemaAsNode)
evaluated <- evaluateSchema(schemaAsNode)
} yield evaluated
}

private def validateSchema(schema: JsonNode): Either[ValidatorError.InvalidSchema, Unit] = {
val issues = validateSchemaAgainstV4(schema)
issues match {
case Nil => Right(())
case head :: tail => Left(ValidatorError.InvalidSchema(NonEmptyList(head, tail)))
}
}

private[client] object WithCaching {

/**
Expand Down Expand Up @@ -230,42 +249,14 @@ object CirceValidator extends Validator[Json] {
case Some(alreadyEvaluatedSchema) =>
alreadyEvaluatedSchema.pure[F]
case None =>
provideNewJsonSchema(schema, maxJsonDepth)
compileJsonSchema(schema, maxJsonDepth)
.pure[F]
.flatTap(result => evaluationCache.put((key, timestamp), result))
}
case ResolverResult.NotCached(SchemaItem(schema, _)) =>
provideNewJsonSchema(schema, maxJsonDepth).pure[F]
compileJsonSchema(schema, maxJsonDepth).pure[F]
}
}

private def provideNewJsonSchema(
schema: Json,
maxJsonDepth: Int
): Either[ValidatorError.InvalidSchema, JsonSchema] = {
for {
schemaAsNode <- circeToJackson(schema, maxJsonDepth).leftMap(_.toInvalidSchema)
_ <- validateSchema(schemaAsNode)
evaluated <- evaluateSchema(schemaAsNode)
} yield evaluated
}

private def validateSchema(schema: JsonNode): Either[ValidatorError.InvalidSchema, Unit] = {
val issues = V4Schema
.validate(schema)
.asScala
.toList
.map(m =>
ValidatorError.SchemaIssue(
Option(m.getInstanceLocation()).map(_.toString).getOrElse(""),
fromValidationMessage(m).message
)
)

issues match {
case Nil => Right(())
case head :: tail => Left(ValidatorError.InvalidSchema(NonEmptyList(head, tail)))
}
}
}
}