Skip to content

feat(dpp): better json schema error messages for data contracts #1175

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

Closed
pauldelucia wants to merge 10 commits into from
Closed

feat(dpp): better json schema error messages for data contracts #1175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2d925b7
add error_message field to JsonSchemaErrorData
pauldelucia Jun 13, 2023
705bf2c
add error_message field to JsonSchemaErrorData
pauldelucia Jun 13, 2023
e80e001
add error_message field to JsonSchemaErrorData
pauldelucia Jun 13, 2023
a8fca93
change JsonSchemaError error message
pauldelucia Jun 13, 2023
ae849bd
small fix of unused variable
pauldelucia Jun 14, 2023
5f35cbb
cargo fmt
pauldelucia Jun 20, 2023
fab8e54
Merge branch 'v0.25-dev' into v0.25-dev
QuantumExplorer Jun 20, 2023
4a37802
Merge branch 'v0.25-dev' into v0.25-dev
QuantumExplorer Jul 13, 2023
5cec1d0
Merge pull request #1 from dashpay/v0.25-dev
pauldelucia Aug 11, 2023
a4ad6c7
Merge branch 'dashpay:v0.25-dev' into v0.25-dev
pauldelucia Aug 21, 2023
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
5 changes: 3 additions & 2 deletions packages/rs-dpp/src/errors/consensus/basic/json_schema_error/json_schema_error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use serde_json::Value as JsonValue;
use thiserror::Error;

#[derive(Error, Debug, Serialize, Deserialize, Clone, Encode, Decode)]
#[error("JsonSchemaError: keyword: {keyword}, instance_path: {instance_path}, schema_path:{schema_path}")]
#[error("JsonSchemaError: {error_summary}, path: {instance_path}")]
pub struct JsonSchemaError {
/*

Expand All @@ -30,11 +30,12 @@ impl<'a> From<ValidationError<'a>> for JsonSchemaError {
keyword,
params,
property_name,
error_message,
} = JsonSchemaErrorData::from(&validation_error);

Self {
keyword,
error_summary: "".to_string(),
error_summary: error_message,
instance_path: validation_error.instance_path.to_string(),
schema_path: validation_error.schema_path.to_string(),
params: JsonValue::Object(params).into(),
Expand Down
109 changes: 53 additions & 56 deletions packages/rs-dpp/src/errors/consensus/basic/json_schema_error/json_schema_error_data.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use jsonschema::paths::PathChunk;
use jsonschema::ValidationError;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::fmt::Write;
use std::ops::Deref;

#[derive(Debug, Serialize, Default, Deserialize)]
Expand All @@ -15,50 +16,55 @@ pub struct JsonSchemaErrorData {
pub keyword: String,
pub params: serde_json::Map<String, Value>,
pub property_name: String,
pub error_message: String,
}

impl<'a> From<&ValidationError<'a>> for JsonSchemaErrorData {
fn from(validation_error: &ValidationError<'a>) -> Self {
let mut error_message = String::new();
let _ = write!(&mut error_message, "{}", validation_error);
let builder = DataBuilder::new().set_error_message(error_message);

match &validation_error.kind {
ValidationErrorKind::Required { property } => DataBuilder::new()
ValidationErrorKind::Required { property } => builder
.set_keyword("required")
.set_property_name(property.to_string())
.add_param("missingProperty", property.clone())
.build(),
ValidationErrorKind::AdditionalItems { limit } => DataBuilder::new()
ValidationErrorKind::AdditionalItems { limit } => builder
.set_keyword("additionalItems")
.add_param("maxItems", Value::from(*limit))
.build(),
ValidationErrorKind::AdditionalProperties { unexpected } => DataBuilder::new()
ValidationErrorKind::AdditionalProperties { unexpected } => builder
.set_keyword("additionalProperties")
.add_param("additionalProperties", unexpected.clone().into())
.build(),
ValidationErrorKind::AnyOf => DataBuilder::new().set_keyword("anyOf").build(),
ValidationErrorKind::BacktrackLimitExceeded { .. } => DataBuilder::new()
.set_keyword("backtrackLimitExceeded")
.build(),
ValidationErrorKind::Constant { expected_value } => DataBuilder::new()
ValidationErrorKind::AnyOf => builder.set_keyword("anyOf").build(),
ValidationErrorKind::BacktrackLimitExceeded { .. } => {
builder.set_keyword("backtrackLimitExceeded").build()
}
ValidationErrorKind::Constant { expected_value } => builder
.set_keyword("const")
.add_param("allowedValue", expected_value.clone())
.build(),
ValidationErrorKind::Contains => DataBuilder::new().set_keyword("contains").build(),
ValidationErrorKind::ContentEncoding { content_encoding } => DataBuilder::new()
ValidationErrorKind::Contains => builder.set_keyword("contains").build(),
ValidationErrorKind::ContentEncoding { content_encoding } => builder
.set_keyword("contentEncoding")
.add_param("contentEncoding", content_encoding.clone().into())
.build(),
ValidationErrorKind::ContentMediaType { content_media_type } => DataBuilder::new()
ValidationErrorKind::ContentMediaType { content_media_type } => builder
.set_keyword("contentMediaType")
.add_param("contentMediaType", content_media_type.clone().into())
.build(),
ValidationErrorKind::Enum { options } => DataBuilder::new()
ValidationErrorKind::Enum { options } => builder
.set_keyword("enum")
.add_param("enum", options.clone())
.build(),
ValidationErrorKind::ExclusiveMaximum { limit } => DataBuilder::new()
ValidationErrorKind::ExclusiveMaximum { limit } => builder
.set_keyword("exclusiveMaximum")
.add_param("exclusiveMaximum", limit.clone())
.build(),
ValidationErrorKind::ExclusiveMinimum { limit } => DataBuilder::new()
ValidationErrorKind::ExclusiveMinimum { limit } => builder
.set_keyword("exclusiveMinimum")
.add_param("exclusiveMinimum", limit.clone())
.build(),
Expand All @@ -69,76 +75,66 @@ impl<'a> From<&ValidationError<'a>> for JsonSchemaErrorData {
_ => "falseSchema",
};

DataBuilder::new().set_keyword(keyword).build()
}
ValidationErrorKind::FileNotFound { .. } => {
DataBuilder::new().set_keyword("fileNotFound").build()
builder.set_keyword(keyword).build()
}
ValidationErrorKind::Format { format } => DataBuilder::new()
ValidationErrorKind::FileNotFound { .. } => builder.set_keyword("fileNotFound").build(),
ValidationErrorKind::Format { format } => builder
.set_keyword("format")
.add_param("format", format.to_string().into())
.build(),
ValidationErrorKind::FromUtf8 { .. } => {
DataBuilder::new().set_keyword("fromUtf8").build()
}
ValidationErrorKind::Utf8 { .. } => DataBuilder::new().set_keyword("utf8").build(),
ValidationErrorKind::JSONParse { .. } => {
DataBuilder::new().set_keyword("JSONParse").build()
}
ValidationErrorKind::InvalidReference { reference } => DataBuilder::new()
ValidationErrorKind::FromUtf8 { .. } => builder.set_keyword("fromUtf8").build(),
ValidationErrorKind::Utf8 { .. } => builder.set_keyword("utf8").build(),
ValidationErrorKind::JSONParse { .. } => builder.set_keyword("JSONParse").build(),
ValidationErrorKind::InvalidReference { reference } => builder
.set_keyword("invalidReference")
.add_param("invalidReference", reference.clone().into())
.build(),
ValidationErrorKind::InvalidURL { .. } => {
DataBuilder::new().set_keyword("invalidURL").build()
}
ValidationErrorKind::MaxItems { limit } => DataBuilder::new()
ValidationErrorKind::InvalidURL { .. } => builder.set_keyword("invalidURL").build(),
ValidationErrorKind::MaxItems { limit } => builder
.set_keyword("maxItems")
.add_param("maxItems", Value::from(*limit))
.build(),
ValidationErrorKind::Maximum { limit } => DataBuilder::new()
ValidationErrorKind::Maximum { limit } => builder
.set_keyword("maximum")
.add_param("maximum", limit.clone())
.build(),
ValidationErrorKind::MaxLength { limit } => DataBuilder::new()
ValidationErrorKind::MaxLength { limit } => builder
.set_keyword("maxLength")
.add_param("maxLength", Value::from(*limit))
.build(),
ValidationErrorKind::MaxProperties { limit } => DataBuilder::new()
ValidationErrorKind::MaxProperties { limit } => builder
.set_keyword("maxProperties")
.add_param("maxProperties", Value::from(*limit))
.build(),
ValidationErrorKind::MinItems { limit } => DataBuilder::new()
ValidationErrorKind::MinItems { limit } => builder
.set_keyword("minItems")
.add_param("minItems", Value::from(*limit))
.build(),
ValidationErrorKind::Minimum { limit } => DataBuilder::new()
ValidationErrorKind::Minimum { limit } => builder
.set_keyword("minimum")
.add_param("minimum", limit.clone())
.build(),
ValidationErrorKind::MinLength { limit } => DataBuilder::new()
ValidationErrorKind::MinLength { limit } => builder
.set_keyword("minLength")
.add_param("minLength", Value::from(*limit))
.build(),
ValidationErrorKind::MinProperties { limit } => DataBuilder::new()
ValidationErrorKind::MinProperties { limit } => builder
.set_keyword("minProperties")
.add_param("minProperties", Value::from(*limit))
.build(),
ValidationErrorKind::MultipleOf { multiple_of } => DataBuilder::new()
ValidationErrorKind::MultipleOf { multiple_of } => builder
.set_keyword("multipleOf")
.add_param("multipleOf", Value::from(*multiple_of))
.build(),
ValidationErrorKind::Not { schema } => DataBuilder::new()
ValidationErrorKind::Not { schema } => builder
.set_keyword("not")
.add_param("not", schema.clone())
.build(),
ValidationErrorKind::OneOfMultipleValid => {
DataBuilder::new().set_keyword("oneOfMultipleValid").build()
builder.set_keyword("oneOfMultipleValid").build()
}
ValidationErrorKind::OneOfNotValid => {
DataBuilder::new().set_keyword("oneOfNotValid").build()
}
ValidationErrorKind::Pattern { pattern } => DataBuilder::new()
ValidationErrorKind::OneOfNotValid => builder.set_keyword("oneOfNotValid").build(),
ValidationErrorKind::Pattern { pattern } => builder
.set_keyword("pattern")
.add_param("pattern", pattern.clone().into())
.build(),
Expand All @@ -147,9 +143,10 @@ impl<'a> From<&ValidationError<'a>> for JsonSchemaErrorData {
keyword,
params,
property_name,
error_message: _,
} = JsonSchemaErrorData::from(error.deref());

DataBuilder::new()
builder
.set_keyword("propertyNames")
.add_param("instancePath", error.instance_path.to_string().into())
.add_param("schemaPath", error.schema_path.to_string().into())
Expand All @@ -159,7 +156,7 @@ impl<'a> From<&ValidationError<'a>> for JsonSchemaErrorData {
.add_param("propertyName", property_name.into())
.build()
}
ValidationErrorKind::Schema => DataBuilder::new().set_keyword("schema").build(),
ValidationErrorKind::Schema => builder.set_keyword("schema").build(),
ValidationErrorKind::Type { kind } => {
let val: Value = match kind {
TypeKind::Single(single) => single.to_string().into(),
Expand All @@ -169,19 +166,14 @@ impl<'a> From<&ValidationError<'a>> for JsonSchemaErrorData {
.collect::<Vec<Value>>()
.into(),
};
DataBuilder::new()
.set_keyword("type")
.add_param("type", val)
.build()
}
ValidationErrorKind::UniqueItems => {
DataBuilder::new().set_keyword("uniqueItems").build()
builder.set_keyword("type").add_param("type", val).build()
}
ValidationErrorKind::UnknownReferenceScheme { scheme } => DataBuilder::new()
ValidationErrorKind::UniqueItems => builder.set_keyword("uniqueItems").build(),
ValidationErrorKind::UnknownReferenceScheme { scheme } => builder
.set_keyword("unknownReferenceScheme")
.add_param("unknownReferenceScheme", scheme.clone().into())
.build(),
ValidationErrorKind::Resolver { url, error: _ } => DataBuilder::new()
ValidationErrorKind::Resolver { url, error: _ } => builder
.set_keyword("resolver")
.add_param("url", url.to_string().into())
.build(),
Expand Down Expand Up @@ -215,6 +207,11 @@ impl DataBuilder {
self
}

fn set_error_message(mut self, message: String) -> Self {
self.data.error_message = message;
self
}

fn build(self) -> JsonSchemaErrorData {
self.data
}
Expand Down