use crate::{
compiler,
error::ValidationError,
evaluation::{absorbed_error_node, ChildList, ErrorDescription},
keywords::{
helpers::{fail_on_non_positive_integer, size_limit},
CompilationResult,
},
paths::{LazyLocation, Location, RefTracker},
validator::{evaluate_assertion, EvaluationResult, Validate, ValidationContext},
Json, Node,
};
use referencing::Uri;
use serde_json::{Map, Value};
use std::sync::Arc;
pub(crate) struct MinLengthValidator {
limit: u64,
location: Location,
}
impl<F: Json> Validate<F> for MinLengthValidator {
fn is_valid(&self, instance: &F::Node<'_>, _ctx: &mut ValidationContext) -> bool {
if let Some(length) = instance.string_length() {
if length < self.limit {
return false;
}
}
true
}
fn validate<'i>(
&self,
instance: &F::Node<'i>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
_ctx: &mut ValidationContext,
) -> Result<(), ValidationError<'i>> {
if let Some(length) = instance.string_length() {
if length < self.limit {
return Err(ValidationError::min_length(
self.location.clone(),
crate::paths::capture_evaluation_path(tracker, &self.location),
location.into(),
instance.lazy_value(),
self.limit,
));
}
}
Ok(())
}
fn evaluate(
&self,
instance: &F::Node<'_>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
ctx: &mut ValidationContext,
) -> EvaluationResult {
evaluate_assertion::<F, _>(self, instance, location, tracker, ctx)
}
}
pub(crate) struct LengthRangeValidator {
minimum: u64,
maximum: u64,
min_location: Location,
max_location: Location,
max_absolute_location: Option<Arc<Uri<String>>>,
}
impl LengthRangeValidator {
fn min_error<'i, F: Json>(
&self,
instance: &F::Node<'i>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
) -> ValidationError<'i> {
ValidationError::min_length(
self.min_location.clone(),
crate::paths::capture_evaluation_path(tracker, &self.min_location),
location.into(),
instance.lazy_value(),
self.minimum,
)
}
fn max_error<'i, F: Json>(
&self,
instance: &F::Node<'i>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
) -> ValidationError<'i> {
ValidationError::max_length(
self.max_location.clone(),
crate::paths::capture_evaluation_path(tracker, &self.max_location),
location.into(),
instance.lazy_value(),
self.maximum,
)
.with_absolute_keyword_location(self.max_absolute_location.clone())
}
}
impl<F: Json> Validate<F> for LengthRangeValidator {
fn is_valid(&self, instance: &F::Node<'_>, _ctx: &mut ValidationContext) -> bool {
if let Some(length) = instance.string_length() {
if length < self.minimum || length > self.maximum {
return false;
}
}
true
}
fn validate<'i>(
&self,
instance: &F::Node<'i>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
_ctx: &mut ValidationContext,
) -> Result<(), ValidationError<'i>> {
if let Some(length) = instance.string_length() {
if length < self.minimum {
return Err(self.min_error::<F>(instance, location, tracker));
}
if length > self.maximum {
return Err(self.max_error::<F>(instance, location, tracker));
}
}
Ok(())
}
fn collect_errors<'i>(
&self,
instance: &F::Node<'i>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
_ctx: &mut ValidationContext,
errors: &mut Vec<ValidationError<'i>>,
) {
if let Some(length) = instance.string_length() {
if length < self.minimum {
errors.push(self.min_error::<F>(instance, location, tracker));
}
if length > self.maximum {
errors.push(self.max_error::<F>(instance, location, tracker));
}
}
}
fn evaluate(
&self,
instance: &F::Node<'_>,
location: &LazyLocation,
tracker: Option<&RefTracker>,
ctx: &mut ValidationContext,
) -> EvaluationResult {
let Some(length) = instance.string_length() else {
return EvaluationResult::valid_empty();
};
let mut children = ChildList::default();
if length > self.maximum {
let error = ErrorDescription::from_validation_error(
&self.max_error::<F>(instance, location, tracker),
);
let child = absorbed_error_node(
location,
tracker,
&self.max_location,
self.max_absolute_location.as_ref(),
error,
ctx,
);
children.push(&mut ctx.arena, child);
}
let mut result = EvaluationResult::from_children(children);
if length < self.minimum {
result.mark_errored(ErrorDescription::from_validation_error(
&self.min_error::<F>(instance, location, tracker),
));
}
result
}
}
#[inline]
pub(crate) fn compile<'a, F: Json>(
ctx: &compiler::Context<F>,
parent: &'a Map<String, Value>,
schema: &'a Value,
) -> Option<CompilationResult<'a, F>> {
let location = ctx.location().join("minLength");
let Some(minimum) = size_limit(ctx, schema) else {
return Some(Err(fail_on_non_positive_integer(schema, location)));
};
let maximum = parent
.get("maxLength")
.filter(|_| !ctx.is_keyword_overridden("maxLength"))
.and_then(|max| size_limit(ctx, max));
if let Some(maximum) = maximum {
let max_location = ctx.location().join("maxLength");
return Some(Ok(Box::new(LengthRangeValidator {
minimum,
maximum,
max_absolute_location: ctx.absolute_location(&max_location),
min_location: location,
max_location,
})));
}
Some(Ok(Box::new(MinLengthValidator {
limit: minimum,
location,
})))
}
#[cfg(test)]
mod tests {
use crate::tests_util;
use serde_json::json;
#[test]
fn location() {
tests_util::assert_schema_location(&json!({"minLength": 1}), &json!(""), "/minLength");
}
#[test]
fn fused_locations() {
let schema = json!({"minLength": 2, "maxLength": 4});
tests_util::assert_schema_location(&schema, &json!("a"), "/minLength");
tests_util::assert_schema_location(&schema, &json!("abcde"), "/maxLength");
}
#[test]
fn fused_bounds_are_inclusive() {
let schema = json!({"minLength": 2, "maxLength": 4});
tests_util::is_valid(&schema, &json!("ab"));
tests_util::is_valid(&schema, &json!("abcd"));
tests_util::is_not_valid(&schema, &json!("a"));
tests_util::is_not_valid(&schema, &json!("abcde"));
}
#[test]
fn fused_ignores_non_strings() {
let schema = json!({"minLength": 2, "maxLength": 4});
tests_util::is_valid(&schema, &json!(1));
tests_util::is_valid(&schema, &json!(null));
tests_util::is_valid(&schema, &json!(["a"]));
}
#[test]
fn fused_counts_code_points() {
tests_util::is_valid(&json!({"minLength": 5, "maxLength": 5}), &json!("héllo"));
tests_util::is_valid(&json!({"minLength": 2, "maxLength": 2}), &json!("💩💩"));
tests_util::is_not_valid(&json!({"minLength": 3, "maxLength": 4}), &json!("💩💩"));
}
#[test]
fn unsatisfiable_range_reports_both() {
let validator = crate::validator_for(&json!({"minLength": 5, "maxLength": 3})).unwrap();
let mut locations: Vec<String> = validator
.iter_errors(&json!("abcd"))
.map(|error| error.schema_path().as_str().to_string())
.collect();
locations.sort();
assert_eq!(locations, ["/maxLength", "/minLength"]);
}
#[test]
fn invalid_sibling_still_reported() {
assert!(crate::validator_for(&json!({"minLength": 1, "maxLength": -1})).is_err());
assert!(crate::validator_for(&json!({"minLength": -1, "maxLength": 1})).is_err());
}
#[test]
fn fused_absolute_keyword_locations() {
tests_util::assert_absolute_keyword_locations(
&json!({
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://example.com/s.json",
"minLength": 20,
"maxLength": 5
}),
&json!("secretvalue"),
&[
("minLength", "https://example.com/s.json#/minLength"),
("maxLength", "https://example.com/s.json#/maxLength"),
],
);
}
#[test]
fn fused_evaluate_keyword_locations() {
let validator = crate::validator_for(&json!({"minLength": 20, "maxLength": 5}))
.expect("Invalid schema");
let instance = json!("secretvalue");
tests_util::assert_keyword_location(&validator, &instance, "", "/minLength");
tests_util::assert_keyword_location(&validator, &instance, "", "/maxLength");
}
#[test]
fn fused_error_locations() {
let schema = json!({"minLength": 2, "maxLength": 3});
tests_util::assert_error_locations(
&schema,
&json!("a"),
&[("\"a\" is shorter than 2 characters", "", "/minLength")],
);
tests_util::assert_error_locations(
&schema,
&json!("abcd"),
&[("\"abcd\" is longer than 3 characters", "", "/maxLength")],
);
tests_util::assert_error_locations(
&json!({"minLength": 20, "maxLength": 5}),
&json!("secretvalue"),
&[
(
"\"secretvalue\" is shorter than 20 characters",
"",
"/minLength",
),
(
"\"secretvalue\" is longer than 5 characters",
"",
"/maxLength",
),
],
);
}
}